[FFmpeg-devel] [PATCH] doc/developer: improve Development Policy formatting

[Michael Niedermayer]

On Sat, Oct 01, 2016 at 02:07:40AM +0100, Josh de Kock wrote:
> Signed-off-by: Josh de Kock <josh at itanimul.li>
> ---
>  doc/developer.texi | 163 ++++++++++++++++++++++++-----------------------------
>  1 file changed, 74 insertions(+), 89 deletions(-)
> 
> diff --git a/doc/developer.texi b/doc/developer.texi
> index 4d3a7ae..2df58a9 100644
> --- a/doc/developer.texi
> +++ b/doc/developer.texi
> @@ -246,8 +246,9 @@ For Emacs, add these roughly equivalent lines to your @file{.emacs.d/init.el}:
>  
>  @section Development Policy
>  
> - at enumerate
> - at item
> + at subsection Patches
> +
> + at subheading Licenses for patches must be compatible with FFmpeg.
>  Contributions should be licensed under the
>  @uref{http://www.gnu.org/licenses/lgpl-2.1.html, LGPL 2.1},
>  including an "or any later version" clause, or, if you prefer
> @@ -260,15 +261,13 @@ preferred.
>  If you add a new file, give it a proper license header. Do not copy and
>  paste it from a random place, use an existing file as template.
>  
> - at item
> -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
> -(#ifdef etc) by default so it does not interfere with other developers'
> -work.
> + at subheading You must not commit code which breaks FFmpeg!
> +This means unfinished code which is enabled and breaks compilation,
> +compiles but does not work or breaks the regression tests). Always
> +check the mailing list for any reviewers with issues and test FATE
> +before you push.
>  
> - at item
> + at subheading Keep the main commit message short with an extended description below.
>  The commit message should have a short first line in the form of
>  a @samp{topic: short description} as a header, separated by a newline
>  from the body consisting of an explanation of why the change is necessary.
> @@ -276,53 +275,7 @@ If the commit fixes a known bug on the bug tracker, the commit message
>  should include its bug ID. Referring to the issue on the bug tracker does
>  not exempt you from writing an excerpt of the bug in the commit message.
>  

> - at item
> -You do not have to over-test things. If it works for you, and you think it
> -should work for others, then commit. If your code has problems
> -(portability, triggers compiler bugs, unusual environment etc) they will be
> -reported and eventually fixed.

This text disappears

[....]
-- 
Michael     GnuPG fingerprint: 9FF2128B147EF6730BADF133611EC787040B0FAB

There will always be a question for which you do not know the correct answer.
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 181 bytes
Desc: Digital signature
URL: <http://ffmpeg.org/pipermail/ffmpeg-devel/attachments/20161001/d9a8d085/attachment.sig>