[FFmpeg-devel] [PATCH v2 3/3] doc/developer.texi: Swapped patch checklist and new codec/format checklist.
Manolis Stamatogiannakis
mstamat at gmail.com
Mon Jul 13 00:53:01 EEST 2020
Adding a new codec/format should be more rare, so it makes sense
to come after the detailed patch submission checklist.
Signed-off-by: Manolis Stamatogiannakis <mstamat at gmail.com>
---
doc/developer.texi | 105 ++++++++++++++++++++++-----------------------
1 file changed, 52 insertions(+), 53 deletions(-)
diff --git a/doc/developer.texi b/doc/developer.texi
index c47d23e349..c482c5e09d 100644
--- a/doc/developer.texi
+++ b/doc/developer.texi
@@ -535,59 +535,6 @@ its @emph{roll-counter}. This is achieved by adding a @code{-v <n>} argument
to @code{git format-patch}/@code{git send-email} commands. While this is not
a strict requirement, it is a commonly followed good practice.
- at anchor{new codec format checklist}
- 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{avcodec.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.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
-
-
@anchor{patch submission checklist}
@section Patch submission checklist
@@ -710,6 +657,58 @@ Test your code with valgrind and or Address Sanitizer to ensure it's free
of leaks, out of array accesses, etc.
@end enumerate
+ at anchor{new codec format checklist}
+ 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{avcodec.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.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
All patches posted to ffmpeg-devel will be reviewed, unless they contain a
--
2.17.1
More information about the ffmpeg-devel
mailing list