Release: update news.

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

diff --git a/Documentation/contributor/source-code.itexi b/Documentation/contributor/source-code.itexi
index 13e3b18be8e1362a7132486b569b004677cb5445..b15e8442488368f883e43f01f601296921f23d1c 100644 (file)
--- a/Documentation/contributor/source-code.itexi
+++ b/Documentation/contributor/source-code.itexi
@@ -65,9 +65,9 @@ Download the @command{lily-git.tcl} script from:
 @c don't change the cgit link below to gitweb; gitweb uses
 @c long filenames like "scripts_auxiliar_lily-git.tcl"
 
 @c don't change the cgit link below to gitweb; gitweb uses
 @c long filenames like "scripts_auxiliar_lily-git.tcl"
 

-@example
+@smallexample

 @uref{http://git.sv.gnu.org/cgit/lilypond.git/plain/scripts/auxiliar/lily-git.tcl}
 @uref{http://git.sv.gnu.org/cgit/lilypond.git/plain/scripts/auxiliar/lily-git.tcl}

-@end example
+@end smallexample

 
 @item
 To run the program from the command line, navigate to the
 
 @item
 To run the program from the command line, navigate to the


@@ -196,7 +196,7 @@ should configure some basic settings with the
 global and repository-specific options.
 
 To configure settings that affect all repositories, use the
 global and repository-specific options.
 
 To configure settings that affect all repositories, use the

-@command{--global} command line option.  For example, the first
+@option{--global} command line option.  For example, the first

 two options that you should always set are your @var{name} and
 @var{email}, since Git needs these to keep track of commit
 authors:
 two options that you should always set are your @var{name} and
 @var{email}, since Git needs these to keep track of commit
 authors:


@@ -247,7 +247,7 @@ by the above commands would look like this:
 @end example
 
 Using the @command{git@tie{}config} command @emph{without} the
 @end example
 
 Using the @command{git@tie{}config} command @emph{without} the

-@command{--global} option configures repository-specific settings,
+@option{--global} option configures repository-specific settings,

 which are stored in the file @file{.git/config}.  This file is
 created when a repository is initialized (using
 @command{git@tie{}init}), and by default contains these lines:
 which are stored in the file @file{.git/config}.  This file is
 created when a repository is initialized (using
 @command{git@tie{}init}), and by default contains these lines:


@@ -522,7 +522,7 @@ git pull    # recommended for translators
 @end example
 
 If you're tracking the remote @code{master} branch, you should add
 @end example
 
 If you're tracking the remote @code{master} branch, you should add

-the @code{-r} option (short for @code{--rebase}) to keep commits
+the @option{-r} option (short for @option{--rebase}) to keep commits

 on your local branch current:
 
 @example
 on your local branch current:
 
 @example


@@ -530,7 +530,7 @@ git pull -r # use with caution when translating
 @end example
 
 If you don't edit translated documentation and don't want to type
 @end example
 
 If you don't edit translated documentation and don't want to type

-@code{-r} every time, configure the master branch to rebase by
+@option{-r} every time, configure the master branch to rebase by

 default with this command:
 
 @example
 default with this command:
 
 @example


@@ -629,7 +629,7 @@ git branch -d @var{name}
 @end example
 
 Git will ask you for confirmation if it sees that data would be
 @end example
 
 Git will ask you for confirmation if it sees that data would be

-lost by deleting the branch.  Use @code{-D} instead of @code{-d}
+lost by deleting the branch.  Use @option{-D} instead of @option{-d}

 to bypass this.  Note that you cannot delete a branch if it is
 currently checked out.
 
 to bypass this.  Note that you cannot delete a branch if it is
 currently checked out.
 


@@ -801,7 +801,7 @@ git commit -a
 @end example
 
 @noindent
 @end example
 
 @noindent

-The @code{-a} is short for @code{--all} which includes modified
+The @option{-a} is short for @option{--all} which includes modified

 and deleted files, but only those newly created files that have
 previously been added.
 
 and deleted files, but only those newly created files that have
 previously been added.
 


@@ -873,7 +873,7 @@ We prefer it if you follow the instructions in
 alternate method here.
 
 You should always run @command{git@tie{}pull@tie{}-r} (translators
 alternate method here.
 
 You should always run @command{git@tie{}pull@tie{}-r} (translators

-should leave off the @code{-r}) before doing this to ensure that
+should leave off the @option{-r}) before doing this to ensure that

 your patches are as current as possible.
 
 Once you have made one or more commits in your local repository,
 your patches are as current as possible.
 
 Once you have made one or more commits in your local repository,


@@ -924,7 +924,7 @@ LilyDev users should skip over these @q{install} instructions.
 Install @command{git-cl} by entering:
 
 @example
 Install @command{git-cl} by entering:
 
 @example

-git clone git://neugierig.org/git-cl.git
+git clone https://github.com/martine/git-cl

 @end example
 
 @item
 @end example
 
 @item


@@ -1017,6 +1017,11 @@ After prompting for your Google email address and password, the
 patch set will be posted to Rietveld, and you will be given a URL
 for your patch.
 
 patch set will be posted to Rietveld, and you will be given a URL
 for your patch.
 

+@warning{Some installations of git-cl fail when uploading a patch
+set that includes a .scm file.  When this happens, it can
+generally be fixed by editing the file @file{/etc/mime.types}.
+Add a line to this file containing @code{text/x-script.scheme scm}.}
+

 @subsubheading Announcing your patch set
 
 You should then announce the patch by logging into the code review
 @subsubheading Announcing your patch set
 
 You should then announce the patch by logging into the code review


@@ -1024,6 +1029,9 @@ issue webpage and using @qq{Publish + Mail Comments} to add a
 (mostly bogus) comment to your issue.  The text of your comment
 will be sent to our developer mailing list.
 
 (mostly bogus) comment to your issue.  The text of your comment
 will be sent to our developer mailing list.
 

+@warning{There is no automatic notification of a new patch; you
+must add a comment yourself.}
+

 @subsubheading Revisions
 
 As revisions are made in response to comments, successive patch sets
 @subsubheading Revisions
 
 As revisions are made in response to comments, successive patch sets


@@ -1078,6 +1086,7 @@ several Git branches of LilyPond source code is presented.
 * Git log::
 * Applying remote patches::
 * Sending and receiving patches via email::
 * Git log::
 * Applying remote patches::
 * Sending and receiving patches via email::

+* Cleaning up multiple patches::

 * Commit access::
 @end menu
 
 * Commit access::
 @end menu
 


@@ -1185,8 +1194,8 @@ any changes you have made!
 
 Sometimes git will become hopelessly confused, and you just want
 to get back to a known, stable state.  This command destroys any
 
 Sometimes git will become hopelessly confused, and you just want
 to get back to a known, stable state.  This command destroys any

-local changes you have made, but at least you get back to the
-current online version:
+local changes you have made in the currently checked-out branch,
+but at least you get back to the current online version:

 
 @example
 git reset --hard origin/master
 
 @example
 git reset --hard origin/master


@@ -1345,6 +1354,23 @@ provided on the Wine wiki at
 @uref{http://wiki.winehq.org/GitWine}.
 
 
 @uref{http://wiki.winehq.org/GitWine}.
 
 

+@node Cleaning up multiple patches
+@subsection Cleaning up multiple patches
+
+If you have been developing on your own branch for a while, you
+may have more commmits than is really sensible.  To revise your
+work and condense commits, use:
+
+@example
+git rebase origin/master
+git rebase -i origin/master
+@end example
+
+@warning{Be a bit cautious -- if you completely remove commits
+during the interactive session, you will... err... completely
+remove those commits.}
+
+

 @node Commit access
 @subsection Commit access
 
 @node Commit access
 @subsection Commit access
 


@@ -1370,6 +1396,9 @@ you visit the link, follow the steps for including the CAcert root
 certificate in your browser, given at
 @uref{http://savannah.gnu.org/tls/tutorial/}.
 
 certificate in your browser, given at
 @uref{http://savannah.gnu.org/tls/tutorial/}.
 

+@warning{Savannah will silently put your username in lower-case --
+do not try to use capital letters.}
+

 
 @item
 After registering, if you are not logged in automatically, login
 
 @item
 After registering, if you are not logged in automatically, login


@@ -1393,15 +1422,15 @@ Contributor of} on your @qq{My Group Membership} page.
 
 
 @item
 
 
 @item

-Generate an SSH @q{dsa} key pair.  Enter the following at the
+Generate an SSH @q{rsa} key pair.  Enter the following at the

 command prompt:
 
 @example
 command prompt:
 
 @example

-ssh-keygen -t dsa
+ssh-keygen -t rsa

 @end example
 
 When prompted for a location to save the key, press <ENTER> to
 @end example
 
 When prompted for a location to save the key, press <ENTER> to

-accept the default location (@file{~/.ssh/id_dsa}).
+accept the default location (@file{~/.ssh/id_rsa}).

 
 Next you are asked to enter an optional passphrase.  On most
 systems, if you use a passphrase, you will likely be prompted for
 
 Next you are asked to enter an optional passphrase.  On most
 systems, if you use a passphrase, you will likely be prompted for


@@ -1413,7 +1442,7 @@ though you may find it tedious to keep re-entering it.
 You can change/enable/disable your passphrase at any time with:
 
 @example
 You can change/enable/disable your passphrase at any time with:
 
 @example

-ssh-keygen -f ~/.ssh/id_dsa -p
+ssh-keygen -f ~/.ssh/id_rsa -p

 @end example
 
 Note that the GNOME desktop has a feature which stores your
 @end example
 
 Note that the GNOME desktop has a feature which stores your


@@ -1428,14 +1457,14 @@ gconftool-2 --set -t bool \
 @end example
 
 After setting up your passphrase, your private key is saved as
 @end example
 
 After setting up your passphrase, your private key is saved as

-@file{~/.ssh/id_dsa} and your public key is saved as
-@file{~/.ssh/id_dsa.pub}.
+@file{~/.ssh/id_rsa} and your public key is saved as
+@file{~/.ssh/id_rsa.pub}.

 
 
 @item
 
 
 @item

-Register your public SSH @q{dsa} key with Savannah.  From the
+Register your public SSH @q{rsa} key with Savannah.  From the

 @qq{My Account Configuration} page, click on @qq{Edit SSH Keys},
 @qq{My Account Configuration} page, click on @qq{Edit SSH Keys},

-then paste the contents of your @file{~/.ssh/id_dsa.pub} file into
+then paste the contents of your @file{~/.ssh/id_rsa.pub} file into

 one of the @qq{Authorized keys} text fields, and click
 @qq{Update}.
 
 one of the @qq{Authorized keys} text fields, and click
 @qq{Update}.
 


@@ -1456,7 +1485,7 @@ git config remote.origin.url \
 @end example
 
 @noindent
 @end example
 
 @noindent

-where @var{user} is your username on Savannah.
+replacing @var{user} with your Savannah username.

 
 
 @item
 
 
 @item


@@ -1537,9 +1566,17 @@ git config push.default matching
 @noindent
 Then @code{git@tie{}push} should work as before.  For more
 details, consult the @code{git@tie{}push} man page.
 @noindent
 Then @code{git@tie{}push} should work as before.  For more
 details, consult the @code{git@tie{}push} man page.

-@end enumerate

 
 
 
 

+@item
+Repeat the steps from generating an RSA key through to testing
+your commit access, for each machine from which you will be
+making commits, or you may simply copy the files from your
+local @file{~/.ssh} folder to the same folder on the other
+machine.
+
+@end enumerate
+

 @subsubheading Technical details
 
 @itemize
 @subsubheading Technical details
 
 @itemize