Add a checklist about new codecs or formats to the documentation.
authorRamiro Polla <ramiro.polla@gmail.com>
Fri, 11 Jul 2008 00:59:27 +0000 (00:59 +0000)
committerRamiro Polla <ramiro.polla@gmail.com>
Fri, 11 Jul 2008 00:59:27 +0000 (00:59 +0000)
Originally committed as revision 14159 to svn://svn.ffmpeg.org/ffmpeg/trunk

doc/general.texi

index e235b761cd9bcc209bdbe4ccaf8b8c2359ca670b..dac41fbff26f81e20002d7755d2135071ddb6e19 100644 (file)
@@ -905,12 +905,6 @@ should also be avoided if they don't make the code easier to understand.
     (e.g. addition of a function to the public API).
     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.
 @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
@@ -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.
 
+@section New codecs or formats checklist
+
+@enumerate
+@item
+    Did you use av_cold for codec initialization and close functions?
+@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}?
+@item
+    Did you register it in @file{allcodecs.c} or @file{allformats.c}?
+@item
+    Did you add the CodecID to @file{avcodec.h}?
+@item
+    If it has a fourcc, did you add it to @file{libavformat/riff.c},
+    even if it is only a decoder?
+@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.
+@item
+    Did you add an entry to the table of supported formats or codecs in the
+    documentation?
+@item
+    Did you add an entry in the Changelog?
+@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?
+@end enumerate
+
 @section patch submission checklist
 
 @enumerate