]> git.donarmstrong.com Git - lilypond.git/blobdiff - Documentation/devel/git-starting.itexi
Doc-fr: Learning Manual full update
[lilypond.git] / Documentation / devel / git-starting.itexi
index 07f63a09e39700b02bc7ccd6c4d23c0643cfe145..6d6d55e86c358c9155a7a7076dd6326e8bed44f2 100644 (file)
@@ -7,11 +7,12 @@ in this chapter, it may be a good idea to look for Git documentation
 at @uref{http://git-scm.com/documentation},
 
 @menu
-* Getting the source code::
-* Updating the source code::
-* Sharing your changes::
-* Advanced git stuff::
-* Git on Windows::
+* Getting the source code::     
+* Updating the source code::    
+* Sharing your changes::        
+* Advanced git stuff::          
+* Git on Windows::              
+* Development inside VirtualBox (compiling on Windows)::  
 @end menu
 
 
@@ -19,13 +20,13 @@ at @uref{http://git-scm.com/documentation},
 @section Getting the source code
 
 @menu
-* Git introduction::
-* Main source code::
-* Website source code::
-* Documentation translations source code::
-* Other branches::
-* Other locations for git::
-* Git user configuration::
+* 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
@@ -145,9 +146,9 @@ git config --global user.email MYEMAIL@@EXAMPLE.NET
 @section Updating the source code
 
 @menu
-* Importance of updating::
-* Update command::
-* Resolving conflicts::
+* Importance of updating::      
+* Update command::              
+* Resolving conflicts::         
 @end menu
 
 
@@ -193,8 +194,8 @@ resolve conflicts} in @command{git merge} man page.
 @section Sharing your changes
 
 @menu
-* Producing a patch::
-* Committing directly::
+* Producing a patch::           
+* Committing directly::         
 @end menu
 
 
@@ -214,10 +215,18 @@ git format-patch origin
 The commit should include a brief message describing the change.
 This consists of a one-line summary describing the change, and
 if necessary a blank line followed by several lines giving the
-details.
+details:
 
-If the change is to the documentation only the one-line summary
-should be prefixed with "Docs: ".
+@example
+Did household chores.
+
+I hung up the wet laundry and then washed the car.  I also
+vacuumed the floors, rinsed the dirty dishes, fed the cat, and
+recalibrated the temporal flux machine.
+@end example
+
+If the change is to the documentation only then the one-line
+summary should be prefixed with @qq{Docs: }.
 
 If you added a file to the source code, you must add it to git
 with:
@@ -232,7 +241,8 @@ git add FILENAME
 These commands will produce one or more files named
 @file{0001-xyz}, @file{0002-abc}, etc. in the top directory of the
 git tree.  Send an email to @email{lilypond-devel@@gnu.org} with
-these files attached.
+these files attached, and a developer will review and apply the
+patches to the main repository.
 
 
 @node Committing directly
@@ -256,10 +266,10 @@ url = ssh://@var{user}@@git.sv.gnu.org/srv/git/lilypond.git
 @noindent
 where @var{user} is your login name on Savannah.
 
-If you have not already done so, you should generate and upload a SSH
-key: open @uref{https://savannah.gnu.org/my/} in your browser, then go to
-@q{Preferences} then to something like @q{Edit SSH Keys}, and follow
-the instructions on that page.
+If you have not already done so, you should generate and upload a
+SSH key: open @uref{https://savannah.gnu.org/my/} in your browser,
+go to @q{Account Configuration}, then to something like
+@q{Edit SSH Keys}, and follow the instructions on that page.
 
 You may then:
 
@@ -267,6 +277,21 @@ You may then:
 git push origin
 @end example
 
+Note that recent versions of Git (Git 1.6.3 or later) will issue a
+big warning if the above command is used.  The simplest solution
+is to add a new section to @file{.git/config} that looks like
+this:
+
+@example
+[push]
+        default = matching
+@end example
+
+@noindent
+Then @code{git push origin} will work as before.  For more
+details, consult the @code{git push} man page.
+
+
 @node Advanced git stuff
 @section Advanced git stuff
 
@@ -284,11 +309,12 @@ Some Git commands are introduced first, then a workflow with several
 Git branches of LilyPond source code is presented.
 
 @menu
-* Introduction to Git concepts::
-* Git commands for managing several branches::
-* Working on LilyPond sources with several branches::
-* Git log::
-* Applying git patches::
+* Introduction to Git concepts::  
+* Git commands for managing several branches::  
+* Working on LilyPond sources with several branches::  
+* Git log::                     
+* Applying git patches::        
+* Reverting all local changes::  
 @end menu
 
 
@@ -502,7 +528,6 @@ order to apply pushed changes in the working tree of the main
 repository.
 
 
-
 @node Git log
 @subsection Git log
 
@@ -520,22 +545,45 @@ gitk        # shows history graphically
 @warning{The @code{gitk} command may require a separate @code{gitk} package,
 available in the appropriate distribution's repositories.}
 
+
 @node Applying git patches
 @subsection Applying git patches
 
-Well-formed git patches should be committed with
+Well-formed git patches created with @code{git format-patch}
+should be committed with the following command:
 
 @example
-git am
+git am @var{patch}
 @end example
 
-Patches created without @code{git format-patch} should be
-committed with
+Patches created without @code{git format-patch} can be applied in
+two steps.  The first step is to apply the patch to the working
+tree:
 
 @example
-git apply
+git apply @var{patch}
 @end example
 
+@noindent
+The second step is to commit the changes and give credit to the
+author of the patch.  This can be done with the following command:
+
+@example
+git commit -a --author="First Last <user@@example.net>"
+@end example
+
+
+@node Reverting all local changes
+@subsection Reverting all local changes
+
+Sometimes git will become hopelessly confused, and you just want
+to get back to a known, stable state.  This command destroys any
+local changes you have made, but at least you get back to the
+current online version:
+
+@example
+git reset --hard origin/master
+@end example
 
 
 @node Git on Windows
@@ -893,3 +941,11 @@ supplement these include
 
 Once familiarity with using git on Windows has been gained the
 standard git manuals can be used to learn about these.
+
+
+@node Development inside VirtualBox (compiling on Windows)
+@section Development inside VirtualBox (compiling on Windows)
+
+
+
+