@node Getting the source code
@section Getting the source code
-The source code is kept in a git respository.
-
-@warning{These instructions assume that you are using the
-command-line version of git 1.5 or higher.}
-
-
@menu
+* Git introduction::
* Main source code::
* Website source code::
* Documentation translations source code::
* Other branches::
+* Other locations for git::
* Git user configuration::
@end menu
+@node Git introduction
+@subsection Git introduction
+
+The source code is kept in a git respository. This allows us to
+track changes to files, and for multiple people to work on the
+same set of files (generally) without any problems.
+
+@warning{These instructions assume that you are using the
+command-line version of git 1.5 or higher. Windows users should
+skip to @ref{Git on Windows}.}
+
+
@node Main source code
@subsection Main source code
To get the website (including translations),
+FIXME: test this!!!
+
@example
-mkdir lilyweb ; cd lilyweb
+mkdir lilypod-web ; cd lilypond-web
git init-db
git remote add -f -t web -m web origin git://git.sv.gnu.org/lilypond.git/
git checkout -b web origin/web
To translate the documentation (@emph{not} the website),
-FIXME: change
+FIXME: change!!!
@example
-mkdir lilytranslate ; cd lilytranslate
+mkdir lilypond-translate; cd lilypond-translate
git init-db
git remote add -f -t web -m web origin git://git.sv.gnu.org/lilypond.git/
git checkout -b web origin/web
@end example
-@menu
-* Other branches::
-* Git user configuration::
-@end menu
-
@node Other branches
@subsection Other branches
@item @code{gub}:
This stores the Grand Unified Binary, our cross-platform building
-tool.
+tool. For more info, see @uref{http://lilypond.org/gub}. The git
+location is:
@example
-FIXME: insert new gub addy
+http://github.com/janneke/gub
@end example
@item @code{dev/XYZ}:
@end itemize
+@node Other locations for git
+@subsection Other locations for git
+
+If you have difficulty connecting to most of the repositories
+listed in earlier sections, try:
+
+@example
+git://git.sv.gnu.org/lilypond.git
+http://git.sv.gnu.org/r/lilypond.git
+ssh://git.sv.gnu.org/srv/git/lilypond.git
+@end example
+
+
@node Git user configuration
@subsection Git user configuration
* Technical notes::
@end menu
+
@node Importance of updating
@subsection Importance of updating
However, serious problems can arise if you do not pull before
attempting commit.
+
@node Update command
@subsection Updating command
git pull origin
@end example
+
@node Resolving conflicts
@subsection Resolving conflicts
@node Technical notes
@subsection Technical notes
-Let's explain a bit of Git vocabulary. The @code{git pull
-origin} command is just a shortcut for this command:
+TODO: I'm not going to bother with this section. -gp
+
+Let's explain a bit of Git vocabulary. The @code{git pull origin}
+command is just a shortcut for this command:
@example
git pull git://git.sv.gnu.org/lilypond.git/ MY-BRANCH:origin/MY-BRANCH
@end example
-A commit is a set of changes made to the sources; it also includes the
-committish of the parent commit, the name and e-mail of the author
-(the person who wrote the changes), the name and e-mail of the
-committer (the person who brings these changes into the git
+A commit is a set of changes made to the sources; it also includes
+the committish of the parent commit, the name and e-mail of the
+author (the person who wrote the changes), the name and e-mail of
+the committer (the person who brings these changes into the git
repository), and a commit message.
A committish is the SHA1 checksum of a commit, a number made of 40
-hexadecimal digits, which acts as the internal unique identifier for
-this commit. To refer to a particular revision, don't use vague
-references like the (approximative) date, simply copy'n'paste the
-committish.
-
-A branch is a tree (in the mathematical or computer science sense) of
-commits, and the topmost commit of this branch is called a head.
-
-The "git fetch" command above has created a branch called origin/web
-in your local Git repository. As this branch is a copy of the remote
-branch web from git.sv.gnu.org LilyPond repository, it is
-called a `remote branch', and is meant to track the changes on the
-branch from git.sv.gnu.org: it will be updated every time you run 'git
-pull' or 'git fetch' with this branch reference as argument, e.g.
-by using .git/remotes/web remote file when running 'git fetch web'.
+hexadecimal digits, which acts as the internal unique identifier
+for this commit. To refer to a particular revision, don't use
+vague references like the (approximative) date, simply
+copy'n'paste the committish.
+
+A branch is a tree (in the mathematical or computer science sense)
+of commits, and the topmost commit of this branch is called a
+head.
+
+The "git fetch" command above has created a branch called
+@code{origin/web} in your local Git repository. As this branch is
+a copy of the remote branch web from git.sv.gnu.org LilyPond
+repository, it is called a `remote branch', and is meant to track
+the changes on the branch from git.sv.gnu.org: it will be updated
+every time you run 'git pull' or 'git fetch' with this branch
+reference as argument, e.g. by using .git/remotes/web remote file
+when running 'git fetch web'.
The 'git checkout' command above has created a branch named 'web'. At
the beginning, this branch is identical to 'origin/web', but it will
-
@node Sharing your changes
@section Sharing your changes
-
@menu
* Producing a patch::
* Committing directly::
@end menu
+
@node Producing a patch
@subsection Producing a patch
you do, edit @file{.git/config} to contain
@example
-FIXME?
+FIXME? Is anything needed, or did the previous commands set it
+up?
@end example
You may then @code{git push}.
@node Other interesting Git commands
@section Other interesting Git commands
+@menu
+* Git log::
+* Applying git patches::
+@end menu
+
+
+@node Git log
+@subsection Git log
+
The commands above don't only bring you the latest version of the
sources, but also the full history of revisions (revisons, also
called commits, are changes made to the sources), stored in the
@end example
+@node Applying git patches
+@subsection Applying git patches
+
+Well-formed git patches should be committed with
+
+@example
+git-am
+@end example
+
+Patches created without @code{git-format-patch} should be
+committed with
+
+@example
+git-apply
+@end example
+
@node Git on Windows
@section Git on Windows
+@c Some of this may duplicate stuff in other sections
+@c Clear this up later -td
+
+@subsection Background to nomenclature
+
+Git is a system for tracking the changes made to source files by
+a distributed set of editors. It is designed to work without a
+master repository, but we have chosen to have a master respository
+for LilyPond files. Editors hold local copies of the master
+repository together with any changes they have made locally. Local
+changes are held in a local @q{branch}, of which there may be
+several, but these instructions assume you are using just one. The
+files visible in the local repository always correspond to those
+on the currently @q{checked out} local branch.
+
+Files are edited on a local branch, and in that state the
+changes are said to be @q{unstaged}. When editing is complete, the
+changes are moved to being @q{staged for commit}, and finally the
+changes are @q{committed} to the local branch. Once
+committed, the changes are given a unique reference number called the
+@q{Committish} which identifies them to Git. Such committed changes
+can be sent to the master repository by @q{pushing} them (if you
+have write permission) or by sending them by email to someone who
+has, either complete or as a @q{diff} or @q{patch} (which send
+just the differences from master).
+
+@subsection Installing git
+
+Obtain Git from
+@uref{http://code.google.com/p/msysgit/downloads/list}.
+(Note, not msysGit, which is for Git developers) and
+install.
+
+Start Git by clicking on the desktop icon.
+This will bring up a command line bash shell. This may be
+unfamiliar to Windows users. If so, follow these
+instructions carefully. Commands are entered at a $ prompt
+and are terminated by keying a newline.
+
+@subsection Initialising Git
+
+Decide where you wish to place your local Git repository,
+creating the folders in Windows as necessary. Here we
+call the folder to contain the repository [path]/Git.
+You will need to have space for around 150Mbytes.
+
+In the git bash shell type
+
+@example
+cd [path]/Git
+@end example
+
+to position the shell at your new Git repository.
+
+Note: if [path] contains folders with names containing
+spaces use
+
+@example
+cd "[path]/Git"
+@end example
+
+Then type
+
+@example
+git init
+@end example
+
+to initialize your Git repository.
+Then type (all on one line; the shell will wrap automatically)
+
+@example
+git remote add -f -t master origin git://git.sv.gnu.org/lilypond.git
+@end example
+
+to download the lilypond master files.
+
+@warning{Be patient! Even on a broadband connection this can take
+10 minutes or more. Wait for lots of [new tag] messages
+and the $ prompt.}
+
+We now need to generate a local copy of the downloaded files
+in a new local branch. Your local branch needs to have a
+name, here we call it @q{lily-local} - you may wish to make up
+your own.
+
+Then, finally, type
+
+@example
+git checkout -b lily-local origin/master
+@end example
+
+to create the lily-local branch containing the local copies of the
+master files. You will be advised your local branch has been set
+up to track the remote branch.
+
+Return to Windows Explorer and look in your Git repository. You
+should see lots of folders. For example, the LilyPond documentation
+can be found in Git/Documentation/user.
+
+Terminate the Git bash shell by typing @code{exit}.
+
+@subsection Git GUI
+
+Almost all subsequent work will use the Git Graphical User
+Interface, which avoids having to type command line
+commands. To start Git GUI first start the Git bash shell by
+clicking on the desktop icon, and type
+
+@example
+cd [path]/Git
+git gui
+@end example
+
+The Git GUI will open in a new window. It contains four panels
+and 7 pull-down menus. At this stage do not use any of the
+commands under Branch, Commit, Merge or Remote. These will
+be explained later.
+
+The two panels on the left contain the names of files which
+you are in the process of editing (Unstaged Changes), and
+files you have finished editing and have staged ready for
+committing (Staged Changes). At this stage these panels will
+be empty as you have not yet made any changes to any file.
+After a file has been edited and saved the top panel on the right
+will display the differences between the edited file selected
+in one of the panels on the left and the last version committed.
+
+The final panel at bottom right is used to enter a descriptive
+message about the change before committing it.
+
+The Git GUI is terminated by entering CNTL-Q while it is the
+active window or by clicking on the usual Windows close-window
+widget.
+
+@subsection Personalising your local git repository
+
+Open the Git GUI, click on
+
+@example
+Edit -> Options
+@end example
+
+and enter your name and email address in the
+left-hand (Git Repository) panel. Leave everything
+else unchanged and save it.
+
+@subsection Checking out a branch
+
+At this stage you have two branches in your local repository,
+both identical. To see them click on
+
+@example
+Branch -> Checkout
+@end example
+
+You should have one local branch called @w{lily-local} and one
+tracking branch called @w{origin/master}. The latter is your
+local copy of the @w{remote/origin/master} branch in the master
+LilyPond repository. The @w{lily-local} branch is where you
+will make your local changes.
+
+When a particular branch is selected, i.e., checked out, the
+files visible in your repository are changed to reflect the
+state of the files on that branch.
+
+@subsection Updating files from @w{remote/origin/master}
+
+Before starting the editing of a file, ensure your local branches
+contain the latest version in @w{remote/origin/master} by first
+clicking
+
+@example
+Remote -> Fetch from -> origin
+@end example
+
+@noindent
+in the Git GUI.
+
+This will place the latest version of every file, including all the
+changes made by others,
+into the @q{origin/master} branch of the tracking branches
+in your git repository. You can see these files by checking
+out this branch. This will not affect any files you have
+modified in your local branch.
+
+You then need to merge these fetched files into your local
+branch by clicking on
+
+@example
+Merge -> Local Merge
+@end example
+
+@noindent
+and if necessary select the local branch into which the merge
+is to be made.
+
+Note that a merge cannot be completed if there are any local
+uncommitted changes on the lily-local branch.
+
+This will update all the files in that branch to reflect the
+current state of the @w{origin/master} branch. If any of the
+changes conflict with changes you have made yourself recently
+you will be notified of the conflict (see below).
+
+@subsection Editing files
+
+First ensure your lily-local branch is checked out, then
+simply edit the files in your local Git repository with your
+favourite editor and save them back there. If any file contains
+non-ASCII characters ensure you save it in UTF-8 format. Git will
+detect any changes whenever you restart Git GUI and the file names
+will then be listed in the Unstaged Changes panel.
+Or you can click the Rescan button to refresh the panel
+contents at any time. You may break off and resume at
+editing any time.
+
+The changes you have made may be displayed in diff form
+in the top right-hand panel by clicking on the name in
+Git GUI.
+
+When your editing is complete, move the files from being
+Unstaged to Staged by clicking the document symbol to
+the left of each name. If you change your mind it can
+be moved back by clicking on the ticked box to the
+left of the name.
+
+Finally the changes you have made may be committed to
+your lily-local branch by entering a brief message in
+the Commit Message box and clicking the Commit button.
+
+If you wish to amend your changes after a commit has been
+made, the original version and the changes you made in that
+commit may be recovered by selecting
+
+@example
+Commit -> Amend Last Commit
+@end example
+
+@noindent
+or by checking the Amend Last Commit radio button at bottom left.
+This will return the changes to the Staged state, so further
+editing made be carried out within that commit. This must only be
+done @emph{before} the changes have been Pushed or sent to your
+mentor for Pushing - after that it is too late and corrections
+have to be made as a separate commit.
+
+
+@subsection Sending changes to remote/origin/master
+
+If you do not have write access to @w{remote/origin/master} you will
+need to send your changes by email to someone who does.
+
+First you need to create a diff or patch file containing
+your changes. To create this, the file must first be
+committed. Then terminate the Git GUI. In the
+git bash shell first cd to your Git repository with
+
+@example
+cd [path]/Git
+@end example
+
+if necessary, then produce the patch with
+
+@example
+git-format-patch -n
+@end example
+
+where n an integer, normally 1. This will create a
+patch file for all the locally committed files which differ
+from @w{origin/master}. The patch file can be found in
+[path]/Git and will have a name formed from n and the
+commit message.
+
+@subsection Resolving merge conflicts
+
+As soon as you have committed a changed file your local
+branch has diverged from @w{origin/master}, and will
+remain diverged until your changes have been committed
+in @w{remote/origin/master} and Fetched back into your
+@w{origin/master}. Similarly, if a new commit has been made
+to @w{remote/origin/master} by someone else and Fetched, your
+lily-local branch is divergent. You can detect a divergent
+branch by clicking on
+
+@example
+Repository -> Visualise all branch history
+@end example
+
+This opens up a very useful new window called @q{gitk}.
+Use this to browse all the commits made by others.
+
+If the diagram at top left of the resulting window
+does not show your branch's tag on the same node as
+the @w{remote/origins/master} tag your branch has diverged from
+@w{origin/master}. This is quite normal if files you have modified
+yourself have not yet been Pushed to @w{remote/origin/master} and
+Fetched, or if files modified and committed by others have been
+Fetched since you last Merged @w{origin/master} into your lily-local
+branch.
+
+If a file being merged from @w{origin/master} differs from
+one you have modified in a way that cannot be resolved
+automatically by git, Merge will report a Conflict
+which you must resolve by editing the file to create the
+version you wish to keep.
+
+This could happen if the person updating @w{remote/origin/master}
+for you has added some changes of his own before
+committing your changes to @w{remote/origin/master}, or if someone
+else has changed the same file since you last
+fetched the file from @w{remote/origin/master}.
+
+Open the file in your editor and look for sections which
+are delimited with ...
+
+[to be completed when I next have a merge conflict to be
+sure I give the right instructions -td]
+
+
+@subsection Other actions
+
+The instructions above describe the simplest way of using
+git on Windows. Other git facilities which may usefully
+supplement these include
+
+@itemize
+
+@item Using multiple local branches (Create, Rename, Delete)
+@item Resetting branches
+@item Cherry-picking commits
+@item Pushing commits to @w{remote/origin/master}
+@item Using gitk to review history
+
+@end itemize
+Once familiarity with using git on Windows has been gained the
+standard git manuals can be used to learn about these.
projects / lilypond.git / blobdiff