[FFmpeg-cvslog] r14159 - trunk/doc/general.texi

[ramiro]

Author: ramiro
Date: Fri Jul 11 02:59:27 2008
New Revision: 14159

Log:
Add a checklist about new codecs or formats to the documentation.

Modified:
   trunk/doc/general.texi

Modified: trunk/doc/general.texi
==============================================================================
--- trunk/doc/general.texi	(original)
+++ trunk/doc/general.texi	Fri Jul 11 02:59:27 2008
@@ -906,12 +906,6 @@ should also be avoided if they don't mak
     Incrementing the third component means a noteworthy binary compatible
     change (e.g. encoder bug fix that matters for the decoder).
 @item
-    If you add a new codec, remember to update the changelog, add it to
-    the supported codecs table in the documentation and bump the second
-    component of the @file{libavcodec} version number appropriately. If
-    it has a fourcc, add it to @file{libavformat/riff.c}, even if it
-    is only a decoder.
- at item
     Compiler warnings indicate potential bugs or code with bad style. If a type of
     warning always points to correct and clean code, that warning should
     be disabled, not the code changed.
@@ -957,6 +951,40 @@ and has no lrint()')
 Also please if you send several patches, send each patch as a separate mail,
 do not attach several unrelated patches to the same mail.
 
+ at section New codecs or formats checklist
+
+ at enumerate
+ at item
+    Did you use av_cold for codec initialization and close functions?
+ at item
+    Did you add a long_name under NULL_IF_CONFIG_SMALL to the AVCodec or
+    AVInputFormat/AVOutputFormat struct?
+ at item
+    Did you bump the minor version number in @file{avcodec.h} or
+    @file{avformat.h}?
+ at item
+    Did you register it in @file{allcodecs.c} or @file{allformats.c}?
+ at item
+    Did you add the CodecID to @file{avcodec.h}?
+ at item
+    If it has a fourcc, did you add it to @file{libavformat/riff.c},
+    even if it is only a decoder?
+ at item
+    Did you add a rule to compile the appropriate files in the Makefile?
+    Remember to do this even if you're just adding a format to a file that is
+    already being compiled by some other rule, like a raw demuxer.
+ at item
+    Did you add an entry to the table of supported formats or codecs in the
+    documentation?
+ at item
+    Did you add an entry in the Changelog?
+ at item
+    If it depends on a parser or a library, did you add that dependency in
+    configure?
+ at item
+    Did you "svn add" the appropriate files before commiting?
+ at end enumerate
+
 @section patch submission checklist
 
 @enumerate