[FFmpeg-devel] [PATCH 2/5] doc/developer: Move codecs/formats checklist into Development Policy chapter

[softworkz]

From: softworkz <softworkz at hotmail.com>

Signed-off-by: softworkz <softworkz at hotmail.com>
---
 doc/developer.texi | 104 +++++++++++++++++++++++----------------------
 1 file changed, 53 insertions(+), 51 deletions(-)

diff --git a/doc/developer.texi b/doc/developer.texi
index 42e42350a5..a723d41f39 100644
--- a/doc/developer.texi
+++ b/doc/developer.texi
@@ -651,6 +651,59 @@ Removing previously deprecated APIs.
 Performing ABI- but not API-breaking changes, like reordering struct contents.
 @end itemize
 
+
+ 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 (and reset the micro version
+number) in @file{libavcodec/version.h} or @file{libavformat/version.h}?
+
+ at item
+Did you register it in @file{allcodecs.c} or @file{allformats.c}?
+
+ at item
+Did you add the AVCodecID to @file{codec_id.h}?
+When adding new codec IDs, also add an entry to the codec descriptor
+list in @file{libavcodec/codec_desc.c}.
+
+ 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
+ at file{doc/general_contents.texi}?
+
+ 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 @code{git add} the appropriate files before committing?
+
+ at item
+Did you make sure it compiles standalone, i.e. with
+ at code{configure --disable-everything --enable-decoder=foo}
+(or @code{--enable-demuxer} or whatever your component is)?
+ at end enumerate
+
+
 @section Documentation/Other
 @subheading Subscribe to the ffmpeg-devel mailing list.
 It is important to be subscribed to the
@@ -879,57 +932,6 @@ Give us a few days to react. But if some time passes without reaction,
 send a reminder by email. Your patch should eventually be dealt with.
 
 
- at chapter 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 (and reset the micro version
-number) in @file{libavcodec/version.h} or @file{libavformat/version.h}?
-
- at item
-Did you register it in @file{allcodecs.c} or @file{allformats.c}?
-
- at item
-Did you add the AVCodecID to @file{codec_id.h}?
-When adding new codec IDs, also add an entry to the codec descriptor
-list in @file{libavcodec/codec_desc.c}.
-
- 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
- at file{doc/general_contents.texi}?
-
- 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 @code{git add} the appropriate files before committing?
-
- at item
-Did you make sure it compiles standalone, i.e. with
- at code{configure --disable-everything --enable-decoder=foo}
-(or @code{--enable-demuxer} or whatever your component is)?
- at end enumerate
-
 
 @chapter Patch review process
 
-- 
ffmpeg-codebot