@section Downloading
-Even numbered minor versions are `stable' (2.4, 2.6 etc), while odd
-version are development releases (2.5, 2.7, etc). Building LilyPond
+Even numbered minor versions are `stable' (2.6, 2.8, etc), while odd
+version are development releases (2.7, 2.9, etc). Building LilyPond
is an involved process. If possible
-@uref{http://lilypond.org/download,download a precompiled binary}
-for your platform.
+@uref{http://lilypond.org/install,download a precompiled binary} for
+your platform.
@subsection Source code
Download source
@itemize @bullet
@item tarballs from
-@itemize @bullet
@uref{http://lilypond.org/download/} by HTTP.
-@item @uref{ftp://sca.uwaterloo.ca/pub/} by FTP (Canadian mirror).
-@end itemize
+@item tarballs from
+@uref{http://download.linuxaudio.org/lilypond/} by HTTP.
@item
-CVS from @uref{http://savannah.gnu.org/cvs/?group=lilypond,savannah.gnu.org}
-@itemize @bullet
-@c @quotation
+GIT from @uref{http://git.sv.gnu.org/gitweb/?p=lilypond.git;a=summary,git.sv.gnu.org}
@example
-CVS_RSH=ssh cvs -d:ext:anoncvs@@savannah.gnu.org:/cvsroot/lilypond co lilypond
+git clone git://git.sv.gnu.org/lilypond.git
@end example
-@c @end quotation
-The CVS repository does not contain generated files. To create
+
+The repository does not contain generated files. To create
@file{configure}, run
@example
./autogen.sh
@end example
@end itemize
-@end itemize
For information on packaging, see @uref{http://lilypond.org/devel}.
@itemize
-@item @uref{http://fontforge.sf.net/,FontForge} 20050624 or newer.
+@item @uref{http://fontforge.sf.net/,FontForge} 20060125 or newer.
@item New Century Schoolbook fonts, as PFB files. These are shipped
with X11 and Ghostscript, and are named @file{c059033l.pfb}
@file{c059036l.pfb}, @file{c059013l.pfb} and @file{c059016l.pfb}
-@item @uref{http://www.xs4all.nl/~hanwen/mftrace/,mftrace} (1.1.9 or
+@item @uref{http://www.xs4all.nl/~hanwen/mftrace/,mftrace} (1.1.19 or
newer),
You will need to install some additional packages to get mftrace to
work.
@item @uref{http://www.gnu.org/software/guile/guile.html,GUILE}
-(version 1.6.5 or newer). If you are installing binary packages, you
+(version 1.8.2 or newer). If you are installing binary packages, you
may need to install guile-devel or guile-dev or libguile-dev too.
@item @uref{ftp://ftp.gnu.org/gnu/texinfo/,Texinfo} (version 4.8 or newer).
@item
- @uref{http://gcc.gnu.org/, The GNU c++ compiler} (version 3.3 or
-newer). EGCS and 2.x are known to cause crashes.
+@uref{http://gcc.gnu.org/, The GNU c++ compiler} (version 4.x or
+newer).
-@item @uref{http://www.python.org,Python} (version 2.1 or newer except
-for Cygwin/Mingw where version 2.3 or newer is needed).
+@item @uref{http://www.python.org,Python} (version 2.3 or newer)
@item @uref{ftp://ftp.gnu.org/gnu/make/,GNU Make} (version 3.78 or newer).
@item @uref{http://www.gnu.org/software/gettext/gettext.html,gettext}.
-
@item @uref{http://www.gnu.org/software/flex/,Flex}
@item @uref{http://www.perl.org/,Perl}
@item @uref{http://www.freetype.org/,Freetype} (version 2).
@item @uref{http://www.freetype.org/,FontConfig} (version 2.2).
-@item @uref{http://www.pango.org/,Pango} (version 1.6 or newer).
+@item @uref{http://www.pango.org/,Pango} (version 1.12 or newer).
@item @uref{http://www.gnu.org/software/guile/guile.html,GUILE}
-(version 1.6.5 or newer).
-@item @uref{http://www.python.org,Python} (version 2.1 or newer).
+(version 1.8.2 or newer), or patch 1.8.1 with
+@uref{http://lilypond.org/vc/gub.darcs/patches/guile-1.8-rational.patch}.
+@item @uref{http://www.python.org,Python} (version 2.4 or newer).
@item @uref{http://www.ghostscript.com,Ghostscript} (version 8.15 or
newer. 8.50 recommended)
@end itemize
@end example
@end quotation
+@section Testing LilyPond
+
+LilyPond comes with an extensive suite that excercises the entire
+program. This suite can be used to automatically check the impact of a
+change. This is done as follows
+
+@example
+ make test-baseline
+ @emph{## apply your changes, compile}
+ make check
+@end example
+
+This will leave an HTML page @file{out/test-results/index.html}. This
+page shows all the important differences that your change introduced,
+whether in the layout, MIDI, performance or error reporting.
+
+To rerun tests, use
+
+@example
+ make test-redo @emph{## redo files differing from baseline}
+ make test-clean @emph{## remove all test results}
+@end example
+
+@noindent
+and then run @code{make check} again.
+
+For tracking memory usage as part of this test, you will need GUILE
+CVS; especially the following patch:
+@uref{http://lilypond.org/vc/gub.darcs/patches/guile-1.9-gcstats.patch}.
+
+For checking the coverage of the test suite, do the following
+
+@example
+ ./buildscripts/build-coverage.sh
+ @emph{# uncovered files, least covered first}
+ python ./buildscripts/coverage.py --summary out-cov/*.cc
+ @emph{# consecutive uncovered lines, longest first}
+ python ./buildscripts/coverage.py --uncovered out-cov/*.cc
+@end example
@section Building LilyPond
@end example
@end quotation
-The most time-consuming part of compiling LilyPond is tracing the
-Type1 fonts. You can shortcut this operation by issuing
-one of the following commands
-
-@quotation
-@example
-make -C mf get-pfa # requires rpm2cpio
-make -C mf get-debian-pfa # may not be up to date
-@end example
-@end quotation
-
If you are not root, you should choose a @code{--prefix} argument that
points into your home directory, e.g.
@quotation
@end quotation
-
-@unnumberedsubsec Gcc-3.0.4
-
-Gcc 3.0.4 is flaky; upgrade GCC.
-
-@unnumberedsubsec Flex-2.5.4a and gcc-3.x
-
-Flex 2.5.4a does not produce g++-3.1.1 compliant C++ code. To compile
-LilyPond with gcc-3.1.1 or higher you may do
-
-@quotation
-@example
-CONF=gcc-3.1 ./lexer-gcc-3.1.sh
-CPPFLAGS=-I$(pwd)/lily/out-gcc-3.1 CC=gcc-3.1 CXX=g++-3.1 \
-./configure --enable-config=gcc-3.1
-CONF=gcc-3.1 ./lexer-gcc-3.1.sh
-make conf=gcc-3.1
-@end example
-@end quotation
-
@unnumberedsubsec MacOS X
For Fink, use the following command to compile.
export GUILE=guile-1.6
export GUILE_CONFIG=guile-1.6-config
export PKG_CONFIG_PATH=/sw/lib/freetype219/lib/pkgconfig/:/sw/lib/fontconfig2/lib/pkgconfig/
-./configure --without-kpathsea
+./configure
@end verbatim
-@unnumberedsubsec OpenBSD
-
-@itemize @bullet
-@item
-Refer to the section ``Linking to kpathsea'': GCC on OpenBSD doesn't
-set include paths for kpathsea.
-@end itemize
-
-@unnumberedsubsec NetBSD
-
-@itemize @bullet
-@item The flex precompiled in NetBSD-1.4.2 is broken.
-Upgrade to flex-2.5.4a.
-@end itemize
-
@unnumberedsubsec Solaris
@itemize @bullet
projects / lilypond.git / blobdiff