Changes between Version 17 and Version 18 of Developer/Git/Users

Timestamp:

06/02/17 00:44:19 (7 years ago)

Author:

Chris Johns

Comment:

Add more detail about using local branchs to the Making Chanages section.

Developer/Git/Users

@@ -41 +41 @@
 }}}
 This command will update all your local branches with any new code revisions available on the central repository.
+
 = Making Changes =
 
-Git allows you to make changes in the RTEMS source tree and track those changes locally. First you need to clone the repository:
+Git allows you to make changes in the RTEMS source tree and track those changes locally. We recommend you make all your changes in local branches. If you are working on a few different changes or a progression of changes it is best to use a local branch for each change. 
+
+A branch for each change lets your repo's master branch track the upstream RTEMS's master branch without interacting with any of the changes you are working on. A completed change is emailed to the developers list for review and this can take time. While this is happening the upstream's master branch may be updated and you may need to rebase your work and test again if you are required to change of update your patch. A local branch isolates a specific change from others and helps you manage the process.
+
+First you need to clone the repository:
 {{{
  git clone git://git.rtems.org/rtems.git rtems
@@ -51 +56 @@
  cd rtems
  git pull
+}}}
+Create a local branch to make your changes in, in this example the change is `faster-context-switch`:
+{{{
+ git checkout -b faster-context-switch
 }}}
 Next make your changes to files. If you add, delete or move/rename files you need to inform Git
@@ -62 +71 @@
  git commit -a
 }}}
-The -a flag commits all the changes that were made, but you can also control which changes to commit by individually adding files as you modify them by using. You can also specify other options to commit, such as a message with the -m flag.
+The `-a` flag commits all the changes that were made, but you can also control which changes to commit by individually adding files as you modify them by using. You can also specify other options to commit, such as a message with the `-m` flag.
 {{{
  git add /some/changed/files
  git commit
 }}}
-But you shouldn't do any of this on the branch that you cloned, instead you should create a new branch to work with, so that the cloned branch (master) is a pristine copy of the upstream RTEMS repository.
+Create a patch from your branch, in this case we have two commits we want to send for review:
+{{{
+ git format-patch -2
+}}}
+We could send the patches directly to the developer's list for review:
+{{{
+ git send-email --to=devel@rtems.org -2
+}}}
+There are new changes pushed to the RTEMS's master branch and our local branch needs to be updated:
+{{{
+ git checkout master
+ git pull
+ git checkout faster-context-switch
+ git rebase
+}}}
 
 = Working with Branches =
@@ -271 +294 @@
  git config --global user.email name@domain.com
 }}}
+
+Please user a real name, we do not allow pseudonyms or anonymous contributions.
 
 = Submitting a Patch =