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; Thu, 05 Sep 2019 11:38:25 -0700 Received: from smtp.corp.redhat.com (int-mx05.intmail.prod.int.phx2.redhat.com [10.5.11.15]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id 3DFBA898106; Thu, 5 Sep 2019 18:38:25 +0000 (UTC) Received: from lacos-laptop-7.usersys.redhat.com (ovpn-116-133.ams2.redhat.com [10.36.116.133]) by smtp.corp.redhat.com (Postfix) with ESMTP id D75375D6A3; Thu, 5 Sep 2019 18:38:23 +0000 (UTC) From: "Laszlo Ersek" To: edk2-devel-groups-io Cc: Andrew Fish , Leif Lindholm , Michael D Kinney , Rebecca Cran Subject: [PATCH edk2-CCSS 1/3] comments: remove "Horror Vacui" rule Date: Thu, 5 Sep 2019 20:38:18 +0200 Message-Id: <20190905183820.10312-2-lersek@redhat.com> In-Reply-To: <20190905183820.10312-1-lersek@redhat.com> References: <20190905183820.10312-1-lersek@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.15 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.6.2 (mx1.redhat.com [10.5.110.67]); Thu, 05 Sep 2019 18:38:25 +0000 (UTC) Content-Transfer-Encoding: quoted-printable The rule about avoiding comments in C code where the opening comment characters are alone on a line conflicts with everyday edk2 practice -- we use comments like // // If the total number of lines in the popup is zero, then ASSERT() // all the time. This comment style is actively enforced by reviewers and maintainers. Remove the rule in order for the CCS to match reality. Cc: Andrew Fish Cc: Leif Lindholm Cc: Michael D Kinney Cc: Rebecca Cran Ref: https://bugzilla.tianocore.org/show_bug.cgi?id=3D607 Signed-off-by: Laszlo Ersek --- 6_documenting_software/62_comments.md | 18 +----------------- 1 file changed, 1 insertion(+), 17 deletions(-) diff --git a/6_documenting_software/62_comments.md b/6_documenting_softwa= re/62_comments.md index 208ce346f607..ae04e008a1eb 100644 --- a/6_documenting_software/62_comments.md +++ b/6_documenting_software/62_comments.md @@ -66,23 +66,7 @@ not behave the same. Banners can be useful to highlight logical divisions within a file; such= as before vital sections. This type of usage should be minimized. =20 -### 6.2.3 Avoid comments where the opening comment characters are alone = on a line. - -``` -/* - * VIOLATION: Horror Vacui -*/ -``` - -or - -```c -// -// VIOLATION: Horror Vacui -// -``` - -### 6.2.4 Do not include jokes or obtuse references in comments. +### 6.2.3 Do not include jokes or obtuse references in comments. =20 ``` "Out of cheese error! Redo from start." --=20 2.19.1.3.g30247aa5d201