Michael Niedermayer
b706ddbae3
doc/developer: Add terse documentation of assumed C implementation defined behavior
...
Suggested-by: "Ronald S. Bultje" <rsbultje@gmail.com>
Signed-off-by: Michael Niedermayer <michael@niedermayer.cc>
8 years ago
Michael Niedermayer
51f3278089
doc/developer: Mention mime type and patchwork in "Submitting patches"
...
Suggested-by: ronald
Reviewed-by: Steven Liu <lingjiujianke@gmail.com>
Signed-off-by: Michael Niedermayer <michael@niedermayer.cc>
8 years ago
Josh de Kock
5173ffb27f
doc/developer: remove duplicate policies and fix error
...
Fixes regression as of ee72b6d1
Reviewed-by: Michael Niedermayer <michael@niedermayer.cc>
Signed-off-by: Josh de Kock <josh@itanimul.li>
Signed-off-by: James Almer <jamrial@gmail.com>
8 years ago
Josh de Kock
ee72b6d187
doc/developer: add sections for policies
...
And sort policies into these sections.
Reviewed-by: Michael Niedermayer <michael@niedermayer.cc>
Signed-off-by: Josh de Kock <josh@itanimul.li>
8 years ago
Josh de Kock
36fa3d8807
doc/developer: reword some of the policies
...
Explicitly state that FATE should pass, and code should work
for all reviewers who tested.
Reviewed-by: Michael Niedermayer <michael@niedermayer.cc>
Signed-off-by: Josh de Kock <josh@itanimul.li>
8 years ago
Michael Niedermayer
89e9393022
doc/developer.texi: Add a code of conduct
...
See: [FFmpeg-devel] [Vote] Code of Conduct
Signed-off-by: Michael Niedermayer <michael@niedermayer.cc>
9 years ago
Vittorio Giovara
41ed7ab45f
cosmetics: Fix spelling mistakes
...
Signed-off-by: Diego Biurrun <diego@biurrun.de>
9 years ago
Diego Biurrun
48362ceade
doc: Update paths to match new examples location
9 years ago
Ganesh Ajjanagadde
82f3d47b4f
doc/developer: misc minor fixes
...
Signed-off-by: Ganesh Ajjanagadde <gajjanagadde@gmail.com>
9 years ago
Rick Kern
2f92322bff
developer.texi: Call out K&R coding style.
...
K&R coding style is implied but not listed in 'Coding Rules'.
Signed-off-by: Rick Kern <kernrj@gmail.com>
9 years ago
Ganesh Ajjanagadde
0281ef9075
doc/developer: minor typo and consistency fixes
...
Signed-off-by: Ganesh Ajjanagadde <gajjanagadde@gmail.com>
9 years ago
Ganesh Ajjanagadde
2d8ef1b690
doc/developer: use https instead of http
...
Change to https for FFmpeg websites.
Signed-off-by: Ganesh Ajjanagadde <gajjanagadde@gmail.com>
Signed-off-by: Michael Niedermayer <michael@niedermayer.cc>
9 years ago
Michael Niedermayer
5fec7942bf
doc/developer: Suggest everyone to help with patch reviews
...
Reviewed-by: Timothy Gu <timothygu99@gmail.com>
Reviewed-by: compn <tempn@mi.rr.com>
Reviewed-by: Ganesh Ajjanagadde <gajjanag@mit.edu>
Signed-off-by: Michael Niedermayer <michael@niedermayer.cc>
9 years ago
Ganesh Ajjanagadde
e3e4f1752c
doc/developer: add url for sample files
...
Signed-off-by: Ganesh Ajjanagadde <gajjanagadde@gmail.com>
Signed-off-by: Michael Niedermayer <michael@niedermayer.cc>
9 years ago
Timothy Gu
c3d0edd406
doc: Use @lisp where appropriate
...
Signed-off-by: Michael Niedermayer <michaelni@gmx.at>
10 years ago
Nicolas George
b491751409
doc: set documentencoding on toplevel texi files.
...
Fix double UTF-8 encoding on output files.
makeinfo / texi2any does not seem to provide a way of setting
it globally for toplevel files.
10 years ago
Lou Logan
919e038a95
doc: fix typos
...
Signed-off-by: Lou Logan <lou@lrcd.com>
10 years ago
James Darnley
e3fb2b0eb7
docs: add example around the suggested commit message format
...
It gets rendered inline in HTML and becomes not very clear.
Reviewed-by: Timothy Gu <timothygu99@gmail.com>
Signed-off-by: Michael Niedermayer <michaelni@gmx.at>
10 years ago
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>
10 years ago
Tim Walker
57ead8449e
doc: fix link to the ISC license text in the developer documentation.
11 years ago
Tim Walker
6c0e835117
doc: fix a coding style error in the developer documentation.
11 years ago
Michael Niedermayer
a6388616e8
doc/developer: Add a policy item about updating the MAINTAINERs file
...
Signed-off-by: Michael Niedermayer <michaelni@gmx.at>
11 years ago
Michael Niedermayer
4b948dcadb
doc/developer: Merge license related policy items
...
Signed-off-by: Michael Niedermayer <michaelni@gmx.at>
11 years ago
Diego Biurrun
270d7e3a18
doc: cosmetics: Consistently format list and table items
11 years ago
Stefano Sabatini
e7a6962e76
doc/developer: update sections about external development
...
Replace the sections "API" and "Integrating libavcodec or libavformat"
with updated / more accurate text.
See thread:
Subject: [FFmpeg-devel] [PATCH] doc/developer: merge and update sections about external development
Date: Fri, 5 Jul 2013 11:07:07 +0200
12 years ago
Michael Niedermayer
7f866c14ba
update all trac links to use the trac subdomain
...
Signed-off-by: Michael Niedermayer <michaelni@gmx.at>
12 years ago
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.
12 years ago
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.
12 years ago
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/
12 years ago
Diego Biurrun
72ad96c854
doc/developer: Clarify symbol naming prefixes section.
12 years ago
Clément Bœsch
1c3b428114
doc/developer: fix typo in regression tests ref.
12 years ago
Michael Niedermayer
ef3c88838e
doc/developer: Add "security fixes" to the release process steps
...
Signed-off-by: Michael Niedermayer <michaelni@gmx.at>
12 years ago
Reinhard Tartler
23f4c5acc4
document the release process
12 years ago
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.
12 years ago
Clément Bœsch
15e7533ca1
doc/dev: clarify public symbols prefixes.
12 years ago
Diego Biurrun
56dea32f09
doc: developer: Fix wording in "naming conventions" section
12 years ago
Diego Biurrun
3658d2dfd4
doc: developer: Add a note about reserved system name space
12 years ago
Diego Biurrun
8787847dc6
doc/developer: Drop obsolete MPlayer reference
12 years ago
Diego Biurrun
8b0fda180e
doc/developer: Add ISC license to list of acceptable licenses
12 years ago
Diego Biurrun
cb30bf7f03
doc/developer: Add web links for all suggested licenses
12 years ago
Michael Niedermayer
1c14c3412e
dec/developer: Add Valgrind / Address Sanitizer to the patch checklist
...
Reviewed-by: saste
Reviewed-by: Paul B Mahol <onemda@gmail.com>
Signed-off-by: Michael Niedermayer <michaelni@gmx.at>
12 years ago
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>
12 years ago
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>
12 years ago
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>
12 years ago
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>
12 years ago
Derek Buitenhuis
9a00374cb4
doc: Fix a few typos in the developer documentation
...
Signed-off-by: Derek Buitenhuis <derek.buitenhuis@gmail.com>
12 years ago
Diego Biurrun
511cf612ac
miscellaneous typo fixes
12 years ago
Peter Ross
f2ceb67e5b
doc: describe micro versioning policy
...
Signed-off-by: Michael Niedermayer <michaelni@gmx.at>
12 years ago
Peter Ross
6253cee497
the hyperlink to the Developer's Certificate of Origin no longer works; use Linux kernel hyperlink
...
Signed-off-by: Peter Ross <pross@xvid.org>
Signed-off-by: Michael Niedermayer <michaelni@gmx.at>
12 years ago
Anton Khirnov
bbabeb56fa
Add reminders to update the codec descriptor list with new codec IDs.
12 years ago