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
Stefano Sabatini
adbb9bcaa7
s/program/programs, as FFmpeg consists of many programs.
...
Originally committed as revision 25421 to svn://svn.ffmpeg.org/ffmpeg/trunk
2010-10-08 23:45:06 +00:00
Carl Eugen Hoyos
7c0460496b
Mention to send a patch before changing API or ABI.
...
Originally committed as revision 25373 to svn://svn.ffmpeg.org/ffmpeg/trunk
2010-10-06 17:43:15 +00:00
Diego Biurrun
7dbcc4f810
Mention that library micro version should be reset if minor version is bumped.
...
Originally committed as revision 25010 to svn://svn.ffmpeg.org/ffmpeg/trunk
2010-08-31 12:54:40 +00:00
Stefano Sabatini
f2c44ad511
Revert commit:
...
Author: stefano
Date: Sat Jul 3 20:19:38 2010
New Revision: 24023
Log:
State in the guidelines that function and parameter descriptions in
the doxy must use impersonal verbal form.
This form is apparently favored by most English speaker developers,
and has the advantage of being easier to use than the third person
form.
This should hopefully put an end to the Third Person Holy Bikeshed
War.
The change was neither discussed on the FFmpeg ML, nor approved by the
project leader.
The Holy War will continue soon on FFmpeg-devel, stay tuned ;-).
Originally committed as revision 24039 to svn://svn.ffmpeg.org/ffmpeg/trunk
2010-07-04 15:40:03 +00:00
Stefano Sabatini
0e7fa0bc3b
State in the guidelines that function and parameter descriptions in
...
the doxy must use impersonal verbal form.
This form is apparently favored by most English speaker developers,
and has the advantage of being easier to use than the third person
form.
This should hopefully put an end to the Third Person Holy Bikeshed
War.
Originally committed as revision 24023 to svn://svn.ffmpeg.org/ffmpeg/trunk
2010-07-03 18:19:38 +00:00
Diego Biurrun
c08b985637
Clarify where the list of supported formats is.
...
Originally committed as revision 22699 to svn://svn.ffmpeg.org/ffmpeg/trunk
2010-03-27 13:17:56 +00:00
Ramiro Polla
2972e36e27
Don't use shell syntax to set variables for make.
...
Originally committed as revision 22471 to svn://svn.ffmpeg.org/ffmpeg/trunk
2010-03-12 02:23:59 +00:00
Ramiro Polla
4cb93f5171
Update documentation for make test.
...
Originally committed as revision 21343 to svn://svn.ffmpeg.org/ffmpeg/trunk
2010-01-20 02:26:32 +00:00
Carl Eugen Hoyos
65214b621f
Cosmetics: Fix typos in r20780.
...
Originally committed as revision 20787 to svn://svn.ffmpeg.org/ffmpeg/trunk
2009-12-09 22:45:56 +00:00