developer.texi 25.5 KB
Newer Older
1 2 3 4 5 6 7
\input texinfo @c -*- texinfo -*-

@settitle Developer Documentation
@titlepage
@center @titlefont{Developer Documentation}
@end titlepage

8 9 10
@top

@contents
11 12 13 14

@chapter Developers Guide

@section API
15

16 17 18 19 20
@itemize @bullet
@item libavcodec is the library containing the codecs (both encoding and
decoding). Look at @file{libavcodec/apiexample.c} to see how to use it.

@item libavformat is the library containing the file format handling (mux and
Anton Khirnov's avatar
Anton Khirnov committed
21
demux code for several formats). Look at @file{avplay.c} to use it in a
22 23 24 25
player. See @file{libavformat/output-example.c} to use it to generate
audio or video streams.
@end itemize

26 27 28 29
@section Integrating libav in your program

Shared libraries should be used whenever is possible in order to reduce
the effort distributors have to pour to support programs and to ensure
30
only the public API is used.
31 32 33

You can use Libav in your commercial program, but you must abide to the
license, LGPL or GPL depending on the specific features used, please refer
34 35 36 37 38 39
to @uref{http://libav.org/legal.html, our legal page} for a quick checklist and to
the following links for the exact text of each license:
@uref{http://git.libav.org/?p=libav.git;a=blob;f=COPYING.GPLv2, GPL version 2},
@uref{http://git.libav.org/?p=libav.git;a=blob;f=COPYING.GPLv3, GPL version 3},
@uref{http://git.libav.org/?p=libav.git;a=blob;f=COPYING.LGPLv2.1, LGPL version 2.1},
@uref{http://git.libav.org/?p=libav.git;a=blob;f=COPYING.LGPLv3, LGPL version 3}.
40
Any modification to the source code can be suggested for inclusion.
41 42 43
The best way to proceed is to send your patches to the
@uref{https://lists.libav.org/mailman/listinfo/libav-devel, libav-devel}
mailing list.
44

45
@anchor{Coding Rules}
46 47
@section Coding Rules

48 49
@subsection Code formatting conventions
The code is written in K&R C style. That means the following:
50

51 52
@itemize @bullet
@item
53
The control statements are formatted by putting space between the statement
54
and parenthesis in the following way:
55
@example
56
for (i = 0; i < filter->input_count; i++) @{
57
@end example
58

59
@item
60 61 62 63 64 65 66 67 68
The case statement is always located at the same level as the switch itself:
@example
switch (link->init_state) @{
case AVLINK_INIT:
    continue;
case AVLINK_STARTINIT:
    av_log(filter, AV_LOG_INFO, "circular filter chain detected");
    return 0;
@end example
69

70
@item
71
Braces in function definitions are written on the new line:
72 73 74 75 76 77
@example
const char *avfilter_configuration(void)
@{
    return LIBAV_CONFIGURATION;
@}
@end example
78

79
@item
80 81 82
Do not check for NULL values by comparison, @samp{if (p)} and
@samp{if (!p)} are correct; @samp{if (p == NULL)} and @samp{if (p != NULL)}
are not.
83

84
@item
85 86 87 88 89
In case of a single-statement if, no curly braces are required:
@example
if (!pic || !picref)
    goto fail;
@end example
90

91
@item
92
Do not put spaces immediately inside parentheses. @samp{if (ret)} is
93
a valid style; @samp{if ( ret )} is not.
94 95
@end itemize

96
There are the following guidelines regarding the indentation in files:
97

98 99 100
@itemize @bullet
@item
Indent size is 4.
101

102
@item
103 104
The TAB character is forbidden outside of Makefiles as is any
form of trailing whitespace. Commits containing either will be
105
rejected by the git repository.
106

107
@item
108 109
You should try to limit your code lines to 80 characters; however, do so if
and only if this improves readability.
110 111
@end itemize
The presentation is one inspired by 'indent -i4 -kr -nut'.
112

113
The main priority in Libav is simplicity and small code size in order to
114 115
minimize the bug count.

116 117
@subsection Comments
Use the JavaDoc/Doxygen  format (see examples below) so that code documentation
118 119 120
can be generated automatically. All nontrivial functions should have a comment
above them explaining what the function does, even if it is just one sentence.
All structures and their member variables should be documented, too.
121 122 123 124 125

Avoid Qt-style and similar Doxygen syntax with @code{!} in it, i.e. replace
@code{//!} with @code{///} and similar.  Also @@ syntax should be employed
for markup commands, i.e. use @code{@@param} and not @code{\param}.

126 127
@example
/**
128
 * @@file
129 130 131 132 133 134 135 136 137
 * MPEG codec.
 * @@author ...
 */

/**
 * Summary sentence.
 * more text ...
 * ...
 */
138
typedef struct Foobar @{
139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155
    int var1; /**< var1 description */
    int var2; ///< var2 description
    /** var3 description */
    int var3;
@} Foobar;

/**
 * Summary sentence.
 * more text ...
 * ...
 * @@param my_parameter description of my_parameter
 * @@return return value description
 */
int myfunc(int my_parameter)
...
@end example

156 157 158 159
@subsection C language features

Libav is programmed in the ISO C90 language with a few additional
features from ISO C99, namely:
160

161 162 163
@itemize @bullet
@item
the @samp{inline} keyword;
164

165 166
@item
@samp{//} comments;
167

168 169
@item
designated struct initializers (@samp{struct s x = @{ .i = 17 @};})
170

171 172 173 174 175 176 177 178 179 180 181
@item
compound literals (@samp{x = (struct s) @{ 17, 23 @};})
@end itemize

These features are supported by all compilers we care about, so we will not
accept patches to remove their use unless they absolutely do not impair
clarity and performance.

All code must compile with recent versions of GCC and a number of other
currently supported compilers. To ensure compatibility, please do not use
additional C99 features or GCC extensions. Especially watch out for:
182

183 184 185
@itemize @bullet
@item
mixing statements and declarations;
186

187 188
@item
@samp{long long} (use @samp{int64_t} instead);
189

190 191
@item
@samp{__attribute__} not protected by @samp{#ifdef __GNUC__} or similar;
192

193 194 195 196 197
@item
GCC statement expressions (@samp{(x = (@{ int y = 4; y; @})}).
@end itemize

@subsection Naming conventions
198 199 200 201
All names should be composed with underscores (_), not CamelCase. For example,
@samp{avfilter_get_video_buffer} is an acceptable function name and
@samp{AVFilterGetVideo} is not. The only exception are structure
names; they should always be CamelCase.
202

203
There are the following conventions for naming variables and functions:
204

205 206 207
@itemize @bullet
@item
For local variables no prefix is required.
208

209
@item
210 211
For file-scope variables and functions declared as @code{static}, no prefix
is required.
212

213
@item
214 215 216
For variables and functions visible outside of file scope, but only used
internally by a library, an @code{ff_} prefix should be used,
e.g. @samp{ff_w64_demuxer}.
217

218
@item
219 220 221
For variables and functions visible outside of file scope, used internally
across multiple libraries, use @code{avpriv_} as prefix, for example,
@samp{avpriv_aac_parse_header}.
222

223
@item
224 225
For externally visible symbols, each library has its own prefix. Check
the existing code and choose names accordingly.
226 227
@end itemize

228 229 230 231 232 233 234 235
Furthermore, name space reserved for the system should not be invaded.
Identifiers ending in @code{_t} are reserved by
@url{http://pubs.opengroup.org/onlinepubs/007904975/functions/xsh_chap02_02.html#tag_02_02_02, POSIX}.
Also avoid names starting with @code{__} or @code{_} followed by an uppercase
letter as they are reserved by the C standard. Names starting with @code{_}
are reserved at the file level and may not be used for externally visible
symbols. If in doubt, just avoid names starting with @code{_} altogether.

Diego Biurrun's avatar
Diego Biurrun committed
236
@subsection Miscellaneous conventions
237

238 239
@itemize @bullet
@item
240 241
fprintf and printf are forbidden in libavformat and libavcodec,
please use av_log() instead.
242

243
@item
244 245
Casts should be used only when necessary. Unneeded parentheses
should also be avoided if they don't make the code easier to understand.
246
@end itemize
247

248 249 250 251
@subsection Editor configuration
In order to configure Vim to follow Libav formatting conventions, paste
the following snippet into your @file{.vimrc}:
@example
252
" Indentation rules for Libav: 4 spaces, no tabs.
253 254 255
set expandtab
set shiftwidth=4
set softtabstop=4
256 257
set cindent
set cinoptions=(0
258
" Allow tabs in Makefiles.
259
autocmd FileType make,automake set noexpandtab shiftwidth=8 softtabstop=8
260 261 262 263 264 265 266 267 268
" Trailing whitespace and tabs are forbidden, so highlight them.
highlight ForbiddenWhitespace ctermbg=red guibg=red
match ForbiddenWhitespace /\s\+$\|\t/
" Do not highlight spaces at the end of line while typing on that line.
autocmd InsertEnter * match ForbiddenWhitespace /\t\|\s\+\%#\@@<!$/
@end example

For Emacs, add these roughly equivalent lines to your @file{.emacs.d/init.el}:
@example
269 270 271
(c-add-style "libav"
             '("k&r"
               (c-basic-offset . 4)
272 273
               (indent-tabs-mode . nil)
               (show-trailing-whitespace . t)
274 275 276 277 278
               (c-offsets-alist
                (statement-cont . (c-lineup-assignments +)))
               )
             )
(setq c-default-style "libav")
279 280
@end example

281 282 283 284
@section Development Policy

@enumerate
@item
285 286 287 288
Contributions should be licensed under the
@uref{http://www.gnu.org/licenses/lgpl-2.1.html, LGPL 2.1},
including an "or any later version" clause, or, if you prefer
a gift-style license, the
289
@uref{http://opensource.org/licenses/isc-license.txt, ISC} or
290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400
@uref{http://mit-license.org/, MIT} license.
@uref{http://www.gnu.org/licenses/gpl-2.0.html, GPL 2} including
an "or any later version" clause is also acceptable, but LGPL is
preferred.

@item
All the patches MUST be reviewed in the mailing list before they are
committed.

@item
The Libav coding style should remain consistent. Changes to
conform will be suggested during the review or implemented on commit.

@item
Patches should be generated using @code{git format-patch} or directly sent
using @code{git send-email}.
Please make sure you give the proper credit by setting the correct author
in the commit.

@item
The commit message should have a short first line in the form of
a @samp{topic: short description} as a header, separated by a newline
from the body consisting of an explanation of why the change is necessary.
If the commit fixes a known bug on the bug tracker, the commit message
should include its bug ID. Referring to the issue on the bug tracker does
not exempt you from writing an excerpt of the bug in the commit message.
If the patch is a bug fix which should be backported to stable releases,
i.e. a non-API/ABI-breaking bug fix, add @code{CC: libav-stable@@libav.org}
to the bottom of your commit message, and make sure to CC your patch to
this address, too. Some git setups will do this automatically.

@item
Work in progress patches should be sent to the mailing list with the [WIP]
or the [RFC] tag.

@item
Branches in public personal repos are advised as way to
work on issues collaboratively.

@item
You do not have to over-test things. If it works for you and you think it
should work for others, send it to the mailing list for review.
If you have doubt about portability please state it in the submission so
people with specific hardware could test it.

@item
Do not commit unrelated changes together, split them into self-contained
pieces. Also do not forget that if part B depends on part A, but A does not
depend on B, then A can and should be committed first and separate from B.
Keeping changes well split into self-contained parts makes reviewing and
understanding them on the commit log mailing list easier. This also helps
in case of debugging later on.

@item
Patches that change behavior of the programs (renaming options etc) or
public API or ABI should be discussed in depth and possible few days should
pass between discussion and commit.
Changes to the build system (Makefiles, configure script) which alter
the expected behavior should be considered in the same regard.

@item
When applying patches that have been discussed (at length) on the mailing
list, reference the thread in the log message.

@item
Subscribe to the
@uref{https://lists.libav.org/mailman/listinfo/libav-devel, libav-devel} and
@uref{https://lists.libav.org/mailman/listinfo/libav-commits, libav-commits}
mailing lists.
Bugs and possible improvements or general questions regarding commits
are discussed on libav-devel. We expect you to react if problems with
your code are uncovered.

@item
Update the documentation if you change behavior or add features. If you are
unsure how best to do this, send an [RFC] patch to libav-devel.

@item
All discussions and decisions should be reported on the public developer
mailing list, so that there is a reference to them.
Other media (e.g. IRC) should be used for coordination and immediate
collaboration.

@item
Never write to unallocated memory, never write over the end of arrays,
always check values read from some untrusted source before using them
as array index or other risky things. Always use valgrind to double-check.

@item
Remember to check if you need to bump versions for the specific libav
parts (libavutil, libavcodec, libavformat) you are changing. You need
to change the version integer.
Incrementing the first component means no backward compatibility to
previous versions (e.g. removal of a function from the public API).
Incrementing the second component means backward compatible change
(e.g. addition of a function to the public API or extension of an
existing data structure).
Incrementing the third component means a noteworthy binary compatible
change (e.g. encoder bug fix that matters for the decoder).

@item
Compiler warnings indicate potential bugs or code with bad style.
If it is a bug, the bug has to be fixed. If it is not, the code should
be changed to not generate a warning unless that causes a slowdown
or obfuscates the code.
If a type of warning leads to too many false positives, that warning
should be disabled, not the code changed.

@item
If you add a new file, give it a proper license header. Do not copy and
paste it from a random place, use an existing file as template.
401 402 403 404 405 406
@end enumerate

We think our rules are not too hard. If you have comments, contact us.

@section Submitting patches

407
First, read the @ref{Coding Rules} above if you did not yet, in particular
408
the rules regarding patch submission.
409

410 411
As stated already, please do not submit a patch which contains several
unrelated changes.
412 413 414 415 416 417
Split it into separate, self-contained pieces. This does not mean splitting
file by file. Instead, make the patch as small as possible while still
keeping it as a logical unit that contains an individual change, even
if it spans multiple files. This makes reviewing your patches much easier
for us and greatly increases your chances of getting your patch applied.

418
Use the patcheck tool of Libav to check your patch.
419
The tool is located in the tools directory.
Zhihang Wang's avatar
Zhihang Wang committed
420

421
Run the @ref{Regression Tests} before submitting a patch in order to verify
422
it does not cause unexpected problems.
423 424 425

It also helps quite a bit if you tell us what the patch does (for example
'replaces lrint by lrintf'), and why (for example '*BSD isn't C99 compliant
426 427
and has no lrint()'). This kind of explanation should be the body of the
commit message.
428 429 430 431

Also please if you send several patches, send each patch as a separate mail,
do not attach several unrelated patches to the same mail.

432 433 434 435 436 437
Patches should be posted to the
@uref{https://lists.libav.org/mailman/listinfo/libav-devel, libav-devel}
mailing list. Use @code{git send-email} when possible since it will properly
send patches without requiring extra care. If you cannot, then send patches
as base64-encoded attachments, so your patch is not trashed during
transmission.
438

439 440 441
Your patch will be reviewed on the mailing list. You will likely be asked
to make some changes and are expected to send in an improved version that
incorporates the requests from the review. This process may go through
442 443
several iterations. Once your patch is deemed good enough, it will be
committed to the official Libav tree.
444 445 446 447 448

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.


449 450 451 452
@section New codecs or formats checklist

@enumerate
@item
453 454
Did you use av_cold for codec initialization and close functions?

455
@item
456 457 458
Did you add a long_name under NULL_IF_CONFIG_SMALL to the AVCodec or
AVInputFormat/AVOutputFormat struct?

459
@item
460 461 462
Did you bump the minor version number (and reset the micro version
number) in @file{libavcodec/version.h} or @file{libavformat/version.h}?

463
@item
464 465
Did you register it in @file{allcodecs.c} or @file{allformats.c}?

466
@item
467 468 469 470
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}.

471
@item
472 473 474
If it has a FourCC, did you add it to @file{libavformat/riff.c},
even if it is only a decoder?

475
@item
476 477 478 479
Did you add a rule to compile the appropriate files in the Makefile?
Remember to do this even if you are just adding a format to a file that
is already being compiled by some other rule, like a raw demuxer.

480
@item
481 482 483
Did you add an entry to the table of supported formats or codecs in
@file{doc/general.texi}?

484
@item
485 486
Did you add an entry in the Changelog?

487
@item
488 489 490
If it depends on a parser or a library, did you add that dependency in
configure?

491
@item
492 493
Did you @code{git add} the appropriate files before committing?

494
@item
495 496 497
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)?
498 499
@end enumerate

500

501 502 503 504
@section patch submission checklist

@enumerate
@item
505 506
Does @code{make check} pass with the patch applied?

507
@item
508 509
Is the patch against latest Libav git master branch?

510
@item
511 512 513 514
Are you subscribed to the
@uref{https://lists.libav.org/mailman/listinfo/libav-devel, libav-devel}
mailing list? (Only list subscribers are allowed to post.)

515
@item
516 517 518
Have you checked that the changes are minimal, so that the same cannot be
achieved with a smaller patch and/or simpler final code?

519
@item
520 521
If the change is to speed critical code, did you benchmark it?

522
@item
523 524
If you did any benchmarks, did you provide them in the mail?

525
@item
526 527 528
Have you checked that the patch does not introduce buffer overflows or
other security issues?

529
@item
530 531 532 533 534 535
Did you test your decoder or demuxer against damaged data? If no, see
tools/trasher, the noise bitstream filter, and
@uref{http://caca.zoy.org/wiki/zzuf, zzuf}. Your decoder or demuxer
should not crash, end in a (near) infinite loop, or allocate ridiculous
amounts of memory when fed damaged data.

536
@item
537 538
Does the patch not mix functional and cosmetic changes?

539
@item
540 541
Did you add tabs or trailing whitespace to the code? Both are forbidden.

542
@item
543 544
Is the patch attached to the email you send?

545
@item
546 547 548
Is the mime type of the patch correct? It should be text/x-diff or
text/x-patch or at least text/plain and not application/octet-stream.

549
@item
550 551
If the patch fixes a bug, did you provide a verbose analysis of the bug?

552
@item
553 554 555 556 557
If the patch fixes a bug, did you provide enough information, including
a sample, so the bug can be reproduced and the fix can be verified?
Note please do not attach samples >100k to mails but rather provide a
URL, you can upload to ftp://upload.libav.org

558
@item
559 560
Did you provide a verbose summary about what the patch does change?

561
@item
562 563
Did you provide a verbose explanation why it changes things like it does?

564
@item
565 566 567
Did you provide a verbose summary of the user visible advantages and
disadvantages if the patch is applied?

568
@item
569 570 571
Did you provide an example so we can verify the new feature added by the
patch easily?

572
@item
573 574 575
If you added a new file, did you insert a license header? It should be
taken from Libav, not randomly copied and pasted from somewhere else.

576
@item
577 578 579
You should maintain alphabetical order in alphabetically ordered lists as
long as doing so does not break API/ABI compatibility.

580
@item
581 582 583
Lines with similar content should be aligned vertically when doing so
improves readability.

584
@item
585 586 587
Make sure you check the return values of function and return appropriate
error codes. Especially memory allocation functions like @code{malloc()}
are notoriously left unchecked, which is a serious problem.
588 589 590 591
@end enumerate

@section Patch review process

592 593 594
All patches posted to the
@uref{https://lists.libav.org/mailman/listinfo/libav-devel, libav-devel}
mailing list will be reviewed, unless they contain a
595
clear note that the patch is not for the git master branch.
596 597 598 599 600 601 602 603 604 605 606 607
Reviews and comments will be posted as replies to the patch on the
mailing list. The patch submitter then has to take care of every comment,
that can be by resubmitting a changed patch or by discussion. Resubmitted
patches will themselves be reviewed like any other patch. If at some point
a patch passes review with no comments then it is approved, that can for
simple and small patches happen immediately while large patches will generally
have to be changed and reviewed many times before they are approved.
After a patch is approved it will be committed to the repository.

We will review all submitted patches, but sometimes we are quite busy so
especially for large patches this can take several weeks.

608 609
When resubmitting patches, if their size grew or during the review different
issues arisen please split the patch so each issue has a specific patch.
610

611 612
@anchor{Regression Tests}
@section Regression Tests
613

614 615
Before submitting a patch (or committing to the repository), you should at
least make sure that it does not break anything.
616

617 618
If the code changed has already a test present in FATE you should run it,
otherwise it is advised to add it.
619

620 621 622
Improvements to codec or demuxer might change the FATE results. Make sure
to commit the update reference with the change and to explain in the comment
why the expected result changed.
623

624
Please refer to @url{fate.html}.
625

626 627 628 629 630 631 632 633 634 635
@subsection Visualizing Test Coverage

The Libav build system allows visualizing the test coverage in an easy
manner with the coverage tools @code{gcov}/@code{lcov}.  This involves
the following steps:

@enumerate
@item
    Configure to compile with instrumentation enabled:
    @code{configure --toolchain=gcov}.
636

637 638 639 640
@item
    Run your test case, either manually or via FATE. This can be either
    the full FATE regression suite, or any arbitrary invocation of any
    front-end tool provided by Libav, in any combination.
641

642 643
@item
    Run @code{make lcov} to generate coverage data in HTML format.
644

645 646 647 648 649 650 651 652
@item
    View @code{lcov/index.html} in your preferred HTML viewer.
@end enumerate

You can use the command @code{make lcov-reset} to reset the coverage
measurements. You will need to rerun @code{make lcov} after running a
new test.

653 654 655 656
@subsection Using Valgrind

The configure script provides a shortcut for using valgrind to spot bugs
related to memory handling. Just add the option
657 658 659 660
@code{--toolchain=valgrind-memcheck} or @code{--toolchain=valgrind-massif}
to your configure line, and reasonable defaults will be set for running
FATE under the supervision of either the @strong{memcheck} or the
@strong{massif} tool of the valgrind suite.
661 662 663 664 665

In case you need finer control over how valgrind is invoked, use the
@code{--target-exec='valgrind <your_custom_valgrind_options>} option in
your configure line instead.

666 667 668 669 670 671 672 673 674 675 676 677 678
@anchor{Release process}
@section Release process

Libav maintains a set of @strong{release branches}, which are the
recommended deliverable for system integrators and distributors (such as
Linux distributions, etc.). At irregular times, a @strong{release
manager} prepares, tests and publishes tarballs on the
@url{http://libav.org} website.

There are two kinds of releases:

@enumerate
@item
679 680 681
@strong{Major releases} always include the latest and greatest
features and functionality.

682
@item
683 684 685
@strong{Point releases} are cut from @strong{release} branches,
which are named @code{release/X}, with @code{X} being the release
version number.
686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705
@end enumerate

Note that we promise to our users that shared libraries from any Libav
release never break programs that have been @strong{compiled} against
previous versions of @strong{the same release series} in any case!

However, from time to time, we do make API changes that require adaptations
in applications. Such changes are only allowed in (new) major releases and
require further steps such as bumping library version numbers and/or
adjustments to the symbol versioning file. Please discuss such changes
on the @strong{libav-devel} mailing list in time to allow forward planning.

@anchor{Criteria for Point Releases}
@subsection Criteria for Point Releases

Changes that match the following criteria are valid candidates for
inclusion into a point release:

@enumerate
@item
706 707 708
Fixes a security issue, preferably identified by a @strong{CVE
number} issued by @url{http://cve.mitre.org/}.

709
@item
710 711
Fixes a documented bug in @url{http://bugzilla.libav.org}.

712
@item
713 714
Improves the included documentation.

715
@item
716 717
Retains both source code and binary compatibility with previous
point releases of the same release branch.
718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733
@end enumerate

The order for checking the rules is (1 OR 2 OR 3) AND 4.

All Libav developers are welcome to nominate commits that they push to
@code{master} by mailing the @strong{libav-stable} mailing list. The
easiest way to do so is to include @code{CC: libav-stable@@libav.org} in
the commit message.


@subsection Release Checklist

The release process involves the following steps:

@enumerate
@item
734 735 736
Ensure that the @file{RELEASE} file contains the version number for
the upcoming release.

737
@item
738 739 740 741
File a release tracking bug in @url{http://bugzilla.libav.org}. Make
sure that the bug has an alias named @code{ReleaseX.Y} for the
@code{X.Y} release.

742
@item
743 744
Announce the intent to do a release to the mailing list.

745
@item
746 747 748
Reassign unresolved blocking bugs from previous release
tracking bugs to the new bug.

749
@item
750 751 752 753
Review patch nominations that reach the @strong{libav-stable}
mailing list, and push patches that fulfill the stable release
criteria to the release branch.

754
@item
755 756 757 758
Ensure that the FATE regression suite still passes in the release
branch on at least @strong{i386} and @strong{amd64}
(cf. @ref{Regression Tests}).

759
@item
760 761 762 763
Prepare the release tarballs in @code{xz} and @code{gz} formats, and
supplementing files that contain @code{md5} and @code{sha1}
checksums.

764
@item
765 766 767 768
Publish the tarballs at @url{http://libav.org/releases}. Create and
push an annotated tag in the form @code{vX}, with @code{X}
containing the version number.

769
@item
770 771 772
Build the tarballs with the Windows binaries, and publish them at
@url{http://win32.libav.org/releases}.

773
@item
774 775 776
Propose and send a patch to the @strong{libav-devel} mailing list
with a news entry for the website.

777
@item
778 779
Publish the news entry.

780
@item
781
Send announcement to the mailing list.
782 783
@end enumerate

784
@bye