@settitle Developer Documentation
@titlepage
-@sp 7
@center @titlefont{Developer Documentation}
-@sp 3
@end titlepage
+@top
+
+@contents
@chapter Developers Guide
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
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
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
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
@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)
@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