summaryrefslogtreecommitdiffstats
path: root/doc/developer.texi
Commit message (Collapse)AuthorAgeFilesLines
* doc/developer: update style guidelines to include for loops with declarationsRostislav Pehlivanov2018-05-181-0/+3
| | | | Signed-off-by: Rostislav Pehlivanov <[email protected]>
* doc/developer: remove merge request method of contributingLou Logan2018-04-061-4/+2
| | | | | | | | | | This seems to confuse Github users into thinking that we may accept pull requests. We do not accept pull requests. Sending patches to the ffmpeg-devel mailing list is our preferred method for users to contribute code. Signed-off-by: Lou Logan <[email protected]>
* doc/developer: update link to "sign-off" infoLou Logan2018-04-051-3/+3
| | | | | | Found by Hendrik Schreiber. Signed-off-by: Lou Logan <[email protected]>
* doc/developer: revise mailing list sectionJim DeLaHunt2017-12-051-4/+20
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The Developer Documentation had instructions to subscribe to the ffmpeg-cvslog email list. But that is no longer accurate. For the purposes in this section -- review of patches, discussion of development issues -- ffmpeg_devel is the appropriate email list. Some developers may want to monitor ffmpeg-cvslog, but it is not mandatory. This is v3 of this doc, based on discussion in thread <https://ffmpeg.org/pipermail/ffmpeg-devel/2017-November/220528.html> and in response to docs Maintainer comments in <https://ffmpeg.org/pipermail/ffmpeg-devel/2017-December/221596.html>. 1. In doc/developer.texi, add a new section about ffmpeg-devel, based on existing text from ffmpeg-cvslog section regarding discussion of patches and of development issues. Reflect wording from discussion at <https://ffmpeg.org/pipermail/ffmpeg-devel/2017-November/221199.html> but with copy-editing to make wording more concise. 2. In doc/developer.texi, rewrite the ffmpeg-cvslog section to match the current usage of ffmpeg-cvslog. Some developers choose to follow this list, but it is not mandatory. There are a lot of improvements possible to the Developer Documentation page, beyond this refactoring. However, making those improvements is a much bigger and more difficult task. This change is "low hanging fruit". Signed-off-by: Jim DeLaHunt <[email protected]> Signed-off-by: Timothy Gu <[email protected]>
* doc: reorganize developer.texi chapter hierarchyJim DeLaHunt2017-12-021-27/+26
| | | | | | | | | | | | | | | | Previously, the Developer Documentation <ffmpeg.org/developer.html> contained a single chapter, "1. Developer Guide," with all content under that single chapter. Thus the document structure was one level deeper and more complicated than it needed to be. It differed from similar documents such as /faq.html, which have multiple chapters. Eliminate the single chapter, and promote each section underneath to chapter, and each subsection to section. Thus content and relative structure remains the same, but the overall structure is simpler. Anchors within the page remain the same. Signed-off-by: Jim DeLaHunt <[email protected]> Signed-off-by: Timothy Gu <[email protected]>
* Merge commit 'b5f19f7478492307e4b4763aeac3180faf50e17f'James Almer2017-10-301-1/+1
|\ | | | | | | | | | | | | * commit 'b5f19f7478492307e4b4763aeac3180faf50e17f': aac: Split function to parse ADTS header data into public and private part Merged-by: James Almer <[email protected]>
| * aac: Split function to parse ADTS header data into public and private partDiego Biurrun2017-05-021-1/+1
| | | | | | | | | | | | This makes the currently semi-public avpriv_aac_parse_header() function private to libavcodec and adds a proper public API function to return the parts of the ADTS header required in libavformat.
| * cosmetics: Fix spelling mistakesVittorio Giovara2016-05-041-2/+2
| | | | | | | | Signed-off-by: Diego Biurrun <[email protected]>
| * doc: Update paths to match new examples locationDiego Biurrun2016-03-231-2/+2
| |
| * doc: Change wrong term to avoid confusionGabriel Dume2014-08-181-1/+1
| | | | | | | | | | | | A function declaration is the prototype. Signed-off-by: Luca Barbato <[email protected]>
* | doc/developer: Add terse documentation of assumed C implementation defined ↵Michael Niedermayer2017-05-011-0/+5
| | | | | | | | | | | | | | behavior Suggested-by: "Ronald S. Bultje" <[email protected]> Signed-off-by: Michael Niedermayer <[email protected]>
* | doc/developer: Mention mime type and patchwork in "Submitting patches"Michael Niedermayer2016-10-111-1/+5
| | | | | | | | | | | | Suggested-by: ronald Reviewed-by: Steven Liu <[email protected]> Signed-off-by: Michael Niedermayer <[email protected]>
* | doc/developer: remove duplicate policies and fix errorJosh de Kock2016-10-041-16/+2
| | | | | | | | | | | | | | | | Fixes regression as of ee72b6d1 Reviewed-by: Michael Niedermayer <[email protected]> Signed-off-by: Josh de Kock <[email protected]> Signed-off-by: James Almer <[email protected]>
* | doc/developer: add sections for policiesJosh de Kock2016-10-041-32/+47
| | | | | | | | | | | | | | And sort policies into these sections. Reviewed-by: Michael Niedermayer <[email protected]> Signed-off-by: Josh de Kock <[email protected]>
* | doc/developer: reword some of the policiesJosh de Kock2016-10-041-47/+44
| | | | | | | | | | | | | | | | Explicitly state that FATE should pass, and code should work for all reviewers who tested. Reviewed-by: Michael Niedermayer <[email protected]> Signed-off-by: Josh de Kock <[email protected]>
* | doc/developer.texi: Add a code of conductMichael Niedermayer2016-05-261-0/+29
| | | | | | | | | | | | See: [FFmpeg-devel] [Vote] Code of Conduct Signed-off-by: Michael Niedermayer <[email protected]>
* | doc/developer: misc minor fixesGanesh Ajjanagadde2015-12-091-11/+10
| | | | | | | | Signed-off-by: Ganesh Ajjanagadde <[email protected]>
* | developer.texi: Call out K&R coding style.Rick Kern2015-11-291-0/+3
| | | | | | | | | | | | K&R coding style is implied but not listed in 'Coding Rules'. Signed-off-by: Rick Kern <[email protected]>
* | doc/developer: minor typo and consistency fixesGanesh Ajjanagadde2015-10-101-3/+3
| | | | | | | | Signed-off-by: Ganesh Ajjanagadde <[email protected]>
* | doc/developer: use https instead of httpGanesh Ajjanagadde2015-10-071-5/+5
| | | | | | | | | | | | | | Change to https for FFmpeg websites. Signed-off-by: Ganesh Ajjanagadde <[email protected]> Signed-off-by: Michael Niedermayer <[email protected]>
* | doc/developer: Suggest everyone to help with patch reviewsMichael Niedermayer2015-08-131-0/+4
| | | | | | | | | | | | | | Reviewed-by: Timothy Gu <[email protected]> Reviewed-by: compn <[email protected]> Reviewed-by: Ganesh Ajjanagadde <[email protected]> Signed-off-by: Michael Niedermayer <[email protected]>
* | doc/developer: add url for sample filesGanesh Ajjanagadde2015-07-181-0/+4
| | | | | | | | | | Signed-off-by: Ganesh Ajjanagadde <[email protected]> Signed-off-by: Michael Niedermayer <[email protected]>
* | doc: Use @lisp where appropriateTimothy Gu2015-03-231-2/+2
| | | | | | | | Signed-off-by: Michael Niedermayer <[email protected]>
* | doc: set documentencoding on toplevel texi files.Nicolas George2015-02-191-0/+1
| | | | | | | | | | | | Fix double UTF-8 encoding on output files. makeinfo / texi2any does not seem to provide a way of setting it globally for toplevel files.
* | doc: fix typosLou Logan2015-01-071-2/+2
| | | | | | | | Signed-off-by: Lou Logan <[email protected]>
* | docs: add example around the suggested commit message formatJames Darnley2014-09-121-0/+3
| | | | | | | | | | | | | | It gets rendered inline in HTML and becomes not very clear. Reviewed-by: Timothy Gu <[email protected]> Signed-off-by: Michael Niedermayer <[email protected]>
* | Merge commit '57ead8449e44bd07b3d4a5bd42f1aab64566f92e'Michael Niedermayer2013-12-231-1/+1
|\| | | | | | | | | | | | | * commit '57ead8449e44bd07b3d4a5bd42f1aab64566f92e': doc: fix link to the ISC license text in the developer documentation. Merged-by: Michael Niedermayer <[email protected]>
| * doc: fix link to the ISC license text in the developer documentation.Tim Walker2013-12-221-1/+1
| |
* | Merge commit '6c0e83511705e7f8f5100e7852a1e7fd16aa8877'Michael Niedermayer2013-12-231-1/+1
|\| | | | | | | | | | | | | * commit '6c0e83511705e7f8f5100e7852a1e7fd16aa8877': doc: fix a coding style error in the developer documentation. Merged-by: Michael Niedermayer <[email protected]>
| * doc: fix a coding style error in the developer documentation.Tim Walker2013-12-221-1/+1
| |
* | doc/developer: Add a policy item about updating the MAINTAINERs fileMichael Niedermayer2013-10-191-0/+6
| | | | | | | | Signed-off-by: Michael Niedermayer <[email protected]>
* | doc/developer: Merge license related policy itemsMichael Niedermayer2013-10-131-3/+2
| | | | | | | | Signed-off-by: Michael Niedermayer <[email protected]>
* | Merge remote-tracking branch 'qatar/master'Michael Niedermayer2013-07-281-226/+316
|\| | | | | | | | | | | | | | | | | | | | | * qatar/master: doc: cosmetics: Consistently format list and table items Conflicts: doc/developer.texi doc/fate.texi Merged-by: Michael Niedermayer <[email protected]>
| * doc: cosmetics: Consistently format list and table itemsDiego Biurrun2013-07-271-201/+292
| |
* | doc/developer: update sections about external developmentStefano Sabatini2013-07-111-23/+17
| | | | | | | | | | | | | | | | | | 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
* | update all trac links to use the trac subdomainMichael Niedermayer2013-06-291-2/+2
| | | | | | | | Signed-off-by: Michael Niedermayer <[email protected]>
* | Merge commit '8e673efc6f5b7a095557664660305148f2788d30'Michael Niedermayer2013-05-191-3/+4
|\| | | | | | | | | | | | | | | | | | | | | | | * 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 <[email protected]>
| * configure: Add basic valgrind-massif supportLuca Barbato2013-05-181-3/+4
| | | | | | | | | | | | With the parameter --toolchain valgrind-massif, the configure script sets reasonable defaults that can be overridden as explained in the documentation.
* | Merge commit 'b1ee8eec849f17fce2f411a297de9cbf2edaeb3a'Michael Niedermayer2013-05-051-0/+12
|\| | | | | | | | | | | | | | | | | | | * commit 'b1ee8eec849f17fce2f411a297de9cbf2edaeb3a': configure: Add basic valgrind-memcheck support Conflicts: configure Merged-by: Michael Niedermayer <[email protected]>
| * configure: Add basic valgrind-memcheck supportReinhard Tartler2013-05-041-0/+12
| | | | | | | | | | | | | | | | 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.
* | Merge commit 'a862c7d3368241e72a465ab944afa38ea62a6640'Michael Niedermayer2013-04-061-0/+24
|\| | | | | | | | | | | | | | | | | | | | | * commit 'a862c7d3368241e72a465ab944afa38ea62a6640': Integrate lcov/gcov into Libav Conflicts: Makefile common.mak Merged-by: Michael Niedermayer <[email protected]>
| * Integrate lcov/gcov into LibavReinhard Tartler2013-04-051-0/+24
| | | | | | | | | | | | | | 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/
* | Merge remote-tracking branch 'qatar/master'Michael Niedermayer2013-03-221-5/+8
|\| | | | | | | | | | | | | | | * qatar/master: configure: Enable hwaccels without external dependencies by default. doc/developer: Clarify symbol naming prefixes section. Merged-by: Michael Niedermayer <[email protected]>
| * doc/developer: Clarify symbol naming prefixes section.Diego Biurrun2013-03-211-5/+8
| |
* | doc/developer: fix typo in regression tests ref.Clément Bœsch2013-03-191-1/+1
| |
* | doc/developer: Add "security fixes" to the release process stepsMichael Niedermayer2013-03-171-0/+3
| | | | | | | | Signed-off-by: Michael Niedermayer <[email protected]>
* | Merge commit '23f4c5acc438366d84cacf49e33b0bcd72f04937'Michael Niedermayer2013-03-171-0/+85
|\| | | | | | | | | | | | | * commit '23f4c5acc438366d84cacf49e33b0bcd72f04937': document the release process Merged-by: Michael Niedermayer <[email protected]>
| * document the release processReinhard Tartler2013-03-161-0/+103
| |
* | Merge commit '040c565e51985477a8fa5e42d2ddfb26ebde6608'Michael Niedermayer2013-02-241-1/+1
|\| | | | | | | | | | | | | | | | | | | | | * 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 <[email protected]>
| * doc: developer: Allow tabs in the vim configuration for Automake filesDiego Biurrun2013-02-231-1/+1
| | | | | | | | | | While we do not use Automake in libav, this allows our config to be used more globally without introducing unwanted breakage.