doc/developer: update sections about external development
[ffmpeg.git] / doc / developer.texi
1 \input texinfo @c -*- texinfo -*-
2
3 @settitle Developer Documentation
4 @titlepage
5 @center @titlefont{Developer Documentation}
6 @end titlepage
7
8 @top
9
10 @contents
11
12 @chapter Developers Guide
13
14 @section Notes for external developers
15
16 This document is mostly useful for internal FFmpeg developers.
17 External developers who need to use the API in their application should
18 refer to the API doxygen documentation in the public headers, and
19 check the examples in @file{doc/examples} and in the source code to
20 see how the public API is employed.
21
22 You can use the FFmpeg libraries in your commercial program, but you
23 are encouraged to @emph{publish any patch you make}. In this case the
24 best way to proceed is to send your patches to the ffmpeg-devel
25 mailing list following the guidelines illustrated in the remainder of
26 this document.
27
28 For more detailed legal information about the use of FFmpeg in
29 external programs read the @file{LICENSE} file in the source tree and
30 consult @url{http://ffmpeg.org/legal.html}.
31
32 @section Contributing
33
34 There are 3 ways by which code gets into ffmpeg.
35 @itemize @bullet
36 @item Submitting Patches to the main developer mailing list
37       see @ref{Submitting patches} for details.
38 @item Directly committing changes to the main tree.
39 @item Committing changes to a git clone, for example on github.com or
40       gitorious.org. And asking us to merge these changes.
41 @end itemize
42
43 Whichever way, changes should be reviewed by the maintainer of the code
44 before they are committed. And they should follow the @ref{Coding Rules}.
45 The developer making the commit and the author are responsible for their changes
46 and should try to fix issues their commit causes.
47
48 @anchor{Coding Rules}
49 @section Coding Rules
50
51 @subsection Code formatting conventions
52
53 There are the following guidelines regarding the indentation in files:
54 @itemize @bullet
55 @item
56 Indent size is 4.
57 @item
58 The TAB character is forbidden outside of Makefiles as is any
59 form of trailing whitespace. Commits containing either will be
60 rejected by the git repository.
61 @item
62 You should try to limit your code lines to 80 characters; however, do so if
63 and only if this improves readability.
64 @end itemize
65 The presentation is one inspired by 'indent -i4 -kr -nut'.
66
67 The main priority in FFmpeg is simplicity and small code size in order to
68 minimize the bug count.
69
70 @subsection Comments
71 Use the JavaDoc/Doxygen  format (see examples below) so that code documentation
72 can be generated automatically. All nontrivial functions should have a comment
73 above them explaining what the function does, even if it is just one sentence.
74 All structures and their member variables should be documented, too.
75
76 Avoid Qt-style and similar Doxygen syntax with @code{!} in it, i.e. replace
77 @code{//!} with @code{///} and similar.  Also @@ syntax should be employed
78 for markup commands, i.e. use @code{@@param} and not @code{\param}.
79
80 @example
81 /**
82  * @@file
83  * MPEG codec.
84  * @@author ...
85  */
86
87 /**
88  * Summary sentence.
89  * more text ...
90  * ...
91  */
92 typedef struct Foobar@{
93     int var1; /**< var1 description */
94     int var2; ///< var2 description
95     /** var3 description */
96     int var3;
97 @} Foobar;
98
99 /**
100  * Summary sentence.
101  * more text ...
102  * ...
103  * @@param my_parameter description of my_parameter
104  * @@return return value description
105  */
106 int myfunc(int my_parameter)
107 ...
108 @end example
109
110 @subsection C language features
111
112 FFmpeg is programmed in the ISO C90 language with a few additional
113 features from ISO C99, namely:
114 @itemize @bullet
115 @item
116 the @samp{inline} keyword;
117 @item
118 @samp{//} comments;
119 @item
120 designated struct initializers (@samp{struct s x = @{ .i = 17 @};})
121 @item
122 compound literals (@samp{x = (struct s) @{ 17, 23 @};})
123 @end itemize
124
125 These features are supported by all compilers we care about, so we will not
126 accept patches to remove their use unless they absolutely do not impair
127 clarity and performance.
128
129 All code must compile with recent versions of GCC and a number of other
130 currently supported compilers. To ensure compatibility, please do not use
131 additional C99 features or GCC extensions. Especially watch out for:
132 @itemize @bullet
133 @item
134 mixing statements and declarations;
135 @item
136 @samp{long long} (use @samp{int64_t} instead);
137 @item
138 @samp{__attribute__} not protected by @samp{#ifdef __GNUC__} or similar;
139 @item
140 GCC statement expressions (@samp{(x = (@{ int y = 4; y; @})}).
141 @end itemize
142
143 @subsection Naming conventions
144 All names should be composed with underscores (_), not CamelCase. For example,
145 @samp{avfilter_get_video_buffer} is an acceptable function name and
146 @samp{AVFilterGetVideo} is not. The exception from this are type names, like
147 for example structs and enums; they should always be in the CamelCase
148
149 There are the following conventions for naming variables and functions:
150 @itemize @bullet
151 @item
152 For local variables no prefix is required.
153 @item
154 For file-scope variables and functions declared as @code{static}, no prefix
155 is required.
156 @item
157 For variables and functions visible outside of file scope, but only used
158 internally by a library, an @code{ff_} prefix should be used,
159 e.g. @samp{ff_w64_demuxer}.
160 @item
161 For variables and functions visible outside of file scope, used internally
162 across multiple libraries, use @code{avpriv_} as prefix, for example,
163 @samp{avpriv_aac_parse_header}.
164 @item
165 Each library has its own prefix for public symbols, in addition to the
166 commonly used @code{av_} (@code{avformat_} for libavformat,
167 @code{avcodec_} for libavcodec, @code{swr_} for libswresample, etc).
168 Check the existing code and choose names accordingly.
169 Note that some symbols without these prefixes are also exported for
170 retro-compatibility reasons. These exceptions are declared in the
171 @code{lib<name>/lib<name>.v} files.
172 @end itemize
173
174 Furthermore, name space reserved for the system should not be invaded.
175 Identifiers ending in @code{_t} are reserved by
176 @url{http://pubs.opengroup.org/onlinepubs/007904975/functions/xsh_chap02_02.html#tag_02_02_02, POSIX}.
177 Also avoid names starting with @code{__} or @code{_} followed by an uppercase
178 letter as they are reserved by the C standard. Names starting with @code{_}
179 are reserved at the file level and may not be used for externally visible
180 symbols. If in doubt, just avoid names starting with @code{_} altogether.
181
182 @subsection Miscellaneous conventions
183 @itemize @bullet
184 @item
185 fprintf and printf are forbidden in libavformat and libavcodec,
186 please use av_log() instead.
187 @item
188 Casts should be used only when necessary. Unneeded parentheses
189 should also be avoided if they don't make the code easier to understand.
190 @end itemize
191
192 @subsection Editor configuration
193 In order to configure Vim to follow FFmpeg formatting conventions, paste
194 the following snippet into your @file{.vimrc}:
195 @example
196 " indentation rules for FFmpeg: 4 spaces, no tabs
197 set expandtab
198 set shiftwidth=4
199 set softtabstop=4
200 set cindent
201 set cinoptions=(0
202 " Allow tabs in Makefiles.
203 autocmd FileType make,automake set noexpandtab shiftwidth=8 softtabstop=8
204 " Trailing whitespace and tabs are forbidden, so highlight them.
205 highlight ForbiddenWhitespace ctermbg=red guibg=red
206 match ForbiddenWhitespace /\s\+$\|\t/
207 " Do not highlight spaces at the end of line while typing on that line.
208 autocmd InsertEnter * match ForbiddenWhitespace /\t\|\s\+\%#\@@<!$/
209 @end example
210
211 For Emacs, add these roughly equivalent lines to your @file{.emacs.d/init.el}:
212 @example
213 (c-add-style "ffmpeg"
214              '("k&r"
215                (c-basic-offset . 4)
216                (indent-tabs-mode . nil)
217                (show-trailing-whitespace . t)
218                (c-offsets-alist
219                 (statement-cont . (c-lineup-assignments +)))
220                )
221              )
222 (setq c-default-style "ffmpeg")
223 @end example
224
225 @section Development Policy
226
227 @enumerate
228 @item
229    Contributions should be licensed under the
230    @uref{http://www.gnu.org/licenses/lgpl-2.1.html, LGPL 2.1},
231    including an "or any later version" clause, or, if you prefer
232    a gift-style license, the
233    @uref{http://www.isc.org/software/license/, ISC} or
234    @uref{http://mit-license.org/, MIT} license.
235    @uref{http://www.gnu.org/licenses/gpl-2.0.html, GPL 2} including
236    an "or any later version" clause is also acceptable, but LGPL is
237    preferred.
238 @item
239    You must not commit code which breaks FFmpeg! (Meaning unfinished but
240    enabled code which breaks compilation or compiles but does not work or
241    breaks the regression tests)
242    You can commit unfinished stuff (for testing etc), but it must be disabled
243    (#ifdef etc) by default so it does not interfere with other developers'
244    work.
245 @item
246    The commit message should have a short first line in the form of
247    a @samp{topic: short description} as a header, separated by a newline
248    from the body consisting of an explanation of why the change is necessary.
249    If the commit fixes a known bug on the bug tracker, the commit message
250    should include its bug ID. Referring to the issue on the bug tracker does
251    not exempt you from writing an excerpt of the bug in the commit message.
252 @item
253    You do not have to over-test things. If it works for you, and you think it
254    should work for others, then commit. If your code has problems
255    (portability, triggers compiler bugs, unusual environment etc) they will be
256    reported and eventually fixed.
257 @item
258    Do not commit unrelated changes together, split them into self-contained
259    pieces. Also do not forget that if part B depends on part A, but A does not
260    depend on B, then A can and should be committed first and separate from B.
261    Keeping changes well split into self-contained parts makes reviewing and
262    understanding them on the commit log mailing list easier. This also helps
263    in case of debugging later on.
264    Also if you have doubts about splitting or not splitting, do not hesitate to
265    ask/discuss it on the developer mailing list.
266 @item
267    Do not change behavior of the programs (renaming options etc) or public
268    API or ABI without first discussing it on the ffmpeg-devel mailing list.
269    Do not remove functionality from the code. Just improve!
270
271    Note: Redundant code can be removed.
272 @item
273    Do not commit changes to the build system (Makefiles, configure script)
274    which change behavior, defaults etc, without asking first. The same
275    applies to compiler warning fixes, trivial looking fixes and to code
276    maintained by other developers. We usually have a reason for doing things
277    the way we do. Send your changes as patches to the ffmpeg-devel mailing
278    list, and if the code maintainers say OK, you may commit. This does not
279    apply to files you wrote and/or maintain.
280 @item
281    We refuse source indentation and other cosmetic changes if they are mixed
282    with functional changes, such commits will be rejected and removed. Every
283    developer has his own indentation style, you should not change it. Of course
284    if you (re)write something, you can use your own style, even though we would
285    prefer if the indentation throughout FFmpeg was consistent (Many projects
286    force a given indentation style - we do not.). If you really need to make
287    indentation changes (try to avoid this), separate them strictly from real
288    changes.
289
290    NOTE: If you had to put if()@{ .. @} over a large (> 5 lines) chunk of code,
291    then either do NOT change the indentation of the inner part within (do not
292    move it to the right)! or do so in a separate commit
293 @item
294    Always fill out the commit log message. Describe in a few lines what you
295    changed and why. You can refer to mailing list postings if you fix a
296    particular bug. Comments such as "fixed!" or "Changed it." are unacceptable.
297    Recommended format:
298    area changed: Short 1 line description
299
300    details describing what and why and giving references.
301 @item
302    Make sure the author of the commit is set correctly. (see git commit --author)
303    If you apply a patch, send an
304    answer to ffmpeg-devel (or wherever you got the patch from) saying that
305    you applied the patch.
306 @item
307    When applying patches that have been discussed (at length) on the mailing
308    list, reference the thread in the log message.
309 @item
310     Do NOT commit to code actively maintained by others without permission.
311     Send a patch to ffmpeg-devel instead. If no one answers within a reasonable
312     timeframe (12h for build failures and security fixes, 3 days small changes,
313     1 week for big patches) then commit your patch if you think it is OK.
314     Also note, the maintainer can simply ask for more time to review!
315 @item
316     Subscribe to the ffmpeg-cvslog mailing list. The diffs of all commits
317     are sent there and reviewed by all the other developers. Bugs and possible
318     improvements or general questions regarding commits are discussed there. We
319     expect you to react if problems with your code are uncovered.
320 @item
321     Update the documentation if you change behavior or add features. If you are
322     unsure how best to do this, send a patch to ffmpeg-devel, the documentation
323     maintainer(s) will review and commit your stuff.
324 @item
325     Try to keep important discussions and requests (also) on the public
326     developer mailing list, so that all developers can benefit from them.
327 @item
328     Never write to unallocated memory, never write over the end of arrays,
329     always check values read from some untrusted source before using them
330     as array index or other risky things.
331 @item
332     Remember to check if you need to bump versions for the specific libav*
333     parts (libavutil, libavcodec, libavformat) you are changing. You need
334     to change the version integer.
335     Incrementing the first component means no backward compatibility to
336     previous versions (e.g. removal of a function from the public API).
337     Incrementing the second component means backward compatible change
338     (e.g. addition of a function to the public API or extension of an
339     existing data structure).
340     Incrementing the third component means a noteworthy binary compatible
341     change (e.g. encoder bug fix that matters for the decoder). The third
342     component always starts at 100 to distinguish FFmpeg from Libav.
343 @item
344     Compiler warnings indicate potential bugs or code with bad style. If a type of
345     warning always points to correct and clean code, that warning should
346     be disabled, not the code changed.
347     Thus the remaining warnings can either be bugs or correct code.
348     If it is a bug, the bug has to be fixed. If it is not, the code should
349     be changed to not generate a warning unless that causes a slowdown
350     or obfuscates the code.
351 @item
352     If you add a new file, give it a proper license header. Do not copy and
353     paste it from a random place, use an existing file as template.
354 @end enumerate
355
356 We think our rules are not too hard. If you have comments, contact us.
357
358 @anchor{Submitting patches}
359 @section Submitting patches
360
361 First, read the @ref{Coding Rules} above if you did not yet, in particular
362 the rules regarding patch submission.
363
364 When you submit your patch, please use @code{git format-patch} or
365 @code{git send-email}. We cannot read other diffs :-)
366
367 Also please do not submit a patch which contains several unrelated changes.
368 Split it into separate, self-contained pieces. This does not mean splitting
369 file by file. Instead, make the patch as small as possible while still
370 keeping it as a logical unit that contains an individual change, even
371 if it spans multiple files. This makes reviewing your patches much easier
372 for us and greatly increases your chances of getting your patch applied.
373
374 Use the patcheck tool of FFmpeg to check your patch.
375 The tool is located in the tools directory.
376
377 Run the @ref{Regression tests} before submitting a patch in order to verify
378 it does not cause unexpected problems.
379
380 It also helps quite a bit if you tell us what the patch does (for example
381 'replaces lrint by lrintf'), and why (for example '*BSD isn't C99 compliant
382 and has no lrint()')
383
384 Also please if you send several patches, send each patch as a separate mail,
385 do not attach several unrelated patches to the same mail.
386
387 Patches should be posted to the
388 @uref{http://lists.ffmpeg.org/mailman/listinfo/ffmpeg-devel, ffmpeg-devel}
389 mailing list. Use @code{git send-email} when possible since it will properly
390 send patches without requiring extra care. If you cannot, then send patches
391 as base64-encoded attachments, so your patch is not trashed during
392 transmission.
393
394 Your patch will be reviewed on the mailing list. You will likely be asked
395 to make some changes and are expected to send in an improved version that
396 incorporates the requests from the review. This process may go through
397 several iterations. Once your patch is deemed good enough, some developer
398 will pick it up and commit it to the official FFmpeg tree.
399
400 Give us a few days to react. But if some time passes without reaction,
401 send a reminder by email. Your patch should eventually be dealt with.
402
403
404 @section New codecs or formats checklist
405
406 @enumerate
407 @item
408     Did you use av_cold for codec initialization and close functions?
409 @item
410     Did you add a long_name under NULL_IF_CONFIG_SMALL to the AVCodec or
411     AVInputFormat/AVOutputFormat struct?
412 @item
413     Did you bump the minor version number (and reset the micro version
414     number) in @file{libavcodec/version.h} or @file{libavformat/version.h}?
415 @item
416     Did you register it in @file{allcodecs.c} or @file{allformats.c}?
417 @item
418     Did you add the AVCodecID to @file{avcodec.h}?
419     When adding new codec IDs, also add an entry to the codec descriptor
420     list in @file{libavcodec/codec_desc.c}.
421 @item
422     If it has a FourCC, did you add it to @file{libavformat/riff.c},
423     even if it is only a decoder?
424 @item
425     Did you add a rule to compile the appropriate files in the Makefile?
426     Remember to do this even if you're just adding a format to a file that is
427     already being compiled by some other rule, like a raw demuxer.
428 @item
429     Did you add an entry to the table of supported formats or codecs in
430     @file{doc/general.texi}?
431 @item
432     Did you add an entry in the Changelog?
433 @item
434     If it depends on a parser or a library, did you add that dependency in
435     configure?
436 @item
437     Did you @code{git add} the appropriate files before committing?
438 @item
439     Did you make sure it compiles standalone, i.e. with
440     @code{configure --disable-everything --enable-decoder=foo}
441     (or @code{--enable-demuxer} or whatever your component is)?
442 @end enumerate
443
444
445 @section patch submission checklist
446
447 @enumerate
448 @item
449     Does @code{make fate} pass with the patch applied?
450 @item
451     Was the patch generated with git format-patch or send-email?
452 @item
453     Did you sign off your patch? (git commit -s)
454     See @url{http://git.kernel.org/?p=linux/kernel/git/torvalds/linux.git;a=blob_plain;f=Documentation/SubmittingPatches} for the meaning
455     of sign off.
456 @item
457     Did you provide a clear git commit log message?
458 @item
459     Is the patch against latest FFmpeg git master branch?
460 @item
461     Are you subscribed to ffmpeg-devel?
462     (the list is subscribers only due to spam)
463 @item
464     Have you checked that the changes are minimal, so that the same cannot be
465     achieved with a smaller patch and/or simpler final code?
466 @item
467     If the change is to speed critical code, did you benchmark it?
468 @item
469     If you did any benchmarks, did you provide them in the mail?
470 @item
471     Have you checked that the patch does not introduce buffer overflows or
472     other security issues?
473 @item
474     Did you test your decoder or demuxer against damaged data? If no, see
475     tools/trasher, the noise bitstream filter, and
476     @uref{http://caca.zoy.org/wiki/zzuf, zzuf}. Your decoder or demuxer
477     should not crash, end in a (near) infinite loop, or allocate ridiculous
478     amounts of memory when fed damaged data.
479 @item
480     Does the patch not mix functional and cosmetic changes?
481 @item
482     Did you add tabs or trailing whitespace to the code? Both are forbidden.
483 @item
484     Is the patch attached to the email you send?
485 @item
486     Is the mime type of the patch correct? It should be text/x-diff or
487     text/x-patch or at least text/plain and not application/octet-stream.
488 @item
489     If the patch fixes a bug, did you provide a verbose analysis of the bug?
490 @item
491     If the patch fixes a bug, did you provide enough information, including
492     a sample, so the bug can be reproduced and the fix can be verified?
493     Note please do not attach samples >100k to mails but rather provide a
494     URL, you can upload to ftp://upload.ffmpeg.org
495 @item
496     Did you provide a verbose summary about what the patch does change?
497 @item
498     Did you provide a verbose explanation why it changes things like it does?
499 @item
500     Did you provide a verbose summary of the user visible advantages and
501     disadvantages if the patch is applied?
502 @item
503     Did you provide an example so we can verify the new feature added by the
504     patch easily?
505 @item
506     If you added a new file, did you insert a license header? It should be
507     taken from FFmpeg, not randomly copied and pasted from somewhere else.
508 @item
509     You should maintain alphabetical order in alphabetically ordered lists as
510     long as doing so does not break API/ABI compatibility.
511 @item
512     Lines with similar content should be aligned vertically when doing so
513     improves readability.
514 @item
515     Consider to add a regression test for your code.
516 @item
517     If you added YASM code please check that things still work with --disable-yasm
518 @item
519     Make sure you check the return values of function and return appropriate
520     error codes. Especially memory allocation functions like @code{av_malloc()}
521     are notoriously left unchecked, which is a serious problem.
522 @item
523     Test your code with valgrind and or Address Sanitizer to ensure it's free
524     of leaks, out of array accesses, etc.
525 @end enumerate
526
527 @section Patch review process
528
529 All patches posted to ffmpeg-devel will be reviewed, unless they contain a
530 clear note that the patch is not for the git master branch.
531 Reviews and comments will be posted as replies to the patch on the
532 mailing list. The patch submitter then has to take care of every comment,
533 that can be by resubmitting a changed patch or by discussion. Resubmitted
534 patches will themselves be reviewed like any other patch. If at some point
535 a patch passes review with no comments then it is approved, that can for
536 simple and small patches happen immediately while large patches will generally
537 have to be changed and reviewed many times before they are approved.
538 After a patch is approved it will be committed to the repository.
539
540 We will review all submitted patches, but sometimes we are quite busy so
541 especially for large patches this can take several weeks.
542
543 If you feel that the review process is too slow and you are willing to try to
544 take over maintainership of the area of code you change then just clone
545 git master and maintain the area of code there. We will merge each area from
546 where its best maintained.
547
548 When resubmitting patches, please do not make any significant changes
549 not related to the comments received during review. Such patches will
550 be rejected. Instead, submit significant changes or new features as
551 separate patches.
552
553 @anchor{Regression tests}
554 @section Regression tests
555
556 Before submitting a patch (or committing to the repository), you should at least
557 test that you did not break anything.
558
559 Running 'make fate' accomplishes this, please see @url{fate.html} for details.
560
561 [Of course, some patches may change the results of the regression tests. In
562 this case, the reference results of the regression tests shall be modified
563 accordingly].
564
565 @subsection Adding files to the fate-suite dataset
566
567 When there is no muxer or encoder available to generate test media for a
568 specific test then the media has to be inlcuded in the fate-suite.
569 First please make sure that the sample file is as small as possible to test the
570 respective decoder or demuxer sufficiently. Large files increase network
571 bandwidth and disk space requirements.
572 Once you have a working fate test and fate sample, provide in the commit
573 message or introductionary message for the patch series that you post to
574 the ffmpeg-devel mailing list, a direct link to download the sample media.
575
576
577 @subsection Visualizing Test Coverage
578
579 The FFmpeg build system allows visualizing the test coverage in an easy
580 manner with the coverage tools @code{gcov}/@code{lcov}.  This involves
581 the following steps:
582
583 @enumerate
584 @item
585     Configure to compile with instrumentation enabled:
586     @code{configure --toolchain=gcov}.
587 @item
588     Run your test case, either manually or via FATE. This can be either
589     the full FATE regression suite, or any arbitrary invocation of any
590     front-end tool provided by FFmpeg, in any combination.
591 @item
592     Run @code{make lcov} to generate coverage data in HTML format.
593 @item
594     View @code{lcov/index.html} in your preferred HTML viewer.
595 @end enumerate
596
597 You can use the command @code{make lcov-reset} to reset the coverage
598 measurements. You will need to rerun @code{make lcov} after running a
599 new test.
600
601 @subsection Using Valgrind
602
603 The configure script provides a shortcut for using valgrind to spot bugs
604 related to memory handling. Just add the option
605 @code{--toolchain=valgrind-memcheck} or @code{--toolchain=valgrind-massif}
606 to your configure line, and reasonable defaults will be set for running
607 FATE under the supervision of either the @strong{memcheck} or the
608 @strong{massif} tool of the valgrind suite.
609
610 In case you need finer control over how valgrind is invoked, use the
611 @code{--target-exec='valgrind <your_custom_valgrind_options>} option in
612 your configure line instead.
613
614 @anchor{Release process}
615 @section Release process
616
617 FFmpeg maintains a set of @strong{release branches}, which are the
618 recommended deliverable for system integrators and distributors (such as
619 Linux distributions, etc.). At regular times, a @strong{release
620 manager} prepares, tests and publishes tarballs on the
621 @url{http://ffmpeg.org} website.
622
623 There are two kinds of releases:
624
625 @enumerate
626 @item
627     @strong{Major releases} always include the latest and greatest
628     features and functionality.
629 @item
630     @strong{Point releases} are cut from @strong{release} branches,
631     which are named @code{release/X}, with @code{X} being the release
632     version number.
633 @end enumerate
634
635 Note that we promise to our users that shared libraries from any FFmpeg
636 release never break programs that have been @strong{compiled} against
637 previous versions of @strong{the same release series} in any case!
638
639 However, from time to time, we do make API changes that require adaptations
640 in applications. Such changes are only allowed in (new) major releases and
641 require further steps such as bumping library version numbers and/or
642 adjustments to the symbol versioning file. Please discuss such changes
643 on the @strong{ffmpeg-devel} mailing list in time to allow forward planning.
644
645 @anchor{Criteria for Point Releases}
646 @subsection Criteria for Point Releases
647
648 Changes that match the following criteria are valid candidates for
649 inclusion into a point release:
650
651 @enumerate
652 @item
653     Fixes a security issue, preferably identified by a @strong{CVE
654     number} issued by @url{http://cve.mitre.org/}.
655 @item
656     Fixes a documented bug in @url{https://trac.ffmpeg.org}.
657 @item
658     Improves the included documentation.
659 @item
660     Retains both source code and binary compatibility with previous
661     point releases of the same release branch.
662 @end enumerate
663
664 The order for checking the rules is (1 OR 2 OR 3) AND 4.
665
666
667 @subsection Release Checklist
668
669 The release process involves the following steps:
670
671 @enumerate
672 @item
673     Ensure that the @file{RELEASE} file contains the version number for
674     the upcoming release.
675 @item
676     Add the release at @url{https://trac.ffmpeg.org/admin/ticket/versions}.
677 @item
678     Announce the intent to do a release to the mailing list.
679 @item
680     Make sure all relevant security fixes have been backported. See
681     @url{https://ffmpeg.org/security.html}.
682 @item
683     Ensure that the FATE regression suite still passes in the release
684     branch on at least @strong{i386} and @strong{amd64}
685     (cf. @ref{Regression tests}).
686 @item
687     Prepare the release tarballs in @code{bz2} and @code{gz} formats, and
688     supplementing files that contain @code{gpg} signatures
689 @item
690     Publish the tarballs at @url{http://ffmpeg.org/releases}. Create and
691     push an annotated tag in the form @code{nX}, with @code{X}
692     containing the version number.
693 @item
694     Propose and send a patch to the @strong{ffmpeg-devel} mailing list
695     with a news entry for the website.
696 @item
697     Publish the news entry.
698 @item
699     Send announcement to the mailing list.
700 @end enumerate
701
702 @bye