X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;ds=sidebyside;f=doc%2Fdeveloper.texi;h=6db93cef707076b511b57f52e50656a64e86c154;hb=67ebc88fb5baaa0de25f22a9207868b3fc9296c2;hp=cad1c297345ae1acd7bc9670ef9945a19e1ebcf3;hpb=93fb4a46298c5dc456154b0eb594b8a704e366cd;p=ffmpeg diff --git a/doc/developer.texi b/doc/developer.texi index cad1c297345..6db93cef707 100644 --- a/doc/developer.texi +++ b/doc/developer.texi @@ -32,10 +32,10 @@ consult @url{https://ffmpeg.org/legal.html}. @section Contributing -There are 3 ways by which code gets into ffmpeg. +There are 3 ways by which code gets into FFmpeg. @itemize @bullet -@item Submitting Patches to the main developer mailing list - see @ref{Submitting patches} for details. +@item Submitting patches to the main developer mailing list. + See @ref{Submitting patches} for details. @item Directly committing changes to the main tree. @item Committing changes to a git clone, for example on github.com or gitorious.org. And asking us to merge these changes. @@ -65,6 +65,9 @@ rejected by the git repository. @item You should try to limit your code lines to 80 characters; however, do so if and only if this improves readability. + +@item +K&R coding style is used. @end itemize The presentation is one inspired by 'indent -i4 -kr -nut'. @@ -394,8 +397,8 @@ or obfuscates the code. Make sure that no parts of the codebase that you maintain are missing from the @file{MAINTAINERS} file. If something that you want to maintain is missing add it with your name after it. -If at some point you no longer want to maintain some code, then please help -finding a new maintainer and also don't forget updating the @file{MAINTAINERS} file. +If at some point you no longer want to maintain some code, then please help in +finding a new maintainer and also don't forget to update the @file{MAINTAINERS} file. @end enumerate We think our rules are not too hard. If you have comments, contact us. @@ -407,7 +410,7 @@ First, read the @ref{Coding Rules} above if you did not yet, in particular the rules regarding patch submission. When you submit your patch, please use @code{git format-patch} or -@code{git send-email}. We cannot read other diffs :-) +@code{git send-email}. We cannot read other diffs :-). Also please do not submit a patch which contains several unrelated changes. Split it into separate, self-contained pieces. This does not mean splitting @@ -567,7 +570,7 @@ If the patch fixes a bug, did you provide a verbose analysis of the bug? 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.ffmpeg.org +URL, you can upload to ftp://upload.ffmpeg.org. @item Did you provide a verbose summary about what the patch does change? @@ -596,10 +599,10 @@ Lines with similar content should be aligned vertically when doing so improves readability. @item -Consider to add a regression test for your code. +Consider adding a regression test for your code. @item -If you added YASM code please check that things still work with --disable-yasm +If you added YASM code please check that things still work with --disable-yasm. @item Make sure you check the return values of function and return appropriate @@ -664,7 +667,6 @@ Once you have a working fate test and fate sample, provide in the commit message or introductory message for the patch series that you post to the ffmpeg-devel mailing list, a direct link to download the sample media. - @subsection Visualizing Test Coverage The FFmpeg build system allows visualizing the test coverage in an easy @@ -803,7 +805,7 @@ with a news entry for the website. Publish the news entry. @item -Send announcement to the mailing list. +Send an announcement to the mailing list. @end enumerate @bye