PATCH: git development note

PATCH: git development note

[Peter Stephenson]

I hope this is simple enough not to spark off a microfactoid war between
ultra-git-experts...

diff --git a/Etc/zsh-development-guide b/Etc/zsh-development-guide
index 2ed7542..7f5266b 100644
--- a/Etc/zsh-development-guide
+++ b/Etc/zsh-development-guide
@@ -60,12 +60,12 @@ Git Workflow
 
 Zsh has migrated from CVS to git for version control. Thus far, we have
 avoided further changes to our workflow.
- 
+
  * To allow changesets to be cross-referenced between the mailing list
    archives and version control history, commit messages should start with
    the mailing list sequence number. This number is generated by the list
    server and inserted as an X-Seq: header field in the e-mail.
- 
+
  * An entry in the ChangeLog file should be added manually before pushing
    a commit to the master repository. Don't create a separate change for
    this: amend the existing commit in your local repository.
@@ -82,6 +82,7 @@ Micro Git Tutorial:
   % $VISUAL file1.c file2.c new-file3.c
   % git add new-file3.c
   % git commit -a
+  % git pull --rebase
   % git push
 
  "git commit -a" automatically finds files which are tracked and have
@@ -89,6 +90,12 @@ Micro Git Tutorial:
  the index to be part of the next commit, and can be used for new files
  or for existing files (commit -a is a shortcut for the latter)
 
+"git pull --rebase" ensures your local branch is up to date, needed
+before pushing; the "--rebase" option means that any changes
+in files also modified by you are handled by replaying your changes
+onto the remote ones, which avoids any unnecessary merges in the
+resulting history.
+
  "git push" assumes that you're on the master branch and the repository
  was created by cloning it from some place, with default options.
 

-- 
Peter Stephenson | Principal Engineer Samsung Cambridge Solution Centre
Email: p.stephenson@samsung.com | Phone: +44 1223 434724 |
www.samsung.com