lavf: fix documentation for avoid_negative_ts
[ffmpeg.git] / doc / git-howto.texi
index b01981e..44e1cc6 100644 (file)
@@ -1,9 +1,9 @@
 \input texinfo @c -*- texinfo -*-
 
-@settitle Using git to develop Libav
+@settitle Using git to develop FFmpeg
 
 @titlepage
-@center @titlefont{Using git to develop Libav}
+@center @titlefont{Using git to develop FFmpeg}
 @end titlepage
 
 @top
@@ -39,7 +39,7 @@ For more information about the Git project, visit the
 
 Consult these resources whenever you have problems, they are quite exhaustive.
 
-What follows now is a basic introduction to Git and some Libav-specific
+What follows now is a basic introduction to Git and some FFmpeg-specific
 guidelines to ease the contribution to the project
 
 @chapter Basics Usage
@@ -53,18 +53,26 @@ Most distribution and operating system provide a package for it.
 @section Cloning the source tree
 
 @example
-git clone git://git.libav.org/libav.git <target>
+git clone git://source.ffmpeg.org/ffmpeg <target>
 @end example
 
-This will put the Libav sources into the directory @var{<target>}.
+This will put the FFmpeg sources into the directory @var{<target>}.
 
 @example
-git clone git@@git.libav.org:libav.git <target>
+git clone git@@source.ffmpeg.org:ffmpeg <target>
 @end example
 
-This will put the Libav sources into the directory @var{<target>} and let
+This will put the FFmpeg sources into the directory @var{<target>} and let
 you push back your changes to the remote repository.
 
+Make sure that you do not have Windows line endings in your checkouts,
+otherwise you may experience spurious compilation failures. One way to
+achieve this is to run
+
+@example
+git config --global core.autocrlf false
+@end example
+
 
 @section Updating the source tree to the latest revision
 
@@ -77,7 +85,7 @@ can be remote. By default the master branch tracks the branch master in
 the remote origin.
 
 @float IMPORTANT
-Since merge commits are forbidden @command{--rebase} (see below) is recommended.
+@command{--rebase} (see below) is recommended.
 @end float
 
 @section Rebasing your local branches
@@ -88,7 +96,7 @@ git pull --rebase
 
 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
-Libav's master tree. The master tree will reject pushes with merge commits.
+FFmpeg's master tree. The master tree will reject pushes with merge commits.
 
 
 @section Adding/removing files/directories
@@ -119,7 +127,7 @@ git log <filename(s)>
 @end example
 
 You may also use the graphical tools like gitview or gitk or the web
-interface available at http://git.libav.org/
+interface available at http://source.ffmpeg.org/
 
 @section Checking source tree status
 
@@ -250,7 +258,33 @@ git commit
 @end example
 
 
-@chapter Libav specific
+@chapter Git configuration
+
+In order to simplify a few workflows, it is advisable to configure both
+your personal Git installation and your local FFmpeg repository.
+
+@section Personal Git installation
+
+Add the following to your @file{~/.gitconfig} to help @command{git send-email}
+and @command{git format-patch} detect renames:
+
+@example
+[diff]
+        renames = copy
+@end example
+
+@section Repository configuration
+
+In order to have @command{git send-email} automatically send patches
+to the ffmpeg-devel mailing list, add the following stanza
+to @file{/path/to/ffmpeg/repository/.git/config}:
+
+@example
+[sendemail]
+        to = ffmpeg-devel@@ffmpeg.org
+@end example
+
+@chapter FFmpeg specific
 
 @section Reverting broken commits
 
@@ -338,7 +372,44 @@ git checkout -b svn_23456 $SHA1
 
 where @var{$SHA1} is the commit hash from the @command{git log} output.
 
+
+@chapter pre-push checklist
+
+Once you have a set of commits that you feel are ready for pushing,
+work through the following checklist to doublecheck everything is in
+proper order. This list tries to be exhaustive. In case you are just
+pushing a typo in a comment, some of the steps may be unnecessary.
+Apply your common sense, but if in doubt, err on the side of caution.
+
+First, make sure that the commits and branches you are going to push
+match what you want pushed and that nothing is missing, extraneous or
+wrong. You can see what will be pushed by running the git push command
+with --dry-run first. And then inspecting the commits listed with
+@command{git log -p 1234567..987654}. The @command{git status} command
+may help in finding local changes that have been forgotten to be added.
+
+Next let the code pass through a full run of our testsuite.
+
+@itemize
+@item @command{make distclean}
+@item @command{/path/to/ffmpeg/configure}
+@item @command{make check}
+@item if fate fails due to missing samples run @command{make fate-rsync} and retry
+@end itemize
+
+Make sure all your changes have been checked before pushing them, the
+testsuite only checks against regressions and that only to some extend. It does
+obviously not check newly added features/code to be working unless you have
+added a test for that (which is recommended).
+
+Also note that every single commit should pass the test suite, not just
+the result of a series of patches.
+
+Once everything passed, push the changes to your public ffmpeg clone and post a
+merge request to ffmpeg-devel. You can also push them directly but this is not
+recommended.
+
 @chapter Server Issues
 
-Contact the project admins @email{git@@libav.org} if you have technical
+Contact the project admins @email{root@@ffmpeg.org} if you have technical
 problems with the GIT server.