Changes between Version 3 and Version 4 of Developer/Git/Users

Timestamp:

03/04/12 22:41:20 (12 years ago)

Author:

Gedare

Comment:

/* Creating a Patch */

Developer/Git/Users

@@ -248 +248 @@
 = Creating a Patch =
 
-To contribute to RTEMS see [wiki:Developer/Contributing Contributing]
+Before submitting a patch read about [wiki:Developer/Contributing Contributing] to RTEMS. A patch is a text file containing the difference between an old and new version of code. Patches against current development (git head) are preferred to patches against releases unless your patch is intended as a bug fix candidate for a release branch. Send one patch for each logical change made. Each patch you submit should be impossible to subdivide into more patches because of dependencies between the changed parts. Patches that fix code formatting to conform to [wiki:Developer/Coding/Conventions our standards] are best not mixed with substantive changes and vice versa, because the code reformatting hides the functional changes.
+
+The recommended way to create a patch is to branch the [wiki:Git git repository] master and use one commit for each logical change. Then you can use ''git-format-patch'' to turn your commits into patches and easily submit them.
+{{{
+ git format-patch master
+}}}
+Creates a separate patch for each commit that has been made between the master branch and the current branch and writes them in the current directory. Use the -o flag to redirect the files to a different directory. These files, appended with .patch, are formatted so they can be emailed and rely on having git configured with your name and email address, for example
+{{{
+ git config --global user.name "Your Name"
+ git config --global user.email name@domain.com
+}}}
+
+If you do not have the Git repository available then you can use the diff program to create a patch by comparing an unmodified RTEMS against the version containing your changes with ''diff -up rtems rtems-new'' and redirect the output to a file.
+
+We prefer patches posted as plain text. If the patch is too big posting it gzipped is acceptable but it would be better as a branch that can be pulled/reviewed. Submit your patch to the [wiki:RTEMSMailingLists_  rtems-devel mailing list] and if the patch fixes a bug, file a PR on the [wiki:Bugzilla Bugzilla].
 =  Troubleshooting  =