@warning{LilyDev does not include the software for the Grand Unified
Builder -- also see @ref{Grand Unified Builder (GUB)}.}
-While compiling LilyPond on MacOs and Windows is possible, both
+While compiling LilyPond on Mac OS and Windows is possible, both
environments are complex to set up. LilyDev can be easily installed
and run inside a @q{virtual machine} on either of these operating
systems relatively easily using readily available virtualization
to a DVD -- it is approximately 900 MB in size -- and installed just
like any standard GNU/Linux distribution.
-The current image is based on a 32bit version of Debian 8 (@q{Jessie})
-and the Disk image was generated using Debian
+The current image is based on a 32-bit version of Debian 8 (@q{Jessie})
+and the disk image was generated using Debian
@uref{http://live.debian.net/, live-build 4}.
@noindent
it.
@warning{Be patient! There is no progress bar in the lily-git UI but the
-complete source is around 180@tie{}Mb.}
+complete source is around 180@tie{}MB.}
@noindent
When the source code has been downloaded, the @qq{command output} window
commit.
@advanced{for more information regarding commits and commit
-messages, see @ref{Commits and patches}.}
+messages, see @ref{Commits}.}
@subsubheading 2b. Amend previous commit
@node Updating git-cl
@unnumberedsubsec Updating @code{git-cl}
-LilyDev users should always make sure that they alwsys have the latest
-version of git-cl installed. It is possible that changes may have been
-made to git-cl that are not (yet) included in the version of LilyDev has
-been installed.
+LilyDev users should make sure that they always have the latest
+version of git-cl installed. It is possible that changes have been
+made to git-cl that are not (yet) included in the version of LilyDev
+that you are using.
@noindent
Using a terminal run the following commands:
@node Configuring git-cl
@unnumberedsubsec Configuring @code{git-cl}
-@subsubheading Set up login accounts
+Because @code{git-cl} updates two separate websites (Google's Rietveld
+Code Review Tool and LilyPond's issue tracker) you @emph{must} have a
+valid user account (login and password) for both sites.
-Because the @code{git-cl} updates two separate websites (Google's
-Rietveld Code Review Tool and LilyPond's issue tracker) you @emph{must}
-have a valid user login and password to both sites.
+@subsubheading Set up a login account for Rietveld Code Review Tool
@noindent
-Although that it may appear that you have to use a @q{Google} email
-address for the Rietveld Code Review Tool when you sign up, you can
-instead select the option @qq{I prefer to use my current email address}
-during sign up.
+For the Rietveld Code Review Tool you will need a Google account but
+this does @emph{not} require @q{Google} email address; i.e. @emph{any}
+email address for your Google account can be used. Just select the
+option @qq{I prefer to use my current email address} when you sign up
+with Google.
+
+@warning{In order for @code{git-cl} to work correctly with this Google
+account, your Google Account Settings must have the
+@q{Access for less secure apps} set to @q{Allowed} -- this is normally
+the default setting.}
+
+@subsubheading Set up a login account for LilyPond's Issue Tracker
@noindent
-For a user login to the LilyPond issue tracker, please send your
-request, preferably using the email address you want to use for your
-login, to the LilyPond Developer's mailing list
-(@code{lilypond-devel@@gnu.org}).
+Please register a user account at
+@code{https://sourceforge.net/user/registration} preferably using the
+same email address that you want to use LilyPond Developer mailing list
+login.
-@subsubheading Authorising git-cl for the LilyPond issue tracker
+@noindent
+Once you have created this Sourceforge user account, send an email to
+the LilyPond Developer's mailing list (@code{lilypond-devel@@gnu.org})
+asking for write access to the issue tracker along with your Sourceforce
+@emph{Username} (not email address) and someone will then be able to set
+this up for you.
+
+@subsubheading Authorizing git-cl for the LilyPond issue tracker
The @code{git-cl} command itself also needs to be @q{authorized} so that
it can access the LilyPond issue tracker.
@enumerate
@item
-Once a valid login has been given for the LilyPond issye tracker, go to
-the @q{Account settings} and select the @q{OAuth} tab.
+Once you have been given a valid login for the LilyPond issue tracker,
+go to the @q{Account settings} and select the @q{OAuth} tab.
@item
Locate the @q{Register New Application} section and enter @code{git-cl}
@q{git-cl} listed under the @q{My Applications} section.
@item
-Click on the @q{Generate Bearer Token} button. You should now see
+Click on the @q{Generate Bearer Token} button. You should now see
@q{git-cl} listed under the @q{Authorized Applications} section along
with a value for the @q{Bearer Token} entry. This value is used, in the
next steps, to allow git-cl to access and update the LilyPond issue
@end enumerate
+@subsubheading Installing ca-certificates
+
+In order to have @code{git-cl} properly update issues on the SourceForge
+Allura issue tracker, you must have the package @code{ca-certificates}
+installed. You can check to see if the package is installed with
+
+@example
+apt --installed list | grep ca-certificates
+@end example
+
+If @code{ca-certificates} is installed, you will get a result that shows
+the version that is installed. If it is not installed, there will be
+no version displayed.
+
+Install @code{ca-certificates} with the following:
+
+@example
+sudo apt-get install ca-certificates
+@end example
+
+
@subsubheading Running git-cl for the first time
@enumerate
@item
-Using a terminal, move to top source directory of the
-@code{$LILYPOND_GIT} directory and then run @code{git-cl} with the
-@code{config} option:
+Using a terminal, move to the top level of the @code{$LILYPOND_GIT}
+directory and then run @code{git-cl} with the @code{config} option:
@example
cd $LILYPOND_GIT
git-cl config
@end example
+@noindent
+You will see a series of prompts. For most of them you can simply
+accept the default value by responding with a newline (i.e. by pressing
+return or enter).
+
@item
-When prompted for the @code{Rietveld server}:
+The prompt for the @code{Rietveld server} (the patch review tool), which
+defaults to @code{codereview.appspot.com}
@example
Rietveld server (host[:port]) [codereview.appspot.com]:
@end example
@item
-When prompted for the @code{Allura server} (the LilyPond issue tracker):
+The prompt for the @code{Allura server} (the issue tracker), which
+defaults to @code{https://sourceforge.net/p/testlilyissues/issues/}
@example
Allura server [https://sourceforge.net/p/testlilyissues/issues/]:
@item
When prompted for the @code{Allura bearer token} copy/paste the value
generated in the previous steps for
-@emph{Authorising git-cl for the LilyPond issue tracker}:
+@emph{Authorising git-cl for the LilyPond issue tracker}
@smallexample
-Allura bearer token (see https://sourceforge.net/auth/oauth/) [fdbfca60801533465480]:
+Allura bearer token (see https://sourceforge.net/auth/oauth/): fdbfca60801533465480
@end smallexample
-@warning{The above is a @q{fake} bearer token just to illustrate the
-example. Do not use this value.}
+@warning{The above is a @q{fake} bearer token used just for
+illustration. Do not use this value.}
@item
-Finally, when prompted for the @code{CC list} entry, add the LilyPond
-Developer's group email.
+Finally, the prompt for the @code{CC list}, which defaults to
+@code{lilypond-devel@@gnu.org}, the LilyPond Developer's email list.
@example
CC list ("x" to clear) [lilypond-devel@@gnu.org]:
projects / lilypond.git / blobdiff