amix: fix format specifier for AVFilterLink.sample_rate.
[ffmpeg.git] / doc / git-howto.txt
index c6cbc2b..036b567 100644 (file)
@@ -28,9 +28,9 @@ Consult these resources whenever you have problems, they are quite exhaustive.
 You do not need a special username or password.
 All you need is to provide a ssh public key to the Git server admin.
 
-What follows now is a basic introduction to Git and some FFmpeg-specific
+What follows now is a basic introduction to Git and some Libav-specific
 guidelines. Read it at least once, if you are granted commit privileges to the
-FFmpeg project you are expected to be familiar with these rules.
+Libav project you are expected to be familiar with these rules.
 
 
 
@@ -46,11 +46,11 @@ I. BASICS:
 
     git clone git://git.libav.org/libav.git <target>
 
-  This will put the FFmpeg sources into the directory <target>.
+  This will put the Libav sources into the directory <target>.
 
     git clone git@git.libav.org:libav.git <target>
 
-  This will put the FFmpeg sources into the directory <target> and let
+  This will put the Libav sources into the directory <target> and let
   you push back your changes to the remote repository.
 
 
@@ -72,7 +72,7 @@ I. BASICS:
 
   fetches the changes from the main repository and replays your local commits
   over it. This is required to keep all your local changes at the top of
-  FFmpeg's master tree. The master tree will reject pushes with merge commits.
+  Libav's master tree. The master tree will reject pushes with merge commits.
 
 
 3. Adding/removing files/directories:
@@ -120,7 +120,7 @@ I. BASICS:
 
   For cosmetics-only commits you should get (almost) empty output from
 
-    git diff -wb <filename(s)>
+    git diff -w -b <filename(s)>
 
   Also check the output of
 
@@ -205,8 +205,19 @@ I. BASICS:
 
     git format-patch <commit> [-o directory]
 
-  will generate a set of patches out of the current branch starting from
-  commit. By default the patches are created in the current directory.
+  will generate a set of patches for each commit between <commit> and
+  current HEAD. E.g.
+
+    git format-patch origin/master
+
+  will generate patches for all commits on current branch which are not
+  present in upstream.
+  A useful shortcut is also
+
+    git format-patch -n
+
+  which will generate patches from last n commits.
+  By default the patches are created in the current directory.
 
 11. Sending patches for review
 
@@ -215,6 +226,8 @@ I. BASICS:
   will send the patches created by git format-patch or directly generates
   them. All the email fields can be configured in the global/local
   configuration or overridden by command line.
+  Note that this tool must often be installed separately (e.g. git-email
+  package on Debian-based distros).
 
 12. Pushing changes to remote trees