From mboxrd@z Thu Jan 1 00:00:00 1970 Authentication-Results: mx.groups.io; dkim=missing; spf=pass (domain: redhat.com, ip: 209.132.183.28, mailfrom: lersek@redhat.com) Received: from mx1.redhat.com (mx1.redhat.com [209.132.183.28]) by groups.io with SMTP; Mon, 09 Sep 2019 05:35:22 -0700 Received: from smtp.corp.redhat.com (int-mx07.intmail.prod.int.phx2.redhat.com [10.5.11.22]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id BC077301A631; Mon, 9 Sep 2019 12:35:21 +0000 (UTC) Received: from lacos-laptop-7.usersys.redhat.com (ovpn-116-196.ams2.redhat.com [10.36.116.196]) by smtp.corp.redhat.com (Postfix) with ESMTP id 636AA10013D9; Mon, 9 Sep 2019 12:35:16 +0000 (UTC) Subject: Re: [PATCH edk2-CCSS 0/3] Coding Standards: add rule for documenting spurious variable assignments To: Leif Lindholm Cc: edk2-devel-groups-io , Andrew Fish , Michael D Kinney , Rebecca Cran , Philippe Mathieu-Daude References: <20190905183820.10312-1-lersek@redhat.com> <20190906122623.GS29255@bivouac.eciton.net> From: "Laszlo Ersek" Message-ID: <54fb3783-7589-feff-e446-1e592686d7d2@redhat.com> Date: Mon, 9 Sep 2019 14:35:15 +0200 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:52.0) Gecko/20100101 Thunderbird/52.9.1 MIME-Version: 1.0 In-Reply-To: <20190906122623.GS29255@bivouac.eciton.net> X-Scanned-By: MIMEDefang 2.84 on 10.5.11.22 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.40]); Mon, 09 Sep 2019 12:35:21 +0000 (UTC) Content-Type: text/plain; charset=utf-8 Content-Language: en-US Content-Transfer-Encoding: 7bit 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 . >> >> The third patch is the one fixing the BZ. > > For 1 and 2, > Reviewed-by: Leif Lindholm > > 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 >> Cc: Leif Lindholm >> Cc: Michael D Kinney >> Cc: Rebecca Cran >> >> 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 >>