]> git.donarmstrong.com Git - lilypond.git/commitdiff
Doc: CG - updates to lily-git section
authorJames Lowe <pkx166h@gmail.com>
Sat, 14 Nov 2015 16:51:15 +0000 (16:51 +0000)
committerJames Lowe <pkx166h@gmail.com>
Thu, 19 Nov 2015 17:29:31 +0000 (17:29 +0000)
Minor updates to the information
for using lily-git.

Removed old references to
lilydev 3.0.

Documentation/contributor/quick-start.itexi

index 6d6dec3e7c87538a2b9960288d6751b4b63c91f2..516a69ec3596cf42887ed5ace7a066882cf74f9e 100644 (file)
@@ -233,7 +233,7 @@ patches.
 
 @menu
 * Where to get lily-git::
-* Configuring lily-git and downloading the source code::
+* Using lily-git to download the source code::
 * How to use lily-git::
 @end menu
 
@@ -245,10 +245,9 @@ installed on your computer.
 
 @itemize
 @item
-If you are using LilyDev (see @ref{LilyDev}) then lily-git should be
-already installed and ready to run.  This is not the case for the
-current version (3.0), but you can easily turn it on by adding this
-line in ~/.bashrc:
+If you are using LilyDev (see @ref{LilyDev}) then lily-git should
+already be installed and ready to run.  If this is not the case you can
+easily turn it on by adding the following line in @code{~/.bashrc}:
 
 @example
 # add lily-git to the PATH
@@ -256,50 +255,51 @@ PATH=$LILYPOND_GIT/scripts/auxiliar:"$@{PATH@}"
 @end example
 
 @item
-For those not using LilyDev then lily-git can be obtained by downloading
+For those not using LilyDev, lily-git can be obtained by downloading
 the software directly. See @ref{Manually installing lily-git.tcl}.
 
 @item
-Finally, lily-git is always part of the LilyPond source code and is
-located in @file{$LILYPOND_GIT/scripts/auxillar/lily-git.tcl}.
+lily-git is part of the LilyPond source code and is located in
+@file{$LILYPOND_GIT/scripts/auxillar/lily-git.tcl}.
 
 @end itemize
 
 
-@node Configuring lily-git and downloading the source code
-@unnumberedsubsec Configuring lily-git and downloading the source code
-
-@warning{The rest of this manual assumes that you are using the
-command-line within a terminal.}
+@node Using lily-git to download the source code
+@unnumberedsubsec Using lily-git to download the source code
 
 @enumerate
 @item
-Type (or copy&paste) into the Terminal:
+Type the following command into a Terminal:
 
 @example
 lily-git.tcl
 @end example
 
 @noindent
-You will be prompted to enter your name and your email address.  This
-information is used only to identify and label any patches you create.
-This information can be edited if required later.  See
-@ref{Configuring Git}.  Click on the @emph{Submit} button to update
-lily-git with this information.
+You will be prompted to enter a name and email address into the lily-git
+UI.  This information is used to label any patches you create (using the
+lily-git UI or git via the command line) and can be changed later if
+required.  See @ref{Configuring Git}.
+
+@item
+Click on the @emph{Submit} button to update lily-git with the
+information.
 
 @item
 Click on the @qq{Get source} button.
 
-A directory called @file{$LILYPOND_GIT} is now created within
-your home directory and the complete source code will start to be
-downloaded into it.
+A directory called @file{lilypond-git} is created within your home
+directory and the entire source code will start to be downloaded into
+it.
 
-@warning{Be patient! The complete source is around 150@tie{}Mb.}
+@warning{Be patient! There is no progress bar in the lily-git UI but the
+complete source is around 180@tie{}Mb.}
 
 @noindent
-When the source code has been downloaded, the @qq{Command output} window
-in lily-git will update and display @qq{Done} on the very last line.
-The button label will change to say @qq{Update source}.
+When the source code has been downloaded, the @qq{command output} window
+in the lily-git UI will update and display @qq{Done} on the very last
+line and the button label will change to say @qq{Update source}.
 
 @warning{Some contributors have reported that occasionally nothing
 happens at this step at all.  If this occurs, then try again in a few
@@ -307,37 +307,43 @@ minutes -- it could be an intermittant network problem.  If the
 problem persists, please ask for help.}
 
 @item
-Close the lily-git GUI and navigate to the @file{$LILYPOND_GIT}
+Close the lily-git GUI and navigate to the @file{lilypond-git}
 directory to view and edit the source files.
 
 @end enumerate
 
 @noindent
-If this is the first time you have compiled LilyPond then please go
-to @ref{Compiling with LilyDev} before reading on.
+If this is the first time you will be attempting to compile LilyPond,
+please see the section @ref{Compiling with LilyDev} before continuing.
 
 
 @node How to use lily-git
 @unnumberedsubsec How to use lily-git
 
-@warning{Throughout the rest of this manual, most command-line
-input should be entered from @file{~/lilypond-git/}.  This is
-known as the @emph{top source directory} and is often referred to as
-@var{$LILYPOND_GIT}.}
+Here is a brief description of what each button does in the lily-git UI.
+
+@advanced{Throughout the rest of this manual, most command-line
+input should be entered from within the top level of the
+@file{~/lilypond-git/} directory.  This is known as the
+@emph{top of the source directory} and is also referred to as
+@var{$LILYPOND_GIT} as a convention for those users who may have
+configured their own locations of the LilyPond source code.}
 
-@warning{Only work on one set of changes at once.  Do not start
-work on any new changes until your first set has been accepted.}
+@warning{For those less experienced contributors using lily-git, we
+recommend that you only work on one set of changes at a time and not
+start on any new changes until your first set has been accepted.}
 
 @subsubheading 1. Update source
 
-At the beginning of each session of lilypond work, you should
-click the @qq{Update source} button to get the latest changes to
-the source code.
+Click the @qq{Update source} button to get any recent changes to the
+source code that have been added by other contributors since your last
+session.
 
-@warning{In some rare and unfortunate circumstances, this will
-result in a @emph{merge conflict}.  If this occurs, follow the
-instructions for @qq{Abort changes}, below.  Your work will not be
-lost.}
+@warning{If another contributor has updated files in the source code
+that you had been working on then updating your own copy of the source
+code may result in what is known as a @emph{merge conflict}.  If this
+occurs, follow the instructions to @qq{Abort changes}, below.  Note that
+your work will not be lost.}
 
 
 @subsubheading 2a. New local commit