@node LilyDev
@section LilyDev
-There is a disk image of a @q{remix} of Ubuntu Linux available for
+There is a disk image of a @q{remix} of Ubuntu GNU/Linux available for
download which includes all the necessary software and tools to compile
both LilyPond and the documentation. Called the
@qq{Ubuntu LilyPond Developer Remix}, but known simply as @qq{LilyDev}
and extremely difficult on MacOS, LilyDev can be installed and run
inside a @q{virtual machine} on any of these operating systems without
disturbing your main operating system. The LilyDev disk image can also
-be burnt to a DVD and installed like any other Ubuntu Linux
+be burnt to a DVD and installed like any other Ubuntu GNU/Linux
distribution.
Most virtualization software can be used but we recommend VirtualBox as
it is available for all major operating systems and is easy to install
& configure.
-If you are not familiar with Linux, it may be beneficial to read a
+If you are not familiar with GNU/Linux, it may be beneficial to read a
couple of @qq{introduction to Ubuntu} web pages.
-Some contributors have recommended a free PDF:
-
-@example
-@uref{http://www.ubuntupocketguide.com/}
-@end example
-
For those interested, the LilyDev remix is currently based on a 32bit
version of 10.04 LTS Ubuntu (Lucid Lynx).
@warning{Apart from installing and configuring LilyDev in VirtualBox,
-the rest of the chapter on assumes that you are comfortable using the
+the rest of the chapter assumes that you are comfortable using the
command-line. While this chapter is intended for users who may have
never created a patch or compiled software before, experienced
developers (who prefer to use their own development environment) may
@end example
@warning{In virtualization terminology, the operating system where
-Virtualbox is installed, is the known as the @strong{host}. LilyDev
+Virtualbox is installed is known as the @strong{host}. LilyDev
will be installed @q{inside} Virtualbox as a @strong{guest}.}
@item
@item
Finally, lily-git is always part of the LilyPond source code and is
-located in @file{~/lilypond-git/scripts/auxillar/lily-git.tcl}.
+located in @file{$LILYPOND_GIT/scripts/auxillar/lily-git.tcl}.
@end itemize
@item
Click on the @qq{Get source} button.
-A directory called @file{lilypond-git/} is now created within
+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.
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
@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}}.
+@var{$LILYPOND_GIT}.}
@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.}
@item
If you have a mentor, send it to them via email.
-@item
-New contributors should send the patch attached to an email to
-@email{frogs@@lilynet.net}. Please add @qq{[PATCH]} to the
-subject line.
-
@item
Translators should send patches to
@email{translations@@lilynet.net}.
web-based review. This requires additional software and use of
the command-line; see @ref{Uploading a patch for review}.
+@item
+If you have trouble uploading the patch for review,
+ask for help on @email{lilypond-devel@@gnu.org}.
+
@end itemize
hopelessly confused!}
The button labeled @qq{Abort changes -- Reset to origin} will copy
-all changed files to a subdirectory of @file{lilypond-git/} named
+all changed files to a subdirectory of @file{$LILYPOND_GIT} named
@file{aborted_edits/}, and will reset the repository to the
current state of the remote repository (at @code{git.sv.gnu.org}).
@c we heavily recommend the out-of-tree build; do not change this!
@example
-cd ~/lilypond-git/
+cd $LILYPOND_GIT
sh autogen.sh --noconfigure
mkdir -p build/
cd build/
speed.
@example
-cd ~/lilypond-git/build/
+cd $LILYPOND_GIT/build/
make
@end example
You may run the compiled @code{lilypond} with:
@example
-cd ~/lilypond-git/build/
+cd $LILYPOND_GIT/build/
out/bin/lilypond my-file.ly
@end example
will likely take 2 to 10 hours.
@example
-cd ~/lilypond-git/build/
+cd $LILYPOND_GIT/build/
make
make doc
@end example
you bookmark the resulting page:
@example
-firefox ~/lilypond-git/build/out-www/offline-root/index.html
+firefox $LILYPOND_GIT/build/out-www/offline-root/index.html
@end example
@subsubheading Installing
Don't. There is no reason to install lilypond within LilyDev.
All development work can (and should) stay within the
-@file{$HOME/lilypond-git/} directory, and any personal composition
+@file{$LILYPOND_GIT} directory, and any personal composition
or typesetting work should be done with an official GUB release.