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{Using 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 55Mb). 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{Daily use of lily-git.tcl}.
101 @advanced{the @qq{Get source} button does not fetch the entire
102 history of the git repository, so utilities like @command{gitk}
103 will only be able to display the most recent additions. As you
104 continue to work with @command{lily-git.tcl}, the @qq{Update
105 source} button will take any new additions and add it to whatever
106 is currently in your repository's history.}
109 @node Starting with Git
110 @section Starting with Git
112 Using the Git program directly (as opposed to using the
113 @command{lily-git.tcl} GUI) allows you to have much greater control
114 over the contributing process. You should consider using Git if
115 you want to work on complex projects, or if you want to work on
116 multiple projects concurrently.
121 * Downloading remote branches::
126 @subsection Setting up
129 TODO: Remove this note if incorporating Windows instructions
130 throughout this section:
132 @warning{These instructions assume that you are using the
133 command-line version of Git 1.5 or higher. Windows users should
134 skip to @ref{Git on Windows}.}
138 * Initializing a repository::
144 @unnumberedsubsubsec Installing Git
147 If you are using a Unix-based machine, the easiest way to download
148 and install Git is through a package manager such as @command{rpm}
149 or @command{apt-get}---the installation is generally automatic.
150 The only required package is (usually) called @command{git-core},
151 although some of the auxiliary @command{git@var{*}} packages are
152 also useful (such as @command{gitk}).
154 Alternatively, you can visit the Git website
155 (@uref{http://git-scm.com/}) for downloadable binaries and
158 TODO: add Windows installation instructions (or @@ref@{Git on
162 @node Initializing a repository
163 @unnumberedsubsubsec Initializing a repository
166 Once Git is installed, you'll need to create a new directory where
167 your initial repository will be stored (the example below uses
168 @file{~/lilypond-git/}, where @code{~} represents your home
169 directory). Run @command{git@tie{}init} from within the new
170 directory to initialize an empty repository:
173 mkdir ~/lilypond-git/; cd ~/lilypond-git/
177 @subsubheading Technical details
179 This creates (within the @file{~/lilypond-git/} directory) a
180 subdirectory called @file{.git/}, which Git uses to keep track of
181 changes to the repository, among other things. Normally you don't
182 need to access it, but it's good to know it's there.
185 @node Configuring Git
186 @unnumberedsubsubsec Configuring Git
188 @warning{Throughout the rest of this manual, all command-line
189 input should be entered from the top directory of the Git
190 repository being discussed (eg. @file{~/lilypond-git/}). This is
191 referred to as the @emph{top source directory}.}
193 Before downloading a copy of the main LilyPond repository, you
194 should configure some basic settings with the
195 @command{git@tie{}config} command. Git allows you to set both
196 global and repository-specific options.
198 To configure settings that affect all repositories, use the
199 @command{--global} command line option. For example, the first
200 two options that you should always set are your @var{name} and
201 @var{email}, since Git needs these to keep track of commit
205 git config --global user.name "@var{John Smith}"
206 git config --global user.email @var{john@@example.com}
209 To configure Git to use colored output where possible, use:
212 git config --global color.ui auto
215 The text editor that opens when using @command{git@tie{}commit}
216 can also be changed. If none of your editor-related environment
217 variables are set ($GIT_EDITOR, $VISUAL, or $EDITOR), the default
218 editor is usually @command{vi} or @command{vim}. If you're not
219 familiar with either of these, you should probably change the
220 default to an editor that you know how to use. For example, to
221 change the default editor to @command{nano}, enter:
224 git config --global core.editor @var{nano}
227 TODO: Add instructions for changing the editor on Windows, which
228 is a little different, I think. -mp
230 @subsubheading Technical details
232 Git stores the information entered with
233 @command{git@tie{}config@tie{}--global} in the file
234 @file{.gitconfig}, located in your home directory. This file can
235 also be modified directly, without using
236 @command{git@tie{}config}. The @file{.gitconfig} file generated
237 by the above commands would look like this:
242 email = john@@example.com
249 Using the @command{git@tie{}config} command @emph{without} the
250 @command{--global} option configures repository-specific settings,
251 which are stored in the file @file{.git/config}. This file is
252 created when a repository is initialized (using
253 @command{git@tie{}init}), and by default contains these lines:
257 repositoryformatversion = 0
260 logallrefupdates = true
263 However, since different repository-specific options are
264 recommended for different development tasks, it is best to avoid
265 setting any now. Specific recommendations will be mentioned later
269 @node Downloading remote branches
270 @subsection Downloading remote branches
274 * Organization of remote branches::
275 * LilyPond repository sources::
276 * Downloading individual branches::
277 * Downloading all remote branches::
282 @node Organization of remote branches
283 @unnumberedsubsubsec Organization of remote branches
286 The main LilyPond repository is organized into @emph{branches} to
287 facilitate development. These are often called @emph{remote}
288 branches to distinguish them from @emph{local} branches you might
289 create yourself (see @ref{Using local branches}).
291 The @code{master} branch contains all the source files used to
292 build LilyPond, which includes the program itself (both stable and
293 development releases), the documentation (and its translations),
294 and the website. Generally, the @code{master} branch is expected
295 to compile successfully.
297 The @code{lilypond/translation} branch is a side branch that
298 allows translators to work without needing to worry about
299 compilation problems. Periodically, the Translation Meister
300 (after verifying that it doesn't break compilation), will
301 @emph{merge} this branch back into @code{master} to incorporate
302 recent translations. Similarly, the @code{master} branch is
303 usually merged into the @code{lilypond/translation} branch after
304 significant changes to the English documentation. See
305 @ref{Translating the documentation} for details.
308 @node LilyPond repository sources
309 @unnumberedsubsubsec LilyPond repository sources
312 The recommended source for downloading a copy of the main
316 git://git.sv.gnu.org/lilypond.git
319 However, if your internet router filters out connections using the
320 GIT protocol, or if you experience difficulty connecting via GIT,
321 you can try these other sources:
324 ssh://git.sv.gnu.org/srv/git/lilypond.git
325 http://git.sv.gnu.org/r/lilypond.git
328 The SSH protocol can only be used if your system is properly set
329 up to use it. Also, the HTTP protocol is slowest, so it should
330 only be used as a last resort.
333 @node Downloading individual branches
334 @unnumberedsubsubsec Downloading individual branches
337 Once you have initialized an empty Git repository on your system
338 (see @ref{Initializing a repository}), you can download a remote
339 branch into it. Make sure you know which branch you want to start
342 To download the @code{master} branch, enter the following:
345 git remote add -ft master -m master \
346 origin git://git.sv.gnu.org/lilypond.git/
349 To download the @code{lilypond/translation} branch, enter:
352 git remote add -ft lilypond/translation -m \
353 lilypond/translation origin git://git.sv.gnu.org/lilypond.git/
356 The @command{git@tie{}remote@tie{}add} process could take up to
357 ten minutes, depending on the speed of your connection. The
358 output will be something like this:
362 remote: Counting objects: 235967, done.
363 remote: Compressing objects: 100% (42721/42721), done.
364 remote: Total 235967 (delta 195098), reused 233311 (delta 192772)
365 Receiving objects: 100% (235967/235967), 68.37 MiB | 479 KiB/s, done.
366 Resolving deltas: 100% (195098/195098), done.
367 From git://git.sv.gnu.org/lilypond
368 * [new branch] master -> origin/master
369 From git://git.sv.gnu.org/lilypond
370 * [new tag] flower/1.0.1 -> flower/1.0.1
371 * [new tag] flower/1.0.10 -> flower/1.0.10
373 * [new tag] release/2.9.6 -> release/2.9.6
374 * [new tag] release/2.9.7 -> release/2.9.7
377 When @command{git@tie{}remote@tie{}add} is finished, the remote
378 branch should be downloaded into your repository---though not yet
379 in a form that you can use. In order to browse the source code
380 files, you need to @emph{create} and @emph{checkout} your own
381 local branch. In this case, however, it is easier to have Git
382 create the branch automatically by using the @command{checkout}
383 command on a non-existent branch. Enter the following:
386 git checkout -b @var{branch} origin/@var{branch}
390 where @code{@var{branch}} is the name of your tracking branch,
391 either @code{master} or @code{lilypond/translation}.
393 Git will issue some warnings; this is normal:
396 warning: You appear to be on a branch yet to be born.
397 warning: Forcing checkout of origin/master.
398 Branch master set up to track remote branch master from origin.
402 By now the source files should be accessible---you should be able
403 to edit any files in the @file{lilypond-git/} directory using a
404 text editor of your choice. But don't start just yet! Before
405 editing any source files, learn how to keep your changes organized
406 and prevent problems later---read @ref{Basic Git procedures}.
408 @subsubheading Technical Details
410 The @command{git@tie{}remote@tie{}add} command should add some
411 lines to your local repository's @file{.git/config} file:
415 url = git://git.sv.gnu.org/lilypond.git/
416 fetch = +refs/heads/master:refs/remotes/origin/master
420 @node Downloading all remote branches
421 @unnumberedsubsubsec Downloading all remote branches
424 To download all remote branches at once, you can @command{clone}
425 the entire repository:
428 git clone git://git.sv.gnu.org/lilypond.git
433 @unnumberedsubsubsec Other branches
435 Most contributors will never need to touch the other branches. If
436 you wish to do so, you will need more familiarity with Git; please
437 see @ref{Other Git documentation}.
440 @item @code{dev/XYZ}:
441 These branches are for individual developers. They store code
442 which is not yet stable enough to be added to the @code{master}
445 @item @code{stable/XYZ}:
446 The branches are kept for archival reasons.
450 Another item of interest might be the Grand Unified Builder, our
451 cross-platform building tool. Since it is used by projects as
452 well, it is not stored in our gub repository. For more info, see
453 @uref{http://lilypond.org/gub}. The git location is
454 @uref{http://github.com/janneke/gub}.
457 @node Basic Git procedures
458 @section Basic Git procedures
462 * The Git contributor's cycle::
463 * Pulling and rebasing::
464 * Using local branches::
465 * Commits and patches::
469 @node The Git contributor's cycle
470 @subsection The Git contributor's cycle
473 Here is a simplified view of the contribution process on Git:
477 Update your local repository by @emph{pulling} the most recent
478 updates from the remote repository.
481 Edit source files within your local repository's @emph{working
485 @emph{Commit} the changes you've made to a local @emph{branch}.
488 Generate a @emph{patch} to share your changes with the developers.
492 @node Pulling and rebasing
493 @subsection Pulling and rebasing
496 When developers push new patches to the @code{git.sv.gnu.org}
497 repository, your local repository is @strong{not} automatically
498 updated. It is important to keep your repository up-to-date by
499 periodically @emph{pulling} the most recent @emph{commits} from
500 the remote branch. Developers expect patches to be as current as
501 possible, since outdated patches require extra work before they
504 Occasionally you may need to rework some of your own modifications
505 to match changes made to the remote branch (see @ref{Resolving
506 conflicts}), and it's considerably easier to rework things
507 incrementally. If you don't update your repository along the way,
508 you may have to spend a lot of time resolving branch conflicts and
509 reconfiguring much of the work you've already done.
511 Fortunately, Git is able to resolve certain types of branch
512 conflicts automatically with a process called @emph{rebasing}.
513 When rebasing, Git tries to modify your old commits so they appear
514 as new commits (based on the latest updates). For a more involved
515 explanation, see the @command{git-rebase} man page.
517 To pull without rebasing (recommended for translators), use the
521 git pull # recommended for translators
524 If you're tracking the remote @code{master} branch, you should add
525 the @code{-r} option (short for @code{--rebase}) to keep commits
526 on your local branch current:
529 git pull -r # use with caution when translating
532 If you don't edit translated documentation and don't want to type
533 @code{-r} every time, configure the master branch to rebase by
534 default with this command:
537 git config branch.master.rebase true
540 If pull fails because of a message like
543 error: Your local changes to 'Documentation/learning/tutorial.itely'
544 would be overwritten by merge. Aborting.
551 Documentation/learning/tutorial.itely: needs update
552 refusing to pull with rebase: your working tree is not up-to-date
556 it means that you have modified some files in you working tree
557 without committing changes (see @ref{Commits and patches}); you
558 can use the @command{git@tie{}stash} command to work around this:
561 git stash # save uncommitted changes
562 git pull -r # pull using rebase (translators omit "-r")
563 git stash pop # reapply previously saved changes
566 Note that @command{git@tie{}stash@tie{}pop} will try to apply a
567 patch, and this may create a conflict. If this happens, see
568 @ref{Resolving conflicts}.
570 TODO: I think the next paragraph is confusing. Perhaps prepare
571 the reader for new terms `committish' and `head'? -mp
573 @warning{translators and documentation editors, if you have
574 changed committishes in the head of translated files using commits
575 you have not yet pushed to @code{git.sv.gnu.org}, please do not
576 rebase. If you want to avoid wondering whether you should rebase
577 each time you pull, please always use committishes from master
578 and/or lilypond/translation branch on @code{git.sv.gnu.org}, which
579 in particular implies that you must push your changes to
580 documentation except committishes updates (possibly after having
581 rebased), then update the committishes and push them.}
583 TODO: when committishes automatic conditional update have been
584 tested and documented, append the following to the warning above:
585 Note that using update-committishes make target generally touches
588 @subsubheading Technical details
590 The @command{git@tie{}config} command mentioned above adds the
591 line @code{rebase = true} to the master branch in your local
592 repository's @file{.git/config} file:
597 merge = refs/heads/master
602 @node Using local branches
603 @subsection Using local branches
607 * Creating and removing branches::
608 * Listing branches and remotes::
609 * Checking out branches::
614 @node Creating and removing branches
615 @unnumberedsubsubsec Creating and removing branches
618 Local branches are useful when you're working on several different
619 projects concurrently. To create a new branch, enter:
622 git branch @var{name}
625 To delete a branch, enter:
628 git branch -d @var{name}
631 Git will ask you for confirmation if it sees that data would be
632 lost by deleting the branch. Use @code{-D} instead of @code{-d}
633 to bypass this. Note that you cannot delete a branch if it is
634 currently checked out.
637 @node Listing branches and remotes
638 @unnumberedsubsubsec Listing branches and remotes
640 You can get the exact path or URL of all remote branches by
647 To list Git branches on your local repositories, run
650 git branch # list local branches only
651 git branch -r # list remote branches
652 git branch -a # list all branches
656 @node Checking out branches
657 @unnumberedsubsubsec Checking out branches
659 To know the currently checked out branch, i.e. the branch whose
660 source files are present in your working tree, read the first line
668 The currently checked out branch is also marked with an asterisk
669 in the output of @command{git branch}.
671 You can check out another branch @code{@var{other_branch}}, i.e.
672 check out @code{@var{other_branch}} to the working tree, by
676 git checkout @var{other_branch}
679 Note that it is possible to check out another branch while having
680 uncommitted changes, but it is not recommended unless you know
681 what you are doing; it is recommended to run @command{git status}
682 to check this kind of issue before checking out another branch.
684 @node Merging branches
685 @unnumberedsubsubsec Merging branches
687 To merge branch @code{@var{foo}} into branch @code{@var{bar}},
688 i.e. to @qq{add} all changes made in branch @code{@var{foo}} to
689 branch @code{@var{bar}}, run
692 git checkout @var{bar}
696 If any conflict happens, see @ref{Resolving conflicts}.
698 There are common usage cases for merging: as a translator, you
699 will often want to merge @code{master} into
700 @code{lilypond/translation}; on the other hand, the Translations
701 meister wants to merge @code{lilypond/translation} into
702 @code{master} whenever he has checked that
703 @code{lilypond/translation} builds successfully.
706 @node Commits and patches
707 @subsection Commits and patches
711 * Understanding commits::
715 * Uploading a patch for review::
719 @node Understanding commits
720 @unnumberedsubsubsec Understanding commits
722 Technically, a @emph{commit} is a single point in the history of a
723 branch, but most developers use the term to mean a @emph{commit
724 object}, which stores information about a particular revision. A
725 single commit can record changes to multiple source files, and
726 typically represents one logical set of related changes (such as a
727 bug-fix). You can list the ten most recent commits in your
728 current branch with this command:
731 git log -10 --oneline
734 If you're using an older version of Git and get an @q{unrecognized
735 argument} error, use this instead:
738 git log -10 --pretty=oneline --abbrev-commit
741 More interactive lists of the commits on the remote @code{master}
742 branch are available at
743 @uref{http://git.sv.gnu.org/gitweb/?p=lilypond.git;a=shortlog} and
744 @uref{http://git.sv.gnu.org/cgit/lilypond.git/log/}.
748 @unnumberedsubsubsec Making commits
751 Once you have modified some source files in your working
752 directory, you can make a commit with the following procedure:
756 Make sure you've configured Git properly (see @ref{Configuring
757 Git}). Check that your changes meet the requirements described in
758 @ref{Code style} and/or @ref{Documentation policy}. For advanced
759 edits, you may also want to verify that the changes don't break
760 the compilation process.
763 Run the following command:
770 to make sure you're on the right branch, and to see which files
771 have been modified, added or removed, etc. You may need to tell
772 Git about any files you've added by running one of these:
775 git add @var{file} # add untracked @var{file} individually
776 git add . # add all untracked files in current directory
780 After @command{git@tie{}add}, run @command{git@tie{}status} again
781 to make sure you got everything. You may also need to modify
785 Preview the changes about to be committed (to make sure everything
793 The @code{HEAD} argument refers to the most recent commit on the
794 currently checked-out branch.
797 Generate the commit with:
804 The @code{-a} is short for @code{--all} which includes modified
805 and deleted files, but only those newly created files that have
806 previously been added.
811 @node Commit messages
812 @unnumberedsubsubsec Commit messages
815 When you run the @command{git@tie{}commit@tie{}-a} command, Git
816 automatically opens the default text editor so you can enter a
817 @emph{commit message}. If you find yourself in a foreign editing
818 environment, you're probably in @command{vi} or @command{vim}. If
819 you want to switch to an editor you're more familiar with, quit by
820 typing @code{:q!} and pressing @code{<Enter>}. See
821 @ref{Configuring Git} for instructions on changing the default
824 In any case, Git will open a text file for your commit message
825 that looks like this:
829 # Please enter the commit message for your changes. Lines starting
830 # with '#' will be ignored, and an empty message aborts the commit.
832 # Changes to be committed:
833 # (use "git reset HEAD <file>..." to unstage)
835 # modified: working.itexi
839 Your commit message should begin with a one-line summary
840 describing the change (no more than 50 characters long), and if
841 necessary a blank line followed by several lines giving the
844 @c $ git log -1 --pretty=medium 4d6f1e5
846 Doc: add Baerenreiter and Henle solo cello suites
848 Added comparison of solo cello suite engravings to new essay with
849 high-res images, fixed cropping on Finale example.
852 Commit messages often start with a short prefix describing the
853 general location of the changes. If a commit affects the
854 documentation in English (or in several languages simultaneously)
855 the commit message should be prefixed with @qq{Doc:@tie{}}. If
856 the commit affects only one of the translations, the commit
857 message should be prefixed with @qq{Doc-@var{**}:@tie{}}, where
858 @var{**} is the two-letter language code. Commits that affect the
859 website should use @qq{Web:@tie{}} for English, and
860 @qq{Web-@var{**}:@tie{}} for the other languages. Also, changes
861 to a single file are often prefixed with the name of the file
862 involved. Visit the links listed in @ref{Understanding commits}
867 @unnumberedsubsubsec Making patches
869 If you want to share your changes with other contributors and
870 developers, you need to generate @emph{patches} from your commits.
871 We prefer it if you follow the instructions in
872 @ref{Uploading a patch for review}. However, we present an
873 alternate method here.
875 You should always run @command{git@tie{}pull@tie{}-r} (translators
876 should leave off the @code{-r}) before doing this to ensure that
877 your patches are as current as possible.
879 Once you have made one or more commits in your local repository,
880 and pulled the most recent commits from the remote branch, you can
881 generate patches from your local commits with the command:
884 git format-patch origin
887 The @code{origin} argument refers to the remote tracking branch at
888 @code{git.sv.gnu.org}. This command generates a separate patch
889 for each commit that's in the current branch but not in the remote
890 branch. Patches are placed in the current working directory and
891 will have names that look something like this:
894 0001-Doc-Fix-typos.patch
895 0002-Web-Remove-dead-links.patch
899 Send an email (must be less than 64 KB) to
900 @email{lilypond-devel@@gnu.org} briefly explaining your work, with
901 the patch files attached. Translators should send patches to
902 @email{translations@@lilynet.net}. After your patches are
903 reviewed, the developers may push one or more of them to the main
904 repository or discuss them with you.
907 @node Uploading a patch for review
908 @unnumberedsubsubsec Uploading a patch for review
910 Any non-trivial change should be uploaded to our @qq{Rietveld}
914 @uref{http://codereview.appspot.com/}
917 @subsubheading @command{git-cl} install
919 LilyDev users should skip over these @q{install} instructions.
924 Install @command{git-cl} by entering:
927 git clone git://neugierig.org/git-cl.git
931 Add the @file{git-cl/} directory to your PATH, or create a
932 symbolic link to the @command{git-cl} and @command{upload.py}
933 scripts in one of your PATH directories (such as
938 @subsubheading @command{git-cl} configuration
940 LilyDev users should perform these @q{configuration} instructions.
944 You must have a gmail account; please create one if you do not
948 Move into the top source directory and then configure @command{git
949 cl} with the following commands. If you do not understand any
950 question, just answer with a newline (CR).
953 cd $HOME/lilypond-git/
957 The @qq{CC list} question should be answered with:
960 lilypond-devel@@gnu.org
965 @subsubheading Uploading patch set
967 @warning{Unless you are familiar with branches, only work on one
968 set of changes at once.}
970 There are two methods, depending on your git setup.
974 @strong{Master branch}: (easy option, and used in @command{lily-git.tcl})
976 If you added your patch to @code{master}, then:
980 git cl upload origin/master
983 If you have git push ability, make sure that you @emph{remove}
984 your patch (with @command{git rebase} or @command{git reset})
985 before pushing other stuff.
988 @strong{Separate branch}: (complicated option)
990 Ensure your changes are committed in a separate branch, which
991 should differ from the reference branch to be used by just the
992 changes to be uploaded. If the reference branch is to be
993 origin/master, ensure this is up-to-date. If necessary, use git
994 rebase to rebase the branch containing the changes to the head of
995 origin/master. Finally, check out branch with the changes and
999 git cl upload <reference SHA1 ID>
1003 where <reference SHA1 ID> is the SHA1 ID of the commit to be used
1004 as a reference source for the patch. Generally, this will be the
1005 SHA1 ID of origin/master, and in that case the command:
1008 git cl upload origin/master
1016 After prompting for your Google email address and password, the
1017 patch set will be posted to Rietveld, and you will be given a URL
1020 @warning{Some installations of git-cl fail when uploading a patch
1021 set that includes a .scm file. When this happens, it can
1022 generally be fixed by editing the file @file{/etc/mime.types}.
1023 Add a line to this file containing @code{text/x-script.scheme scm}.}
1025 @subsubheading Announcing your patch set
1027 You should then announce the patch by logging into the code review
1028 issue webpage and using @qq{Publish + Mail Comments} to add a
1029 (mostly bogus) comment to your issue. The text of your comment
1030 will be sent to our developer mailing list.
1032 @subsubheading Revisions
1034 As revisions are made in response to comments, successive patch sets
1035 for the same issue can be uploaded by reissuing the git-cl command
1036 with the modified branch checked out.
1038 Sometimes in response to comments on revisions, the best way to
1039 work may require creation of a new branch in git. In order to
1040 associate the new branch with an existing Rietveld issue,
1041 the following command can be used:
1044 git cl issue issue-number
1048 where @code{issue-number} is the number of the existing Rietveld
1051 @subsubheading Resetting git cl
1053 If @command{git cl} becomes confused, you can @qq{reset} it by
1061 @node Advanced Git procedures
1062 @section Advanced Git procedures
1065 @warning{This section is not necessary for normal contributors;
1066 these commands are presented for information for people interested
1067 in learning more about git.}
1069 It is possible to work with several branches on the same local Git
1070 repository; this is especially useful for translators who may have
1071 to deal with both @code{lilypond/translation} and a stable branch,
1072 e.g. @code{stable/2.12}.
1074 Some Git commands are introduced first, then a workflow with
1075 several Git branches of LilyPond source code is presented.
1079 * Advanced Git concepts::
1080 * Resolving conflicts::
1081 * Reverting all local changes::
1082 * Working with remote branches::
1084 * Applying remote patches::
1085 * Sending and receiving patches via email::
1090 @node Advanced Git concepts
1091 @subsection Advanced Git concepts
1094 A bit of Git vocabulary will be explained below. The following is
1095 only introductory; for a better understanding of Git concepts, you
1096 may wish to read @ref{Other Git documentation}.
1098 The @code{git@tie{}pull@tie{}origin} command above is just a
1099 shortcut for this command:
1102 git pull git://git.sv.gnu.org/lilypond.git/ @var{branch}:origin/@var{branch}
1106 where @code{@var{branch}} is typically @code{master} or
1107 @code{lilypond/translation}; if you do not know or remember, see
1108 @ref{Downloading remote branches} to remember which commands you
1109 issued or which source code you wanted to get.
1111 A @emph{commit} is a set of changes made to the sources; it also
1112 includes the committish of the parent commit, the name and e-mail
1113 of the @emph{author} (the person who wrote the changes), the name
1114 and e-mail of the @emph{committer} (the person who brings these
1115 changes into the Git repository), and a commit message.
1117 A @emph{committish} is the SHA1 checksum of a commit, a number
1118 made of 40 hexadecimal digits, which acts as the internal unique
1119 identifier for this commit. To refer to a particular revision,
1120 don't use vague references like the (approximative) date, simply
1121 copy and paste the committish.
1123 A @emph{branch} is nothing more than a pointer to a particular
1124 commit, which is called the @emph{head} of the branch; when
1125 referring to a branch, one often actually thinks about its head
1126 and the ancestor commits of the head.
1128 Now we will explain the two last commands you used to get the
1129 source code from Git---see @ref{Downloading individual branches}.
1132 git remote add -ft @var{branch} -m @var{branch} \
1133 origin git://git.sv.gnu.org/lilypond.git/
1135 git checkout -b @var{branch} origin/@var{branch}
1138 The @command{git@tie{}remote} has created a branch called
1139 @code{origin/@var{branch}} in your local Git repository. As this
1140 branch is a copy of the remote branch web from git.sv.gnu.org
1141 LilyPond repository, it is called a @emph{remote branch}, and is
1142 meant to track the changes on the branch from git.sv.gnu.org: it
1143 will be updated every time you run
1144 @command{git@tie{}pull@tie{}origin} or
1145 @command{git@tie{}fetch@tie{}origin}.
1147 The @command{git@tie{}checkout} command has created a branch named
1148 @code{@var{branch}}. At the beginning, this branch is identical
1149 to @code{origin/@var{branch}}, but it will differ as soon as you
1150 make changes, e.g. adding newly translated pages or editing some
1151 documentation or code source file. Whenever you pull, you merge
1152 the changes from @code{origin/@var{branch}} and
1153 @code{@var{branch}} since the last pulling. If you do not have
1154 push (i.e. @qq{write}) access on git.sv.gnu.org, your
1155 @code{@var{branch}} will always differ from
1156 @code{origin/@var{branch}}. In this case, remember that other
1157 people working like you with the remote branch @code{@var{branch}}
1158 of git://git.sv.gnu.org/lilypond.git/ (called
1159 @code{origin/@var{branch}} on your local repository) know nothing
1160 about your own @code{@var{branch}}: this means that whenever you
1161 use a committish or make a patch, others expect you to take the
1162 latest commit of @code{origin/@var{branch}} as a reference.
1164 Finally, please remember to read the man page of every Git command
1165 you will find in this manual in case you want to discover
1166 alternate methods or just understand how it works.
1169 @node Resolving conflicts
1170 @subsection Resolving conflicts
1173 Occasionally an update may result in conflicts -- this happens
1174 when you and somebody else have modified the same part of the same
1175 file and git cannot figure out how to merge the two versions
1176 together. When this happens, you must manually merge the two
1179 If you need some documentation to understand and resolve
1180 conflicts, see paragraphs @emph{How conflicts are presented} and
1181 @emph{How to resolve conflicts} in @command{git merge} man page.
1183 If all else fails, you can follow the instructions in
1184 @ref{Reverting all local changes}. Be aware that this eliminates
1185 any changes you have made!
1188 @node Reverting all local changes
1189 @subsection Reverting all local changes
1191 Sometimes git will become hopelessly confused, and you just want
1192 to get back to a known, stable state. This command destroys any
1193 local changes you have made, but at least you get back to the
1194 current online version:
1197 git reset --hard origin/master
1201 @node Working with remote branches
1202 @subsection Working with remote branches
1205 @subsubheading Fetching new branches from git.sv.gnu.org
1207 To fetch and check out a new branch named @code{@var{branch}} on
1208 git.sv.gnu.org, run from top of the Git repository
1211 git config --add remote.origin.fetch \
1212 +refs/heads/@var{branch}:refs/remotes/origin/@var{branch}
1214 git checkout --track -b @var{branch} origin/@var{branch}
1217 After this, you can pull @code{@var{branch}} from git.sv.gnu.org
1224 Note that this command generally fetches all branches you added
1225 with @command{git@tie{}remote@tie{}add} (when you initialized the
1226 repository) or @command{git@tie{}config@tie{}--add}, i.e. it
1227 updates all remote branches from remote @code{origin}, then it
1228 merges the remote branch tracked by the current branch into the
1229 current branch. For example, if your current branch is
1230 @code{master}, @code{origin/master} will be merged into
1234 @subsubheading Local clones, or having several working trees
1236 If you play with several Git branches, e.g. @code{master},
1237 @code{lilypond/translation}, @code{stable/2.12}), you may want to
1238 have one source and build tree for each branch; this is possible
1239 with subdirectories of your local Git repository, used as local
1240 cloned subrepositories. To create a local clone for the branch
1241 named @code{@var{branch}}, run
1244 git checkout @var{branch}
1245 git clone -lsn . @var{subdir}
1250 Note that @code{@var{subdir}} must be a directory name which does
1251 not already exist. In @code{@var{subdir}}, you can use all Git
1252 commands to browse revisions history, commit and uncommit changes;
1253 to update the cloned subrepository with changes made on the main
1254 repository, cd into @code{@var{subdir}} and run
1255 @command{git@tie{}pull}; to send changes made on the subrepository
1256 back to the main repository, run @command{git@tie{}push} from
1257 @code{@var{subdir}}. Note that only one branch (the currently
1258 checked out branch) is created in the subrepository by default; it
1259 is possible to have several branches in a subrepository and do
1260 usual operations (checkout, merge, create, delete...) on these
1261 branches, but this possibility is not detailed here.
1263 When you push @code{@var{branch}} from @code{@var{subdir}} to the
1264 main repository, and @code{@var{branch}} is checked out in the
1265 main repository, you must save uncommitted changes (see
1266 @command{git@tie{}stash}) and do
1267 @command{git@tie{}reset@tie{}--hard} in the main repository in
1268 order to apply pushed changes in the working tree of the main
1276 The commands above don't only bring you the latest version of the
1277 sources, but also the full history of revisions (revisions, also
1278 called commits, are changes made to the sources), stored in the
1279 @file{.git} directory. You can browse this history with
1282 git log # only shows the logs (author, committish and commit message)
1283 git log -p # also shows diffs
1284 gitk # shows history graphically
1287 @warning{The @code{gitk} command may require a separate
1288 @code{gitk} package, available in the appropriate distribution's
1292 @node Applying remote patches
1293 @subsection Applying remote patches
1296 TODO: Explain how to determine if a patch was created with
1297 @code{git@tie{}format-patch}.
1299 Well-formed git patches created with @code{git@tie{}format-patch}
1300 should be committed with the following command:
1306 Patches created without @code{git@tie{}format-patch} can be
1307 applied in two steps. The first step is to apply the patch to the
1311 git apply @var{patch}
1315 The second step is to commit the changes and give credit to the
1316 author of the patch. This can be done with the following command:
1319 git commit -a --author="@var{John Smith} <@var{john@@example.com}>"
1323 @node Sending and receiving patches via email
1324 @subsection Sending and receiving patches via email
1327 The default @code{x-diff} MIME type associated with patch files
1328 (i.e., files whose name ends in @code{.patch}) means that the
1329 encoding of line endings may be changed from UNIX to DOS format
1330 when they are sent as attachments. Attempting to apply such an
1331 inadvertently altered patch will cause git to fail with a message
1332 about @q{whitespace errors}.
1334 The solution to such problems is surprisingly simple---just change
1335 the default file extension of patches generated by git to end in
1336 @code{.txt}, for example:
1339 git config format.suffix '.patch.txt'
1342 This should cause email programs to apply the correct base64
1343 encoding to attached patches.
1345 If you receive a patch with DOS instead of UNIX line-endings, it
1346 can be converted back using the @code{dos2unix} utility.
1348 Lots of useful information on email complications with patches is
1349 provided on the Wine wiki at
1350 @uref{http://wiki.winehq.org/GitWine}.
1354 @subsection Commit access
1357 Most contributors are not able to commit patches directly to the
1358 main repository---only members of the LilyPond development team
1359 have @emph{commit access}. If you are a contributor and are
1360 interested in joining the development team, contact the Project
1361 Manager through the mailing list
1362 (@email{lilypond-devel@@gnu.org}). Generally, only contributors
1363 who have already provided a number of patches which have been
1364 pushed to the main repository will be considered for membership.
1366 If you have been approved by the Project Manager, use the
1367 following procedure to obtain commit access:
1371 If you don't already have one, set up a Savannah user account at
1372 @uref{https://savannah.gnu.org/account/register.php}. If your web
1373 browser responds with an @qq{untrusted connection} message when
1374 you visit the link, follow the steps for including the CAcert root
1375 certificate in your browser, given at
1376 @uref{http://savannah.gnu.org/tls/tutorial/}.
1380 After registering, if you are not logged in automatically, login
1381 at @uref{https://savannah.gnu.org/account/login.php}---this should
1382 take you to your @qq{my} page
1383 (@uref{https://savannah.gnu.org/my/}).
1387 Click on the @qq{My Groups} link to access the @qq{My Group
1388 Membership} page. From there, find the @qq{Request for Inclusion}
1389 box and search for @qq{LilyPond}. Among the search results, check
1390 the box labeled @qq{GNU LilyPond Music Typesetter} and write a
1391 brief (required) message for the Project Manager (@qq{Hey it's
1392 me!} should be fine).
1394 Note that you will not have commit access until the Project
1395 Manager activates your membership. Once your membership is
1396 activated, LilyPond should appear under the heading @qq{Groups I'm
1397 Contributor of} on your @qq{My Group Membership} page.
1401 Generate an SSH @q{dsa} key pair. Enter the following at the
1408 When prompted for a location to save the key, press <ENTER> to
1409 accept the default location (@file{~/.ssh/id_dsa}).
1411 Next you are asked to enter an optional passphrase. On most
1412 systems, if you use a passphrase, you will likely be prompted for
1413 it every time you use @command{git@tie{}push} or
1414 @command{git@tie{}pull}. You may prefer this since it can protect
1415 you from your own mistakes (like pushing when you mean to pull),
1416 though you may find it tedious to keep re-entering it.
1418 You can change/enable/disable your passphrase at any time with:
1421 ssh-keygen -f ~/.ssh/id_dsa -p
1424 Note that the GNOME desktop has a feature which stores your
1425 passphrase for you for an entire GNOME session. If you use a
1426 passphrase to @qq{protect you from yourself}, you will want to
1427 disable this feature, since you'll only be prompted once. Run the
1428 following command, then logout of GNOME and log back in:
1431 gconftool-2 --set -t bool \
1432 /apps/gnome-keyring/daemon-components/ssh false
1435 After setting up your passphrase, your private key is saved as
1436 @file{~/.ssh/id_dsa} and your public key is saved as
1437 @file{~/.ssh/id_dsa.pub}.
1441 Register your public SSH @q{dsa} key with Savannah. From the
1442 @qq{My Account Configuration} page, click on @qq{Edit SSH Keys},
1443 then paste the contents of your @file{~/.ssh/id_dsa.pub} file into
1444 one of the @qq{Authorized keys} text fields, and click
1447 Savannah should respond with something like:
1450 Success: Key #1 seen Keys registered
1455 Configure Git to use the SSH protocol (instead of the GIT
1456 protocol). From your local Git repository, enter:
1459 git config remote.origin.url \
1460 ssh://@var{user}@@git.sv.gnu.org/srv/git/lilypond.git
1464 where @var{user} is your username on Savannah.
1468 After your membership has been activated and you've configured Git
1469 to use SSH, test the connection with:
1475 SSH should issue the following warning:
1478 The authenticity of host 'git.sv.gnu.org (140.186.70.72)' can't
1480 RSA key fingerprint is
1481 80:5a:b0:0c:ec:93:66:29:49:7e:04:2b:fd:ba:2c:d5.
1482 Are you sure you want to continue connecting (yes/no)?
1485 Make sure the RSA key fingerprint displayed matches the one above.
1486 If it doesn't, respond @qq{no} and check that you configured Git
1487 properly in the previous step. If it does match, respond
1488 @qq{yes}. SSH should then issue another warning:
1491 Warning: Permanently added 'git.sv.gnu.org,140.186.70.72' (RSA) to
1492 the list of known hosts.
1495 The list of known hosts is stored in the file
1496 @file{~/.ssh/known_hosts}.
1498 At this point, you are prompted for your passphrase if you have
1499 one, then Git will attempt a pull.
1501 If @command{git@tie{}pull@tie{}--verbose} fails, you should see
1502 error messages like these:
1505 Permission denied (publickey).
1506 fatal: The remote end hung up unexpectedly
1509 If you get the above error, you may have made a mistake when
1510 registering your SSH key at Savannah. If the key is properly
1511 registered, you probably just need to wait for the Savannah server
1512 to activate it. It usually takes a few minutes for the key to be
1513 active after registering it, but if it still doesn't work after an
1514 hour, ask for help on the mailing list.
1516 If @command{git@tie{}pull@tie{}--verbose} succeeds, the output
1517 will include a @q{From} line that shows @q{ssh} as the protocol:
1520 From ssh://@var{user}@@git.sv.gnu.org/srv/git/lilypond
1523 If the protocol shown is not @q{ssh}, check that you configured
1524 Git properly in the previous step.
1528 Test your commit access with a dry run:
1531 git push --dry-run --verbose
1534 Note that recent versions of Git (Git 1.6.3 or later) will issue a
1535 big warning if the above command is used. The simplest solution
1536 is to tell Git to push all matching branches by default:
1539 git config push.default matching
1543 Then @code{git@tie{}push} should work as before. For more
1544 details, consult the @code{git@tie{}push} man page.
1548 @subsubheading Technical details
1552 On Firefox, to view or remove the CAcert root certificate, go to:
1553 Edit > Preferences > Advanced > Encryption > View Certificates >
1554 Authorities > Certificate Name > Root CA > CA Cert Signing
1558 The @command{git@tie{}config} commands above should modify your
1559 local repository's @file{.git/config} file. These lines:
1563 url = git://git.sv.gnu.org/lilypond.git/
1567 should now be changed to:
1571 url = ssh://@var{user}@@git.sv.gnu.org/srv/git/lilypond.git
1575 where @var{user} is your login name on Savannah.
1579 @command{git@tie{}config@tie{}push.default@tie{}matching} command
1580 should add these lines to @file{.git/config}:
1589 Encryption protocols, including ssh, generally do not permit packet
1590 fragmentation to avoid introducing a point of insecurity. This
1591 means that the maximum packet size must not exceed the smallest
1592 MTU (Maximum Transmission Unit) set in the routers along the path.
1593 This smallest MTU is determined by a procedure during call set-up
1594 which relies on the transmission over the path of ICMP packets.
1595 If any of the routers in the path block ICMP packets this mechanism
1596 fails, resulting in the possibility of packets being transmitted
1597 which exceed the MTU of one of the routers. If this happens the
1598 packet is discarded, causing the ssh session to hang, timeout or
1599 terminate with the error message
1602 ssh: connect to host <host ip addr> port 22: Bad file number
1603 fatal: The remote end hung up unexpectedly
1606 depending on precisely when in the proceedings the first large
1607 packet is transmitted. Most routers on the internet have MTU
1608 set to 1500, but routers installed in homes to connect via
1609 broadband may use a slightly smaller MTU for efficient transmission
1610 over ATM. If this problem is encountered a possible work-around is
1611 to set the MTU in the local router to 1500.
1613 @node Git on Windows
1614 @section Git on Windows
1616 @c Some of this may duplicate stuff in other sections
1617 @c But it is probably best for windows users to have it all together
1618 @c If necessary, clear this up later -td
1620 TODO: Decide what to do with this... Pare it down? Move
1621 paragraphs next to analogous Unix instructions? -mp
1623 @subsection Background to nomenclature
1625 Git is a system for tracking the changes made to source files by a
1626 distributed set of editors. It is designed to work without a
1627 master repository, but we have chosen to have a master repository
1628 for LilyPond files. Editors hold a local copy of the master
1629 repository together with any changes they have made locally.
1630 Local changes are held in a local @q{branch}, of which there may
1631 be several, but these instructions assume you are using just one.
1632 The files visible in the local repository always correspond to
1633 those on the currently @q{checked out} local branch.
1635 Files are edited on a local branch, and in that state the changes
1636 are said to be @q{unstaged}. When editing is complete, the
1637 changes are moved to being @q{staged for commit}, and finally the
1638 changes are @q{committed} to the local branch. Once committed,
1639 the changes (called a @q{commit}) are given a unique 40-digit
1640 hexadecimal reference number called the @q{Committish} or @q{SHA1
1641 ID} which identifies the commit to Git. Such committed changes
1642 can be sent to the master repository by @q{pushing} them (if you
1643 have write permission) or by sending them by email to someone who
1644 has, either as a complete file or as a @q{diff} or @q{patch}
1645 (which send just the differences from the master repository).
1647 @subsection Installing git
1650 @uref{http://code.google.com/p/msysgit/downloads/list} (note, not
1651 msysGit, which is for Git developers and not PortableGit, which is
1652 not a full git installation) and install it.
1654 Note that most users will not need to install SSH. That is not
1655 required until you have been granted direct push permissions to
1656 the master git repository.
1658 Start Git by clicking on the desktop icon. This will bring up a
1659 command line bash shell. This may be unfamiliar to Windows users.
1660 If so, follow these instructions carefully. Commands are entered
1661 at a $ prompt and are terminated by keying a newline.
1663 @subsection Initialising Git
1665 Decide where you wish to place your local Git repository, creating
1666 the folders in Windows as necessary. Here we call the folder to
1667 contain the repository @code{[path]/Git}, but if you intend using
1668 Git for other projects a directory name like @code{lilypond-git}
1669 might be better. You will need to have space for around
1672 Start the Git bash shell by clicking on the desk-top icon
1673 installed with Git and type
1679 to position the shell at your new Git repository.
1681 Note: if [path] contains folders with names containing spaces use
1693 to initialize your Git repository.
1695 Then type (all on one line; the shell will wrap automatically)
1698 git remote add -ft master origin git://git.sv.gnu.org/lilypond.git
1701 to download the lilypond master files.
1703 @warning{Be patient! Even on a broadband connection this can take
1704 10 minutes or more. Wait for lots of [new tag] messages and the $
1707 We now need to generate a local copy of the downloaded files in a
1708 new local branch. Your local branch needs to have a name. It is
1709 usual to call it @q{master} and we shall do that here.
1714 git checkout -b master origin/master
1717 This creates a second branch called @q{master}. You will see two
1718 warnings (ignore these), and a message advising you that your
1719 local branch @q{master} has been set up to track the remote
1720 branch. You now have two branches, a local branch called
1721 @q{master}, and a tracking branch called @q{origin/master}, which
1722 is a shortened form of @q{remotes/origin/master}.
1724 Return to Windows Explorer and look in your Git repository. You
1725 should see lots of folders. For example, the LilyPond
1726 documentation can be found in [path]/Git/Documentation/.
1728 The Git bash shell is terminated by typing @code{exit} or by
1729 clicking on the usual Windows close-window widget.
1733 Almost all subsequent work will use the Git Graphical User
1734 Interface, which avoids having to type command line commands. To
1735 start Git GUI first start the Git bash shell by clicking on the
1736 desktop icon, and type
1743 The Git GUI will open in a new window. It contains four panels
1744 and 7 pull-down menus. At this stage do not use any of the
1745 commands under Branch, Commit, Merge or Remote. These will be
1748 The top panel on the left contains the names of files which you
1749 are in the process of editing (Unstaged Changes), and the lower
1750 panel on the left contains the names of files you have finished
1751 editing and have staged ready for committing (Staged Changes). At
1752 present, these panels will be empty as you have not yet made any
1753 changes to any file. After a file has been edited and saved the
1754 top panel on the right will display the differences between the
1755 edited file selected in one of the panels on the left and the last
1756 version committed on the current branch.
1758 The panel at bottom right is used to enter a descriptive message
1759 about the change before committing it.
1761 The Git GUI is terminated by entering CNTL-Q while it is the
1762 active window or by clicking on the usual Windows close-window
1765 @subsection Personalising your local git repository
1767 Open the Git GUI, click on
1773 and enter your name and email address in the left-hand (Git
1774 Repository) panel. Leave everything else unchanged and save it.
1776 Note that Windows users must leave the default setting for line
1777 endings unchanged. All files in a git repository must have lines
1778 terminated by just a LF, as this is required for Merge to work,
1779 but Windows files are terminated by CRLF by default. The git
1780 default setting causes the line endings of files in a Windows git
1781 repository to be flipped automatically between LF and CRLF as
1782 required. This enables files to be edited by any Windows editor
1783 without causing problems in the git repository.
1785 @subsection Checking out a branch
1787 At this stage you have two branches in your local repository,
1788 both identical. To see them click on
1794 You should have one local branch called @q{master} and one
1795 tracking branch called @q{origin/master}. The latter is your
1796 local copy of the @q{remotes/origin/master} branch in the master
1797 LilyPond repository. The local @q{master} branch is where you
1798 will make your local changes.
1800 When a particular branch is selected, i.e., checked out, the files
1801 visible in your repository are changed to reflect the state of the
1802 files on that branch.
1804 @subsection Updating files from @q{remote/origin/master}
1806 Before starting the editing of a file, ensure your local
1807 repository contains the latest version of the files in the remote
1808 repository by first clicking
1811 Remote -> Fetch from -> origin
1817 This will place the latest version of every file, including all
1818 the changes made by others, into the @q{origin/master} branch of
1819 the tracking branches in your git repository. You can see these
1820 files by checking out this branch, but you must @emph{never} edit
1821 any files while this branch is checked out. Check out your local
1822 @q{master} branch again.
1824 You then need to merge these fetched files into your local
1825 @q{master} branch by clicking on
1828 Merge -> Local Merge
1832 and if necessary select the local @q{master} branch.
1834 Note that a merge cannot be completed if you have made any local
1835 changes which have not yet been committed.
1837 This merge will update all the files in the @q{master} branch to
1838 reflect the current state of the @q{origin/master} branch. If any
1839 of the changes conflict with changes you have made yourself
1840 recently you will be notified of the conflict (see below).
1842 @subsection Editing files
1844 First ensure your @q{master} branch is checked out, then simply
1845 edit the files in your local Git repository with your favourite
1846 editor and save them back there. If any file contains non-ASCII
1847 characters ensure you save it in UTF-8 format. Git will detect
1848 any changes whenever you restart Git GUI and the file names will
1849 then be listed in the Unstaged Changes panel. Or you can click
1850 the Rescan button to refresh the panel contents at any time. You
1851 may break off and resume editing any time.
1853 The changes you have made may be displayed in diff form in the top
1854 right-hand panel of Git GUI by clicking on the file name shown in
1855 one of the left panels.
1857 When your editing is complete, move the files from being Unstaged
1858 to Staged by clicking the document symbol to the left of each
1859 name. If you change your mind it can be moved back by clicking on
1860 the ticked box to the left of the name.
1862 Finally the changes you have made may be committed to your
1863 @q{master} branch by entering a brief message in the Commit
1864 Message box and clicking the Commit button.
1866 If you wish to amend your changes after a commit has been made,
1867 the original version and the changes you made in that commit may
1868 be recovered by selecting
1871 Commit -> Amend Last Commit
1875 or by checking the Amend Last Commit radio button at bottom right.
1876 This will return the changes to the Staged state, so further
1877 editing made be carried out within that commit. This must only be
1878 done @emph{before} the changes have been Pushed or sent to your
1879 mentor for Pushing - after that it is too late and corrections
1880 have to be made as a separate commit.
1883 @subsection Sending changes to @q{remotes/origin/master}
1885 If you do not have write access to @q{remotes/origin/master} you
1886 will need to send your changes by email to someone who does.
1888 First you need to create a diff or patch file containing your
1889 changes. To create this, the file must first be committed. Then
1890 terminate the Git GUI. In the git bash shell first cd to your Git
1897 if necessary, then produce the patch with
1900 git format-patch origin
1903 This will create a patch file for all the locally committed files
1904 which differ from @q{origin/master}. The patch file can be found
1905 in [path]/Git and will have a name formed from the commit message.
1907 @subsection Resolving merge conflicts
1909 As soon as you have committed a changed file your local
1910 @code{master} branch has diverged from @code{origin/master}, and
1911 will remain diverged until your changes have been committed in
1912 @code{remotes/origin/master} and Fetched back into your
1913 @code{origin/master} branch. Similarly, if a new commit has been
1914 made to @code{remotes/origin/master} by someone else and Fetched,
1915 your local @code{master} branch is divergent. You can detect a
1916 divergent branch by clicking on
1919 Repository -> Visualise all branch history
1922 This opens up a very useful new window called @q{gitk}. Use this
1923 to browse all the commits made by yourself and others.
1925 If the diagram at top left of the resulting window does not show
1926 your @code{master} tag on the same node as the
1927 @code{remotes/origin/master} tag your branch has diverged from
1928 @code{origin/master}. This is quite normal if files you have
1929 modified yourself have not yet been Pushed to
1930 @code{remotes/origin/master} and Fetched, or if files modified and
1931 committed by others have been Fetched since you last Merged
1932 @code{origin/master} into your local @code{master} branch.
1934 If a file being merged from @code{origin/master} differs from one
1935 you have modified in a way that cannot be resolved automatically
1936 by git, Merge will report a Conflict which you must resolve by
1937 editing the file to create the version you wish to keep.
1939 This could happen if the person updating
1940 @code{remotes/origin/master} for you has added some changes of his
1941 own before committing your changes to
1942 @code{remotes/origin/master}, or if someone else has changed the
1943 same file since you last fetched the file from
1944 @code{remotes/origin/master}.
1946 Open the file in your editor and look for sections which are
1949 [to be completed when I next have a merge conflict to be sure I
1950 give the right instructions -td]
1953 @subsection Other actions
1955 The instructions above describe the simplest way of using git on
1956 Windows. Other git facilities which may usefully supplement these
1960 @item Using multiple local branches (Create, Rename, Delete)
1961 @item Resetting branches
1962 @item Cherry-picking commits
1963 @item Pushing commits to @w{remote/origin/master}
1964 @item Using gitk to review history
1967 Once familiarity with using git on Windows has been gained the
1968 standard git manuals can be used to learn about these.
1971 @node Repository directory structure
1972 @section Repository directory structure
1975 @c TODO: integrate the roadmap better
1976 @verbatiminclude ROADMAP
1979 @node Other Git documentation
1980 @section Other Git documentation
1984 Official git man pages:
1985 @uref{http://www.kernel.org/pub/software/scm/git/docs/}
1988 More in-depth tutorials: @uref{http://git-scm.com/documentation}
1991 Book about git: @uref{http://progit.org/,Pro Git}