yading@10: \input texinfo @c -*- texinfo -*- yading@10: yading@10: @settitle Developer Documentation yading@10: @titlepage yading@10: @center @titlefont{Developer Documentation} yading@10: @end titlepage yading@10: yading@10: @top yading@10: yading@10: @contents yading@10: yading@10: @chapter Developers Guide yading@10: yading@10: @section API yading@10: @itemize @bullet yading@10: @item libavcodec is the library containing the codecs (both encoding and yading@10: decoding). Look at @file{doc/examples/decoding_encoding.c} to see how to use yading@10: it. yading@10: yading@10: @item libavformat is the library containing the file format handling (mux and yading@10: demux code for several formats). Look at @file{ffplay.c} to use it in a yading@10: player. See @file{doc/examples/muxing.c} to use it to generate audio or video yading@10: streams. yading@10: yading@10: @end itemize yading@10: yading@10: @section Integrating libavcodec or libavformat in your program yading@10: yading@10: You can integrate all the source code of the libraries to link them yading@10: statically to avoid any version problem. All you need is to provide a yading@10: 'config.mak' and a 'config.h' in the parent directory. See the defines yading@10: generated by ./configure to understand what is needed. yading@10: yading@10: You can use libavcodec or libavformat in your commercial program, but yading@10: @emph{any patch you make must be published}. The best way to proceed is yading@10: to send your patches to the FFmpeg mailing list. yading@10: yading@10: @section Contributing yading@10: yading@10: There are 3 ways by which code gets into ffmpeg. yading@10: @itemize @bullet yading@10: @item Submitting Patches to the main developer mailing list yading@10: see @ref{Submitting patches} for details. yading@10: @item Directly committing changes to the main tree. yading@10: @item Committing changes to a git clone, for example on github.com or yading@10: gitorious.org. And asking us to merge these changes. yading@10: @end itemize yading@10: yading@10: Whichever way, changes should be reviewed by the maintainer of the code yading@10: before they are committed. And they should follow the @ref{Coding Rules}. yading@10: The developer making the commit and the author are responsible for their changes yading@10: and should try to fix issues their commit causes. yading@10: yading@10: @anchor{Coding Rules} yading@10: @section Coding Rules yading@10: yading@10: @subsection Code formatting conventions yading@10: yading@10: There are the following guidelines regarding the indentation in files: yading@10: @itemize @bullet yading@10: @item yading@10: Indent size is 4. yading@10: @item yading@10: The TAB character is forbidden outside of Makefiles as is any yading@10: form of trailing whitespace. Commits containing either will be yading@10: rejected by the git repository. yading@10: @item yading@10: You should try to limit your code lines to 80 characters; however, do so if yading@10: and only if this improves readability. yading@10: @end itemize yading@10: The presentation is one inspired by 'indent -i4 -kr -nut'. yading@10: yading@10: The main priority in FFmpeg is simplicity and small code size in order to yading@10: minimize the bug count. yading@10: yading@10: @subsection Comments yading@10: Use the JavaDoc/Doxygen format (see examples below) so that code documentation yading@10: can be generated automatically. All nontrivial functions should have a comment yading@10: above them explaining what the function does, even if it is just one sentence. yading@10: All structures and their member variables should be documented, too. yading@10: yading@10: Avoid Qt-style and similar Doxygen syntax with @code{!} in it, i.e. replace yading@10: @code{//!} with @code{///} and similar. Also @@ syntax should be employed yading@10: for markup commands, i.e. use @code{@@param} and not @code{\param}. yading@10: yading@10: @example yading@10: /** yading@10: * @@file yading@10: * MPEG codec. yading@10: * @@author ... yading@10: */ yading@10: yading@10: /** yading@10: * Summary sentence. yading@10: * more text ... yading@10: * ... yading@10: */ yading@10: typedef struct Foobar@{ yading@10: int var1; /**< var1 description */ yading@10: int var2; ///< var2 description yading@10: /** var3 description */ yading@10: int var3; yading@10: @} Foobar; yading@10: yading@10: /** yading@10: * Summary sentence. yading@10: * more text ... yading@10: * ... yading@10: * @@param my_parameter description of my_parameter yading@10: * @@return return value description yading@10: */ yading@10: int myfunc(int my_parameter) yading@10: ... yading@10: @end example yading@10: yading@10: @subsection C language features yading@10: yading@10: FFmpeg is programmed in the ISO C90 language with a few additional yading@10: features from ISO C99, namely: yading@10: @itemize @bullet yading@10: @item yading@10: the @samp{inline} keyword; yading@10: @item yading@10: @samp{//} comments; yading@10: @item yading@10: designated struct initializers (@samp{struct s x = @{ .i = 17 @};}) yading@10: @item yading@10: compound literals (@samp{x = (struct s) @{ 17, 23 @};}) yading@10: @end itemize yading@10: yading@10: These features are supported by all compilers we care about, so we will not yading@10: accept patches to remove their use unless they absolutely do not impair yading@10: clarity and performance. yading@10: yading@10: All code must compile with recent versions of GCC and a number of other yading@10: currently supported compilers. To ensure compatibility, please do not use yading@10: additional C99 features or GCC extensions. Especially watch out for: yading@10: @itemize @bullet yading@10: @item yading@10: mixing statements and declarations; yading@10: @item yading@10: @samp{long long} (use @samp{int64_t} instead); yading@10: @item yading@10: @samp{__attribute__} not protected by @samp{#ifdef __GNUC__} or similar; yading@10: @item yading@10: GCC statement expressions (@samp{(x = (@{ int y = 4; y; @})}). yading@10: @end itemize yading@10: yading@10: @subsection Naming conventions yading@10: All names should be composed with underscores (_), not CamelCase. For example, yading@10: @samp{avfilter_get_video_buffer} is an acceptable function name and yading@10: @samp{AVFilterGetVideo} is not. The exception from this are type names, like yading@10: for example structs and enums; they should always be in the CamelCase yading@10: yading@10: There are the following conventions for naming variables and functions: yading@10: @itemize @bullet yading@10: @item yading@10: For local variables no prefix is required. yading@10: @item yading@10: For file-scope variables and functions declared as @code{static}, no prefix yading@10: is required. yading@10: @item yading@10: For variables and functions visible outside of file scope, but only used yading@10: internally by a library, an @code{ff_} prefix should be used, yading@10: e.g. @samp{ff_w64_demuxer}. yading@10: @item yading@10: For variables and functions visible outside of file scope, used internally yading@10: across multiple libraries, use @code{avpriv_} as prefix, for example, yading@10: @samp{avpriv_aac_parse_header}. yading@10: @item yading@10: Each library has its own prefix for public symbols, in addition to the yading@10: commonly used @code{av_} (@code{avformat_} for libavformat, yading@10: @code{avcodec_} for libavcodec, @code{swr_} for libswresample, etc). yading@10: Check the existing code and choose names accordingly. yading@10: Note that some symbols without these prefixes are also exported for yading@10: retro-compatibility reasons. These exceptions are declared in the yading@10: @code{lib/lib.v} files. yading@10: @end itemize yading@10: yading@10: Furthermore, name space reserved for the system should not be invaded. yading@10: Identifiers ending in @code{_t} are reserved by yading@10: @url{http://pubs.opengroup.org/onlinepubs/007904975/functions/xsh_chap02_02.html#tag_02_02_02, POSIX}. yading@10: Also avoid names starting with @code{__} or @code{_} followed by an uppercase yading@10: letter as they are reserved by the C standard. Names starting with @code{_} yading@10: are reserved at the file level and may not be used for externally visible yading@10: symbols. If in doubt, just avoid names starting with @code{_} altogether. yading@10: yading@10: @subsection Miscellaneous conventions yading@10: @itemize @bullet yading@10: @item yading@10: fprintf and printf are forbidden in libavformat and libavcodec, yading@10: please use av_log() instead. yading@10: @item yading@10: Casts should be used only when necessary. Unneeded parentheses yading@10: should also be avoided if they don't make the code easier to understand. yading@10: @end itemize yading@10: yading@10: @subsection Editor configuration yading@10: In order to configure Vim to follow FFmpeg formatting conventions, paste yading@10: the following snippet into your @file{.vimrc}: yading@10: @example yading@10: " indentation rules for FFmpeg: 4 spaces, no tabs yading@10: set expandtab yading@10: set shiftwidth=4 yading@10: set softtabstop=4 yading@10: set cindent yading@10: set cinoptions=(0 yading@10: " Allow tabs in Makefiles. yading@10: autocmd FileType make,automake set noexpandtab shiftwidth=8 softtabstop=8 yading@10: " Trailing whitespace and tabs are forbidden, so highlight them. yading@10: highlight ForbiddenWhitespace ctermbg=red guibg=red yading@10: match ForbiddenWhitespace /\s\+$\|\t/ yading@10: " Do not highlight spaces at the end of line while typing on that line. yading@10: autocmd InsertEnter * match ForbiddenWhitespace /\t\|\s\+\%#\@@ 5 lines) chunk of code, yading@10: then either do NOT change the indentation of the inner part within (do not yading@10: move it to the right)! or do so in a separate commit yading@10: @item yading@10: Always fill out the commit log message. Describe in a few lines what you yading@10: changed and why. You can refer to mailing list postings if you fix a yading@10: particular bug. Comments such as "fixed!" or "Changed it." are unacceptable. yading@10: Recommended format: yading@10: area changed: Short 1 line description yading@10: yading@10: details describing what and why and giving references. yading@10: @item yading@10: Make sure the author of the commit is set correctly. (see git commit --author) yading@10: If you apply a patch, send an yading@10: answer to ffmpeg-devel (or wherever you got the patch from) saying that yading@10: you applied the patch. yading@10: @item yading@10: When applying patches that have been discussed (at length) on the mailing yading@10: list, reference the thread in the log message. yading@10: @item yading@10: Do NOT commit to code actively maintained by others without permission. yading@10: Send a patch to ffmpeg-devel instead. If no one answers within a reasonable yading@10: timeframe (12h for build failures and security fixes, 3 days small changes, yading@10: 1 week for big patches) then commit your patch if you think it is OK. yading@10: Also note, the maintainer can simply ask for more time to review! yading@10: @item yading@10: Subscribe to the ffmpeg-cvslog mailing list. The diffs of all commits yading@10: are sent there and reviewed by all the other developers. Bugs and possible yading@10: improvements or general questions regarding commits are discussed there. We yading@10: expect you to react if problems with your code are uncovered. yading@10: @item yading@10: Update the documentation if you change behavior or add features. If you are yading@10: unsure how best to do this, send a patch to ffmpeg-devel, the documentation yading@10: maintainer(s) will review and commit your stuff. yading@10: @item yading@10: Try to keep important discussions and requests (also) on the public yading@10: developer mailing list, so that all developers can benefit from them. yading@10: @item yading@10: Never write to unallocated memory, never write over the end of arrays, yading@10: always check values read from some untrusted source before using them yading@10: as array index or other risky things. yading@10: @item yading@10: Remember to check if you need to bump versions for the specific libav* yading@10: parts (libavutil, libavcodec, libavformat) you are changing. You need yading@10: to change the version integer. yading@10: Incrementing the first component means no backward compatibility to yading@10: previous versions (e.g. removal of a function from the public API). yading@10: Incrementing the second component means backward compatible change yading@10: (e.g. addition of a function to the public API or extension of an yading@10: existing data structure). yading@10: Incrementing the third component means a noteworthy binary compatible yading@10: change (e.g. encoder bug fix that matters for the decoder). The third yading@10: component always starts at 100 to distinguish FFmpeg from Libav. yading@10: @item yading@10: Compiler warnings indicate potential bugs or code with bad style. If a type of yading@10: warning always points to correct and clean code, that warning should yading@10: be disabled, not the code changed. yading@10: Thus the remaining warnings can either be bugs or correct code. yading@10: If it is a bug, the bug has to be fixed. If it is not, the code should yading@10: be changed to not generate a warning unless that causes a slowdown yading@10: or obfuscates the code. yading@10: @item yading@10: If you add a new file, give it a proper license header. Do not copy and yading@10: paste it from a random place, use an existing file as template. yading@10: @end enumerate yading@10: yading@10: We think our rules are not too hard. If you have comments, contact us. yading@10: yading@10: @anchor{Submitting patches} yading@10: @section Submitting patches yading@10: yading@10: First, read the @ref{Coding Rules} above if you did not yet, in particular yading@10: the rules regarding patch submission. yading@10: yading@10: When you submit your patch, please use @code{git format-patch} or yading@10: @code{git send-email}. We cannot read other diffs :-) yading@10: yading@10: Also please do not submit a patch which contains several unrelated changes. yading@10: Split it into separate, self-contained pieces. This does not mean splitting yading@10: file by file. Instead, make the patch as small as possible while still yading@10: keeping it as a logical unit that contains an individual change, even yading@10: if it spans multiple files. This makes reviewing your patches much easier yading@10: for us and greatly increases your chances of getting your patch applied. yading@10: yading@10: Use the patcheck tool of FFmpeg to check your patch. yading@10: The tool is located in the tools directory. yading@10: yading@10: Run the @ref{Regression tests} before submitting a patch in order to verify yading@10: it does not cause unexpected problems. yading@10: yading@10: It also helps quite a bit if you tell us what the patch does (for example yading@10: 'replaces lrint by lrintf'), and why (for example '*BSD isn't C99 compliant yading@10: and has no lrint()') yading@10: yading@10: Also please if you send several patches, send each patch as a separate mail, yading@10: do not attach several unrelated patches to the same mail. yading@10: yading@10: Patches should be posted to the yading@10: @uref{http://lists.ffmpeg.org/mailman/listinfo/ffmpeg-devel, ffmpeg-devel} yading@10: mailing list. Use @code{git send-email} when possible since it will properly yading@10: send patches without requiring extra care. If you cannot, then send patches yading@10: as base64-encoded attachments, so your patch is not trashed during yading@10: transmission. yading@10: yading@10: Your patch will be reviewed on the mailing list. You will likely be asked yading@10: to make some changes and are expected to send in an improved version that yading@10: incorporates the requests from the review. This process may go through yading@10: several iterations. Once your patch is deemed good enough, some developer yading@10: will pick it up and commit it to the official FFmpeg tree. yading@10: yading@10: Give us a few days to react. But if some time passes without reaction, yading@10: send a reminder by email. Your patch should eventually be dealt with. yading@10: yading@10: yading@10: @section New codecs or formats checklist yading@10: yading@10: @enumerate yading@10: @item yading@10: Did you use av_cold for codec initialization and close functions? yading@10: @item yading@10: Did you add a long_name under NULL_IF_CONFIG_SMALL to the AVCodec or yading@10: AVInputFormat/AVOutputFormat struct? yading@10: @item yading@10: Did you bump the minor version number (and reset the micro version yading@10: number) in @file{libavcodec/version.h} or @file{libavformat/version.h}? yading@10: @item yading@10: Did you register it in @file{allcodecs.c} or @file{allformats.c}? yading@10: @item yading@10: Did you add the AVCodecID to @file{avcodec.h}? yading@10: When adding new codec IDs, also add an entry to the codec descriptor yading@10: list in @file{libavcodec/codec_desc.c}. yading@10: @item yading@10: If it has a FourCC, did you add it to @file{libavformat/riff.c}, yading@10: even if it is only a decoder? yading@10: @item yading@10: Did you add a rule to compile the appropriate files in the Makefile? yading@10: Remember to do this even if you're just adding a format to a file that is yading@10: already being compiled by some other rule, like a raw demuxer. yading@10: @item yading@10: Did you add an entry to the table of supported formats or codecs in yading@10: @file{doc/general.texi}? yading@10: @item yading@10: Did you add an entry in the Changelog? yading@10: @item yading@10: If it depends on a parser or a library, did you add that dependency in yading@10: configure? yading@10: @item yading@10: Did you @code{git add} the appropriate files before committing? yading@10: @item yading@10: Did you make sure it compiles standalone, i.e. with yading@10: @code{configure --disable-everything --enable-decoder=foo} yading@10: (or @code{--enable-demuxer} or whatever your component is)? yading@10: @end enumerate yading@10: yading@10: yading@10: @section patch submission checklist yading@10: yading@10: @enumerate yading@10: @item yading@10: Does @code{make fate} pass with the patch applied? yading@10: @item yading@10: Was the patch generated with git format-patch or send-email? yading@10: @item yading@10: Did you sign off your patch? (git commit -s) yading@10: See @url{http://git.kernel.org/?p=linux/kernel/git/torvalds/linux.git;a=blob_plain;f=Documentation/SubmittingPatches} for the meaning yading@10: of sign off. yading@10: @item yading@10: Did you provide a clear git commit log message? yading@10: @item yading@10: Is the patch against latest FFmpeg git master branch? yading@10: @item yading@10: Are you subscribed to ffmpeg-devel? yading@10: (the list is subscribers only due to spam) yading@10: @item yading@10: Have you checked that the changes are minimal, so that the same cannot be yading@10: achieved with a smaller patch and/or simpler final code? yading@10: @item yading@10: If the change is to speed critical code, did you benchmark it? yading@10: @item yading@10: If you did any benchmarks, did you provide them in the mail? yading@10: @item yading@10: Have you checked that the patch does not introduce buffer overflows or yading@10: other security issues? yading@10: @item yading@10: Did you test your decoder or demuxer against damaged data? If no, see yading@10: tools/trasher, the noise bitstream filter, and yading@10: @uref{http://caca.zoy.org/wiki/zzuf, zzuf}. Your decoder or demuxer yading@10: should not crash, end in a (near) infinite loop, or allocate ridiculous yading@10: amounts of memory when fed damaged data. yading@10: @item yading@10: Does the patch not mix functional and cosmetic changes? yading@10: @item yading@10: Did you add tabs or trailing whitespace to the code? Both are forbidden. yading@10: @item yading@10: Is the patch attached to the email you send? yading@10: @item yading@10: Is the mime type of the patch correct? It should be text/x-diff or yading@10: text/x-patch or at least text/plain and not application/octet-stream. yading@10: @item yading@10: If the patch fixes a bug, did you provide a verbose analysis of the bug? yading@10: @item yading@10: If the patch fixes a bug, did you provide enough information, including yading@10: a sample, so the bug can be reproduced and the fix can be verified? yading@10: Note please do not attach samples >100k to mails but rather provide a yading@10: URL, you can upload to ftp://upload.ffmpeg.org yading@10: @item yading@10: Did you provide a verbose summary about what the patch does change? yading@10: @item yading@10: Did you provide a verbose explanation why it changes things like it does? yading@10: @item yading@10: Did you provide a verbose summary of the user visible advantages and yading@10: disadvantages if the patch is applied? yading@10: @item yading@10: Did you provide an example so we can verify the new feature added by the yading@10: patch easily? yading@10: @item yading@10: If you added a new file, did you insert a license header? It should be yading@10: taken from FFmpeg, not randomly copied and pasted from somewhere else. yading@10: @item yading@10: You should maintain alphabetical order in alphabetically ordered lists as yading@10: long as doing so does not break API/ABI compatibility. yading@10: @item yading@10: Lines with similar content should be aligned vertically when doing so yading@10: improves readability. yading@10: @item yading@10: Consider to add a regression test for your code. yading@10: @item yading@10: If you added YASM code please check that things still work with --disable-yasm yading@10: @item yading@10: Make sure you check the return values of function and return appropriate yading@10: error codes. Especially memory allocation functions like @code{av_malloc()} yading@10: are notoriously left unchecked, which is a serious problem. yading@10: @item yading@10: Test your code with valgrind and or Address Sanitizer to ensure it's free yading@10: of leaks, out of array accesses, etc. yading@10: @end enumerate yading@10: yading@10: @section Patch review process yading@10: yading@10: All patches posted to ffmpeg-devel will be reviewed, unless they contain a yading@10: clear note that the patch is not for the git master branch. yading@10: Reviews and comments will be posted as replies to the patch on the yading@10: mailing list. The patch submitter then has to take care of every comment, yading@10: that can be by resubmitting a changed patch or by discussion. Resubmitted yading@10: patches will themselves be reviewed like any other patch. If at some point yading@10: a patch passes review with no comments then it is approved, that can for yading@10: simple and small patches happen immediately while large patches will generally yading@10: have to be changed and reviewed many times before they are approved. yading@10: After a patch is approved it will be committed to the repository. yading@10: yading@10: We will review all submitted patches, but sometimes we are quite busy so yading@10: especially for large patches this can take several weeks. yading@10: yading@10: If you feel that the review process is too slow and you are willing to try to yading@10: take over maintainership of the area of code you change then just clone yading@10: git master and maintain the area of code there. We will merge each area from yading@10: where its best maintained. yading@10: yading@10: When resubmitting patches, please do not make any significant changes yading@10: not related to the comments received during review. Such patches will yading@10: be rejected. Instead, submit significant changes or new features as yading@10: separate patches. yading@10: yading@10: @anchor{Regression tests} yading@10: @section Regression tests yading@10: yading@10: Before submitting a patch (or committing to the repository), you should at least yading@10: test that you did not break anything. yading@10: yading@10: Running 'make fate' accomplishes this, please see @url{fate.html} for details. yading@10: yading@10: [Of course, some patches may change the results of the regression tests. In yading@10: this case, the reference results of the regression tests shall be modified yading@10: accordingly]. yading@10: yading@10: @subsection Adding files to the fate-suite dataset yading@10: yading@10: When there is no muxer or encoder available to generate test media for a yading@10: specific test then the media has to be inlcuded in the fate-suite. yading@10: First please make sure that the sample file is as small as possible to test the yading@10: respective decoder or demuxer sufficiently. Large files increase network yading@10: bandwidth and disk space requirements. yading@10: Once you have a working fate test and fate sample, provide in the commit yading@10: message or introductionary message for the patch series that you post to yading@10: the ffmpeg-devel mailing list, a direct link to download the sample media. yading@10: yading@10: yading@10: @subsection Visualizing Test Coverage yading@10: yading@10: The FFmpeg build system allows visualizing the test coverage in an easy yading@10: manner with the coverage tools @code{gcov}/@code{lcov}. This involves yading@10: the following steps: yading@10: yading@10: @enumerate yading@10: @item yading@10: Configure to compile with instrumentation enabled: yading@10: @code{configure --toolchain=gcov}. yading@10: @item yading@10: Run your test case, either manually or via FATE. This can be either yading@10: the full FATE regression suite, or any arbitrary invocation of any yading@10: front-end tool provided by FFmpeg, in any combination. yading@10: @item yading@10: Run @code{make lcov} to generate coverage data in HTML format. yading@10: @item yading@10: View @code{lcov/index.html} in your preferred HTML viewer. yading@10: @end enumerate yading@10: yading@10: You can use the command @code{make lcov-reset} to reset the coverage yading@10: measurements. You will need to rerun @code{make lcov} after running a yading@10: new test. yading@10: yading@10: @anchor{Release process} yading@10: @section Release process yading@10: yading@10: FFmpeg maintains a set of @strong{release branches}, which are the yading@10: recommended deliverable for system integrators and distributors (such as yading@10: Linux distributions, etc.). At regular times, a @strong{release yading@10: manager} prepares, tests and publishes tarballs on the yading@10: @url{http://ffmpeg.org} website. yading@10: yading@10: There are two kinds of releases: yading@10: yading@10: @enumerate yading@10: @item yading@10: @strong{Major releases} always include the latest and greatest yading@10: features and functionality. yading@10: @item yading@10: @strong{Point releases} are cut from @strong{release} branches, yading@10: which are named @code{release/X}, with @code{X} being the release yading@10: version number. yading@10: @end enumerate yading@10: yading@10: Note that we promise to our users that shared libraries from any FFmpeg yading@10: release never break programs that have been @strong{compiled} against yading@10: previous versions of @strong{the same release series} in any case! yading@10: yading@10: However, from time to time, we do make API changes that require adaptations yading@10: in applications. Such changes are only allowed in (new) major releases and yading@10: require further steps such as bumping library version numbers and/or yading@10: adjustments to the symbol versioning file. Please discuss such changes yading@10: on the @strong{ffmpeg-devel} mailing list in time to allow forward planning. yading@10: yading@10: @anchor{Criteria for Point Releases} yading@10: @subsection Criteria for Point Releases yading@10: yading@10: Changes that match the following criteria are valid candidates for yading@10: inclusion into a point release: yading@10: yading@10: @enumerate yading@10: @item yading@10: Fixes a security issue, preferably identified by a @strong{CVE yading@10: number} issued by @url{http://cve.mitre.org/}. yading@10: @item yading@10: Fixes a documented bug in @url{https://ffmpeg.org/trac/ffmpeg}. yading@10: @item yading@10: Improves the included documentation. yading@10: @item yading@10: Retains both source code and binary compatibility with previous yading@10: point releases of the same release branch. yading@10: @end enumerate yading@10: yading@10: The order for checking the rules is (1 OR 2 OR 3) AND 4. yading@10: yading@10: yading@10: @subsection Release Checklist yading@10: yading@10: The release process involves the following steps: yading@10: yading@10: @enumerate yading@10: @item yading@10: Ensure that the @file{RELEASE} file contains the version number for yading@10: the upcoming release. yading@10: @item yading@10: Add the release at @url{https://ffmpeg.org/trac/ffmpeg/admin/ticket/versions}. yading@10: @item yading@10: Announce the intent to do a release to the mailing list. yading@10: @item yading@10: Make sure all relevant security fixes have been backported. See yading@10: @url{https://ffmpeg.org/security.html}. yading@10: @item yading@10: Ensure that the FATE regression suite still passes in the release yading@10: branch on at least @strong{i386} and @strong{amd64} yading@10: (cf. @ref{Regression tests}). yading@10: @item yading@10: Prepare the release tarballs in @code{bz2} and @code{gz} formats, and yading@10: supplementing files that contain @code{gpg} signatures yading@10: @item yading@10: Publish the tarballs at @url{http://ffmpeg.org/releases}. Create and yading@10: push an annotated tag in the form @code{nX}, with @code{X} yading@10: containing the version number. yading@10: @item yading@10: Propose and send a patch to the @strong{ffmpeg-devel} mailing list yading@10: with a news entry for the website. yading@10: @item yading@10: Publish the news entry. yading@10: @item yading@10: Send announcement to the mailing list. yading@10: @end enumerate yading@10: yading@10: @bye