1 @c -*- coding: utf-8; mode: texinfo; -*-
6 Want to submit a patch for LilyPond? Great! This chapter is
7 designed to let you do this as quickly and easily as possible.
9 It is not possible to compile LilyPond on Windows, and extremely
10 difficulty to compile it on MacOS X. We have therefore made a
11 @q{remix} of Ubuntu which includes all necessary dependencies to
12 compile both LilyPond and the documentation. This can be run
13 inside a virtual machine without disturbing your main operating
14 system. The full name is @qq{Ubuntu LilyPond Developer Remix},
15 but we refer to it as @qq{lilydev} for short.
17 @advanced{experienced developers may prefer to use their own
18 development environment. It may be instructive to skim over these
19 instructions, but be aware that this chapter is intended for
20 helpful users who may have never created a patch before.}
25 * Compiling with lilydev::
32 This section discusses how to install and use the Ubuntu LilyPond
36 * Installing lilydev::
37 * Configuring lilydev in virtualbox::
41 @node Installing lilydev
42 @subsection Installing lilydev
46 Install some virtualization software.
48 Any virtualization tool can be used, but we recommend VirtualBox:
51 @uref{http://@/www.virtualbox.org/@/wiki/@/Downloads}
54 In virtualization terminology, your main operating system is the
55 @qq{host}, while lilydev is the @qq{guest}.
58 Download the Ubuntu LilyPond Developer Remix disk image:
62 @uref{http://files.lilynet.net/ubuntu-lilydev-remix-1.1.iso}
65 @advanced{Some users might want these files, but if you don't
66 recognize what they are, then you don't want them:
68 @uref{http://files.lilynet.net/ubuntu-lilydev-remix-1.1.iso.md5}
70 @c @uref{http://files.lilynet.net/ubuntu-lilydev-remix-1.0.iso.torrent}
74 Create a music new @qq{virtual machine} inside your virtualization
77 If possible, use at least 700 MB of RAM (1GB would be better) for
78 the virtual machine, and use @qq{dynamically expanding storage}
79 for the virtual hard drive. A complete compile of everything
80 (code, docs, regression tests) can reach 10 GB.
83 Install @file{lilydev2.iso} as the @qq{guest} operating system
84 on your virtualized system.
89 When @file{lilydev.iso} boots, it shows an ISOLINUX
90 @code{boot:} prompt. Type:
97 At the @qq{Prepare disk space} stage, do not be afraid to select
98 @qq{Erase and use the entire disk}, since this refers to your
99 @emph{virtual disk}, not your machine's actual hard drive.
102 When prompted to remove the installation CD, go to
103 @clicksequence{Devices @click{} CD/DVD Devices} and de-select
109 The latest version of lilydev is based on Ubuntu 10.04.1; if you
110 encounter any difficulties installing it, search for one of the
111 many tutorials for installing that particular version of Ubuntu as
112 a guest operating system.
116 Do any extra configuration for your virtualization software.
118 There are additional instructions for VirtualBox in
119 @ref{Configuring lilydev in virtualbox}.
121 If you use other virtualization software, then follow the normal
122 procedures for your virtualization software with Ubuntu as the
129 Not all hardware is supported in all virtualization tools. In
130 particular, some contributors have reported problems with USB
131 devices, for example USB network adapters. If you have problems
132 with network connection (for example internet connection in the
133 host system is lost when you launch virtual system), try installing
134 and running Lilydev with your computer's built-in network adapter
135 used to connect to the network.
136 If you would like to investigate further, then look for
137 help for your virtualization tool using your normal OS as the
138 @qq{host} and Ubuntu as the @qq{client}.
141 @node Configuring lilydev in virtualbox
142 @subsection Configuring lilydev in virtualbox
144 VirtualBox has extra @qq{guest additions} which can make the
145 virtualization easier to use (full-screen, easy file sharing
146 between host and guest operating systems, shared clipboards, etc).
151 In @emph{VirtualBox}, select @clicksequence{Devices @click{}
152 Install Guest Additions...}.
155 In @emph{Ubuntu}, select @clicksequence{Places @click{}
156 VBOXADDITIONS_}. A file-system window will open.
159 Double-click on the @file{autorun.sh} file, then select @qq{Run in
160 Terminal}, and enter your password when prompted.
163 Once the script is finished, @qq{eject} the virtual CD, and then
164 go to @clicksequence{Devices @click{} CD/DVD Devices} and
165 de-select @file{VBoxGuestAdditions.iso}.
168 Restart Ubuntu to complete the installation.
170 @advanced{If you do any kernel upgrades, you may need to re-run
171 these VBOXADDITIONS instructions.}
174 Some other steps may be helpful:
178 In the settings for the virtual machine, set the network to
179 Bridged mode to allow you to access shared folders on your Windows
183 Set up any additional features, such as @q{Shared Folders} between
184 your main operating system and ubuntu. This is distinct from the
185 networked share folders in Windows. Consult external
186 documentation for this step.
188 Some longtime contributors have reported that @q{shared folders}
189 are rarely useful and not worth the fuss, particularly since files
190 can be shared over a network instead.
196 @subsection Using lilydev
198 If you are not familiar with Linux, it may be beneficial to read a
199 couple of @qq{introduction to Ubuntu} webpages.
203 One particular change from Windows and MacOS X is that most
204 software should be installed with your @qq{package manager}; this
205 vastly simplifies the process of installing and configuring
206 software. Go to @clicksequence{Applications @click{} Ubuntu
210 The rest of this manual assumes that you are using the
211 command-line; double-click on the @q{Terminal} icon on the
215 Pasting into a terminal is done with @code{Ctrl+Shift+v}.
218 The @qq{Places} top-menu has shortcuts to a graphical
219 @qq{navigator} like Windows Explorer or the MacOS X Finder.
222 Right-click allows you to edit a file with gedit. We recommend
226 Some contributors have recommended: (pdf available for free)
229 @uref{http://www.ubuntupocketguide.com/}
236 @section Using lily-git
238 @command{lily-git.tcl} is a graphical tool to help you access and
239 share changes to the lilypond source code.
242 * Install and configuration of lily-git.tcl::
243 * Daily use of lily-git.tcl::
246 @node Install and configuration of lily-git.tcl
247 @unnumberedsubsec Install and configuration of @command{lily-git.tcl}
249 @warning{The rest of this manual assumes that you are using the
250 command-line; double-click on the @q{Terminal} icon on the
255 Type (or copy&paste) into the Terminal:
262 Click on the @qq{Get source} button.
264 This will create a directory called @file{lilypond-git/} within
265 your home directory, and will download the source code into that
266 directory (around 55Mb). When the process is finished, the
267 @qq{Command output} window will display @qq{Done}, and the button
268 label will change to say @qq{Update source}.
271 Navigate to the @file{lilypond-git/} directory to view the source
276 You should now progress to @ref{Compiling with lilydev}.
278 @warning{Throughout the rest of this manual, most command-line
279 input should be entered from @file{~/lilypond-git/}. This is
280 referred to as the @emph{top source directory}.}
282 @advanced{the @qq{Get source} button does not fetch the entire
283 history of the git repository, so utilities like @command{gitk}
284 will only be able to display the most recent additions. As you
285 continue to work with @command{lily-git.tcl}, the @qq{Update
286 source} button will take any new additions and add it to whatever
287 is currently in your repository's history.}
290 @node Daily use of lily-git.tcl
291 @unnumberedsubsec Daily use of @command{lily-git.tcl}
293 @warning{Only work on one set of changes at once. Do not start
294 work on any new changes until your first set has been accepted.}
296 @subsubheading 1. Update source
298 At the beginning of each session of lilypond work, you should
299 click the @qq{Update source} button to get the latest changes to
302 @warning{In some rare and unfortunate circumstances, this will
303 result in a @emph{merge conflict}. If this occurs, follow the
304 instructions for @qq{Abort changes}, below. Your work will not be
308 @subsubheading 2a. New local commit
310 A single commit typically represents one logical set of related
311 changes (such as a bug-fix), and may incorporate changes to
312 multiple files at the same time.
314 When you're finished making the changes for a commit, click the
315 @qq{New local commit} button. This will open the @qq{Git Commit
316 Message} window. The message header is required, and the message
319 After entering a commit message, click @qq{OK} to finalize the
322 @advanced{for more information regarding commits and commit
323 messages, see @ref{Commits and patches}.}
326 @subsubheading 2b. Amend previous commit
328 You can go back and make changes to the most recent commit with
329 the @qq{Amend previous commit} button. This is useful if a
330 mistake is found after you have clicked the @qq{New local commit}
333 To amend the most recent commit, re-edit the source files as
334 needed and then click the @qq{Amend previous commit} button. The
335 earlier version of the commit is not saved, but is replaced by the
338 @warning{This does not update the patch @strong{files}; if you
339 have a patch file from an earlier version of the commit, you will
340 need to make another patch set when using this feature. The old
341 patch file will not be saved, but will be replaced by the new one
342 after you click on @qq{Make patch set}.}
345 @subsubheading 3. Make patch set
347 Before making a patch set from any commits, you should click the
348 @qq{Update source} button to make sure the commits are based on
349 the most recent remote snapshot.
351 When you click the @qq{Make patch set} button,
352 @command{lily-git.tcl} will produce patch files for any new
353 commits, saving them to the current directory. The command output
354 will display the name of the new patch files near the end of the
358 0001-CG-add-lily-git-instructions.patch
362 Send patch files to the appropriate place:
366 If you have a mentor, send it to them via email.
369 New contributors should send the patch attached to an email to
370 @email{frogs@@lilynet.net}. Please add @qq{[PATCH]} to the
374 Translators should send patches to
375 @email{translations@@lilynet.net}.
378 More experienced contributors should upload the patch for
379 web-based review. This requires additional software and use of
380 the command-line; see @ref{Uploading a patch for review}.
385 @subsubheading The @qq{Abort changes -- Reset to origin} button
387 @warning{Only use this if your local commit history gets
388 hopelessly confused!}
390 The button labeled @qq{Abort changes -- Reset to origin} will copy
391 all changed files to a subdirectory of @file{lilypond-git/} named
392 @file{aborted_edits/}, and will reset the repository to the
393 current state of the remote repository (at @code{git.sv.gnu.org}).
397 @node Compiling with lilydev
398 @section Compiling with lilydev
400 Lilydev is our @q{remix} of Ubuntu which contains all the
401 necessary dependencies to do lilypond development; for more
402 information, see @rcontrib{Lilydev}.
404 @subsubheading Preparing the build
406 To prepare the build directory, enter (or copy&paste) the below
407 text. This should take less than a minute.
409 @c we heavily recommend the out-of-tree build; do not change this!
413 sh autogen.sh --noconfigure
419 @subsubheading Building @code{lilypond}
421 Compiling lilypond will likely take between 5 and 60 minutes,
422 depending on your computer's speed and available RAM. We
423 recommend that you minimize the terminal window while it is
424 building; this can have a non-negligible effect on compilation
428 cd ~/lilypond-git/build/
432 You may run the compiled @code{lilypond} with:
435 cd ~/lilypond-git/build/
436 out/bin/lilypond my-file.ly
439 @subsubheading Building the documentation
441 Compiling the documentation is a much more involved process, and
442 will likely take 2 to 10 hours.
445 cd ~/lilypond-git/build/
449 The documentation is put in @file{out-www/offline-root/}. You may
450 view the html files by entering the below text; we recommend that
451 you bookmark the resulting page:
454 firefox ~/lilypond-git/build/out-www/offline-root/index.html
457 @subsubheading Installing
459 Don't. There is no reason to install lilypond within lilydev.
460 All development work can (and should) stay within the
461 @file{$HOME/lilypond-git/} directory, and any personal composition
462 or typesetting work should be done with an official GUB release.
465 @subsubheading Problems and other options
467 To select different build options, or isolate certain parts of the
468 build, or to use multiple CPUs while building, read
471 In particular, contributors working on the documentation should be
472 aware of some bugs in the build system, and should read the
473 workarounds in @ref{Generating documentation}.
476 @node Now start work!
477 @section Now start work!
479 Lilydev users may now skip to the chapter which is aimed at
480 their intended contributions:
483 @item @ref{Documentation work}
484 @item @ref{Translating the documentation}
485 @item @ref{Website work}
486 @item @ref{Regression tests}
487 @item @ref{Programming work}
490 These chapters are mainly intended for people not using LilyDev,
491 but they contain extra information about the
492 @qq{behind-the-scenes} activities. We recommend that you read
493 these at your leisure, a few weeks after beginning work with
497 @item @ref{Working with source code}
498 @item @ref{Compiling}