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.0.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.0.iso.md5}
70 @uref{http://files.lilynet.net/ubuntu-lilydev-remix-1.0.iso.torrent}
74 Create a 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{lilydev2.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. If you would like to investigate further, then look for
132 help for your virtualization tool using your normal OS as the
133 @qq{host} and Ubuntu as the @qq{client}.
136 @node Configuring lilydev in virtualbox
137 @subsection Configuring lilydev in virtualbox
139 VirtualBox has extra @qq{guest additions} which can make the
140 virtualization easier to use (full-screen, easy file sharing
141 between host and guest operating systems, shared clipboards, etc).
146 In @emph{VirtualBox}, select @clicksequence{Devices @click{}
147 Install Guest Additions...}.
150 In @emph{Ubuntu}, select @clicksequence{Places @click{}
151 VBOXADDITIONS_}. A file-system window will open.
154 Double-click on the @file{autorun.sh} file, then select @qq{Run in
155 Terminal}, and enter your password when prompted.
158 Once the script is finished, @qq{eject} the virtual CD, and then
159 go to @clicksequence{Devices @click{} CD/DVD Devices} and
160 de-select @file{VBoxGuestAdditions.iso}.
163 Restart Ubuntu to complete the installation.
165 @advanced{If you do any kernel upgrades, you may need to re-run
166 these VBOXADDITIONS instructions.}
169 Some other steps may be helpful:
173 In the settings for the virtual machine, set the network to
174 Bridged mode to allow you to access shared folders on your Windows
178 Set up any additional features, such as @q{Shared Folders} between
179 your main operating system and ubuntu. This is distinct from the
180 networked share folders in Windows. Consult external
181 documentation for this step.
183 Some longtime contributors have reported that @q{shared folders}
184 are rarely useful and not worth the fuss, particularly since files
185 can be shared over a network instead.
191 @subsection Using lilydev
193 If you are not familiar with Linux, it may be beneficial to read a
194 couple of @qq{introduction to Ubuntu} webpages.
198 One particular change from Windows and MacOS X is that most
199 software should be installed with your @qq{package manager}; this
200 vastly simplifies the process of installing and configuring
201 software. Go to @clicksequence{Applications @click{} Ubuntu
205 The rest of this manual assumes that you are using the
206 command-line; double-click on the @q{Terminal} icon on the
210 Pasting into a terminal is done with @code{Ctrl+Shift+v}.
213 The @qq{Places} top-menu has shortcuts to a graphical
214 @qq{navigator} like Windows Explorer or the MacOS X Finder.
217 Right-click allows you to edit a file with gedit. We recommend
221 Some contributors have recommended: (pdf available for free)
224 @uref{http://www.ubuntupocketguide.com/}
231 @section Using lily-git
233 @command{lily-git.tcl} is a graphical tool to help you access and
234 share changes to the lilypond source code.
237 * Install and configuration of lily-git.tcl::
238 * Daily use of lily-git.tcl::
241 @node Install and configuration of lily-git.tcl
242 @unnumberedsubsec Install and configuration of @command{lily-git.tcl}
244 @warning{The rest of this manual assumes that you are using the
245 command-line; double-click on the @q{Terminal} icon on the
250 Type (or copy&paste) into the Terminal:
257 Click on the @qq{Get source} button.
259 This will create a directory called @file{lilypond-git/} within
260 your home directory, and will download the source code into that
261 directory (around 55Mb). When the process is finished, the
262 @qq{Command output} window will display @qq{Done}, and the button
263 label will change to say @qq{Update source}.
266 Navigate to the @file{lilypond-git/} directory to view the source
271 You should now progress to @ref{Compiling with lilydev}.
273 @warning{Throughout the rest of this manual, most command-line
274 input should be entered from @file{~/lilypond-git/}. This is
275 referred to as the @emph{top source directory}.}
277 @advanced{the @qq{Get source} button does not fetch the entire
278 history of the git repository, so utilities like @command{gitk}
279 will only be able to display the most recent additions. As you
280 continue to work with @command{lily-git.tcl}, the @qq{Update
281 source} button will take any new additions and add it to whatever
282 is currently in your repository's history.}
285 @node Daily use of lily-git.tcl
286 @unnumberedsubsec Daily use of @command{lily-git.tcl}
288 @warning{Only work on one set of changes at once. Do not start
289 work on any new changes until your first set has been accepted.}
291 @subsubheading 1. Update source
293 At the beginning of each session of lilypond work, you should
294 click the @qq{Update source} button to get the latest changes to
297 @warning{In some rare and unfortunate circumstances, this will
298 result in a @emph{merge conflict}. If this occurs, follow the
299 instructions for @qq{Abort changes}, below. Your work will not be
303 @subsubheading 2a. New local commit
305 A single commit typically represents one logical set of related
306 changes (such as a bug-fix), and may incorporate changes to
307 multiple files at the same time.
309 When you're finished making the changes for a commit, click the
310 @qq{New local commit} button. This will open the @qq{Git Commit
311 Message} window. The message header is required, and the message
314 After entering a commit message, click @qq{OK} to finalize the
317 @advanced{for more information regarding commits and commit
318 messages, see @ref{Commits and patches}.}
321 @subsubheading 2b. Amend previous commit
323 You can go back and make changes to the most recent commit with
324 the @qq{Amend previous commit} button. This is useful if a
325 mistake is found after you have clicked the @qq{New local commit}
328 To amend the most recent commit, re-edit the source files as
329 needed and then click the @qq{Amend previous commit} button. The
330 earlier version of the commit is not saved, but is replaced by the
333 @warning{This does not update the patch @strong{files}; if you
334 have a patch file from an earlier version of the commit, you will
335 need to make another patch set when using this feature. The old
336 patch file will not be saved, but will be replaced by the new one
337 after you click on @qq{Make patch set}.}
340 @subsubheading 3. Make patch set
342 Before making a patch set from any commits, you should click the
343 @qq{Update source} button to make sure the commits are based on
344 the most recent remote snapshot.
346 When you click the @qq{Make patch set} button,
347 @command{lily-git.tcl} will produce patch files for any new
348 commits, saving them to the current directory. The command output
349 will display the name of the new patch files near the end of the
353 0001-CG-add-lily-git-instructions.patch
357 Send patch files to the appropriate place:
361 If you have a mentor, send it to them via email.
364 New contributors should send the patch attached to an email to
365 @email{frogs@@lilynet.net}. Please add @qq{[PATCH]} to the
369 Translators should send patches to
370 @email{translations@@lilynet.net}.
373 More experienced contributors should upload the patch for
374 web-based review. This requires additional software and use of
375 the command-line; see @ref{Uploading a patch for review}.
380 @subsubheading The @qq{Abort changes -- Reset to origin} button
382 @warning{Only use this if your local commit history gets
383 hopelessly confused!}
385 The button labeled @qq{Abort changes -- Reset to origin} will copy
386 all changed files to a subdirectory of @file{lilypond-git/} named
387 @file{aborted_edits/}, and will reset the repository to the
388 current state of the remote repository (at @code{git.sv.gnu.org}).
392 @node Compiling with lilydev
393 @section Compiling with lilydev
395 Lilydev is our @q{remix} of Ubuntu which contains all the
396 necessary dependencies to do lilypond development; for more
397 information, see @rcontrib{Lilydev}.
399 @subsubheading Preparing the build
401 To prepare the build directory, enter (or copy&paste) the below
402 text. This should take less than a minute.
404 @c we heavily recommend the out-of-tree build; do not change this!
408 sh autogen.sh --noconfigure
414 @subsubheading Building @code{lilypond}
416 Compiling lilypond will likely take between 5 and 60 minutes,
417 depending on your computer's speed and available RAM. We
418 recommend that you minimize the terminal window while it is
419 building; this can have a non-negligible effect on compilation
423 cd ~/lilypond-git/build/
427 You may run the compiled @code{lilypond} with:
430 cd ~/lilypond-git/build/
431 out/bin/lilypond my-file.ly
434 @subsubheading Building the documentation
436 Compiling the documentation is a much more involved process, and
437 will likely take 2 to 10 hours.
440 cd ~/lilypond-git/build/
444 The documentation is put in @file{out-www/offline-root/}. You may
445 view the html files by entering the below text; we recommend that
446 you bookmark the resulting page:
449 firefox ~/lilypond-git/build/out-www/offline-root/index.html
452 @subsubheading Installing
454 Don't. There is no reason to install lilypond within lilydev.
455 All development work can (and should) stay within the
456 @file{$HOME/lilypond-git/} directory, and any personal composition
457 or typesetting work should be done with an official GUB release.
460 @subsubheading Problems and other options
462 To select different build options, or isolate certain parts of the
463 build, or to use multiple CPUs while building, read
466 In particular, contributors working on the documentation should be
467 aware of some bugs in the build system, and should read the
468 workarounds in @ref{Generating documentation}.
471 @node Now start work!
472 @section Now start work!
474 Lilydev users may now skip to the chapter which is aimed at
475 their intended contributions:
478 @item @ref{Documentation work}
479 @item @ref{Translating the documentation}
480 @item @ref{Website work}
481 @item @ref{Regression tests}
482 @item @ref{Programming work}
485 These chapters are mainly intended for people not using LilyDev,
486 but they contain extra information about the
487 @qq{behind-the-scenes} activities. We recommend that you read
488 these at your leisure, a few weeks after beginning work with
492 @item @ref{Working with source code}
493 @item @ref{Compiling}