Commit Graph

143 Commits

Author SHA1 Message Date
Timothy Gu c3d0edd406 doc: Use @lisp where appropriate
Signed-off-by: Michael Niedermayer <michaelni@gmx.at>
2015-03-23 17:21:38 +01:00
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.
2015-02-19 11:30:30 +01:00
Lou Logan 919e038a95 doc: fix typos
Signed-off-by: Lou Logan <lou@lrcd.com>
2015-01-07 17:17:33 -09:00
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>
2014-09-12 01:59:44 +02:00
Michael Niedermayer 5a8b4ed580 Merge commit '57ead8449e44bd07b3d4a5bd42f1aab64566f92e'
* commit '57ead8449e44bd07b3d4a5bd42f1aab64566f92e':
  doc: fix link to the ISC license text in the developer documentation.

Merged-by: Michael Niedermayer <michaelni@gmx.at>
2013-12-23 12:52:50 +01:00
Michael Niedermayer 5b4c7b7dcf Merge commit '6c0e83511705e7f8f5100e7852a1e7fd16aa8877'
* commit '6c0e83511705e7f8f5100e7852a1e7fd16aa8877':
  doc: fix a coding style error in the developer documentation.

Merged-by: Michael Niedermayer <michaelni@gmx.at>
2013-12-23 11:58:36 +01: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
Michael Niedermayer a6388616e8 doc/developer: Add a policy item about updating the MAINTAINERs file
Signed-off-by: Michael Niedermayer <michaelni@gmx.at>
2013-10-19 15:20:03 +02:00
Michael Niedermayer 4b948dcadb doc/developer: Merge license related policy items
Signed-off-by: Michael Niedermayer <michaelni@gmx.at>
2013-10-13 10:46:32 +02:00
Michael Niedermayer f0308af5fa Merge remote-tracking branch 'qatar/master'
* qatar/master:
  doc: cosmetics: Consistently format list and table items

Conflicts:
	doc/developer.texi
	doc/fate.texi

Merged-by: Michael Niedermayer <michaelni@gmx.at>
2013-07-28 14:21:11 +02:00
Diego Biurrun 270d7e3a18 doc: cosmetics: Consistently format list and table items 2013-07-27 16:24:55 +02:00
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
2013-07-11 00:01:19 +02:00
Michael Niedermayer 7f866c14ba update all trac links to use the trac subdomain
Signed-off-by: Michael Niedermayer <michaelni@gmx.at>
2013-06-29 19:27:49 +02:00
Michael Niedermayer fa6001e728 Merge commit '8e673efc6f5b7a095557664660305148f2788d30'
* commit '8e673efc6f5b7a095557664660305148f2788d30':
  prores: update FATE test to account for alpha plane present in the test sample
  configure: Add basic valgrind-massif support

Conflicts:
	tests/fate/prores.mak
	tests/ref/fate/prores-alpha

Merged-by: Michael Niedermayer <michaelni@gmx.at>
2013-05-19 10:53:39 +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
Michael Niedermayer 4451be5ce1 Merge commit 'b1ee8eec849f17fce2f411a297de9cbf2edaeb3a'
* commit 'b1ee8eec849f17fce2f411a297de9cbf2edaeb3a':
  configure: Add basic valgrind-memcheck support

Conflicts:
	configure

Merged-by: Michael Niedermayer <michaelni@gmx.at>
2013-05-05 10:47:19 +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
Michael Niedermayer 84bfa8beb7 Merge commit 'a862c7d3368241e72a465ab944afa38ea62a6640'
* commit 'a862c7d3368241e72a465ab944afa38ea62a6640':
  Integrate lcov/gcov into Libav

Conflicts:
	Makefile
	common.mak

Merged-by: Michael Niedermayer <michaelni@gmx.at>
2013-04-06 13:23:38 +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
Michael Niedermayer abbc34c372 Merge remote-tracking branch 'qatar/master'
* qatar/master:
  configure: Enable hwaccels without external dependencies by default.
  doc/developer: Clarify symbol naming prefixes section.

Merged-by: Michael Niedermayer <michaelni@gmx.at>
2013-03-22 12:58:22 +01:00
Diego Biurrun 72ad96c854 doc/developer: Clarify symbol naming prefixes section. 2013-03-21 14:17:37 +01:00
Clément Bœsch 1c3b428114 doc/developer: fix typo in regression tests ref. 2013-03-19 17:45:53 +01:00
Michael Niedermayer ef3c88838e doc/developer: Add "security fixes" to the release process steps
Signed-off-by: Michael Niedermayer <michaelni@gmx.at>
2013-03-17 22:53:28 +01:00
Michael Niedermayer ac1cea55ad Merge commit '23f4c5acc438366d84cacf49e33b0bcd72f04937'
* commit '23f4c5acc438366d84cacf49e33b0bcd72f04937':
  document the release process

Merged-by: Michael Niedermayer <michaelni@gmx.at>
2013-03-17 12:58:44 +01:00
Reinhard Tartler 23f4c5acc4 document the release process 2013-03-16 18:00:54 +01:00
Michael Niedermayer 2fc662ae63 Merge commit '040c565e51985477a8fa5e42d2ddfb26ebde6608'
* commit '040c565e51985477a8fa5e42d2ddfb26ebde6608':
  doc: developer: Allow tabs in the vim configuration for Automake files
  Remove pointless av_cold attributes in header files

Conflicts:
	libavcodec/h264.h

Merged-by: Michael Niedermayer <michaelni@gmx.at>
2013-02-24 14:32:55 +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
Clément Bœsch 15e7533ca1 doc/dev: clarify public symbols prefixes. 2013-02-13 20:19:32 +01:00
Michael Niedermayer a63dc846b5 Merge remote-tracking branch 'qatar/master'
* qatar/master:
  lavu: avoid clashing definition of E
  doc: developer: Add a note about reserved system name space

Conflicts:
	libavutil/internal.h

Merged-by: Michael Niedermayer <michaelni@gmx.at>
2013-02-12 14:10:36 +01:00
Michael Niedermayer 08db519e12 Merge commit '56dea32f09e71460add14a1b6d0fbe6eb16f02a4'
* commit '56dea32f09e71460add14a1b6d0fbe6eb16f02a4':
  doc: developer: Fix wording in "naming conventions" section
  openbsd: Add minor number to shared library install name

Conflicts:
	doc/developer.texi

Merged-by: Michael Niedermayer <michaelni@gmx.at>
2013-02-12 13:41:24 +01:00
Diego Biurrun 56dea32f09 doc: developer: Fix wording in "naming conventions" section 2013-02-11 20:17:15 +01:00
Diego Biurrun 3658d2dfd4 doc: developer: Add a note about reserved system name space 2013-02-11 20:17:15 +01:00
Michael Niedermayer 69a6eddd60 Merge commit 'f2960097e42ddf9a356bab6547f87906f6999e0a'
* commit 'f2960097e42ddf9a356bab6547f87906f6999e0a':
  bink: fix a check for the first frame.
  doc/developer: Drop obsolete MPlayer reference
  doc/developer: Add ISC license to list of acceptable licenses
  doc/developer: Add web links for all suggested licenses

Conflicts:
	doc/developer.texi

Merged-by: Michael Niedermayer <michaelni@gmx.at>
2013-02-01 14:15:30 +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
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>
2013-01-12 18:23:32 +01:00
Michael Niedermayer 249fca3df9 Merge commit '074a00d192c0e749d677b008b337da42597e780f'
* commit '074a00d192c0e749d677b008b337da42597e780f':
  lavr: add a public function for setting a custom channel map
  lavr: typedef internal structs in internal.h
  doc: Extend commit message section

Conflicts:
	doc/APIchanges
	doc/developer.texi

Merged-by: Michael Niedermayer <michaelni@gmx.at>
2013-01-08 12:56:41 +01:00
Michael Niedermayer 3a0bac27b3 Merge commit 'ac2603be28602bea76cf38bdbf37aead0dc2979a'
* commit 'ac2603be28602bea76cf38bdbf37aead0dc2979a':
  doc: Mention memory allocation in the fuzz testing section

Merged-by: Michael Niedermayer <michaelni@gmx.at>
2013-01-08 12:49:02 +01:00
Michael Niedermayer 32cf37d097 Merge commit 'dc3e12d1cb65d74fb120197ce869a205718b6715'
* commit 'dc3e12d1cb65d74fb120197ce869a205718b6715':
  doc: Mention zzuf in the fuzz testing section

Merged-by: Michael Niedermayer <michaelni@gmx.at>
2013-01-08 12:46:59 +01:00
Michael Niedermayer adc7296aa5 Merge commit 'b5f9b9ac3681acb06d95530f34660ba9fe225305'
* commit 'b5f9b9ac3681acb06d95530f34660ba9fe225305':
  doc: Merge disjointed bits about emailing patches

Conflicts:
	doc/developer.texi

Merged-by: Michael Niedermayer <michaelni@gmx.at>
2013-01-08 12:45:24 +01:00
Michael Niedermayer 3bca69c2a8 Merge commit '9a00374cb4512a58a1fee366b850dfa87c76e1f3'
* commit '9a00374cb4512a58a1fee366b850dfa87c76e1f3':
  doc: Fix a few typos in the developer documentation
  xwma: Remove unused variable
  asfdec: Fix printf format string length modifier

Conflicts:
	doc/developer.texi

Merged-by: Michael Niedermayer <michaelni@gmx.at>
2013-01-08 12:34:14 +01: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 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 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
Michael Niedermayer d27edc038a Merge commit '511cf612ac979f536fd65e14603a87ca5ad435f3'
* commit '511cf612ac979f536fd65e14603a87ca5ad435f3':
  miscellaneous typo fixes

Conflicts:
	libavcodec/4xm.c
	libavcodec/lagarith.c
	libavcodec/parser.c
	libavcodec/ratecontrol.c
	libavcodec/shorten.c
	libavcodec/vda_h264.c
	libavformat/dvenc.c
	libavformat/wtv.c
	tools/patcheck

Merged-by: Michael Niedermayer <michaelni@gmx.at>
2012-12-21 17:32:52 +01:00
Diego Biurrun 511cf612ac miscellaneous typo fixes 2012-12-21 00:18:34 +01:00