From nobody Wed May 8 13:34:23 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zoho.com: domain of groups.io designates 66.175.222.12 as permitted sender) client-ip=66.175.222.12; envelope-from=bounce+27952+46933+1787277+3901457@groups.io; helo=web01.groups.io; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zoho.com: domain of groups.io designates 66.175.222.12 as permitted sender) smtp.mailfrom=bounce+27952+46933+1787277+3901457@groups.io; dmarc=fail(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1567708706; cv=none; d=zoho.com; s=zohoarc; b=TU4cnJIswiDfi4bSte/+S9Iwfd3/DHQZv+g6RRzzD6/Q+4Ip6ak2oogmX8ieNwr973llPuSio4S/ZVKPBEf3DToVj8Rt7oTmBBhmtOPNVigW0OVvcIn61oDgmc6iXGDYXUrRwQzqso4Q0RH5gMCfTBoP2uJjM8V15acYRYFYANE= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zoho.com; s=zohoarc; t=1567708706; h=Content-Transfer-Encoding:Cc:Date:From:In-Reply-To:List-Id:List-Unsubscribe:MIME-Version:Message-ID:Reply-To:References:Sender:Subject:To:ARC-Authentication-Results; bh=tRoUkjypHUALc+ny6stKSOBCCGRrJ/n7wAGsb/dNvls=; b=hZzbWL3CCFiJBBarMSrnLImSjDEvznkw0Ad9h03IiqrH8OaCEoo75bYFWr/2KQ+Qwof0kUCNs2iU2kHtsfR9LlwufmC+2w0tfB1cKn3tpdKPrur8KNixkXgb0Wd4fhz9ukCGOwUu0CuVsZzWjXQtUI9ZrRhwCwBf0uFeqcef664= ARC-Authentication-Results: i=1; mx.zoho.com; dkim=pass; spf=pass (zoho.com: domain of groups.io designates 66.175.222.12 as permitted sender) smtp.mailfrom=bounce+27952+46933+1787277+3901457@groups.io; dmarc=fail header.from= (p=none dis=none) header.from= Received: from web01.groups.io (web01.groups.io [66.175.222.12]) by mx.zohomail.com with SMTPS id 1567708706630510.1226751137598; Thu, 5 Sep 2019 11:38:26 -0700 (PDT) Return-Path: X-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 X-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) X-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: [edk2-devel] [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) Precedence: Bulk List-Unsubscribe: Sender: devel@edk2.groups.io List-Id: Mailing-List: list devel@edk2.groups.io; contact devel+owner@edk2.groups.io Reply-To: devel@edk2.groups.io,lersek@redhat.com Content-Transfer-Encoding: quoted-printable DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=groups.io; q=dns/txt; s=20140610; t=1567708706; bh=AiM8n3SY+E88Yml2tgvtNPE6OCc1njUO5DRXKS/cSzE=; h=Cc:Date:From:Reply-To:Subject:To; b=CWzKETDnJD7wQdPgENyGf4q6BZGMGV4TbcbC4mECrCrZDCzyc9VSBcUUFR0KgWqUEYr LhdllsKOU+up9TgOQdwpKyD6bvJnG4DWOLxsdFgRhT4yGWjF6ZaIOH6p1VlOYv5fktuK0 O84uEuek/Sy1GlSX9KRl97QkbrNWEYcJRQo= X-ZohoMail-DKIM: pass (identity @groups.io) Content-Type: text/plain; charset="utf-8" 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_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. =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 -=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D- Groups.io Links: You receive all messages sent to this group. View/Reply Online (#46933): https://edk2.groups.io/g/devel/message/46933 Mute This Topic: https://groups.io/mt/33157542/1787277 Group Owner: devel+owner@edk2.groups.io Unsubscribe: https://edk2.groups.io/g/devel/unsub [importer@patchew.org] -=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-