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
Michael Niedermayer
5ac603df83
doc/developer: add "Adding files to the fate-suite dataset"
...
Signed-off-by: Michael Niedermayer <michaelni@gmx.at>
12 years ago
Jordi Ortiz
fd6a085a22
doc: Fix syntax errors in sample Emacs config
...
Signed-off-by: Diego Biurrun <diego@biurrun.de>
12 years ago
Anton Khirnov
36ef5369ee
Replace all CODEC_ID_* with AV_CODEC_ID_*
12 years ago
Michael Niedermayer
41dd30068a
doc/developer: refer to av_malloc() instead of malloc()
...
Signed-off-by: Michael Niedermayer <michaelni@gmx.at>
13 years ago
Diego Biurrun
4aad316bff
doc: Remind devs to check return values, especially for malloc() et al
13 years ago
Diego Biurrun
4982e1ddfa
build: Add 'check' target to run all compile and test targets.
13 years ago
Luca Barbato
e004bc16a1
doc: clarify check for NULL pointer style
...
Our code should be terse and clear.
13 years ago
Clément Bœsch
77c0b361b0
doc: fix API examples references.
13 years ago
Diego Biurrun
b553a425fb
doc: Update sample Vim config with suitable (function) indentation settings.
13 years ago
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.
13 years ago
Derek Buitenhuis
d1c1e350c6
doc: make developer.texi point to correct fate doc
...
Signed-off-by: Derek Buitenhuis <derek.buitenhuis@gmail.com>
Signed-off-by: Michael Niedermayer <michaelni@gmx.at>
13 years ago
Clément Bœsch
c0bea18411
doc: fix "reference to nonexistent node `Regression Tests'" warning.
13 years ago
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>
13 years ago
Diego Biurrun
da9cea77e3
Fix a bunch of common typos.
13 years ago
Michael Niedermayer
fab97adb66
docs: Minor project name cleanup
...
Signed-off-by: Michael Niedermayer <michaelni@gmx.at>
13 years ago
Diego Biurrun
d8538f06e6
doc: add editor configuration section with Vim and Emacs settings
...
based on a patch by Victor Vasiliev, vasilvv gmail com
13 years ago
Diego Biurrun
def5dc1260
doc: document preferred Doxygen syntax and make patcheck detect it
13 years ago