public inbox for devel@edk2.groups.io
 help / color / mirror / Atom feed
From: "Laszlo Ersek" <lersek@redhat.com>
To: Leif Lindholm <leif.lindholm@linaro.org>
Cc: edk2-devel-groups-io <devel@edk2.groups.io>,
	Andrew Fish <afish@apple.com>,
	Michael D Kinney <michael.d.kinney@intel.com>,
	Rebecca Cran <rebecca@bsdio.com>,
	Philippe Mathieu-Daude <philmd@redhat.com>
Subject: Re: [PATCH edk2-CCSS 0/3] Coding Standards: add rule for documenting spurious variable assignments
Date: Mon, 9 Sep 2019 14:35:15 +0200	[thread overview]
Message-ID: <54fb3783-7589-feff-e446-1e592686d7d2@redhat.com> (raw)
In-Reply-To: <20190906122623.GS29255@bivouac.eciton.net>

On 09/06/19 14:26, Leif Lindholm wrote:
> On Thu, Sep 05, 2019 at 08:38:17PM +0200, Laszlo Ersek wrote:
>> Repo:   https://github.com/lersek/edk2-CCodingStandardsSpecification.git
>> Branch: spurious_assign_bz_607
>>
>> HTML-rendered views of the modified pages:
>> - https://lersek.gitbooks.io/laszlo-s-fork-of-the-edk-ii-c-coding-standards-sp/content/v/spurious_assign_bz_607
>> - https://lersek.gitbooks.io/laszlo-s-fork-of-the-edk-ii-c-coding-standards-sp/content/v/spurious_assign_bz_607/6_documenting_software/62_comments.html
>> - https://lersek.gitbooks.io/laszlo-s-fork-of-the-edk-ii-c-coding-standards-sp/content/v/spurious_assign_bz_607/6_documenting_software/64_what_you_must_comment.html
>>
>> The first two patches are cleanups for things that popped up in the
>> discussion in <https://bugzilla.tianocore.org/show_bug.cgi?id=607>.
>>
>> The third patch is the one fixing the BZ.
> 
> For 1 and 2,
> Reviewed-by: Leif Lindholm <leif.lindholm@linaro.org>
> 
> For 3, I see no issue with it, but I do feel tempted by Phil's input
> of using explicit macros (obviating the need for specific comment).
> I seem to recall back in the mists of time we considered something
> similar.

Yes, I remember similarly.

> Vaguely. Am I misremembering, or did we disount that option?

Phil's current recommendation is what I would have preferred back then,
but it was rejected, as far as I recall. If I remember correctly, most
developers preferred naked NULLs / zeroes. I insisted on the comment as
a fallback / compromise, so that we'd have at least some visual cue.

I could be mis-remembering; we can restart that discussion if now the
macros are preferred.

Thanks,
Laszlo

> 
> Regards,
> 
> Leif
> 
>> Thanks,
>> Laszlo
>>
>> Cc: Andrew Fish <afish@apple.com>
>> Cc: Leif Lindholm <leif.lindholm@linaro.org>
>> Cc: Michael D Kinney <michael.d.kinney@intel.com>
>> Cc: Rebecca Cran <rebecca@bsdio.com>
>>
>> Laszlo Ersek (3):
>>   comments: remove "Horror Vacui" rule
>>   comments: restrict and clarify applicability of "/*" comments
>>   must comment: add rule for documenting spurious variable assignments
>>
>>  6_documenting_software/62_comments.md              | 20 +---------
>>  6_documenting_software/64_what_you_must_comment.md | 39 ++++++++++++++++++++
>>  README.md                                          |  1 +
>>  3 files changed, 42 insertions(+), 18 deletions(-)
>>
>> -- 
>> 2.19.1.3.g30247aa5d201
>>


  reply	other threads:[~2019-09-09 12:35 UTC|newest]

Thread overview: 15+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-09-05 18:38 [PATCH edk2-CCSS 0/3] Coding Standards: add rule for documenting spurious variable assignments Laszlo Ersek
2019-09-05 18:38 ` [PATCH edk2-CCSS 1/3] comments: remove "Horror Vacui" rule Laszlo Ersek
2019-09-05 18:38 ` [PATCH edk2-CCSS 2/3] comments: restrict and clarify applicability of "/*" comments Laszlo Ersek
2019-09-06  8:00   ` [edk2-devel] " Philippe Mathieu-Daudé
2019-09-05 18:38 ` [PATCH edk2-CCSS 3/3] must comment: add rule for documenting spurious variable assignments Laszlo Ersek
2019-09-06  8:13   ` [edk2-devel] " Philippe Mathieu-Daudé
2019-09-09 12:25     ` Laszlo Ersek
2019-09-09 13:35       ` Philippe Mathieu-Daudé
2019-09-06 12:26 ` [PATCH edk2-CCSS 0/3] Coding Standards: " Leif Lindholm
2019-09-09 12:35   ` Laszlo Ersek [this message]
2019-09-10 15:33     ` Leif Lindholm
2019-09-10 15:44       ` [edk2-devel] " Ryszard Knop
2019-09-11 17:51         ` Laszlo Ersek
2019-09-17 19:10           ` Michael D Kinney
2019-09-18 10:18             ` Laszlo Ersek

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-list 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=54fb3783-7589-feff-e446-1e592686d7d2@redhat.com \
    --to=devel@edk2.groups.io \
    /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
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox