aboutsummaryrefslogtreecommitdiffstats
path: root/doc/developer.texi
Commit message (Collapse)AuthorAgeFilesLines
* all: fix typos found by codespellTimo Rothenpieler4 days1-3/+3
|
* configure: Allow mixing declarations and statementsAndreas Rheinhardt2025-04-091-3/+0
| | | | | | | | | | | | | This C90 rule forces us to use a too big scope and should therefore be dropped. Given that we already require C11, all supported compilers can handle mixed declarations and statements just fine. Reviewed-by: Zhao Zhili <quinkblack-at-foxmail.com@ffmpeg.org> Reviewed-by: Marvin Scholz <epirat07@gmail.com> Reviewed-by: Michael Niedermayer <michael@niedermayer.cc> Reviewed-by: softworkz . <softworkz-at-hotmail.com@ffmpeg.org> Signed-off-by: Andreas Rheinhardt <andreas.rheinhardt@outlook.com>
* doc/developer: Better {} style ruleMichael Niedermayer2025-03-011-6/+5
| | | | | | This makes developer.texi consistent with tools/patcheck Signed-off-by: Michael Niedermayer <michael@niedermayer.cc>
* doc/developer: add examples to clarify code styleMarvin Scholz2024-11-251-1/+100
| | | | | | Given the frequency that new developers, myself included, get the code style wrong, it is useful to add some examples to clarify how things should be done.
* doc/developer: Document relationship between git accounts and MAINTAINERSMichael Niedermayer2024-11-201-0/+19
| | | | | | This should have been documented long ago and i thought it was Signed-off-by: Michael Niedermayer <michael@niedermayer.cc>
* configure: drop yasm supportLynne2024-10-061-1/+1
| | | | | | | | | | We started defauling to nasm 8 years ago. We are still compatible with yasm 0.8.0, released in 2009. **15 years ago**. The time has more than come to remove support for it. Maintaining compatibility started cutting into writing new code long ago. We still can't have 2-argument instructions, preprocessor booleans, and all AVX2 code must still be wrapped in ifdefs. Newly added code often breaks this.
* doc/developer: Provide information about git send-email and gmailMichael Niedermayer2024-06-131-0/+5
| | | | | | The 2 links are the clearest i found. Signed-off-by: Michael Niedermayer <michael@niedermayer.cc>
* doc/developer: update outdated informationMarcus B Spencer2024-06-031-2/+2
| | | | | | | | | | | | | Codec IDs have split from `avcodec.h` into `codec_id.h` after commit c6978418b836180c349aea3512f0a96227ecfc9b. General documentation contents (which are now in `general_contents.texi`) have split from the header in `general.texi` after commit 6accb7718aa4c9f5ca8f3280a1ed4e09587a627f. Update the developer documentation to match these changes. Signed-off-by: Marcus B Spencer <marcus@marcusspencer.xyz>
* doc/developer: (security) researchers should be creditedMichael Niedermayer2024-04-031-0/+4
| | | | | Reviewed-by: Tomas Härdin <git@haerdin.se> Signed-off-by: Michael Niedermayer <michael@niedermayer.cc>
* Require compilers to support C11.Anton Khirnov2024-02-181-8/+2
| | | | | | | | | It should be available in all relevant modern compilers and will allow us to use features like anonymous unions. Note that stdatomic.h is still emulated on MSVC, as current versions require the /experimental:c11atomics, and do not support ATOMIC_VAR_INIT() anyway.
* doc/developer: require asm for RISC-VJean-Baptiste Kempf2023-12-051-1/+1
| | | | | | | Explicitly document our usage of assembly, following suit with other architectures. Signed-off-by: J. Dekker <jdek@itanimul.li>
* doc/developer: deduplicate commit message rulesAnton Khirnov2023-10-031-23/+18
| | | | | | The patches/committing section currently contains several partially-overlapping rules on commit messages. Merge and simplify them into one item.
* doc/developer: drop an outdated itemAnton Khirnov2023-10-031-9/+0
| | | | | | | It dates back to pre-2005 days, when people generally tended to commit their work directly without going through the mailing list. Few developers do it today, and never outside of their standalone modules. This item is thus confusing and misleading and is better removed.
* doc/developer: add a code behaviour section to development policyAnton Khirnov2023-10-031-14/+36
| | | | | Document our longstanding de facto policies on things like correctness, thread-safety, undefined behaviour, etc.
* doc/developer: fix a nonsense statementAnton Khirnov2023-10-031-1/+1
| | | | | Adding new fields to _functions_ makes no sense, it was supposed to be structs.
* doc/developer: merge the 'contributing code' section into its parent chapterAnton Khirnov2023-10-031-2/+0
| | | | | | | The section consistes of a single short paragraph linking to other chapters. The enclosing chapter also has no other sections, all other text is placed in the chapter directly. Keeping a separate section for this paragraph just adds more clutter.
* doc/developer: move a sentence to a more appropriate placeAnton Khirnov2023-10-031-4/+4
| | | | | It's targeted at our users, not developers, so it makes more sense to group it with other text targeted at our users.
* doc/developer: Require new modules to include testsMichael Niedermayer2023-06-241-1/+4
| | | | Signed-off-by: Michael Niedermayer <michael@niedermayer.cc>
* doc/developer: mention samples-request for FATE upload requestsThilo Borgmann2023-04-231-0/+2
|
* doc/developer.texi: add a section on API/ABI compatibilityAnton Khirnov2023-03-201-16/+146
| | | | Document established practices in it.
* doc/developer.texi: document checkasmAnton Khirnov2023-03-201-0/+4
|
* doc/developer.texi: document the use of other languages than CAnton Khirnov2023-03-201-2/+36
|
* doc: Merge doc/dev_community/* and Code of Conduct into a seperate fileThilo Borgmann2023-03-011-29/+0
| | | | | | Remove doc/dev_communit markup files completely as they are at the wrong place. Create a new community page, merging all of doc/dev_community and subsection Code of Conduct into a common place. The corresponding patch to ffmpeg-web puts the Organisation & Code of Conduct into a seperate community chapter on the FFmpeg website.
* doc/developer.texi: extend and update naming conventionsAnton Khirnov2022-11-231-16/+27
| | | | | | Bring it up to date with current practice, as the current text does not cover everything. Drop the reference to unprefixed exported symbols, which do not exist anymore.
* doc/developer.texi: drop a misplaced sentence from code formatting sectionAnton Khirnov2022-11-231-3/+0
| | | | | | It describes a general development policy, not code formatting. It is also not true, as these days we tend to prioritize correctness, safety, and completeness over code size.
* doc/developer.texi: move editor configuration under formattingAnton Khirnov2022-11-231-33/+34
| | | | It logically belongs there.
* doc/developer.texi: update the language feature sectionAnton Khirnov2022-11-231-37/+12
| | | | | | | | It is currently very out of touch with reality. * declare we are using C99 fully, rather than C90 plus extensions * mention our use of stdatomic.h * mention forbidden C99 features, like VLAs and complex numbers
* doc/developer.texi: move the language feature section higher upAnton Khirnov2022-11-231-52/+52
| | | | | It makes more sense to first describe the language we are using and only then document how to format code in it, rather than the reverse.
* doc/developer.texi: refine the "contributing code" sectionAnton Khirnov2022-11-171-9/+5
| | | | | | | | Drop the reference to directly committing code, because - it is highly discouraged and very rarely done these days - there is no good reason NOT to submit patches for review Add a link to the development policy chapter.
* doc/developer.texi: demote the "contributing" chapter to a sectionAnton Khirnov2022-11-171-1/+1
| | | | | It is very short and its main functions is linking to the coding rules/submitting patches chapters.
* doc/developer.texi: extend the argument for submitting patchesAnton Khirnov2022-11-171-5/+15
| | | | | Stop talking about commercial programs, since this applies to any downstream user.
* doc/developer.texi: improve the introductory textAnton Khirnov2022-11-171-6/+12
| | | | Remove confusing references to "external" vs. "internal" developers.
* doc/developer: add description about safely sending patches via E-Mail clientsSoft Works2021-11-131-0/+16
| | | | | Signed-off-by: softworkz <softworkz@hotmail.com> Signed-off-by: Marton Balint <cus@passwd.hu>
* fftools/ffmpeg: update text requesting samplesAndriy Gelman2020-06-011-1/+1
| | | | | Signed-off-by: Andriy Gelman <andriy.gelman@gmail.com> Reviewed-by: Marton Balint <cus@passwd.hu>
* doc/developer.texi: Add variadic macros to allowed C language featuresAndreas Rheinhardt2020-03-261-0/+3
| | | | | | They are used in several places like CBS. Signed-off-by: Andreas Rheinhardt <andreas.rheinhardt@gmail.com>
* doc/developer: update style guidelines to include for loops with declarationsRostislav Pehlivanov2018-05-181-0/+3
| | | | Signed-off-by: Rostislav Pehlivanov <atomnuker@gmail.com>
* 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 <lou@lrcd.com>
* doc/developer: update link to "sign-off" infoLou Logan2018-04-051-3/+3
| | | | | | Found by Hendrik Schreiber. Signed-off-by: Lou Logan <lou@lrcd.com>
* 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 <from.ffmpeg-dev@jdlh.com> Signed-off-by: Timothy Gu <timothygu99@gmail.com>
* 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 <from.ffmpeg-dev@jdlh.com> Signed-off-by: Timothy Gu <timothygu99@gmail.com>
* 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 <jamrial@gmail.com>
| * 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 <diego@biurrun.de>
| * 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 <lu_zero@gentoo.org>
* | doc/developer: Add terse documentation of assumed C implementation defined ↵Michael Niedermayer2017-05-011-0/+5
| | | | | | | | | | | | | | behavior Suggested-by: "Ronald S. Bultje" <rsbultje@gmail.com> Signed-off-by: Michael Niedermayer <michael@niedermayer.cc>
* | doc/developer: Mention mime type and patchwork in "Submitting patches"Michael Niedermayer2016-10-111-1/+5
| | | | | | | | | | | | Suggested-by: ronald Reviewed-by: Steven Liu <lingjiujianke@gmail.com> Signed-off-by: Michael Niedermayer <michael@niedermayer.cc>
* | doc/developer: remove duplicate policies and fix errorJosh de Kock2016-10-041-16/+2
| | | | | | | | | | | | | | | | 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>
* | doc/developer: add sections for policiesJosh de Kock2016-10-041-32/+47
| | | | | | | | | | | | | | And sort policies into these sections. Reviewed-by: Michael Niedermayer <michael@niedermayer.cc> Signed-off-by: Josh de Kock <josh@itanimul.li>
* | 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 <michael@niedermayer.cc> Signed-off-by: Josh de Kock <josh@itanimul.li>
generated by cgit v1.2.3 (git 2.25.1) at 2025-08-07 16:38:08 +0000