1 @c -*- coding: utf-8; mode: texinfo; -*-
4 @node Working with source code
5 @chapter Working with source code
7 @warning{New contributors should read @ref{Quick start}, and in
8 particular @ref{lily-git}, instead of this chapter.}
10 Advanced contributors will find this material quite useful,
11 particularly if they are working on major new features.
14 * Manually installing lily-git.tcl::
16 * Basic Git procedures::
17 * Advanced Git procedures::
19 * Repository directory structure::
20 * Other Git documentation::
24 @node Manually installing lily-git.tcl
25 @section Manually installing lily-git.tcl
27 We have created an easy-to-use GUI to simplify git for new
28 contributors. If you are comfortable with the command-line, then
29 skip ahead to @ref{Starting with Git}.
31 @warning{These instructions are only for people who are @emph{not}
34 @c there's some duplication in this section with stuff covered in
35 @c Quick Start, but moving it into a macro inside included/ would
36 @c be getting a bit icky. -gp
40 If you haven't already, download and install Git.
44 @item Windows users: download the @code{.exe} file labeled
45 @qq{Full installer for official Git} from:
48 @uref{http://code.google.com/p/msysgit/downloads/list}
51 @item Other operating systems: either install @command{git} with
52 your package manager, or download it from the @qq{Binaries}
56 @uref{http://git-scm.com/download}
63 Download the @command{lily-git.tcl} script from:
65 @c don't change the cgit link below to gitweb; gitweb uses
66 @c long filenames like "scripts_auxiliar_lily-git.tcl"
69 @uref{http://git.sv.gnu.org/cgit/lilypond.git/plain/scripts/auxiliar/lily-git.tcl}
73 To run the program from the command line, navigate to the
74 directory containing @command{lily-git.tcl} and enter:
81 Click on the @qq{Get source} button.
83 This will create a directory called @file{lilypond-git/} within
84 your home directory, and will download the source code into that
85 directory (around 150@tie{}Mb). When the process is finished, the
86 @qq{Command output} window will display @qq{Done}, and the button
87 label will change to say @qq{Update source}.
90 Navigate to the @file{lilypond-git/} directory to view the source
95 @warning{Throughout the rest of this manual, most command-line
96 input should be entered from @file{$LILYPOND_GIT}. This is
97 referred to as the @emph{top source directory}.}
99 Further instructions are in @ref{How to use lily-git}.
102 @node Starting with Git
103 @section Starting with Git
105 Using the Git program directly (as opposed to using the
106 @command{lily-git.tcl} GUI) allows you to have much greater control
107 over the contributing process. You should consider using Git if
108 you want to work on complex projects, or if you want to work on
109 multiple projects concurrently.
114 * Git for the impatient::
115 * Other repositories::
116 * Downloading remote branches::
121 @subsection Setting up
123 @warning{These instructions assume that you are using the
124 command-line version of Git 1.5 or higher. Windows users should
125 skip to @ref{Git on Windows}.}
129 * Initializing a repository::
135 @unnumberedsubsubsec Installing Git
137 If you are using a Unix-based machine, the easiest way to download
138 and install Git is through a package manager such as @command{rpm}
139 or @command{apt-get} -- the installation is generally automatic.
140 The only required package is (usually) called @command{git-core},
141 although some of the auxiliary @command{git@var{*}} packages are
142 also useful (such as @command{gitk}).
144 Alternatively, you can visit the Git website
145 (@uref{http://git-scm.com/}) for downloadable binaries and
149 @node Initializing a repository
150 @unnumberedsubsubsec Initializing a repository
152 Once Git is installed, get a copy of the source code:
155 git clone git://git.sv.gnu.org/lilypond.git ~/lilypond-git
158 The above command will put the it in @file{~/lilypond-git}, where
159 @code{~} represents your home directory.
161 @subsubheading Technical details
163 This creates (within the @file{$LILYPOND_GIT} directory) a
164 subdirectory called @file{.git/}, which Git uses to keep track of
165 changes to the repository, among other things. Normally you don't
166 need to access it, but it's good to know it's there.
169 @node Configuring Git
170 @unnumberedsubsubsec Configuring Git
172 @warning{Throughout the rest of this manual, all command-line
173 input should be entered from the top directory of the Git
174 repository being discussed (eg. @file{$LILYPOND_GIT}). This is
175 referred to as the @emph{top source directory}.}
177 Before working with the copy of the main LilyPond repository, you
178 should configure some basic settings with the
179 @command{git@tie{}config} command. Git allows you to set both
180 global and repository-specific options.
182 To configure settings that affect all repositories, use the
183 @option{--global} command line option. For example, the first
184 two options that you should always set are your @var{name} and
185 @var{email}, since Git needs these to keep track of commit
189 git config --global user.name "@var{John Smith}"
190 git config --global user.email @var{john@@example.com}
193 To configure Git to use colored output where possible, use:
196 git config --global color.ui auto
199 The text editor that opens when using @command{git@tie{}commit}
200 can also be changed. If none of your editor-related environment
201 variables are set ($GIT_EDITOR, $VISUAL, or $EDITOR), the default
202 editor is usually @command{vi} or @command{vim}. If you're not
203 familiar with either of these, you should probably change the
204 default to an editor that you know how to use. For example, to
205 change the default editor to @command{nano}, enter:
208 git config --global core.editor @var{nano}
211 Finally, and in some ways most importantly, let's make sure that
212 we know what branch we're on. If you're not using LilyDev, add
213 this to your @file{~/.bashrc}:
216 export PS1="\u@\h \w\$(__git_ps1)$ "
219 You may need to install the additional @code{bash-completion}
220 package, but it is definitely worth it. After installation
221 you must log out, and then log back in again to enable it.
224 @subsubheading Technical details
226 Git stores the information entered with
227 @command{git@tie{}config@tie{}--global} in the file
228 @file{.gitconfig}, located in your home directory. This file can
229 also be modified directly, without using
230 @command{git@tie{}config}. The @file{.gitconfig} file generated
231 by the above commands would look like this:
236 email = john@@example.com
243 Using the @command{git@tie{}config} command @emph{without} the
244 @option{--global} option configures repository-specific settings,
245 which are stored in the file @file{.git/config}. This file is
246 created when a repository is initialized (using
247 @command{git@tie{}init}), and by default contains these lines:
251 repositoryformatversion = 0
254 logallrefupdates = true
257 However, since different repository-specific options are
258 recommended for different development tasks, it is best to avoid
259 setting any now. Specific recommendations will be mentioned later
263 @node Git for the impatient
264 @subsection Git for the impatient
266 @advanced{The intent of this subsection is to get you working on lilypond as
267 soon as possible. If you want to learn about git, go read
268 @ref{Other Git documentation}.
270 Also, these instructions are designed to eliminate the most common
271 problems we have found in using git. If you already know git and
272 have a different way of working, great! Feel free to ignore the
273 advice in this subsection.}
276 Ok, so you've been using @command{lily-git.tcl} for a while, but
277 it's time to take the next step. Since our review process delays
278 patches by 60-120 hours, and you want to be able to work on other
279 stuff while your previous work is getting reviewed, you're going
280 to use @strong{branches}.
282 You can think of a branch as being a separate copy of the source
283 code. But don't worry about it.
285 @subsubheading Start work: make a new branch
287 Let's pretend you want to add a section to the Contributor's Guide
288 about using branches.
290 Start by updating the repository, then making a new branch. Call
291 the branch anything you want as long as the name starts with
292 @code{dev/}. Branch names that don't begin with @code{dev/} are
293 reserved for special things in lilypond.
297 git pull -r origin master
301 @subsubheading Switch to that branch
303 Nothing has happened to the files yet. Let's change into the new
304 branch. You can think of this as @qq{loading a file}, although in
305 this case it's really @qq{loading a directory and subdirectories
312 Your prompt now shows you that you're on the other branch:
315 gperciva@@LilyDev:~/lilypond-git (dev/cg)$
318 To be able to manage multiple lilypond issues at once, you'll need to switch
319 branches. You should have each lilypond issue on a separate branch.
320 Switching branches is easy:
324 git checkout origin/staging
325 git checkout origin/release/unstable
329 Branches that begin with @code{origin/} are part of the remote repository,
330 rather than your local repository, so when you check them out you get a
331 temporary local branch. You should never make changes directly on a
332 branch beginning with @code{origin/}. You get changes into the remote
333 repository by making them in local branches, and then pushing them to
334 @code{origin/staging} as described below.
336 @subsubheading Make your changes
338 Edit files, then commit them.
345 Remember how I said that switching to a branch was like
346 @qq{loading a directory}? Well, you've just @qq{saved a
347 directory}, so that you can @qq{load} it later.
349 @advanced{If you have used @command{cvs} or @command{svn}, you may
350 be very confused: those programs use @qq{commit} to mean
351 @qq{upload my changes to the shared source repository}.
352 Unfortunately, just to be different, @w{@command{git commit}}
353 means @qq{save my changes to the files}.}
355 When you create a new file, you need to add it to git, then commit it:
358 git add input/regression/avoid-crash-on-condition.ly
363 Edit more files. Commit them again. Edit yet more files, commit
364 them again. Go eat dinner. Switch to @code{master} so you can
365 play with the latest changes from other developers. Switch back
366 to your branch and edit some more. Commit those changes.
368 At this stage, don't worry about how many commits you have.
371 @subsubheading Save commits to external files
373 Branches are nerve-wracking until you get used to them. You can
374 save your hard work as individual @file{.patch} files. Be sure to
375 commit your changes first.
379 git format-patch master
382 I personally have between 4 and 20 of those files saved in a
383 special folder at any point in time. Git experts might laugh as
384 that behavior, but I feel a @emph{lot} better knowing that I've
388 @subsubheading Prepare your branch for review
390 After committing, you can update your branch with the latest master:
395 git pull -r origin master
401 Due to the speed of lilypond development, sometimes
402 @code{master} has changed so much that your branch can no
403 longer be applied to it. In that happens, you will have a merge
404 conflict. Stop for a moment to either cry or have a stiff drink,
405 then proceed to @ref{Merge conflicts}.
408 @subsubheading Upload your branch
410 Finally, you're finished your changes. Time to upload for review.
411 Make sure that you're on your branch, then upload:
419 @subsubheading Wait for reviews
421 While you're waiting for a countdown and reviews, go back to
422 master, make a @code{dev/doc-beams} branch, and start adding doc
423 suggestions from issue 12345 from the tracker. Or make a
424 @code{dev/page-breaks} and fix bug in page breaking. Or whatever.
425 Don't worry, your @code{dev/cg} is safe.
428 @subsubheading Combining commits (optional unless you have broken commits)
430 Does the history of your branch look good?
436 If you have a lot of commits on your branch, you might want to
437 combine some of them. Alternately, you may like your commits, but
438 want to edit the commit messages.
444 Follow instructions on the screen.
446 @warning{This step gives you the power to completely lose your
447 work. Make a backup of your commits by saving them to
448 @file{.patch} files before playing with this. If you do lose
449 your work, don't despair. You can get it back by using @code{git reflog}.
450 The use of @code{git reflog} is not covered here.}
452 @warning{If any of the commits on your branch represent partial work that will
453 not pass @var{make && make doc}, you @strong{must} squash these
454 commits into a working commit. Otherwise, your push will break staging
455 and will not be able to be merged to master. In general, you will
456 be safer to have one commit per push.}
459 @subsubheading Push to staging
461 When you've got the coveted @code{Patch-push} status, time to
466 git rebase origin/staging dev/cg~0
470 @warning{Do not skip the @command{gitk} step; a quick 5-second
471 check of the visual history can save a great deal of frustration
472 later on. You should see a set of your commits that are ahead of
473 @code{origin/staging}, with no label for the top commit -- only a
476 @warning{If @code{origin/staging} and @code{origin/master} are the
477 same commit, your branch (@code{dev/cg} in the example) will also
478 be at the top of the @code{gitk} tree. This is normal.}
480 If everything looks good, push it:
483 git push origin HEAD:staging
486 Then change back to your working branch:
492 @warning{It is a best practice to avoid rebasing any of your branches
493 to @code{origin/staging}. If @code{origin/staging} is broken, it
494 will be deleted and rebuilt. If you have rebased one of your branches
495 to @code{origin/staging}, the broken commits can end up in your branch.
496 The commands given above do the rebase on a temporary branch, and avoid
497 changing your working branch.}
500 @subsubheading Delete your branch (safe)
502 After a few hours, if there's nothing wrong with your branch, it
503 should be automatically moved to @code{origin/master}. Update,
504 then try removing your branch:
508 git pull -r origin master
512 The last command will fail if the contents of @code{dev/cg} are
513 not present in @code{origin/master}.
516 @subsubheading Delete your branch (UNSAFE)
518 @c don't give explicit commands here -- this is too dangerous to copy and paste
519 Sometimes everything goes wrong. If you want to remove a branch even though
520 it will cause your work to be lost (that is, if the contents of @code{dev/cg}
521 are @strong{not} present in master), follow the instructions in @qq{Delete
522 your branch (safe)}, but replace the @code{-d} on the final line with
526 @node Other repositories
527 @subsection Other repositories
529 We have a few other code repositories.
533 * Grand Unified Builder (GUB)::
535 * yet more repositories::
539 @unnumberedsubsubsec lilypond-extra
541 There is a separate repository for general administrative scripts,
542 as well as pictures and media files for the website. People
543 interested in working on the website should download this
544 repository, and set their @code{$LILYPOND_WEB_MEDIA_GIT}
545 environment variable to point to that repository.
548 @uref{https://github.com/gperciva/lilypond-extra}
551 To configure an environment variable in bash (the default for most
552 GNU/Linux distributions),
555 export LILYPOND_WEB_MEDIA_GIT=$HOME/dir/of/lilypond-extra/
558 Be aware that @code{lilypond-extra} is the definitive source for some binary
559 files - in particular PDF versions of papers concerning LilyPond. To add
560 further PDFs of this sort, all that is necessary is to add the PDF to
561 @code{lilypond-extra} and then add a reference to it in the documentation. The
562 file will then be copied to the website when @code{make website} is run.
564 However, pictures that are also used in the documentation build are mastered in
565 the main git repository. If any of these is changed, it should be updated in
566 git, and then the updates copied to @code{lilypond-extra}.
568 @node Grand Unified Builder (GUB)
569 @unnumberedsubsubsec Grand Unified Builder (GUB)
571 Another item of interest might be the Grand Unified Builder, our
572 cross-platform building tool. Since it is used by other projects as
573 well, it is not stored in our gub repository. For more info, see
574 @uref{http://lilypond.org/gub}.
576 There are two locations for this repository: the version being used to
577 build lilypond, which is at
580 @uref{http://github.com/gperciva/gub}
583 and the original version by Jan Nieuwenhuizen, kept at
586 @uref{http://github.com/janneke/gub}
591 @unnumberedsubsubsec LilyPad
593 Our binary releases on MacOS X and Windows contain a lightweight
596 To make any modifications the Windows editor, you will need to do the
601 Clone the git repository from @code{https://github.com/gperciva/lilypad}
604 Make changes to the source, and check it compiles. In a Windows environment
605 @code{MinGW} provides both a @code{Git} installation and a @code{gcc}
606 compiler. This can be obtained from @code{http://www.mingw.org/}
609 Update the version which is contained in the @file{rsrc.rc}. Check
613 Commit the changes with an informative commit message.
616 Push the changes to github. You will need to use syntax similiar to this:
619 git push https://UserName@@github.com/gperciva/lilypad.git
622 You will need to have push access to the git repository for this to be
626 Make a tarball of the source code to be used by GUB by pulling the updated
627 repository from GitHub. Ensure that the tarball has the correct Version
631 Copy the tarball to @code{http://lilypond.org/download/gub-sources/lilypad/}.
632 You will need to have SSH access to @code{lilypond.org}. If you do not, contact
633 the Release Manager via the lilypond-devel mailing list.
636 Update GUB to make it use the new tarball by editing
637 @file{gub/specs/lilypad.py} and changing the @code{source =} line to point to
641 Push this updated @file{lilypad.py} version to the GUB repository on GitHub.
644 Test the changes with a new GUB compile.
648 @node yet more repositories
649 @unnumberedsubsubsec yet more repositories
651 There are a few other repositories floating around, which will
652 hopefully be documented in the near future.
655 @node Downloading remote branches
656 @subsection Downloading remote branches
658 @warning{contains obsolete + misleading info}
661 * Organization of remote branches::
662 * LilyPond repository sources::
663 * Downloading individual branches::
664 * Downloading all remote branches::
669 @node Organization of remote branches
670 @unnumberedsubsubsec Organization of remote branches
673 The main LilyPond repository is organized into @emph{branches} to
674 facilitate development. These are often called @emph{remote}
675 branches to distinguish them from @emph{local} branches you might
676 create yourself (see @ref{Using local branches}).
678 The @code{master} branch contains all the source files used to
679 build LilyPond, which includes the program itself (both stable and
680 development releases), the documentation (and its translations),
681 and the website. Generally, the @code{master} branch is expected
682 to compile successfully.
684 The @code{translation} branch is a side branch that
685 allows translators to work without needing to worry about
686 compilation problems. Periodically, the Translation Meister
687 (after verifying that it doesn't break compilation), will
688 @emph{merge} this branch into @code{staging} to incorporate
689 recent translations. Similarly, the @code{master} branch is
690 usually merged into the @code{translation} branch after
691 significant changes to the English documentation. See
692 @ref{Translating the documentation} for details.
695 @node LilyPond repository sources
696 @unnumberedsubsubsec LilyPond repository sources
699 The recommended source for downloading a copy of the main
703 git://git.sv.gnu.org/lilypond.git
706 However, if your internet router filters out connections using the
707 GIT protocol, or if you experience difficulty connecting via GIT,
708 you can try these other sources:
711 ssh://git.sv.gnu.org/srv/git/lilypond.git
712 http://git.sv.gnu.org/r/lilypond.git
715 The SSH protocol can only be used if your system is properly set
716 up to use it. Also, the HTTP protocol is slowest, so it should
717 only be used as a last resort.
720 @node Downloading individual branches
721 @unnumberedsubsubsec Downloading individual branches
723 @warning{obsolete, should be deleted!}
726 Once you have initialized an empty Git repository on your system
727 (see @ref{Initializing a repository}), you can download a remote
728 branch into it. Make sure you know which branch you want to start
731 To download the @code{master} branch, enter the following:
734 git remote add -ft master -m master \
735 origin git://git.sv.gnu.org/lilypond.git/
738 To download the @code{translation} branch, enter:
741 git remote add -ft translation -m \
742 translation origin git://git.sv.gnu.org/lilypond.git/
745 The @command{git@tie{}remote@tie{}add} process could take up to
746 ten minutes, depending on the speed of your connection. The
747 output will be something like this:
751 remote: Counting objects: 235967, done.
752 remote: Compressing objects: 100% (42721/42721), done.
753 remote: Total 235967 (delta 195098), reused 233311 (delta 192772)
754 Receiving objects: 100% (235967/235967), 68.37 MiB | 479 KiB/s, done.
755 Resolving deltas: 100% (195098/195098), done.
756 From git://git.sv.gnu.org/lilypond
757 * [new branch] master -> origin/master
758 From git://git.sv.gnu.org/lilypond
759 * [new tag] flower/1.0.1 -> flower/1.0.1
760 * [new tag] flower/1.0.10 -> flower/1.0.10
762 * [new tag] release/2.9.6 -> release/2.9.6
763 * [new tag] release/2.9.7 -> release/2.9.7
766 When @command{git@tie{}remote@tie{}add} is finished, the remote
767 branch should be downloaded into your repository---though not yet
768 in a form that you can use. In order to browse the source code
769 files, you need to @emph{create} and @emph{checkout} your own
770 local branch. In this case, however, it is easier to have Git
771 create the branch automatically by using the @command{checkout}
772 command on a non-existent branch. Enter the following:
775 git checkout -b @var{branch} origin/@var{branch}
779 where @code{@var{branch}} is the name of your tracking branch,
780 either @code{master} or @code{translation}.
782 Git will issue some warnings; this is normal:
785 warning: You appear to be on a branch yet to be born.
786 warning: Forcing checkout of origin/master.
787 Branch master set up to track remote branch master from origin.
791 By now the source files should be accessible---you should be able
792 to edit any files in the @file{$LILYPOND_GIT} directory using a
793 text editor of your choice. But don't start just yet! Before
794 editing any source files, learn how to keep your changes organized
795 and prevent problems later---read @ref{Basic Git procedures}.
797 @subsubheading Technical Details
799 The @command{git@tie{}remote@tie{}add} command should add some
800 lines to your local repository's @file{.git/config} file:
804 url = git://git.sv.gnu.org/lilypond.git/
805 fetch = +refs/heads/master:refs/remotes/origin/master
809 @node Downloading all remote branches
810 @unnumberedsubsubsec Downloading all remote branches
813 To download all remote branches at once, you can @command{clone}
814 the entire repository:
817 git clone git://git.sv.gnu.org/lilypond.git
822 @unnumberedsubsubsec Other branches
824 Most contributors will never need to touch the other branches. If
825 you wish to do so, you will need more familiarity with Git; please
826 see @ref{Other Git documentation}.
829 @item @code{dev/XYZ}:
830 These branches are for individual developers. They store code
831 which is not yet stable enough to be added to the @code{master}
834 @item @code{stable/XYZ}:
835 The branches are kept for archival reasons.
837 @item @code{archive/XYZ}:
838 The branches are kept for archival reasons.
843 @node Basic Git procedures
844 @section Basic Git procedures
848 * The Git contributor's cycle::
849 * Pulling and rebasing::
850 * Using local branches::
851 * Commits and patches::
855 @node The Git contributor's cycle
856 @subsection The Git contributor's cycle
859 Here is a simplified view of the contribution process on Git:
863 Update your local repository by @emph{pulling} the most recent
864 updates from the remote repository.
867 Edit source files within your local repository's @emph{working
871 @emph{Commit} the changes you've made to a local @emph{branch}.
874 Generate a @emph{patch} to share your changes with the developers.
878 @node Pulling and rebasing
879 @subsection Pulling and rebasing
882 When developers push new patches to the @code{git.sv.gnu.org}
883 repository, your local repository is @strong{not} automatically
884 updated. It is important to keep your repository up-to-date by
885 periodically @emph{pulling} the most recent @emph{commits} from
886 the remote branch. Developers expect patches to be as current as
887 possible, since outdated patches require extra work before they
890 Occasionally you may need to rework some of your own modifications
891 to match changes made to the remote branch (see @ref{Resolving
892 conflicts}), and it's considerably easier to rework things
893 incrementally. If you don't update your repository along the way,
894 you may have to spend a lot of time resolving branch conflicts and
895 reconfiguring much of the work you've already done.
897 Fortunately, Git is able to resolve certain types of branch
898 conflicts automatically with a process called @emph{rebasing}.
899 When rebasing, Git tries to modify your old commits so they appear
900 as new commits (based on the latest updates). For a more involved
901 explanation, see the @command{git-rebase} man page.
903 To pull without rebasing (recommended for translators), use the
907 git pull # recommended for translators
910 If you're tracking the remote @code{master} branch, you should add
911 the @option{-r} option (short for @option{--rebase}) to keep commits
912 on your local branch current:
915 git pull -r # use with caution when translating
918 If you don't edit translated documentation and don't want to type
919 @option{-r} every time, configure the master branch to rebase by
920 default with this command:
923 git config branch.master.rebase true
926 If pull fails because of a message like
929 error: Your local changes to 'Documentation/learning/tutorial.itely'
930 would be overwritten by merge. Aborting.
937 Documentation/learning/tutorial.itely: needs update
938 refusing to pull with rebase: your working tree is not up-to-date
942 it means that you have modified some files in you working tree
943 without committing changes (see @ref{Commits and patches}); you
944 can use the @command{git@tie{}stash} command to work around this:
947 git stash # save uncommitted changes
948 git pull -r # pull using rebase (translators omit "-r")
949 git stash pop # reapply previously saved changes
952 Note that @command{git@tie{}stash@tie{}pop} will try to apply a
953 patch, and this may create a conflict. If this happens, see
954 @ref{Resolving conflicts}.
956 TODO: I think the next paragraph is confusing. Perhaps prepare
957 the reader for new terms `committish' and `head'? -mp
959 @warning{translators and documentation editors, if you have
960 changed committishes in the head of translated files using commits
961 you have not yet pushed to @code{git.sv.gnu.org}, please do not
962 rebase. If you want to avoid wondering whether you should rebase
963 each time you pull, please always use committishes from master
964 and/or translation branch on @code{git.sv.gnu.org}, which
965 in particular implies that you must push your changes to
966 documentation except committishes updates (possibly after having
967 rebased), then update the committishes and push them.}
969 TODO: when committishes automatic conditional update have been
970 tested and documented, append the following to the warning above:
971 Note that using update-committishes make target generally touches
974 @subsubheading Technical details
976 The @command{git@tie{}config} command mentioned above adds the
977 line @code{rebase = true} to the master branch in your local
978 repository's @file{.git/config} file:
983 merge = refs/heads/master
988 @node Using local branches
989 @subsection Using local branches
993 * Creating and removing branches::
994 * Listing branches and remotes::
995 * Checking out branches::
1000 @node Creating and removing branches
1001 @unnumberedsubsubsec Creating and removing branches
1004 Local branches are useful when you're working on several different
1005 projects concurrently. To create a new branch, enter:
1008 git branch @var{name}
1011 To delete a branch, enter:
1014 git branch -d @var{name}
1017 Git will ask you for confirmation if it sees that data would be
1018 lost by deleting the branch. Use @option{-D} instead of @option{-d}
1019 to bypass this. Note that you cannot delete a branch if it is
1020 currently checked out.
1023 @node Listing branches and remotes
1024 @unnumberedsubsubsec Listing branches and remotes
1026 You can get the exact path or URL of all remote branches by
1033 To list Git branches on your local repositories, run
1036 git branch # list local branches only
1037 git branch -r # list remote branches
1038 git branch -a # list all branches
1042 @node Checking out branches
1043 @unnumberedsubsubsec Checking out branches
1045 To know the currently checked out branch, i.e. the branch whose
1046 source files are present in your working tree, read the first line
1054 The currently checked out branch is also marked with an asterisk
1055 in the output of @command{git branch}.
1057 You can check out another branch @code{@var{other_branch}}, i.e.
1058 check out @code{@var{other_branch}} to the working tree, by
1062 git checkout @var{other_branch}
1065 Note that it is possible to check out another branch while having
1066 uncommitted changes, but it is not recommended unless you know
1067 what you are doing; it is recommended to run @command{git status}
1068 to check this kind of issue before checking out another branch.
1070 @node Merging branches
1071 @unnumberedsubsubsec Merging branches
1073 To merge branch @code{@var{foo}} into branch @code{@var{bar}},
1074 i.e. to @qq{add} all changes made in branch @code{@var{foo}} to
1075 branch @code{@var{bar}}, run
1078 git checkout @var{bar}
1082 If any conflict happens, see @ref{Resolving conflicts}.
1084 There are common usage cases for merging: as a translator, you will
1085 often want the Translations meister to merge @code{master} into
1086 @code{translation}; on the other hand, the Translations meister wants
1087 to merge @code{translation} into @code{staging} whenever he has
1088 checked that @code{translation} builds successfully.
1091 @node Commits and patches
1092 @subsection Commits and patches
1096 * Understanding commits::
1100 * Uploading a patch for review::
1104 @node Understanding commits
1105 @unnumberedsubsubsec Understanding commits
1107 Technically, a @emph{commit} is a single point in the history of a
1108 branch, but most developers use the term to mean a @emph{commit
1109 object}, which stores information about a particular revision. A
1110 single commit can record changes to multiple source files, and
1111 typically represents one logical set of related changes (such as a
1112 bug-fix). You can list the ten most recent commits in your
1113 current branch with this command:
1116 git log -10 --oneline
1119 If you're using an older version of Git and get an @q{unrecognized
1120 argument} error, use this instead:
1123 git log -10 --pretty=oneline --abbrev-commit
1126 More interactive lists of the commits on the remote @code{master}
1127 branch are available at
1128 @uref{http://git.sv.gnu.org/gitweb/?p=lilypond.git;a=shortlog} and
1129 @uref{http://git.sv.gnu.org/cgit/lilypond.git/log/}.
1132 @node Making commits
1133 @unnumberedsubsubsec Making commits
1136 Once you have modified some source files in your working
1137 directory, you can make a commit with the following procedure:
1141 Make sure you've configured Git properly (see @ref{Configuring
1142 Git}). Check that your changes meet the requirements described in
1143 @ref{Code style} and/or @ref{Documentation policy}. For advanced
1144 edits, you may also want to verify that the changes don't break
1145 the compilation process.
1148 Run the following command:
1155 to make sure you're on the right branch, and to see which files
1156 have been modified, added or removed, etc. You may need to tell
1157 Git about any files you've added by running one of these:
1160 git add @var{file} # add untracked @var{file} individually
1161 git add . # add all untracked files in current directory
1165 After @command{git@tie{}add}, run @command{git@tie{}status} again
1166 to make sure you got everything. You may also need to modify
1170 Preview the changes about to be committed (to make sure everything
1178 The @code{HEAD} argument refers to the most recent commit on the
1179 currently checked-out branch.
1182 Generate the commit with:
1189 The @option{-a} is short for @option{--all} which includes modified
1190 and deleted files, but only those newly created files that have
1191 previously been added.
1196 @node Commit messages
1197 @unnumberedsubsubsec Commit messages
1200 When you run the @command{git@tie{}commit@tie{}-a} command, Git
1201 automatically opens the default text editor so you can enter a
1202 @emph{commit message}. If you find yourself in a foreign editing
1203 environment, you're probably in @command{vi} or @command{vim}. If
1204 you want to switch to an editor you're more familiar with, quit by
1205 typing @code{:q!} and pressing @code{<Enter>}. See
1206 @ref{Configuring Git} for instructions on changing the default
1209 In any case, Git will open a text file for your commit message
1210 that looks like this:
1214 # Please enter the commit message for your changes. Lines starting
1215 # with '#' will be ignored, and an empty message aborts the commit.
1217 # Changes to be committed:
1218 # (use "git reset HEAD <file>..." to unstage)
1220 # modified: working.itexi
1224 Your commit message should begin with a one-line summary
1225 describing the change (no more than 50 characters long), and if
1226 necessary a blank line followed by several lines giving the
1229 @c $ git log -1 --pretty=medium 4d6f1e5
1231 Doc: add Baerenreiter and Henle solo cello suites
1233 Added comparison of solo cello suite engravings to new essay with
1234 high-res images, fixed cropping on Finale example.
1237 Commit messages often start with a short prefix describing the
1238 general location of the changes. If a commit affects the
1239 documentation in English (or in several languages simultaneously)
1240 the commit message should be prefixed with @qq{Doc:@tie{}}. If
1241 the commit affects only one of the translations, the commit
1242 message should be prefixed with @qq{Doc-@var{**}:@tie{}}, where
1243 @var{**} is the two-letter language code. Commits that affect the
1244 website should use @qq{Web:@tie{}} for English, and
1245 @qq{Web-@var{**}:@tie{}} for the other languages. Also, changes
1246 to a single file are often prefixed with the name of the file
1247 involved. Visit the links listed in @ref{Understanding commits}
1251 @node Making patches
1252 @unnumberedsubsubsec Making patches
1254 If you want to share your changes with other contributors and
1255 developers, you need to generate @emph{patches} from your commits.
1256 We prefer it if you follow the instructions in
1257 @ref{Uploading a patch for review}. However, we present an
1258 alternate method here.
1260 You should always run @command{git@tie{}pull@tie{}-r} (translators
1261 should leave off the @option{-r}) before doing this to ensure that
1262 your patches are as current as possible.
1264 Once you have made one or more commits in your local repository,
1265 and pulled the most recent commits from the remote branch, you can
1266 generate patches from your local commits with the command:
1269 git format-patch origin
1272 The @code{origin} argument refers to the remote tracking branch at
1273 @code{git.sv.gnu.org}. This command generates a separate patch
1274 for each commit that's in the current branch but not in the remote
1275 branch. Patches are placed in the current working directory and
1276 will have names that look something like this:
1279 0001-Doc-Fix-typos.patch
1280 0002-Web-Remove-dead-links.patch
1284 Send an email (must be less than 64 KB) to
1285 @email{lilypond-devel@@gnu.org} briefly explaining your work, with
1286 the patch files attached. Translators should send patches to
1287 @email{translations@@lilynet.net}. After your patches are
1288 reviewed, the developers may push one or more of them to the main
1289 repository or discuss them with you.
1292 @node Uploading a patch for review
1293 @unnumberedsubsubsec Uploading a patch for review
1295 Any non-trivial change should be uploaded to our @qq{Rietveld}
1296 code review website:
1299 @uref{http://codereview.appspot.com/}
1302 @subsubheading @command{git-cl} install
1304 LilyDev users should skip over these @q{install} instructions.
1309 Install @command{git-cl} by entering:
1312 git clone https://github.com/gperciva/git-cl.git
1315 If that command fails for some reason, try this instead:
1318 git clone git://github.com/gperciva/git-cl.git
1322 Add the @file{git-cl/} directory to your PATH,
1323 or create a symbolic link to the @command{git-cl}
1324 and @command{upload.py} scripts in one of your PATH
1325 directories (such as @file{$HOME/bin}).
1327 In GNU/Linux you can add directories to PATH
1328 by adding this line to a hidden file @file{.bashrc},
1329 located in your home directory:
1332 PATH=~/type-here-directory-containing-git-cl:"$@{PATH@}"
1337 @subsubheading @command{git-cl} configuration
1339 LilyDev users should perform these @q{configuration} instructions.
1343 You must have a google account; please create one if you do not
1346 Note that a google account does not need to be a gmail account; you can
1347 use any email address for your google account when you sign up.
1350 Move into the top source directory and then configure @command{git
1351 cl} with the following commands:
1358 For the @qq{Rietveld server} question, the default value
1359 (@qq{codereview.appspot.com}) should be accepted by
1360 answering with a newline (CR).
1362 The @qq{CC list} question should be answered with:
1365 lilypond-devel@@gnu.org
1368 The @qq{Tree status URL} value should be left blank. So should
1369 the @qq{ViewVC URL} value, since it is used by @command{git cl
1370 dcommit} which is only for repositories which use @command{git
1371 svn} (LilyPond doesn't).
1375 @subsubheading Uploading patch set
1377 @warning{Unless you are familiar with branches, only work on one
1378 set of changes at once.}
1380 There are two methods, depending on your git setup.
1384 @strong{Master branch}: (easy option, and used in @command{lily-git.tcl})
1386 If you added your patch to @code{master}, then:
1390 git cl upload origin/master
1393 @c Mention staging here?
1394 If you have git push ability, make sure that you @emph{remove}
1395 your patch (with @command{git rebase} or @command{git reset})
1396 before pushing other stuff.
1398 @c don't make this one an @example; we don't want to make it easy
1399 @c for people to use this accidently
1400 Notifications of patches are automatically added to our issue
1401 tracker to reduce the chance of patches getting lost. To suppress
1402 this (not recommended), add the @code{-n / --no-code-issue}
1406 @strong{Separate branch}: (complicated option)
1408 Ensure your changes are committed in a separate branch, which
1409 should differ from the reference branch to be used by just the
1410 changes to be uploaded. If the reference branch is to be
1411 origin/master, ensure this is up-to-date. If necessary, use git
1412 rebase to rebase the branch containing the changes to the head of
1413 origin/master. Finally, check out branch with the changes and
1417 git cl upload <reference SHA1 ID>
1421 where <reference SHA1 ID> is the SHA1 ID of the commit to be used
1422 as a reference source for the patch. Generally, this will be the
1423 SHA1 ID of origin/master, and in that case the command:
1426 git cl upload origin/master
1434 First you will see a terminal editor where you can edit the
1435 message that will accompany your patch. @command{git-cl} will
1436 respect the @env{EDITOR} environment variable if defined,
1437 otherwise it will use @command{vi} as the default editor.
1439 After prompting for your Google email address and password, the
1440 patch set will be posted to Rietveld, and you will be given a URL
1443 @warning{Some installations of git-cl fail when uploading a patch
1444 with certain filename extensions. If this happens, it can
1445 generally be fixed by editing the list of exceptions at top of
1448 @subsubheading Announcing your patch set
1450 You should then announce the patch by logging into the code review
1451 issue webpage and using @qq{Publish + Mail Comments} to add a
1452 (mostly bogus) comment to your issue. The text of your comment
1453 will be sent to our developer mailing list.
1455 @warning{There is no automatic notification of a new patch; you
1456 must add a comment yourself.}
1458 @subsubheading Revisions
1460 As revisions are made in response to comments, successive patch sets
1461 for the same issue can be uploaded by reissuing the git-cl command
1462 with the modified branch checked out.
1464 Sometimes in response to comments on revisions, the best way to
1465 work may require creation of a new branch in git. In order to
1466 associate the new branch with an existing Rietveld issue,
1467 the following command can be used:
1470 git cl issue issue-number
1474 where @code{issue-number} is the number of the existing Rietveld
1477 @subsubheading Resetting git cl
1479 If @command{git cl} becomes confused, you can @qq{reset} it by
1486 @subsubheading Wait for a countdown
1488 Your patch will be available for reviews for the next few hours or
1489 days. Three times a week, patches with no known problems are
1490 gathered into a @qq{patch countdown} and their status changed to
1491 @code{patch-countdown}. The countdown is a 48-hour waiting period
1492 in which any final reviews or complaints should be made.
1494 During the countdown, your patch may be set to
1495 @code{patch-needs_work}, indicating that you should fix something
1496 (or at least discuss why the patch needs no modification). If no
1497 problems are found, the patch will be set to @code{patch-push}.
1499 Once a patch has @code{patch-push}, it should be sent to your
1500 mentor for uploading. If you have git push ability, look at
1501 @ref{Pushing to staging}.
1504 @node Advanced Git procedures
1505 @section Advanced Git procedures
1508 @warning{This section is not necessary for normal contributors;
1509 these commands are presented for information for people interested
1510 in learning more about git.}
1512 It is possible to work with several branches on the same local Git
1513 repository; this is especially useful for translators who may have
1514 to deal with both @code{translation} and a stable branch,
1515 e.g. @code{stable/2.12}.
1517 Some Git commands are introduced first, then a workflow with
1518 several Git branches of LilyPond source code is presented.
1523 * Advanced Git concepts::
1524 * Resolving conflicts::
1525 * Reverting all local changes::
1526 * Working with remote branches::
1528 * Applying remote patches::
1529 * Sending and receiving patches via email::
1530 * Cleaning up multiple patches::
1532 * Pushing to staging::
1536 @node Merge conflicts
1537 @subsection Merge conflicts
1539 To be filled in later, and/or moved to a different section. I
1540 just wanted to make sure that I had a stub ready somewhere.
1543 @node Advanced Git concepts
1544 @subsection Advanced Git concepts
1547 A bit of Git vocabulary will be explained below. The following is
1548 only introductory; for a better understanding of Git concepts, you
1549 may wish to read @ref{Other Git documentation}.
1551 The @code{git@tie{}pull@tie{}origin} command above is just a
1552 shortcut for this command:
1555 git pull git://git.sv.gnu.org/lilypond.git/ @var{branch}:origin/@var{branch}
1559 where @code{@var{branch}} is typically @code{master} or
1560 @code{translation}; if you do not know or remember, see
1561 @ref{Downloading remote branches} to remember which commands you
1562 issued or which source code you wanted to get.
1564 A @emph{commit} is a set of changes made to the sources; it also
1565 includes the committish of the parent commit, the name and e-mail
1566 of the @emph{author} (the person who wrote the changes), the name
1567 and e-mail of the @emph{committer} (the person who brings these
1568 changes into the Git repository), and a commit message.
1570 A @emph{committish} is the SHA1 checksum of a commit, a number
1571 made of 40 hexadecimal digits, which acts as the internal unique
1572 identifier for this commit. To refer to a particular revision,
1573 don't use vague references like the (approximative) date, simply
1574 copy and paste the committish.
1576 A @emph{branch} is nothing more than a pointer to a particular
1577 commit, which is called the @emph{head} of the branch; when
1578 referring to a branch, one often actually thinks about its head
1579 and the ancestor commits of the head.
1581 Now we will explain the two last commands you used to get the
1582 source code from Git---see @ref{Downloading individual branches}.
1585 git remote add -ft @var{branch} -m @var{branch} \
1586 origin git://git.sv.gnu.org/lilypond.git/
1588 git checkout -b @var{branch} origin/@var{branch}
1591 The @command{git@tie{}remote} has created a branch called
1592 @code{origin/@var{branch}} in your local Git repository. As this
1593 branch is a copy of the remote branch web from git.sv.gnu.org
1594 LilyPond repository, it is called a @emph{remote branch}, and is
1595 meant to track the changes on the branch from git.sv.gnu.org: it
1596 will be updated every time you run
1597 @command{git@tie{}pull@tie{}origin} or
1598 @command{git@tie{}fetch@tie{}origin}.
1600 The @command{git@tie{}checkout} command has created a branch named
1601 @code{@var{branch}}. At the beginning, this branch is identical
1602 to @code{origin/@var{branch}}, but it will differ as soon as you
1603 make changes, e.g. adding newly translated pages or editing some
1604 documentation or code source file. Whenever you pull, you merge
1605 the changes from @code{origin/@var{branch}} and
1606 @code{@var{branch}} since the last pulling. If you do not have
1607 push (i.e. @qq{write}) access on git.sv.gnu.org, your
1608 @code{@var{branch}} will always differ from
1609 @code{origin/@var{branch}}. In this case, remember that other
1610 people working like you with the remote branch @code{@var{branch}}
1611 of git://git.sv.gnu.org/lilypond.git/ (called
1612 @code{origin/@var{branch}} on your local repository) know nothing
1613 about your own @code{@var{branch}}: this means that whenever you
1614 use a committish or make a patch, others expect you to take the
1615 latest commit of @code{origin/@var{branch}} as a reference.
1617 Finally, please remember to read the man page of every Git command
1618 you will find in this manual in case you want to discover
1619 alternate methods or just understand how it works.
1622 @node Resolving conflicts
1623 @subsection Resolving conflicts
1626 Occasionally an update may result in conflicts -- this happens
1627 when you and somebody else have modified the same part of the same
1628 file and git cannot figure out how to merge the two versions
1629 together. When this happens, you must manually merge the two
1632 If you need some documentation to understand and resolve
1633 conflicts, see paragraphs @emph{How conflicts are presented} and
1634 @emph{How to resolve conflicts} in @command{git merge} man page.
1636 If all else fails, you can follow the instructions in
1637 @ref{Reverting all local changes}. Be aware that this eliminates
1638 any changes you have made!
1641 @node Reverting all local changes
1642 @subsection Reverting all local changes
1644 Sometimes git will become hopelessly confused, and you just want
1645 to get back to a known, stable state. This command destroys any
1646 local changes you have made in the currently checked-out branch,
1647 but at least you get back to the current online version:
1650 git reset --hard origin/master
1654 @node Working with remote branches
1655 @subsection Working with remote branches
1658 @subsubheading Fetching new branches from git.sv.gnu.org
1660 To fetch and check out a new branch named @code{@var{branch}} on
1661 git.sv.gnu.org, run from top of the Git repository
1664 git config --add remote.origin.fetch \
1665 +refs/heads/@var{branch}:refs/remotes/origin/@var{branch}
1667 git checkout --track -b @var{branch} origin/@var{branch}
1670 After this, you can pull @code{@var{branch}} from git.sv.gnu.org
1677 Note that this command generally fetches all branches you added
1678 with @command{git@tie{}remote@tie{}add} (when you initialized the
1679 repository) or @command{git@tie{}config@tie{}--add}, i.e. it
1680 updates all remote branches from remote @code{origin}, then it
1681 merges the remote branch tracked by the current branch into the
1682 current branch. For example, if your current branch is
1683 @code{master}, @code{origin/master} will be merged into
1687 @subsubheading Local clones, or having several working trees
1689 If you play with several Git branches, e.g. @code{master},
1690 @code{translation}, @code{stable/2.12}), you may want to
1691 have one source and build tree for each branch; this is possible
1692 with subdirectories of your local Git repository, used as local
1693 cloned subrepositories. To create a local clone for the branch
1694 named @code{@var{branch}}, run
1697 git checkout @var{branch}
1698 git clone -lsn . @var{subdir}
1703 Note that @code{@var{subdir}} must be a directory name which does
1704 not already exist. In @code{@var{subdir}}, you can use all Git
1705 commands to browse revisions history, commit and uncommit changes;
1706 to update the cloned subrepository with changes made on the main
1707 repository, cd into @code{@var{subdir}} and run
1708 @command{git@tie{}pull}; to send changes made on the subrepository
1709 back to the main repository, run @command{git@tie{}push} from
1710 @code{@var{subdir}}. Note that only one branch (the currently
1711 checked out branch) is created in the subrepository by default; it
1712 is possible to have several branches in a subrepository and do
1713 usual operations (checkout, merge, create, delete...) on these
1714 branches, but this possibility is not detailed here.
1716 When you push @code{@var{branch}} from @code{@var{subdir}} to the
1717 main repository, and @code{@var{branch}} is checked out in the
1718 main repository, you must save uncommitted changes (see
1719 @command{git@tie{}stash}) and do
1720 @command{git@tie{}reset@tie{}--hard} in the main repository in
1721 order to apply pushed changes in the working tree of the main
1729 The commands above don't only bring you the latest version of the
1730 sources, but also the full history of revisions (revisions, also
1731 called commits, are changes made to the sources), stored in the
1732 @file{.git} directory. You can browse this history with
1735 git log # only shows the logs (author, committish and commit message)
1736 git log -p # also shows diffs
1737 gitk # shows history graphically
1740 @warning{The @code{gitk} command may require a separate
1741 @code{gitk} package, available in the appropriate distribution's
1745 @node Applying remote patches
1746 @subsection Applying remote patches
1749 TODO: Explain how to determine if a patch was created with
1750 @code{git@tie{}format-patch}.
1752 Well-formed git patches created with @code{git@tie{}format-patch}
1753 should be committed with the following command:
1759 Patches created without @code{git@tie{}format-patch} can be
1760 applied in two steps. The first step is to apply the patch to the
1761 working tree and the index:
1764 git apply --index @var{patch}
1768 The second step is to commit the changes and give credit to the
1769 author of the patch. This can be done with the following command:
1772 git commit --author="@var{John Smith} <@var{john@@example.com}>"
1775 Please note that using the @code{--index} option for patching is quite
1776 important here and @emph{cannot} reliably be replaced by using the
1777 @code{-a} option when committing: that would only commit files from the
1778 working tree that are already registered with git, so every file that
1779 the patch actually @emph{adds}, like a regtest for a fixed bug, would
1780 get lost. For the same reason, you should not use the git-independent
1781 @samp{patch} program for applying patches.
1783 @node Sending and receiving patches via email
1784 @subsection Sending and receiving patches via email
1787 The default @code{x-diff} MIME type associated with patch files
1788 (i.e., files whose name ends in @code{.patch}) means that the
1789 encoding of line endings may be changed from UNIX to DOS format
1790 when they are sent as attachments. Attempting to apply such an
1791 inadvertently altered patch will cause git to fail with a message
1792 about @q{whitespace errors}.
1794 The solution to such problems is surprisingly simple---just change
1795 the default file extension of patches generated by git to end in
1796 @code{.txt}, for example:
1799 git config format.suffix '.patch.txt'
1802 This should cause email programs to apply the correct base64
1803 encoding to attached patches.
1805 If you receive a patch with DOS instead of UNIX line-endings, it
1806 can be converted back using the @code{dos2unix} utility.
1808 Lots of useful information on email complications with patches is
1809 provided on the Wine wiki at
1810 @uref{http://wiki.winehq.org/GitWine}.
1813 @node Cleaning up multiple patches
1814 @subsection Cleaning up multiple patches
1816 If you have been developing on your own branch for a while, you
1817 may have more commmits than is really sensible. To revise your
1818 work and condense commits, use:
1821 git rebase origin/master
1822 git rebase -i origin/master
1825 @warning{Be a bit cautious -- if you completely remove commits
1826 during the interactive session, you will... err... completely
1827 remove those commits.}
1831 @subsection Commit access
1833 Most contributors are not able to commit patches directly to the
1834 main repository---only members of the LilyPond development team
1835 have @emph{commit access}. If you are a contributor and are
1836 interested in joining the development team, contact the Project
1837 Manager through the mailing list
1838 (@email{lilypond-devel@@gnu.org}). Generally, only contributors
1839 who have already provided a number of patches which have been
1840 pushed to the main repository will be considered for membership.
1842 If you have been approved by the Project Manager, use the
1843 following procedure to obtain commit access:
1847 If you don't already have one, set up a Savannah user account at
1848 @uref{https://savannah.gnu.org/account/register.php}. If your web
1849 browser responds with an @qq{untrusted connection} message when
1850 you visit the link, follow the steps for including the CAcert root
1851 certificate in your browser, given at
1852 @uref{http://savannah.gnu.org/tls/tutorial/}.
1854 @warning{Savannah will silently put your username in lower-case --
1855 do not try to use capital letters.}
1859 After registering, if you are not logged in automatically, login
1860 at @uref{https://savannah.gnu.org/account/login.php}---this should
1861 take you to your @qq{my} page
1862 (@uref{https://savannah.gnu.org/my/}).
1866 Click on the @qq{My Groups} link to access the @qq{My Group
1867 Membership} page. From there, find the @qq{Request for Inclusion}
1868 box and search for @qq{LilyPond}. Among the search results, check
1869 the box labeled @qq{GNU LilyPond Music Typesetter} and write a
1870 brief (required) message for the Project Manager (@qq{Hey it's
1871 me!} should be fine).
1873 Note that you will not have commit access until the Project
1874 Manager activates your membership. Once your membership is
1875 activated, LilyPond should appear under the heading @qq{Groups I'm
1876 Contributor of} on your @qq{My Group Membership} page.
1880 Generate an SSH @q{rsa} key pair. Enter the following at the
1887 When prompted for a location to save the key, press <ENTER> to
1888 accept the default location (@file{~/.ssh/id_rsa}).
1890 Next you are asked to enter an optional passphrase. On most
1891 systems, if you use a passphrase, you will likely be prompted for
1892 it every time you use @command{git@tie{}push} or
1893 @command{git@tie{}pull}. You may prefer this since it can protect
1894 you from your own mistakes (like pushing when you mean to pull),
1895 though you may find it tedious to keep re-entering it.
1897 You can change/enable/disable your passphrase at any time with:
1900 ssh-keygen -f ~/.ssh/id_rsa -p
1903 Note that the GNOME desktop has a feature which stores your
1904 passphrase for you for an entire GNOME session. If you use a
1905 passphrase to @qq{protect you from yourself}, you will want to
1906 disable this feature, since you'll only be prompted once. Run the
1907 following command, then logout of GNOME and log back in:
1910 gconftool-2 --set -t bool \
1911 /apps/gnome-keyring/daemon-components/ssh false
1914 After setting up your passphrase, your private key is saved as
1915 @file{~/.ssh/id_rsa} and your public key is saved as
1916 @file{~/.ssh/id_rsa.pub}.
1920 Register your public SSH @q{rsa} key with Savannah. From the
1921 @qq{My Account Configuration} page, click on @qq{Edit SSH Keys},
1922 then paste the contents of your @file{~/.ssh/id_rsa.pub} file into
1923 one of the @qq{Authorized keys} text fields, and click
1926 Savannah should respond with something like:
1929 Success: Key #1 seen Keys registered
1934 Configure Git to use the SSH protocol (instead of the GIT
1935 protocol). From your local Git repository, enter:
1938 git config remote.origin.url \
1939 ssh://@var{user}@@git.sv.gnu.org/srv/git/lilypond.git
1943 replacing @var{user} with your Savannah username.
1947 After your membership has been activated and you've configured Git
1948 to use SSH, test the connection with:
1954 SSH should issue the following warning:
1957 The authenticity of host 'git.sv.gnu.org (140.186.70.72)' can't
1959 RSA key fingerprint is
1960 80:5a:b0:0c:ec:93:66:29:49:7e:04:2b:fd:ba:2c:d5.
1961 Are you sure you want to continue connecting (yes/no)?
1964 Make sure the RSA key fingerprint displayed matches the one above.
1965 If it doesn't, respond @qq{no} and check that you configured Git
1966 properly in the previous step. If it does match, respond
1967 @qq{yes}. SSH should then issue another warning:
1970 Warning: Permanently added 'git.sv.gnu.org,140.186.70.72' (RSA) to
1971 the list of known hosts.
1974 The list of known hosts is stored in the file
1975 @file{~/.ssh/known_hosts}.
1977 At this point, you are prompted for your passphrase if you have
1978 one, then Git will attempt a pull.
1980 If @command{git@tie{}pull@tie{}--verbose} fails, you should see
1981 error messages like these:
1984 Permission denied (publickey).
1985 fatal: The remote end hung up unexpectedly
1988 If you get the above error, you may have made a mistake when
1989 registering your SSH key at Savannah. If the key is properly
1990 registered, you probably just need to wait for the Savannah server
1991 to activate it. It usually takes a few minutes for the key to be
1992 active after registering it, but if it still doesn't work after an
1993 hour, ask for help on the mailing list.
1995 If @command{git@tie{}pull@tie{}--verbose} succeeds, the output
1996 will include a @q{From} line that shows @q{ssh} as the protocol:
1999 From ssh://git.sv.gnu.org/srv/git/lilypond
2002 If the protocol shown is not @q{ssh}, check that you configured
2003 Git properly in the previous step.
2007 Test your commit access with a dry run:
2009 @warning{Do not push directly to master; instead, push to staging.
2010 See @ref{Pushing to staging}.}
2013 git push --dry-run --verbose
2016 Note that recent versions of Git (Git 1.6.3 or later) will issue a
2017 big warning if the above command is used. The simplest solution
2018 is to tell Git to push all matching branches by default:
2021 git config push.default matching
2025 Then @code{git@tie{}push} should work as before. For more
2026 details, consult the @code{git@tie{}push} man page.
2030 Repeat the steps from generating an RSA key through to testing
2031 your commit access, for each machine from which you will be
2032 making commits, or you may simply copy the files from your
2033 local @file{~/.ssh} folder to the same folder on the other
2038 @subsubheading Technical details
2042 On Firefox, to view or remove the CAcert root certificate, go to:
2043 Edit > Preferences > Advanced > Encryption > View Certificates >
2044 Authorities > Certificate Name > Root CA > CA Cert Signing
2048 The @command{git@tie{}config} commands above should modify your
2049 local repository's @file{.git/config} file. These lines:
2053 url = git://git.sv.gnu.org/lilypond.git/
2057 should now be changed to:
2061 url = ssh://@var{user}@@git.sv.gnu.org/srv/git/lilypond.git
2065 where @var{user} is your login name on Savannah.
2069 @command{git@tie{}config@tie{}push.default@tie{}matching} command
2070 should add these lines to @file{.git/config}:
2079 Encryption protocols, including ssh, generally do not permit packet
2080 fragmentation to avoid introducing a point of insecurity. This
2081 means that the maximum packet size must not exceed the smallest
2082 MTU (Maximum Transmission Unit) set in the routers along the path.
2083 This smallest MTU is determined by a procedure during call set-up
2084 which relies on the transmission over the path of ICMP packets.
2085 If any of the routers in the path block ICMP packets this mechanism
2086 fails, resulting in the possibility of packets being transmitted
2087 which exceed the MTU of one of the routers. If this happens the
2088 packet is discarded, causing the ssh session to hang, timeout or
2089 terminate with the error message
2092 ssh: connect to host <host ip addr> port 22: Bad file number
2093 fatal: The remote end hung up unexpectedly
2096 depending on precisely when in the proceedings the first large
2097 packet is transmitted. Most routers on the internet have MTU
2098 set to 1500, but routers installed in homes to connect via
2099 broadband may use a slightly smaller MTU for efficient transmission
2100 over ATM. If this problem is encountered a possible work-around is
2101 to set the MTU in the local router to 1500.
2104 @node Pushing to staging
2105 @subsection Pushing to staging
2107 Do not push directly to the git @code{master} branch. Instead,
2108 push to @code{staging}.
2110 You will not see your patch on @code{origin/master} until some
2111 automatic tests have been run. These tests are run every couple
2112 of hours; please wait at least 12 hours before wondering if your
2113 patch has been lost. Note that you can check the commits on
2114 @code{origin/staging} by looking at the git web interface on
2117 It may happen occasionally that the staging branch breaks automated
2118 testing. In this case the automatic move of staging material to
2119 master gets halted in order to avoid broken material entering master.
2120 This is a safety net. Please do not try breaking out from it by
2121 adding fixes on top of staging: in that case the whole sequence will
2122 end up in master after all, defeating the purpose of the system. The
2123 proper fix usually involves rewriting the staging branch and is best
2124 left to core developers after discussion on the developer list.
2126 @subsubheading If your work is in a patch file
2128 Assuming that your patch is in a file called
2129 @file{0001-my-patch.patch}, and you are currently on git master,
2133 git checkout staging
2135 git am 0001-my-patch.patch
2137 git push origin staging
2141 @warning{Do not skip the @command{gitk} step; a quick 5-second
2142 check of the visual history can save a great deal of frustration
2143 later on. You should only see that @command{staging} is only 1
2144 commit ahead of @code{origin/staging}.}
2146 @subsubheading If your work is in a branch
2148 If you are working on branches and your work in is
2149 @code{my_branch_name}, then do:
2152 git checkout staging
2154 git merge my_branch_name
2156 git push origin staging
2159 @warning{Do not skip the @command{gitk} step; a quick 5-second
2160 check of the visual history can save a great deal of frustration
2161 later on. You should see that @code{staging} is only ahead of
2162 @code{origin/staging} by the commits from your branch.}
2166 @node Git on Windows
2167 @section Git on Windows
2169 @warning{We heavily recommend that development be done with our
2170 virtual machine @ref{LilyDev}.}
2172 @c Some of this may duplicate stuff in other sections
2173 @c But it is probably best for windows users to have it all together
2174 @c If necessary, clear this up later -td
2176 TODO: Decide what to do with this... Pare it down? Move
2177 paragraphs next to analogous Unix instructions? -mp
2179 @subsection Background to nomenclature
2181 Git is a system for tracking the changes made to source files by a
2182 distributed set of editors. It is designed to work without a
2183 master repository, but we have chosen to have a master repository
2184 for LilyPond files. Editors hold a local copy of the master
2185 repository together with any changes they have made locally.
2186 Local changes are held in a local @q{branch}, of which there may
2187 be several, but these instructions assume you are using just one.
2188 The files visible in the local repository always correspond to
2189 those on the currently @q{checked out} local branch.
2191 Files are edited on a local branch, and in that state the changes
2192 are said to be @q{unstaged}. When editing is complete, the
2193 changes are moved to being @q{staged for commit}, and finally the
2194 changes are @q{committed} to the local branch. Once committed,
2195 the changes (called a @q{commit}) are given a unique 40-digit
2196 hexadecimal reference number called the @q{Committish} or @q{SHA1
2197 ID} which identifies the commit to Git. Such committed changes
2198 can be sent to the master repository by @q{pushing} them (if you
2199 have write permission) or by sending them by email to someone who
2200 has, either as a complete file or as a @q{diff} or @q{patch}
2201 (which send just the differences from the master repository).
2203 @subsection Installing git
2206 @uref{http://code.google.com/p/msysgit/downloads/list} (note, not
2207 msysGit, which is for Git developers and not PortableGit, which is
2208 not a full git installation) and install it.
2210 Note that most users will not need to install SSH. That is not
2211 required until you have been granted direct push permissions to
2212 the master git repository.
2214 Start Git by clicking on the desktop icon. This will bring up a
2215 command line bash shell. This may be unfamiliar to Windows users.
2216 If so, follow these instructions carefully. Commands are entered
2217 at a $ prompt and are terminated by keying a newline.
2219 @subsection Initialising Git
2221 Decide where you wish to place your local Git repository, creating
2222 the folders in Windows as necessary. Here we call the folder to
2223 contain the repository @code{[path]/Git}, but if you intend using
2224 Git for other projects a directory name like @code{lilypond-git}
2225 might be better. You will need to have space for around
2228 Start the Git bash shell by clicking on the desk-top icon
2229 installed with Git and type
2235 to position the shell at your new Git repository.
2237 Note: if [path] contains folders with names containing spaces use
2249 to initialize your Git repository.
2251 Then type (all on one line; the shell will wrap automatically)
2254 git remote add -ft master origin git://git.sv.gnu.org/lilypond.git
2257 to download the lilypond master files.
2259 @warning{Be patient! Even on a broadband connection this can take
2260 10 minutes or more. Wait for lots of [new tag] messages and the $
2263 We now need to generate a local copy of the downloaded files in a
2264 new local branch. Your local branch needs to have a name. It is
2265 usual to call it @q{master} and we shall do that here.
2270 git checkout -b master origin/master
2273 This creates a second branch called @q{master}. You will see two
2274 warnings (ignore these), and a message advising you that your
2275 local branch @q{master} has been set up to track the remote
2276 branch. You now have two branches, a local branch called
2277 @q{master}, and a tracking branch called @q{origin/master}, which
2278 is a shortened form of @q{remotes/origin/master}.
2280 Return to Windows Explorer and look in your Git repository. You
2281 should see lots of folders. For example, the LilyPond
2282 documentation can be found in [path]/Git/Documentation/.
2284 The Git bash shell is terminated by typing @code{exit} or by
2285 clicking on the usual Windows close-window widget.
2289 Almost all subsequent work will use the Git Graphical User
2290 Interface, which avoids having to type command line commands. To
2291 start Git GUI first start the Git bash shell by clicking on the
2292 desktop icon, and type
2299 The Git GUI will open in a new window. It contains four panels
2300 and 7 pull-down menus. At this stage do not use any of the
2301 commands under Branch, Commit, Merge or Remote. These will be
2304 The top panel on the left contains the names of files which you
2305 are in the process of editing (Unstaged Changes), and the lower
2306 panel on the left contains the names of files you have finished
2307 editing and have staged ready for committing (Staged Changes). At
2308 present, these panels will be empty as you have not yet made any
2309 changes to any file. After a file has been edited and saved the
2310 top panel on the right will display the differences between the
2311 edited file selected in one of the panels on the left and the last
2312 version committed on the current branch.
2314 The panel at bottom right is used to enter a descriptive message
2315 about the change before committing it.
2317 The Git GUI is terminated by entering CNTL-Q while it is the
2318 active window or by clicking on the usual Windows close-window
2321 @subsection Personalising your local git repository
2323 Open the Git GUI, click on
2329 and enter your name and email address in the left-hand (Git
2330 Repository) panel. Leave everything else unchanged and save it.
2332 Note that Windows users must leave the default setting for line
2333 endings unchanged. All files in a git repository must have lines
2334 terminated by just a LF, as this is required for Merge to work,
2335 but Windows files are terminated by CRLF by default. The git
2336 default setting causes the line endings of files in a Windows git
2337 repository to be flipped automatically between LF and CRLF as
2338 required. This enables files to be edited by any Windows editor
2339 without causing problems in the git repository.
2341 @subsection Checking out a branch
2343 At this stage you have two branches in your local repository,
2344 both identical. To see them click on
2350 You should have one local branch called @q{master} and one
2351 tracking branch called @q{origin/master}. The latter is your
2352 local copy of the @q{remotes/origin/master} branch in the master
2353 LilyPond repository. The local @q{master} branch is where you
2354 will make your local changes.
2356 When a particular branch is selected, i.e., checked out, the files
2357 visible in your repository are changed to reflect the state of the
2358 files on that branch.
2360 @subsection Updating files from @q{remote/origin/master}
2362 Before starting the editing of a file, ensure your local
2363 repository contains the latest version of the files in the remote
2364 repository by first clicking
2367 Remote -> Fetch from -> origin
2373 This will place the latest version of every file, including all
2374 the changes made by others, into the @q{origin/master} branch of
2375 the tracking branches in your git repository. You can see these
2376 files by checking out this branch, but you must @emph{never} edit
2377 any files while this branch is checked out. Check out your local
2378 @q{master} branch again.
2380 You then need to merge these fetched files into your local
2381 @q{master} branch by clicking on
2384 Merge -> Local Merge
2388 and if necessary select the local @q{master} branch.
2390 Note that a merge cannot be completed if you have made any local
2391 changes which have not yet been committed.
2393 This merge will update all the files in the @q{master} branch to
2394 reflect the current state of the @q{origin/master} branch. If any
2395 of the changes conflict with changes you have made yourself
2396 recently you will be notified of the conflict (see below).
2398 @subsection Editing files
2400 First ensure your @q{master} branch is checked out, then simply
2401 edit the files in your local Git repository with your favourite
2402 editor and save them back there. If any file contains non-ASCII
2403 characters ensure you save it in UTF-8 format. Git will detect
2404 any changes whenever you restart Git GUI and the file names will
2405 then be listed in the Unstaged Changes panel. Or you can click
2406 the Rescan button to refresh the panel contents at any time. You
2407 may break off and resume editing any time.
2409 The changes you have made may be displayed in diff form in the top
2410 right-hand panel of Git GUI by clicking on the file name shown in
2411 one of the left panels.
2413 When your editing is complete, move the files from being Unstaged
2414 to Staged by clicking the document symbol to the left of each
2415 name. If you change your mind it can be moved back by clicking on
2416 the ticked box to the left of the name.
2418 Finally the changes you have made may be committed to your
2419 @q{master} branch by entering a brief message in the Commit
2420 Message box and clicking the Commit button.
2422 If you wish to amend your changes after a commit has been made,
2423 the original version and the changes you made in that commit may
2424 be recovered by selecting
2427 Commit -> Amend Last Commit
2431 or by checking the Amend Last Commit radio button at bottom right.
2432 This will return the changes to the Staged state, so further
2433 editing made be carried out within that commit. This must only be
2434 done @emph{before} the changes have been Pushed or sent to your
2435 mentor for Pushing - after that it is too late and corrections
2436 have to be made as a separate commit.
2439 @subsection Sending changes to @q{remotes/origin/master}
2441 If you do not have write access to @q{remotes/origin/master} you
2442 will need to send your changes by email to someone who does.
2444 First you need to create a diff or patch file containing your
2445 changes. To create this, the file must first be committed. Then
2446 terminate the Git GUI. In the git bash shell first cd to your Git
2453 if necessary, then produce the patch with
2456 git format-patch origin
2459 This will create a patch file for all the locally committed files
2460 which differ from @q{origin/master}. The patch file can be found
2461 in [path]/Git and will have a name formed from the commit message.
2463 @subsection Resolving merge conflicts
2465 As soon as you have committed a changed file your local
2466 @code{master} branch has diverged from @code{origin/master}, and
2467 will remain diverged until your changes have been committed in
2468 @code{remotes/origin/master} and Fetched back into your
2469 @code{origin/master} branch. Similarly, if a new commit has been
2470 made to @code{remotes/origin/master} by someone else and Fetched,
2471 your local @code{master} branch is divergent. You can detect a
2472 divergent branch by clicking on
2475 Repository -> Visualise all branch history
2478 This opens up a very useful new window called @q{gitk}. Use this
2479 to browse all the commits made by yourself and others.
2481 If the diagram at top left of the resulting window does not show
2482 your @code{master} tag on the same node as the
2483 @code{remotes/origin/master} tag your branch has diverged from
2484 @code{origin/master}. This is quite normal if files you have
2485 modified yourself have not yet been Pushed to
2486 @code{remotes/origin/master} and Fetched, or if files modified and
2487 committed by others have been Fetched since you last Merged
2488 @code{origin/master} into your local @code{master} branch.
2490 If a file being merged from @code{origin/master} differs from one
2491 you have modified in a way that cannot be resolved automatically
2492 by git, Merge will report a Conflict which you must resolve by
2493 editing the file to create the version you wish to keep.
2495 This could happen if the person updating
2496 @code{remotes/origin/master} for you has added some changes of his
2497 own before committing your changes to
2498 @code{remotes/origin/master}, or if someone else has changed the
2499 same file since you last fetched the file from
2500 @code{remotes/origin/master}.
2502 Open the file in your editor and look for sections which are
2505 [to be completed when I next have a merge conflict to be sure I
2506 give the right instructions -td]
2509 @subsection Other actions
2511 The instructions above describe the simplest way of using git on
2512 Windows. Other git facilities which may usefully supplement these
2516 @item Using multiple local branches (Create, Rename, Delete)
2517 @item Resetting branches
2518 @item Cherry-picking commits
2519 @item Pushing commits to @w{remote/origin/master}
2520 @item Using gitk to review history
2523 Once familiarity with using git on Windows has been gained the
2524 standard git manuals can be used to learn about these.
2527 @node Repository directory structure
2528 @section Repository directory structure
2531 @c TODO: integrate the roadmap better
2532 @verbatiminclude ROADMAP
2535 @node Other Git documentation
2536 @section Other Git documentation
2540 Official git man pages:
2541 @uref{http://www.kernel.org/pub/software/scm/git/docs/}
2544 More in-depth tutorials: @uref{http://git-scm.com/documentation}
2547 Book about git: @uref{http://progit.org/,Pro Git}
2550 Github help: @uref{http://help.github.com/}
2551 (very highly recommended by Graham)