X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=Documentation%2Fdevel%2Fcompiling.itexi;h=1d0dfd8bc0dd078dc315a48c8723a3b738fd4b20;hb=1423508c355989fa26a8cfe5985b0d6e1ab0a538;hp=05d2963e1e08d0a7ed4c44e32d696cc5863bb90a;hpb=3590aec4a7475d8840383e9c8ab285f92fb808b8;p=lilypond.git
diff --git a/Documentation/devel/compiling.itexi b/Documentation/devel/compiling.itexi
index 05d2963e1e..1d0dfd8bc0 100644
--- a/Documentation/devel/compiling.itexi
+++ b/Documentation/devel/compiling.itexi
@@ -1,518 +1,167 @@
@c -*- coding: us-ascii; mode: texinfo; -*-
-@node Compiling from source
-@chapter Compiling from source
-
-@ignore
-You can also compile LilyPond directly from the source code. This
-requires that you can read English, so this section is not
-translated. If you really want to compile LilyPond, see
-@iftex
-@c DO NOT translate the following line at all.
-@ref{Compiling from source,,,lilypond-program,Application Usage}.
-@end iftex
-@ifhtml
-@c Please translate the following line (but not the .html file name)
-the @uref{Compiling-from-source.html,documentation in English}.
-@end ifhtml
-@end ignore
-
-@c TRANSLATORS:
-@c Please **do not** translate anything below this line. Users
-@c should not be compiling LilyPond themselves; if they really
-@c want to do so, they should be able to read the English docs,
-@c because they'll probably need to ask questions in English
-@c on the -devel list. -gp
-@c Instead, please uncomment and translate the paragraph above,
-@c and remove all stuff (menu, nodes, contents) below this line.
-
-@menu
-* Downloading source code::
-* Requirements::
-* Building LilyPond::
-* Building documentation::
-* Testing LilyPond::
-* Problems::
-@end menu
-
-@node Downloading source code
-@subsection Downloading source code
-
-Download source
-
-@itemize
-@item tarballs from
-@uref{http://lilypond.org/download/} by HTTP.
-@item tarballs from
-@uref{http://download.linuxaudio.org/lilypond/} by HTTP.
-@item
-GIT from @uref{http://git.sv.gnu.org/gitweb/?p=lilypond.git;a=summary,git.sv.gnu.org}
-
-@example
-git clone git://git.sv.gnu.org/lilypond.git
-@end example
-
-The repository does not contain generated files. To create
-@file{configure}, run
-@example
-./autogen.sh
-@end example
-@end itemize
-
-For information on packaging, see @uref{http://lilypond.org/devel}.
-
-
-@node Requirements
-@subsection Requirements
-
-@unnumberedsubsubsec Compilation
-
-In addition to the packages needed for running LilyPond (see below), you
-need the following extra packages for building.
-
-When installing a binary package FOO, you may need to install the
-FOO-devel, libFOO-dev or FOO-dev package too.
-
-@itemize
-
-@item @uref{http://fontforge.sf.net/,FontForge} 20060125 or newer.
-
-@item @uref{http://metafont.tutorial.free.fr/,MetaFont} (mf-nowin, mf, mfw or
-mfont binaries) and @uref{http://cm.bell-labs.com/who/hobby/MetaPost.html,MetaPost}
-(mpost binary), usually packaged with a @LaTeX{} distribution like
-tetex or texlive.
-
-@item @uref{http://www.lcdf.org/~eddietwo/type/#t1utils,t1utils}
-(version 1.33 or newer recommended).
-
-@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.gnu.org/software/guile/guile.html,GUILE} (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.11 or newer).
-
-@item @uref{http://gcc.gnu.org/, The GNU c++ compiler} (version 3.4 or
-newer. 4.x is strongly recommended).
-
-@item @uref{http://www.python.org,Python} (version 2.4 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}
-(version 0.17 or newer).
-
-@item @uref{http://www.gnu.org/software/flex/,Flex}.
-
-@item @uref{http://www.perl.org/,Perl}.
-
-@item @uref{http://www.gnu.org/software/flex/,GNU Bison}.
-
-@item All packages required for running, including development packages with
-header files and libraries.
-
-@end itemize
-
-
-@unnumberedsubsubsec Running requirements
-
-Running LilyPond requires proper installation of the following software
-
-@itemize
-
-@item @uref{http://www.freetype.org/,Freetype} (version 2.1.10 or newer).
-@item @uref{http://fontconfig.org/,FontConfig} (version 2.2 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.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.60 recommended)
-@item Dejaview. (This is normally installed by default)
-@end itemize
-
-International fonts are required to create music with international text
-or lyrics.
-
-
-@unnumberedsubsubsec Requirements for building documentation
-
-You can view the documentation online at
-@uref{http://lilypond.org/doc/}, but you can also build it locally.
-This process requires a successful compile of LilyPond, and some
-additional tools and packages:
-
-@itemize
-@item The @uref{http://netpbm.sourceforge.net/,netpbm utilities}
-@item ImageMagick
-@item International fonts (see input/regression/utf-8.ly for hints
-about which font packages are necessary for your platform)
-@item Ghostscript 8.60 or newer, or 8.50 with the patch from
-@uref{http://bugs.ghostscript.com/show_bug.cgi?id=688154}
-and the patch from
-@uref{http://bugs.ghostscript.com/show_bug.cgi?id=688017}.
-@item @uref{http://www.nongnu.org/texi2html/,Texi2HTML} 1.80 or newer
-@item rsync
-@end itemize
-
-
-@node Building LilyPond
-@subsection Building LilyPond
-
-@unnumberedsubsubsec Compiling
-
-To install GNU LilyPond, type
-
-@example
-gunzip -c lilypond-x.y.z | tar xf -
-cd lilypond-x.y.z
-./configure # run with --help for applicable options
-make
-su -c 'make install'
-@end example
-
-@noindent
-If you are not root, you should choose a @code{--prefix} argument that
-points into your home directory, e.g.
-
-@example
-./configure --prefix=$HOME/usr
-@end example
-
-
-@unnumberedsubsubsec Compiling for multiple platforms
-
-If you want to build multiple versions of LilyPond with different
-configuration settings, you can use the @code{--enable-config=CONF}
-option of @command{configure}. You should use @code{make conf=CONF}
-to generate the output in @file{out-CONF}. For example, suppose you
-want to build with and without profiling, then use the following for
-the normal build
-
-@example
-./configure --prefix=$HOME/usr/ --enable-checking
-make
-make install
-@end example
-
-and for the profiling version, specify a different configuration
-
-@example
-./configure --prefix=$HOME/usr/ --enable-profiling --enable-config=prof --disable-checking
-make conf=prof
-make conf=prof install
-@end example
-
-@unnumberedsubsubsec Compiling outside the source tree
-
-It is possible to compile LilyPond in a build tree different from the
-source tree, with @code{--srcdir} option of @command{configure}:
-
-@example
-mkdir lily-build && cd lily-build
-@var{sourcedir}/configure --srcdir=@var{sourcedir}
-
-@end example
-
-
-@unnumberedsubsubsec Useful @command{make} variables
-
-If a less verbose build output if desired, the variable
-@code{QUIET_BUILD} may be set to @code{1} on @command{make} command
-line, or in @file{local.make} at top of the build tree.
-
-
-@node Building documentation
-@subsection Building documentation
-
-This requires a successful compile of LilyPond, or using an external
-LilyPond binary.
+@node Compiling LilyPond
+@chapter Compiling LilyPond
@menu
-* Commands for building documentation:: Compiling and installing the documentation.
-* Building documentation without compiling LilyPond:: Using a LilyPond binary already installed.
+* Compiling from source::
+* Concurrent Stable and Development Versions::
+* Using a Virtual Machine to Compile Lilypond::
@end menu
-@node Commands for building documentation
-@unnumberedsubsubsec Commands for building documentation
+@node Compiling from source
+@section Compiling from source
-The documentation is built by issuing
+TODO (see AU 1 for now)
+@c currently broken; will fix after 2.14
+@c @include compile.itely
-@example
-make web
-@end example
-After compilation, the HTML documentation tree is available in
-@file{out-www/offline-root/}, and can be browsed locally.
+@node Concurrent Stable and Development Versions
+@section Concurrent Stable and Development Versions
-The HTML and PDF files can be installed into the standard documentation
-path by issuing
+It can be useful to have both the stable and the development versions
+of Lilypond available at once. One way to do this on GNU/Linux is to
+install the stable version using the precompiled binary, and run the
+development version from the source tree. After running @command{make
+all} from the top directory of the Lilypond source files, there will
+be a binary called @code{lilypond} in the @code{out} directory:
@example
-make web-install
+<@var{path to}>/lilypond/out/bin/lilypond
@end example
-@noindent
-This also installs Info documentation with images if the installation
-prefix is properly set; otherwise, instructions for manual installation
-of Info documentation are printed on standard output.
-
-It is also possible to build a documentation tree in
-@file{out-www/online-root/}, with special processing, so it can be used
-on a website with content negotiation for automatic language selection;
-this can be achieved by issuing
-
-@example
-make WEB_TARGETS=online web
-@end example
+This binary can be run without actually doing the @code{make
+install} command. The advantage to this is that you can have all
+of the latest changes available after pulling from git and running
+@code{make all}, without having to uninstall the old version and
+reinstall the new.
-@noindent
-and both @q{offline} and @q{online} targets can be generated by issuing
+So, to use the stable version, install it as usual and use the
+normal commands:
@example
-make WEB_TARGETS="offline online" web
+lilypond foobar.ly
@end example
-Several targets are available to clean the documentation build and
-help with maintaining documentation; an overview of these targets is
-available with
+To use the development version, create a link to the binary in the
+source tree by saving the following line in a file somewhere in your
+@code{$PATH}:
@example
-make help
+exec <@var{path to}>/lilypond/out/bin/lilypond "$@@"
@end example
-@noindent
-from every directory in the build tree. Most targets for
-documentation maintenance are available from @file{Documentation/};
-for more information, see @file{Documentation/user/README.txt} and
-@file{Documentation/TRANSLATION}.
-
-The makefile variable @code{QUIET_BUILD} may be set to @code{1} for a
-less verbose build output, just like for building the programs.
-
-@knownissues
-
-The most time consuming task for building the documentation is running
-LilyPond to build images of music, and there cannot be several
-simultaneously running @command{lilypond-book} instances, so @code{-j}
-@command{make} option does not significantly speed up the build process.
-To help speed it up, the makefile variable @var{CPU_COUNT} may be set
-in @file{local.make} or on the command line to the number of
-@code{.ly} files that LilyPond should process simultaneously, e.g. on
-a bi-processor or dual core machine
+Save it as @code{Lilypond} (with a capital L to distinguish it
+from the stable @code{lilypond}), and make it executable:
@example
-make -j3 CPU_COUNT=3 web
+chmod +x Lilypond
@end example
-@noindent
-The recommended value of @var{CPU_COUNT} is one plus the number of
-cores or processors, but it is advisable to set it to a smaller value
-if your system has not enough RAM to run that many simultaneous
-LilyPond instances.
-
-If source files have changed since last documentation build, output
-files that need to be rebuilt are normally rebuilt, even if you do not
-run @code{make web-clean} first. However, building dependencies in the
-documentation are so complex that rebuilding of some targets may not
-be triggered as they should be; a workaround is to force rebuilding
-by touching appropriate files, e.g.
+Then you can invoke the development version this way:
@example
-touch Documentation/user/*.itely
-touch input/lsr/*.ly
+Lilypond foobar.ly
@end example
-@node Building documentation without compiling LilyPond
-@unnumberedsubsubsec Building documentation without compiling LilyPond
+TODO: ADD
-The documentation can be built locally without compiling LilyPond
-binary, if LilyPond is already installed on your system.
+- other compilation tricks for developers
-From a fresh Git checkout, do
-@example
-./autogen.sh # ignore any warning messages
-cp GNUmakefile.in GNUmakefile
-make -C python
-nice make LILYPOND_EXTERNAL_BINARY=/path/to/bin/lilypond web
-@end example
+@node Using a Virtual Machine to Compile Lilypond
+@section Using a Virtual Machine to Compile Lilypond
-Please note that this may break sometimes -- for example, if a new
-feature is added with a test file in input/regression, even the latest
-development release of LilyPond will fail to build the docs.
-
-You may build the manual without building all the @file{input/*}
-stuff: change directory, for example to @file{Documentation/user},
-issue @code{make web}, which will build documentation in a
-subdirectory @file{out-www} from the source files in current
-directory. In this case, if you also want to browse the documentation
-in its post-processed form, change back to top directory and issue
+Since it is not possible to compile Lilypond on Windows, some
+developers may find it useful to install a GNU/Linux virtual
+machine. A disk image with a special remix of @strong{Ubuntu}
+has been created for this purpose. It has all of the Lilypond
+build dependencies in place, so that once installed, it is
+ready to compile both Lilypond and the Documentation.
+The @code{lilybuntu} remix is available for download here:
@example
-make out=www WWW-post
+@uref{http://@/prodet.hu/@/bert/@/lilydev/@/lilybuntu.iso}
@end example
-@knownissues
-
-You may also need to create a script for @command{pngtopnm} and
-@code{pnmtopng}. On GNU/Linux, I use this:
+We do not necessarily recommend any one virtualization tool,
+however the @code{lilybuntu} remix is known to work well on
+@uref{http://www.virtualbox.org/wiki/Downloads, Sun VirtualBox},
+which is a free download. Consult your virtualization software's
+documentation for instructions on setting up the software and
+for general instructions on installing a virtual machine.
-@verbatim
-export LD_LIBRARY_PATH=/usr/lib
-exec /usr/bin/pngtopnm "$@"
-@end verbatim
+Steps to setting up @code{lilybuntu} in a virtual machine:
-On MacOS@tie{}X, I use this:
+@enumerate
+@item Download the @code{lilybuntu} disk image.
-@verbatim
-export DYLD_LIBRARY_PATH=/sw/lib
-exec /sw/bin/pngtopnm "$@"
-@end verbatim
+@item Install @code{lilybuntu}. You will use the @code{.iso}
+file as the boot disk. It should not be necessary to burn it
+to a DVD, but consult the documentation for your virtualization
+software for specific instructions. If possible, use at least
+the recommended amount of RAM for the virtual machine (384 MB on
+VirtualBox), and use a dynamically expanding virtual hard drive
+starting with at least 5-6 GB of space, more if you can spare it.
+The Ubuntu installer should be straightforward, although in the
+partitioning stage do not be afraid to select @qq{use entire disk,}
+since this is only your @strong{virtual disk} and not your
+machine's actual hard drive.
+@item After installation is complete, restart the virtual
+machine. (If you are using @strong{VirtualBox}, you may wish
+to install the @qq{Guest Additions,} which will allow you to
+use the virtual machine in full screen.)
+@item Open a @strong{terminal}.
+(@code{Applications > Accessories > Terminal})
-@node Testing LilyPond
-@subsection Testing LilyPond
+@item Open @strong{Firefox} (there's an icon for it on the
+panel at the top of the screen) and go to the online Lilypond
+@uref{http://lilypond.org/doc/v2.13/Documentation/devel/contrib-guide, Contributor's Guide}.
-@html
-
-@end html
+@item To retrieve the Lilypond source code from @code{git},
+copy-and-paste each command from the CG @qq{Main source code}
+section into the terminal. (paste into the terminal with keystroke
+@code{CTRL+SHIFT+V})
-LilyPond comes with an extensive suite that exercises the entire
-program. This suite can be used to automatically check the impact of a
-change. This is done as follows
+@item Prepare to build Lilypond by running the configuration script.
+Type
@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
-./scripts/auxiliar/build-coverage.sh
-@emph{# uncovered files, least covered first}
-./scripts/auxiliar/coverage.py --summary out-cov/*.cc
-@emph{# consecutive uncovered lines, longest first}
-./scripts/auxiliar/coverage.py --uncovered out-cov/*.cc
+./autogen.sh
@end example
-
-@node Problems
-@subsection Problems
-
-For help and questions use @email{lilypond-user@@gnu.org}. Send bug
-reports to @email{bug-lilypond@@gnu.org}.
-
-Bugs that are not fault of LilyPond are documented here.
-
-@unnumberedsubsubsec Bison 1.875
-
-There is a bug in bison-1.875: compilation fails with "parse error
-before `goto'" in line 4922 due to a bug in bison. To fix, please
-recompile bison 1.875 with the following fix
+When it is finished you should be presented
+with the three most common @code{make} options:
@example
-$ cd lily; make out/parser.cc
-$ vi +4919 out/parser.cc
-# append a semicolon to the line containing "__attribute__ ((__unused__))
-# save
-$ make
-@end example
-
-
-@unnumberedsubsubsec Solaris
-
-Solaris7, ./configure
+Type:
+ make all to build LilyPond
+ make install to install LilyPond
+ make help to see all possible targets
-@file{./configure} needs a POSIX compliant shell. On Solaris7,
-@file{/bin/sh} is not yet POSIX compliant, but @file{/bin/ksh} or bash
-is. Run configure like
-
-@example
-CONFIG_SHELL=/bin/ksh ksh -c ./configure
+Edit local.make for local Makefile overrides.
@end example
-@noindent
-or
+@item First type @code{make all} to build Lilypond. This will take
+a while.
-@example
-CONFIG_SHELL=/bin/bash bash -c ./configure
-@end example
-
-@unnumberedsubsubsec FreeBSD
-
-To use system fonts, dejaview must be installed. With the default
-port, the fonts are installed in @file{usr/X11R6/lib/X11/fonts/dejavu}.
-
-Open the file @file{$LILYPONDBASE/usr/etc/fonts/local.conf} and add the
-following line just after the @code{} line. (Adjust as necessary
-for your hierarchy.)
+@item When Lilypond is finished building, build the documentation
+by typing
@example
-/usr/X11R6/lib/X11/fonts
+make doc
@end example
+Depending on your system specs it could take from 30-60 minutes
+to finish.
-@unnumberedsubsubsec International fonts
-
-On MacOS@tie{}X, all fonts are installed by default. However, finding all
-system fonts requires a bit of configuration; see
-@uref{http://lists.gnu.org/archive/html/lilypond-user/2007-03/msg00472.html,
-this post} on the @code{lilypond-user} mailing list.
-
-On Linux, international fonts are installed by different means on
-every distribution. We cannot list the exact commands or packages
-that are necessary, as each distribution is different, and the exact
-package names within each distribution changes. Here are some
-hints, though:
-
-@verbatim
-Red Hat Fedora
-
- taipeifonts fonts-xorg-truetype ttfonts-ja fonts-arabic \
- ttfonts-zh_CN fonts-ja fonts-hebrew
-
-Debian GNU/Linux
-
- apt-get install emacs-intl-fonts xfonts-intl-.* \
- ttf-kochi-gothic ttf-kochi-mincho \
- xfonts-bolkhov-75dpi xfonts-cronyx-100dpi xfonts-cronyx-75dpi
-@end verbatim
-
-
-
-ALSO ADD:
-
-- how to make a stable version and development version coexist on
- your system
-
-- how to build with debug info
-
-
+@end enumerate
+At this point everything has been compiled.
+You may install Lilypond using @code{make install}, or you may wish
+to set up your system with concurrent stable and development
+versions as described in the previous section.