Commit Graph

29 Commits

Author SHA1 Message Date
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
Zhihang Wang
24b403f3b7 Mention patcheck.
Patch by Zhihang Wang, zhihang D wang A gmail

Originally committed as revision 20780 to svn://svn.ffmpeg.org/ffmpeg/trunk
2009-12-08 23:23:44 +00:00
Diego Biurrun
07f77dad7a Explain the process of patch review and commit a bit.
Originally committed as revision 20119 to svn://svn.ffmpeg.org/ffmpeg/trunk
2009-10-01 11:58:34 +00:00
Diego Biurrun
72cdcc0b9b Replace @node commands with @anchor to refer to specific points in the text.
This fixes the warnings
** `Developers Guide' is up for `Coding Rules', but has no menu entry for this node
** `Invocation' is up for `FFmpeg formula evaluator', but has no menu entry for this node

Originally committed as revision 19831 to svn://svn.ffmpeg.org/ffmpeg/trunk
2009-09-13 16:46:28 +00:00
Benjamin Larsson
76bcd87b4c Change developer doc to reflect reality
Originally committed as revision 19799 to svn://svn.ffmpeg.org/ffmpeg/trunk
2009-09-09 17:27:30 +00:00
Diego Biurrun
a752069dba Split developer documentation off from general documentation.
Originally committed as revision 19269 to svn://svn.ffmpeg.org/ffmpeg/trunk
2009-06-24 22:58:58 +00:00