]> git.sesse.net Git - ffmpeg/blobdiff - doc/developer.texi
lavf: replace all uses of url_fskip with avio_seek
[ffmpeg] / doc / developer.texi
index c8163529dcdf6f6d24d5d13a04cc87c01901fc1a..acffbe67e276ee16c216e9d57719c53e46e6bd77 100644 (file)
@@ -2,11 +2,12 @@
 
 @settitle Developer Documentation
 @titlepage
-@sp 7
 @center @titlefont{Developer Documentation}
-@sp 3
 @end titlepage
 
+@top
+
+@contents
 
 @chapter Developers Guide
 
@@ -83,9 +84,6 @@ format (see examples below) so that code documentation
 can be generated automatically. All nontrivial functions should have a comment
 above them explaining what the function does, even if it is just one sentence.
 All structures and their member variables should be documented, too.
-Impersonal form must be used for the function and parameter
-descriptions, e.g. "Set the bikeshed color." is favored over "Sets the
-bikeshed color.".
 @example
 /**
  * @@file mpeg.c
@@ -152,9 +150,9 @@ should also be avoided if they don't make the code easier to understand.
    Also if you have doubts about splitting or not splitting, do not hesitate to
    ask/discuss it on the developer mailing list.
 @item
-   Do not change behavior of the program (renaming options etc) without
-   first discussing it on the ffmpeg-devel mailing list. Do not remove
-   functionality from the code. Just improve!
+   Do not change behavior of the programs (renaming options etc) or public
+   API or ABI without first discussing it on the ffmpeg-devel mailing list.
+   Do not remove functionality from the code. Just improve!
 
    Note: Redundant code can be removed.
 @item
@@ -292,8 +290,8 @@ send a reminder by email. Your patch should eventually be dealt with.
     Did you add a long_name under NULL_IF_CONFIG_SMALL to the AVCodec or
     AVInputFormat/AVOutputFormat struct?
 @item
-    Did you bump the minor version number in @file{avcodec.h} or
-    @file{avformat.h}?
+    Did you bump the minor version number (and reset the micro version
+    number) in @file{avcodec.h} or @file{avformat.h}?
 @item
     Did you register it in @file{allcodecs.c} or @file{allformats.c}?
 @item
@@ -314,7 +312,7 @@ send a reminder by email. Your patch should eventually be dealt with.
     If it depends on a parser or a library, did you add that dependency in
     configure?
 @item
-    Did you "svn add" the appropriate files before commiting?
+    Did you "git add" the appropriate files before committing?
 @end enumerate
 
 @section patch submission checklist
@@ -327,7 +325,7 @@ send a reminder by email. Your patch should eventually be dealt with.
 @item
     Is the patch a unified diff?
 @item
-    Is the patch against latest FFmpeg SVN?
+    Is the patch against latest FFmpeg git master branch?
 @item
     Are you subscribed to ffmpeg-dev?
     (the list is subscribers only due to spam)
@@ -390,7 +388,7 @@ send a reminder by email. Your patch should eventually be dealt with.
 @section Patch review process
 
 All patches posted to ffmpeg-devel will be reviewed, unless they contain a
-clear note that the patch is not for SVN.
+clear note that the patch is not for the git master branch.
 Reviews and comments will be posted as replies to the patch on the
 mailing list. The patch submitter then has to take care of every comment,
 that can be by resubmitting a changed patch or by discussion. Resubmitted