From mboxrd@z Thu Jan 1 00:00:00 1970 Authentication-Results: mx.groups.io; dkim=missing; spf=none, err=permanent DNS error (domain: linux.intel.com, ip: 192.55.52.43, mailfrom: ryszard.knop@linux.intel.com) Received: from mga05.intel.com (mga05.intel.com [192.55.52.43]) by groups.io with SMTP; Tue, 10 Sep 2019 08:44:43 -0700 X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from orsmga008.jf.intel.com ([10.7.209.65]) by fmsmga105.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 10 Sep 2019 08:44:42 -0700 X-IronPort-AV: E=Sophos;i="5.64,489,1559545200"; d="scan'208";a="178715350" Received: from torii.igk.intel.com (HELO torii) ([10.102.24.20]) by orsmga008-auth.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 10 Sep 2019 08:44:40 -0700 Message-ID: <57976eb87976eba0e18f70726ad1813f440e7acf.camel@linux.intel.com> Subject: Re: [edk2-devel] [PATCH edk2-CCSS 0/3] Coding Standards: add rule for documenting spurious variable assignments From: "Ryszard Knop" To: devel@edk2.groups.io, leif.lindholm@linaro.org, Laszlo Ersek Cc: Andrew Fish , Michael D Kinney , Rebecca Cran , Philippe Mathieu-Daude Date: Tue, 10 Sep 2019 17:44:29 +0200 In-Reply-To: <20190910153304.GD15201@bivouac.eciton.net> References: <20190905183820.10312-1-lersek@redhat.com> <20190906122623.GS29255@bivouac.eciton.net> <54fb3783-7589-feff-e446-1e592686d7d2@redhat.com> <20190910153304.GD15201@bivouac.eciton.net> Organization: Intel Corporation User-Agent: Evolution 3.32.4 MIME-Version: 1.0 Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: 7bit On Tue, 2019-09-10 at 16:33 +0100, Leif Lindholm wrote: > On Mon, Sep 09, 2019 at 02:35:15PM +0200, Laszlo Ersek wrote: > > 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 > > > > > > 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'm not even sure I wasn't one of the people opposed to it then. > But if I was, I would appear to have changed my mind. > > > I could be mis-remembering; we can restart that discussion if now > > the > > macros are preferred. > > I would be all for that. If my 2 cents are worth anything, that'd be preferred by some folks in my team too. Although something shorter like "UNINITIALIZED_INT/PTR" would be nicer, IMO. Both work of course. Richard > However, I see no reason why we shouldn't document the current > process > in the meantime, so for 3/3 also: > Reviewed-by: Leif Lindholm > > Best Regards, > > Leif > > > 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 > > > > > > >