diff options
Diffstat (limited to 'doc/developer.texi')
| -rw-r--r-- | doc/developer.texi | 42 |
1 files changed, 21 insertions, 21 deletions
diff --git a/doc/developer.texi b/doc/developer.texi index ec196d7d0e..aedc4777bf 100644 --- a/doc/developer.texi +++ b/doc/developer.texi @@ -32,12 +32,12 @@ generated by ./configure to understand what is needed. You can use libavcodec or libavformat in your commercial program, but @emph{any patch you make must be published}. The best way to proceed is -to send your patches to the Libav mailing list. +to send your patches to the FFmpeg mailing list. @anchor{Coding Rules} @section Coding Rules -Libav is programmed in the ISO C90 language with a few additional +FFmpeg is programmed in the ISO C90 language with a few additional features from ISO C99, namely: @itemize @bullet @item @@ -54,7 +54,7 @@ These features are supported by all compilers we care about, so we will not accept patches to remove their use unless they absolutely do not impair clarity and performance. -All code must compile with GCC 2.95 and GCC 3.3. Currently, Libav also +All code must compile with GCC 2.95 and GCC 3.3. Currently, FFmpeg also compiles with several other compilers, such as the Compaq ccc compiler or Sun Studio 9, and we would like to keep it that way unless it would be exceedingly involved. To ensure compatibility, please do not use any @@ -76,7 +76,7 @@ The TAB character is forbidden outside of Makefiles as is any form of trailing whitespace. Commits containing either will be rejected by the git repository. -The main priority in Libav is simplicity and small code size in order to +The main priority in FFmpeg is simplicity and small code size in order to minimize the bug count. Comments: Use the JavaDoc/Doxygen @@ -129,7 +129,7 @@ should also be avoided if they don't make the code easier to understand. an "or any later version" clause is also acceptable, but LGPL is preferred. @item - You must not commit code which breaks Libav! (Meaning unfinished but + You must not commit code which breaks FFmpeg! (Meaning unfinished but enabled code which breaks compilation or compiles but does not work or breaks the regression tests) You can commit unfinished stuff (for testing etc), but it must be disabled @@ -151,7 +151,7 @@ should also be avoided if they don't make the code easier to understand. ask/discuss it on the developer mailing list. @item Do not change behavior of the programs (renaming options etc) or public - API or ABI without first discussing it on the libav-devel mailing list. + API or ABI without first discussing it on the ffmpeg-devel mailing list. Do not remove functionality from the code. Just improve! Note: Redundant code can be removed. @@ -160,7 +160,7 @@ should also be avoided if they don't make the code easier to understand. which change behavior, defaults etc, without asking first. The same applies to compiler warning fixes, trivial looking fixes and to code maintained by other developers. We usually have a reason for doing things - the way we do. Send your changes as patches to the libav-devel mailing + the way we do. Send your changes as patches to the ffmpeg-devel mailing list, and if the code maintainers say OK, you may commit. This does not apply to files you wrote and/or maintain. @item @@ -168,7 +168,7 @@ should also be avoided if they don't make the code easier to understand. with functional changes, such commits will be rejected and removed. Every developer has his own indentation style, you should not change it. Of course if you (re)write something, you can use your own style, even though we would - prefer if the indentation throughout Libav was consistent (Many projects + prefer if the indentation throughout FFmpeg was consistent (Many projects force a given indentation style - we do not.). If you really need to make indentation changes (try to avoid this), separate them strictly from real changes. @@ -182,27 +182,27 @@ should also be avoided if they don't make the code easier to understand. particular bug. Comments such as "fixed!" or "Changed it." are unacceptable. @item If you apply a patch by someone else, include the name and email address in - the log message. Since the libav-commits mailing list is publicly + the log message. Since the ffmpeg-cvslog mailing list is publicly archived you should add some SPAM protection to the email address. Send an - answer to libav-devel (or wherever you got the patch from) saying that + answer to ffmpeg-devel (or wherever you got the patch from) saying that you applied the patch. @item When applying patches that have been discussed (at length) on the mailing list, reference the thread in the log message. @item Do NOT commit to code actively maintained by others without permission. - Send a patch to libav-devel instead. If no one answers within a reasonable + Send a patch to ffmpeg-devel instead. If no one answers within a reasonable timeframe (12h for build failures and security fixes, 3 days small changes, 1 week for big patches) then commit your patch if you think it is OK. Also note, the maintainer can simply ask for more time to review! @item - Subscribe to the libav-commits mailing list. The diffs of all commits + Subscribe to the ffmpeg-cvslog mailing list. The diffs of all commits are sent there and reviewed by all the other developers. Bugs and possible improvements or general questions regarding commits are discussed there. We expect you to react if problems with your code are uncovered. @item Update the documentation if you change behavior or add features. If you are - unsure how best to do this, send a patch to libav-devel, the documentation + unsure how best to do this, send a patch to ffmpeg-devel, the documentation maintainer(s) will review and commit your stuff. @item Try to keep important discussions and requests (also) on the public @@ -253,7 +253,7 @@ keeping it as a logical unit that contains an individual change, even if it spans multiple files. This makes reviewing your patches much easier for us and greatly increases your chances of getting your patch applied. -Use the patcheck tool of Libav to check your patch. +Use the patcheck tool of FFmpeg to check your patch. The tool is located in the tools directory. Run the regression tests before submitting a patch so that you can @@ -261,8 +261,8 @@ verify that there are no big problems. Patches should be posted as base64 encoded attachments (or any other encoding which ensures that the patch will not be trashed during -transmission) to the libav-devel mailing list, see -@url{https://lists.libav.org/mailman/listinfo/libav-devel} +transmission) to the ffmpeg-devel mailing list, see +@url{http://lists.mplayerhq.hu/mailman/listinfo/ffmpeg-devel} It also helps quite a bit if you tell us what the patch does (for example 'replaces lrint by lrintf'), and why (for example '*BSD isn't C99 compliant @@ -275,7 +275,7 @@ Your patch will be reviewed on the mailing list. You will likely be asked to make some changes and are expected to send in an improved version that incorporates the requests from the review. This process may go through several iterations. Once your patch is deemed good enough, some developer -will pick it up and commit it to the official Libav tree. +will pick it up and commit it to the official FFmpeg tree. Give us a few days to react. But if some time passes without reaction, send a reminder by email. Your patch should eventually be dealt with. @@ -325,7 +325,7 @@ send a reminder by email. Your patch should eventually be dealt with. @item Is the patch a unified diff? @item - Is the patch against latest Libav git master branch? + Is the patch against latest FFmpeg git master branch? @item Are you subscribed to ffmpeg-dev? (the list is subscribers only due to spam) @@ -361,7 +361,7 @@ send a reminder by email. Your patch should eventually be dealt with. If the patch fixes a bug, did you provide enough information, including a sample, so the bug can be reproduced and the fix can be verified? Note please do not attach samples >100k to mails but rather provide a - URL, you can upload to ftp://upload.libav.org + URL, you can upload to ftp://upload.ffmpeg.org @item Did you provide a verbose summary about what the patch does change? @item @@ -374,7 +374,7 @@ send a reminder by email. Your patch should eventually be dealt with. patch easily? @item If you added a new file, did you insert a license header? It should be - taken from Libav, not randomly copied and pasted from somewhere else. + taken from FFmpeg, not randomly copied and pasted from somewhere else. @item You should maintain alphabetical order in alphabetically ordered lists as long as doing so does not break API/ABI compatibility. @@ -387,7 +387,7 @@ send a reminder by email. Your patch should eventually be dealt with. @section Patch review process -All patches posted to libav-devel will be reviewed, unless they contain a +All patches posted to ffmpeg-devel will be reviewed, unless they contain a clear note that the patch is not for the git master branch. Reviews and comments will be posted as replies to the patch on the mailing list. The patch submitter then has to take care of every comment, |