From: softworkz <ffmpegagent@gmail.com> To: ffmpeg-devel@ffmpeg.org Cc: softworkz <softworkz@hotmail.com> Subject: [FFmpeg-devel] [PATCH 2/5] doc/developer: Move codecs/formats checklist into Development Policy chapter Date: Thu, 08 May 2025 10:22:26 +0000 Message-ID: <ae47e8bda02767c0d335f0cd2fb4aecab872b88f.1746699749.git.ffmpegagent@gmail.com> (raw) In-Reply-To: <pull.76.ffstaging.FFmpeg.1746699749.ffmpegagent@gmail.com> From: softworkz <softworkz@hotmail.com> Signed-off-by: softworkz <softworkz@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 + +@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 (and reset the micro version +number) in @file{libavcodec/version.h} or @file{libavformat/version.h}? + +@item +Did you register it in @file{allcodecs.c} or @file{allformats.c}? + +@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}. + +@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 +@file{doc/general_contents.texi}? + +@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 @code{git add} the appropriate files before committing? + +@item +Did you make sure it compiles standalone, i.e. with +@code{configure --disable-everything --enable-decoder=foo} +(or @code{--enable-demuxer} or whatever your component is)? +@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. -@chapter 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 (and reset the micro version -number) in @file{libavcodec/version.h} or @file{libavformat/version.h}? - -@item -Did you register it in @file{allcodecs.c} or @file{allformats.c}? - -@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}. - -@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 -@file{doc/general_contents.texi}? - -@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 @code{git add} the appropriate files before committing? - -@item -Did you make sure it compiles standalone, i.e. with -@code{configure --disable-everything --enable-decoder=foo} -(or @code{--enable-demuxer} or whatever your component is)? -@end enumerate - @chapter Patch review process -- ffmpeg-codebot _______________________________________________ ffmpeg-devel mailing list ffmpeg-devel@ffmpeg.org https://ffmpeg.org/mailman/listinfo/ffmpeg-devel To unsubscribe, visit link above, or email ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".
next prev parent reply other threads:[~2025-05-08 10:23 UTC|newest] Thread overview: 22+ messages / expand[flat|nested] mbox.gz Atom feed top 2025-05-08 10:22 [FFmpeg-devel] [PATCH 0/5] doc/developer: Add subsection about patch submission via FFstaging ffmpegagent 2025-05-08 10:22 ` [FFmpeg-devel] [PATCH 1/5] doc/developer: Move checklist into Submitting Patches chapter softworkz 2025-05-08 10:22 ` softworkz [this message] 2025-05-08 10:22 ` [FFmpeg-devel] [PATCH 3/5] doc/developer: Reorder Submission procedures content softworkz 2025-05-08 10:22 ` [FFmpeg-devel] [PATCH 4/5] doc/developer: Merge Review paragraphs and deduplicate softworkz 2025-05-08 10:22 ` [FFmpeg-devel] [PATCH 5/5] doc/developer: Add subsection about patch submission via FFstaging softworkz 2025-05-08 12:40 ` James Almer 2025-05-08 12:55 ` softworkz . 2025-05-08 11:13 ` [FFmpeg-devel] [PATCH 0/5] " softworkz . 2025-05-08 11:20 ` Lynne 2025-05-08 11:33 ` softworkz . 2025-05-08 11:59 ` Lynne 2025-05-08 12:26 ` softworkz . 2025-05-08 12:36 ` Lynne 2025-05-08 12:47 ` Nicolas George 2025-05-08 13:12 ` softworkz . 2025-05-09 10:17 ` softworkz . 2025-05-13 18:05 ` [FFmpeg-devel] [PATCH v2 0/4] doc/developer: Restructure docs about patch submission ffmpegagent 2025-05-13 18:05 ` [FFmpeg-devel] [PATCH v2 1/4] doc/developer: Move checklist into Submitting Patches chapter softworkz 2025-05-13 18:05 ` [FFmpeg-devel] [PATCH v2 2/4] doc/developer: Move codecs/formats checklist into Development Policy chapter softworkz 2025-05-13 18:05 ` [FFmpeg-devel] [PATCH v2 3/4] doc/developer: Reorder Submission procedures content softworkz 2025-05-13 18:05 ` [FFmpeg-devel] [PATCH v2 4/4] doc/developer: Merge Review paragraphs and deduplicate softworkz
Reply instructions: You may reply publicly to this message via plain-text email using any one of the following methods: * Save the following mbox file, import it into your mail client, and reply-to-all from there: mbox Avoid top-posting and favor interleaved quoting: https://en.wikipedia.org/wiki/Posting_style#Interleaved_style * Reply using the --to, --cc, and --in-reply-to switches of git-send-email(1): git send-email \ --in-reply-to=ae47e8bda02767c0d335f0cd2fb4aecab872b88f.1746699749.git.ffmpegagent@gmail.com \ --to=ffmpegagent@gmail.com \ --cc=ffmpeg-devel@ffmpeg.org \ --cc=softworkz@hotmail.com \ /path/to/YOUR_REPLY https://kernel.org/pub/software/scm/git/docs/git-send-email.html * If your mail client supports setting the In-Reply-To header via mailto: links, try the mailto: link
Git Inbox Mirror of the ffmpeg-devel mailing list - see https://ffmpeg.org/mailman/listinfo/ffmpeg-devel This inbox may be cloned and mirrored by anyone: git clone --mirror https://master.gitmailbox.com/ffmpegdev/0 ffmpegdev/git/0.git # If you have public-inbox 1.1+ installed, you may # initialize and index your mirror using the following commands: public-inbox-init -V2 ffmpegdev ffmpegdev/ https://master.gitmailbox.com/ffmpegdev \ ffmpegdev@gitmailbox.com public-inbox-index ffmpegdev Example config snippet for mirrors. AGPL code for this site: git clone https://public-inbox.org/public-inbox.git