Git Inbox Mirror of the ffmpeg-devel mailing list - see https://ffmpeg.org/mailman/listinfo/ffmpeg-devel
 help / color / mirror / Atom feed
From: Lynne <dev@lynne.ee>
To: ffmpeg-devel@ffmpeg.org
Subject: Re: [FFmpeg-devel] [PATCH] doc/developer: Better {} style rule
Date: Fri, 28 Feb 2025 13:24:46 +0100
Message-ID: <e88955d9-fbcd-47d5-874a-df4e72b3136e@lynne.ee> (raw)
In-Reply-To: <20250228023318.GR4991@pb2>


[-- Attachment #1.1.1.1: Type: text/plain, Size: 2294 bytes --]



On 28/02/2025 03:33, Michael Niedermayer wrote:
> On Fri, Feb 28, 2025 at 03:25:06AM +0100, Lynne wrote:
>> On 27/02/2025 02:10, Michael Niedermayer wrote:
>>> Signed-off-by: Michael Niedermayer <michael@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)
>>>    @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
>>
>> Strongly objecting to this patch. It's all over our codebase, and I like it.
>> Literally everywhere you look.
>> If future patches need to add more under the branch, then it only needs to
>> be done once.
>>
>> Such fundamental changes need more than a single patch hastily accepted, and
>> should involve the community as a whole, I believe.
> 
> Its not a change, look at tools/patcheck
> 
> or try:
> 
> +    if(this)
> +        that
> +    else
> +        nothat
> +
> 
> patcheck reports:
> 
> missing } prior to else
> patcheck.stdout:11:+    else
> 
> missing whitespace between keyword and ( (feel free to ignore)
> patcheck.stdout:9:+    if(this)

Ah, okay. I didn't read properly. The double negative in the sentence 
makes it hard to understand.

Rather than
 > No braces around single-line blocks, unless they are followed by an 
else (to keep future patches cleaner)

Consider
 > Don't wrap single-line blocks in braces. Use braces only if there is 
an accompanying else statement. This keeps future code changes easier to 
keep track of.

[-- Attachment #1.1.1.2: OpenPGP public key --]
[-- Type: application/pgp-keys, Size: 637 bytes --]

[-- Attachment #1.2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 236 bytes --]

[-- Attachment #2: Type: text/plain, Size: 251 bytes --]

_______________________________________________
ffmpeg-devel mailing list
ffmpeg-devel@ffmpeg.org
https://ffmpeg.org/mailman/listinfo/ffmpeg-devel

To unsubscribe, visit link above, or email
ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".

  reply	other threads:[~2025-02-28 12:25 UTC|newest]

Thread overview: 22+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-02-27  1:10 Michael Niedermayer
2025-02-27 22:46 ` epirat07
2025-02-27 22:53   ` Vittorio Giovara
2025-02-27 22:57     ` James Almer
2025-02-28  0:40       ` Devin Heitmueller
2025-02-28  0:58         ` Michael Niedermayer
2025-02-28  7:53           ` Nicolas George
2025-02-28 10:13             ` Marvin S.
2025-02-28 14:07           ` Devin Heitmueller
2025-02-28 14:16             ` Nicolas George
2025-02-28 14:21             ` martin schitter
2025-02-28 15:09               ` Nicolas George
2025-02-28 15:13                 ` Vittorio Giovara
2025-02-28  1:11         ` Soft Works
2025-02-27 23:14   ` Michael Niedermayer
2025-02-27 23:25     ` epirat07
2025-02-28  3:22       ` Michael Niedermayer
2025-02-28  2:25 ` Lynne
2025-02-28  2:33   ` Michael Niedermayer
2025-02-28 12:24     ` Lynne [this message]
2025-02-28 13:44       ` Vittorio Giovara
2025-02-28 15:12       ` Michael Niedermayer

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=e88955d9-fbcd-47d5-874a-df4e72b3136e@lynne.ee \
    --to=dev@lynne.ee \
    --cc=ffmpeg-devel@ffmpeg.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

Git Inbox Mirror of the ffmpeg-devel mailing list - see https://ffmpeg.org/mailman/listinfo/ffmpeg-devel

This inbox may be cloned and mirrored by anyone:

	git clone --mirror https://master.gitmailbox.com/ffmpegdev/0 ffmpegdev/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 ffmpegdev ffmpegdev/ https://master.gitmailbox.com/ffmpegdev \
		ffmpegdev@gitmailbox.com
	public-inbox-index ffmpegdev

Example config snippet for mirrors.


AGPL code for this site: git clone https://public-inbox.org/public-inbox.git