From: "Laszlo Ersek" <lersek@redhat.com>
To: edk2-devel-groups-io <devel@edk2.groups.io>
Cc: Andrew Fish <afish@apple.com>,
Leif Lindholm <leif.lindholm@linaro.org>,
Michael D Kinney <michael.d.kinney@intel.com>,
Rebecca Cran <rebecca@bsdio.com>
Subject: [PATCH edk2-CCSS 1/3] comments: remove "Horror Vacui" rule
Date: Thu, 5 Sep 2019 20:38:18 +0200 [thread overview]
Message-ID: <20190905183820.10312-2-lersek@redhat.com> (raw)
In-Reply-To: <20190905183820.10312-1-lersek@redhat.com>
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 <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>
Ref: https://bugzilla.tianocore.org/show_bug.cgi?id=607
Signed-off-by: Laszlo Ersek <lersek@redhat.com>
---
| 18 +-----------------
1 file changed, 1 insertion(+), 17 deletions(-)
--git a/6_documenting_software/62_comments.md b/6_documenting_software/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.
-### 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.
```
"Out of cheese error! Redo from start."
--
2.19.1.3.g30247aa5d201
next prev parent reply other threads:[~2019-09-05 18:38 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 ` Laszlo Ersek [this message]
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
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=20190905183820.10312-2-lersek@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