[FFmpeg-devel] [PATCH] doc/developer: Better {} style rule

[epirat07 at gmail.com]

On 27 Feb 2025, at 2:10, Michael Niedermayer wrote:

> Signed-off-by: Michael Niedermayer <michael at niedermayer.cc>
> ---
>  doc/developer.texi | 11 +++++------
>  1 file changed, 5 insertions(+), 6 deletions(-)
>
> diff --git a/doc/developer.texi b/doc/developer.texi
> index a1bfe180c9b..6a753f99da6 100644
> --- a/doc/developer.texi
> +++ b/doc/developer.texi
> @@ -179,18 +179,17 @@ int fields = ilace ? 2 : 1;
>  @end example
>
>  @item
> -No braces around single-line blocks:
> +No braces around single-line blocks, unless they are followed by an else (to keep future patches cleaner)
>

I agree with this, however people in the past pointed it out when new code did this, IIRC.

So if we merge this, people should stop flagging this in reviews, else its frustrating
for new contributors following the documentation and then getting contradicting reviews.

>  @example c, good
>  // Good
> -if (bits_pixel == 24)
> +if (bits_pixel == 24) @{
>      avctx->pix_fmt = AV_PIX_FMT_BGR24;
> -else if (bits_pixel == 8)
> +@} else if (bits_pixel == 8) @{
>      avctx->pix_fmt = AV_PIX_FMT_GRAY8;
> -else @{
> -    av_log(avctx, AV_LOG_ERROR, "Invalid pixel format.\n");
> +@} else
>      return AVERROR_INVALIDDATA;
> -@}
> +
>  @end example
>
>  @item
> -- 
> 2.48.1
>
> _______________________________________________
> ffmpeg-devel mailing list
> ffmpeg-devel at ffmpeg.org
> https://ffmpeg.org/mailman/listinfo/ffmpeg-devel
>
> To unsubscribe, visit link above, or email
> ffmpeg-devel-request at ffmpeg.org with subject "unsubscribe".