Commit Graph

64 Commits

Author SHA1 Message Date
Gabriel Dume
dd35d451fb doc: Change wrong term to avoid confusion
A function declaration is the prototype.

Signed-off-by: Luca Barbato <lu_zero@gentoo.org>
2014-08-18 13:29:25 +02:00
Tim Walker
57ead8449e doc: fix link to the ISC license text in the developer documentation. 2013-12-22 22:35:11 +01:00
Tim Walker
6c0e835117 doc: fix a coding style error in the developer documentation. 2013-12-22 22:34:58 +01:00
Diego Biurrun
270d7e3a18 doc: cosmetics: Consistently format list and table items 2013-07-27 16:24:55 +02:00
Luca Barbato
edfe609fc9 configure: Add basic valgrind-massif support
With the parameter --toolchain valgrind-massif, the configure
script sets reasonable defaults that can be overridden as explained
in the documentation.
2013-05-18 21:29:17 +02:00
Reinhard Tartler
b1ee8eec84 configure: Add basic valgrind-memcheck support
With the parameter --valgrind-memcheck, the configure script sets
reasonable defaults that can be overridden as explained in the
documentation.

The idea of using set_defaults is from Luca Barbato.
2013-05-04 12:17:51 +02:00
Reinhard Tartler
a862c7d336 Integrate lcov/gcov into Libav
The gcov/lcov are a common toolchain for visualizing code coverage with
the GNU/Toolchain. The documentation and implementation of this
integration was heavily inspired from the blog entry by Mike Melanson:
http://multimedia.cx/eggs/using-lcov-with-ffmpeg/
2013-04-05 18:55:11 +02:00
Diego Biurrun
72ad96c854 doc/developer: Clarify symbol naming prefixes section. 2013-03-21 14:17:37 +01:00
Reinhard Tartler
23f4c5acc4 document the release process 2013-03-16 18:00:54 +01:00
Diego Biurrun
040c565e51 doc: developer: Allow tabs in the vim configuration for Automake files
While we do not use Automake in libav, this allows our config to be
used more globally without introducing unwanted breakage.
2013-02-23 20:13:47 +01:00
Diego Biurrun
3658d2dfd4 doc: developer: Add a note about reserved system name space 2013-02-11 20:17:15 +01:00
Diego Biurrun
56dea32f09 doc: developer: Fix wording in "naming conventions" section 2013-02-11 20:17:15 +01:00
Diego Biurrun
8787847dc6 doc/developer: Drop obsolete MPlayer reference 2013-02-01 11:17:24 +01:00
Diego Biurrun
8b0fda180e doc/developer: Add ISC license to list of acceptable licenses 2013-02-01 11:17:21 +01:00
Diego Biurrun
cb30bf7f03 doc/developer: Add web links for all suggested licenses 2013-02-01 11:16:55 +01:00
Derek Buitenhuis
6042a12174 doc: Extend commit message section
If a bug exists on the tracker, its ID should always be included
in fix messages.

Also, any relevant bug fixes should be CC'd to libav-stable, so
we can actually track what needs to be backported, instead of
just randomly combing the git history and old CVEs.

Signed-off-by: Derek Buitenhuis <derek.buitenhuis@gmail.com>
2013-01-07 14:55:49 -05:00
Derek Buitenhuis
ac2603be28 doc: Mention memory allocation in the fuzz testing section
It's obviously undesireable to blindly allocate memory based on
a damaged 'size' value, for example.

Signed-off-by: Derek Buitenhuis <derek.buitenhuis@gmail.com>
2013-01-07 14:55:49 -05:00
Derek Buitenhuis
dc3e12d1cb doc: Mention zzuf in the fuzz testing section
It's pretty much the best tool for the job, and it's what we
all use now anyway.

Signed-off-by: Derek Buitenhuis <derek.buitenhuis@gmail.com>
2013-01-07 14:55:49 -05:00
Derek Buitenhuis
b5f9b9ac36 doc: Merge disjointed bits about emailing patches
We obviously prefer git-send-email(1), and the disjointed nature
of the two statements was misleading.

Signed-off-by: Derek Buitenhuis <derek.buitenhuis@gmail.com>
2013-01-07 14:55:48 -05:00
Derek Buitenhuis
9a00374cb4 doc: Fix a few typos in the developer documentation
Signed-off-by: Derek Buitenhuis <derek.buitenhuis@gmail.com>
2013-01-07 14:55:48 -05:00
Diego Biurrun
511cf612ac miscellaneous typo fixes 2012-12-21 00:18:34 +01:00
Anton Khirnov
bbabeb56fa Add reminders to update the codec descriptor list with new codec IDs. 2012-08-29 10:47:59 +02:00
Jordi Ortiz
fd6a085a22 doc: Fix syntax errors in sample Emacs config
Signed-off-by: Diego Biurrun <diego@biurrun.de>
2012-08-17 10:59:42 +02:00
Anton Khirnov
36ef5369ee Replace all CODEC_ID_* with AV_CODEC_ID_* 2012-08-07 16:00:24 +02:00
Diego Biurrun
4aad316bff doc: Remind devs to check return values, especially for malloc() et al 2012-07-02 10:56:54 +02:00
Diego Biurrun
4982e1ddfa build: Add 'check' target to run all compile and test targets. 2012-05-15 19:10:46 +02:00
Luca Barbato
e004bc16a1 doc: clarify check for NULL pointer style
Our code should be terse and clear.
2012-05-06 15:47:10 -07:00
Diego Biurrun
b553a425fb doc: Update sample Vim config with suitable (function) indentation settings. 2012-04-16 10:12:45 +02:00
Diego Biurrun
3892e784f2 doc: Improve suggested Emacs settings for our coding style.
Switch from changing global values to defining a separate C style
and add appropriate settings for indenting assignments that span
more than one line.
2012-04-15 16:18:03 +02:00
Derek Buitenhuis
86ae512453 doc: make developer.texi point to correct fate doc
Signed-off-by: Derek Buitenhuis <derek.buitenhuis@gmail.com>
Signed-off-by: Diego Biurrun <diego@biurrun.de>
2011-12-13 23:34:23 +01:00
Diego Biurrun
da9cea77e3 Fix a bunch of common typos. 2011-12-11 00:32:25 +01:00
Diego Biurrun
d8538f06e6 doc: add editor configuration section with Vim and Emacs settings
based on a patch by Victor Vasiliev, vasilvv gmail com
2011-12-07 18:57:43 +01:00
Diego Biurrun
def5dc1260 doc: document preferred Doxygen syntax and make patcheck detect it 2011-12-04 23:49:48 +01:00
Luca Barbato
a0338b598b doc: break some long lines in developer.texi 2011-12-03 01:35:38 +01:00
Janne Grunau
84994421bc doc: remove space between variable and post increment in example code 2011-12-03 01:11:12 +01:00
Victor Vasiliev
9b9815eec4 Update developers documentation with coding conventions.
Signed-off-by: Luca Barbato <lu_zero@gentoo.org>
2011-12-02 23:06:41 +01:00
Diego Biurrun
dd8d808ba6 doc: library versions need to be bumped in version.h 2011-09-21 14:57:29 +02:00
Michael Niedermayer
2dbdb309ac patch checklist: suggest fate instead of regression tests
Signed-off-by: Anton Khirnov <anton@khirnov.net>
2011-08-15 11:53:45 +02:00
Anton Khirnov
266463daff Rename ffplay to avplay. 2011-08-09 19:56:21 +02:00
Diego Biurrun
a2f31564b4 doc: remove file name from @file directive in Doxygen usage example
The file name is redundant and brittle across file renamings.
2011-07-14 20:51:01 +02:00
Diego Biurrun
2cb6dec61c doc: Improve references to external URLs.
Sometimes it makes sense to replace a raw URL with some informative text
that links to the URL instead of using the raw URL itself in the text.
Also transform some mailing list references into links.
2011-07-12 23:42:20 +02:00
Diego Biurrun
5ccbf80963 doc: Remove outdated comments about gcc 2.95 and gcc 3.3 support. 2011-07-11 23:25:44 +02:00
Diego Biurrun
4c98976124 doc: replace @pxref by @ref where appropriate 2011-07-09 21:53:59 +02:00
Diego Biurrun
af1ca249e8 doc: Check standalone compilation before submitting new components. 2011-05-04 21:12:42 +02:00
Luca Barbato
4c362a5212 doc: update developer guide
Refer to the current submission policy and refer to FATE in the
Regression Test section.
2011-04-13 10:01:14 +02:00
Janne Grunau
faa6f1c306 get rid of the last svn mentions 2011-03-18 21:57:38 +01:00
Janne Grunau
f8a45fa1b1 replace FFmpeg with Libav in doc/
unless it stands for ffmpeg the program or is historic
2011-03-16 22:01:01 +01:00
Johan Andersson
21de920472 Update the url to the site website and change ffmpeg-devel to libav-devel
Signed-off-by: Ronald S. Bultje <rsbultje@gmail.com>
2011-03-13 18:45:29 -04:00
Reinhard Tartler
87800dc2bf Documentation updates for the git migration
This cleanup patch updates the developer documentation with respect to
the migration to the git scm.
2011-02-08 22:07:02 +01:00
Janne Grunau
a8f0814a74 doc: modify style for texi2html 1.78+
The generated HTML files are similar to the ones generated with
texi2html 1.56k used on the website.

Tested with texi2html 1.78 and 5.0. 1.78 is the minimal recommended
version.

The removed @sp from the titlepage section were ignored until
texi2html 5.0. If not removed the pages generated by 5.0 will have ugly
empty space around the title.
2011-01-29 16:57:29 +01:00