From mboxrd@z Thu Jan 1 00:00:00 1970 Authentication-Results: mx.groups.io; dkim=pass header.i=@linaro.org header.s=google header.b=wG+TLH55; spf=pass (domain: linaro.org, ip: 209.85.221.66, mailfrom: leif.lindholm@linaro.org) Received: from mail-wr1-f66.google.com (mail-wr1-f66.google.com [209.85.221.66]) by groups.io with SMTP; Fri, 06 Sep 2019 05:26:28 -0700 Received: by mail-wr1-f66.google.com with SMTP id w13so6377006wru.7 for ; Fri, 06 Sep 2019 05:26:27 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=date:from:to:cc:subject:message-id:references:mime-version :content-disposition:in-reply-to:user-agent; bh=Tq8RcjMyMHraFzX1fsjkN3i3P35kYwB8Hea9EPodl0M=; b=wG+TLH55VHtmV5rydaFSY9l9AqHFk2IQROKe18vMsj5Gy73spz5aJv9rDpm/Qr0ppi IuK+e7ykoRUCM8CN5MMW+crMiDOOeDeztG2QU0dniIgSTKkabQHhyxfBYMO33hehTeAx KfEJ6UgTdVzuOqVpn5dMqtTP+dtb5woz2ZOlKdN7eQghh3If4wJecFHDJnbVE6CVsOTf bSYNHdInf4z+WhNGydf7sCGLUig/RaKjhNRU5Y3SU61DEi706SsjTdb+eYr9TBGVG3Ar QnDtlScpzJfDCU2PB7ya/qiBi9OA3xXQTZZhvRO0vcekyF+WO0Dv0QilOLZiGiEVRhVh cPEA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:date:from:to:cc:subject:message-id:references :mime-version:content-disposition:in-reply-to:user-agent; bh=Tq8RcjMyMHraFzX1fsjkN3i3P35kYwB8Hea9EPodl0M=; b=BcfR4g2mfiR7Uycya8Zjt/IxuWwmbKnmqNwwGsh23z7ykvtcFkq6g6so1CoCzs6Kaj t+spn/YnhdsB8yo06xgdX0EOGJQ8GzNDzDuoc/Hd3DkzdfgmYB31OLlJJmaIiUBqS5cS 548MFWz97KcdZmMCDb8vKubbZGd5UVq6q866zdR2hNDOp5IgAg+4yeG4pp1aKQxbXTNM wcxoC8F2Mc+kdwsXWaiMzOl5njbKJNHKJx1RPuP6juF1mjantGTHi3w4lrdqJpI3yXbq 5nmWbO8RPQTQmxlEanLLAHOKnMy5olHa7nydueLnWX9EtFbk3jA/GG3vrZXIkPYboW9z 9AIw== X-Gm-Message-State: APjAAAU2udR3oPquw/I430scbLGA4n2Lqk9CvvbdpyoN+Jdl1CEMeOpC a90pZQFQj5VuQGcBcO8syWopKw== X-Google-Smtp-Source: APXvYqwQoJZqwy4cYi6AsCh6ANSWNudbnKoMhoKJAscZKpb0Z3GSDkzwo8o0/ROJY1DR3WcJjMAb1Q== X-Received: by 2002:a5d:658d:: with SMTP id q13mr6839587wru.78.1567772786318; Fri, 06 Sep 2019 05:26:26 -0700 (PDT) Return-Path: Received: from bivouac.eciton.net (bivouac.eciton.net. [2a00:1098:0:86:1000:23:0:2]) by smtp.gmail.com with ESMTPSA id v7sm3868639wrn.41.2019.09.06.05.26.24 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 06 Sep 2019 05:26:25 -0700 (PDT) Date: Fri, 6 Sep 2019 13:26:23 +0100 From: "Leif Lindholm" To: Laszlo Ersek Cc: edk2-devel-groups-io , Andrew Fish , Michael D Kinney , Rebecca Cran , Philippe Mathieu-Daude Subject: Re: [PATCH edk2-CCSS 0/3] Coding Standards: add rule for documenting spurious variable assignments Message-ID: <20190906122623.GS29255@bivouac.eciton.net> References: <20190905183820.10312-1-lersek@redhat.com> MIME-Version: 1.0 In-Reply-To: <20190905183820.10312-1-lersek@redhat.com> User-Agent: Mutt/1.10.1 (2018-07-13) Content-Type: text/plain; charset=us-ascii Content-Disposition: inline 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. Vaguely. Am I misremembering, or did we disount that option? 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 >