Change several instances of "git cl" in the Contributors Guide to "git-cl".

[lilypond.git] / Documentation / contributor / source-code.itexi

diff --git a/Documentation/contributor/source-code.itexi b/Documentation/contributor/source-code.itexi
index 250ad99d2e6ae476caa26d4d786b9728306ecac0..4a7357878c85e13f87a3aaf5ed289baed674596a 100644 (file)
--- a/Documentation/contributor/source-code.itexi
+++ b/Documentation/contributor/source-code.itexi
@@ -1352,16 +1352,12 @@ Account Settings must have the @q{Access for less secure apps} set to
 @q{Allowed}.  This is normally the default setting.}
 
 @item
-Move into the top source directory and then configure @command{git
-cl} with the following commands:
-
-@item
-Move into the top source directory and then configure @command{git
-cl} with the following commands:
+Move into the top source directory and then configure
+@command{git-cl} with the following commands:
 
 @example
 cd $LILYPOND_GIT
-git cl config
+git-cl config
 @end example
 
 For the @qq{Rietveld server} question, the default value
@@ -1375,7 +1371,7 @@ lilypond-devel@@gnu.org
 @end example
 
 The @qq{Tree status URL} value should be left blank.  So should
-the @qq{ViewVC URL} value, since it is used by @command{git cl
+the @qq{ViewVC URL} value, since it is used by @command{git-cl
 dcommit} which is only for repositories which use @command{git
 svn} (LilyPond doesn't).
 
@@ -1383,6 +1379,9 @@ svn} (LilyPond doesn't).
 
 @subsubheading Uploading patch set
 
+This section assumes that you have already configured the
+@command{git-cl} @q{helper-script}.  See @ref{git-cl}.
+
 @warning{Unless you are familiar with branches, only work on one
 set of changes at once.}
 
@@ -1390,13 +1389,13 @@ There are two methods, depending on your git setup.
 
 @itemize
 @item
-@strong{Master branch}: (easy option, and used in @command{lily-git.tcl})
+@strong{Master branch}: (easy option)
 
 If you added your patch to @code{master}, then:
 
 @example
 git pull -r
-git cl upload origin/master
+git-cl upload origin/master
 @end example
 
 @c Mention staging here?
@@ -1414,16 +1413,28 @@ option.
 @item
 @strong{Separate branch}: (complicated option)
 
-Ensure your changes are committed in a separate branch, which
-should differ from the reference branch to be used by just the
-changes to be uploaded.  If the reference branch is to be
-origin/master, ensure this is up-to-date.  If necessary, use git
-rebase to rebase the branch containing the changes to the head of
-origin/master.  Finally, check out branch with the changes and
-enter the command:
+Ensure your changes are committed in a separate branch, which should
+differ from the reference branch to be used (usually
+@code{origin/master}) by just the changes to be uploaded.  Checkout the
+branch with the changes:
+
+@example
+git checkout some-branch-with-changes
+@end example
+
+If the reference branch is to be @code{origin/master}, ensure that the
+branch containing the changes is up-to-date with it.  Use
+@command{git rebase} or @command{git pull -r} to rebase the branch to
+the head of @code{origin/master}.  For example:
+
+@example
+git pull -r origin master
+@end example
+
+Finally, start the upload by entering:
 
 @example
-git cl upload <reference SHA1 ID>
+git-cl upload <reference SHA1 ID>
 @end example
 
 @noindent
@@ -1432,7 +1443,7 @@ as a reference source for the patch.  Generally, this will be the
 SHA1 ID of origin/master, and in that case the command:
 
 @example
-git cl upload origin/master
+git-cl upload origin/master
 @end example
 
 @noindent
@@ -1476,20 +1487,20 @@ associate the new branch with an existing Rietveld issue,
 the following command can be used:
 
 @example
-git cl issue issue-number
+git-cl issue issue-number
 @end example
 
 @noindent
 where @code{issue-number} is the number of the existing Rietveld
 issue.
 
-@subsubheading Resetting git cl
+@subsubheading Resetting git-cl
 
-If @command{git cl} becomes confused, you can @qq{reset} it by
+If @command{git-cl} becomes confused, you can @qq{reset} it by
 running:
 
 @example
-git cl issue 0
+git-cl issue 0
 @end example
 
 @subsubheading Wait for a countdown