From nobody Thu Mar 28 23:13:06 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+46934+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+46934+1787277+3901457@groups.io; dmarc=fail(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1567708708; cv=none; d=zoho.com; s=zohoarc; b=XXMpd9zwKdoG9fg8CrA6w6nmqB+BW/XYbxTSiGgjrqKgsrpsHARr7wpknM2pajUo9eHppalFsTch6vPbfWCTw16dubWAoWBajs8FXIKY982F87GgXMBS9AW7Fz4xaHHaLd0yeK/SURF33HR66la8JfQeCVv1O28R7qL1fz5H180= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zoho.com; s=zohoarc; t=1567708708; 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=z7C41hFoNzU4DUMNRjgUhQVDCMzoZKywX55fDWKSd/I=; b=fWWrRPqkNe5TxEOu9B455OXa/PgD2VjsZVLnFnJ4ormbANsUoIGRj9px5casYy4rDAJQ4VPI6M/1Y6kFYzGpbTo+bFbrj+4G2mXF9+brG8VibpITHLECECffrPIHv+QdauXdewiibUqTRtkPg8/jv4FtYGMFFZzVv0KwC81l68A= 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+46934+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 1567708708311117.18407627818203; Thu, 5 Sep 2019 11:38:28 -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:27 -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 E16CBC04D312; Thu, 5 Sep 2019 18:38:26 +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 8CB245D6A3; Thu, 5 Sep 2019 18:38:25 +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 2/3] comments: restrict and clarify applicability of "/*" comments Date: Thu, 5 Sep 2019 20:38:19 +0200 Message-Id: <20190905183820.10312-3-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.5.16 (mx1.redhat.com [10.5.110.31]); Thu, 05 Sep 2019 18:38:26 +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=1567708708; bh=+ZfZjmkXZ0EQ6DmlvB3xd1yV/0h4cUFkVecYK5LmEYc=; h=Cc:Date:From:Reply-To:Subject:To; b=ucmsgf9huZ7cBjH6WM9xHCPmKJj9kjwbgaGfAADUFeLGMqA0k8vbaBkm5RqLlkCzmsm aX5sdlocp04ChvljOUSTm+nNmT4KNs1f30MBCEjHS7umyN0gdarege+PkjcKkXDrXgPb/ CuqOqPZmxHsBO21YZ9pRjbRpEdpYK1CPqqs= X-ZohoMail-DKIM: pass (identity @groups.io) Content-Type: text/plain; charset="utf-8" Section "6.2 Comments" seems to permit "/*" for multi-line comments in general. That's incorrect; "/*" comments are permitted only for a subset of multi-line comments (namely Doxygen-style file and function header comment blocks). Update the rule accordingly. 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 Reviewed-by: Philippe Mathieu-Daude --- 6_documenting_software/62_comments.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/6_documenting_software/62_comments.md b/6_documenting_software= /62_comments.md index ae04e008a1eb..5feb5cee2055 100644 --- a/6_documenting_software/62_comments.md +++ b/6_documenting_software/62_comments.md @@ -54,7 +54,7 @@ minimal familiarity with the code. Clarity is important, = but one should also strive for terse and concise comments. One should be able to see both the comment, and the code being commented on, on the same screen. =20 -### 6.2.1 Only use C style, "/*", comments for multi-line comments and on = the same line as pre-processor directives. +### 6.2.1 Only use C style, "/*", comments on the same line as pre-process= or directives, and in Doxygen-style file and function header comment blocks. =20 Compile can vary in their support for use of `//` in preprocessor directiv= es (e.g. `#define`). Note that the mixing of `/* ... */` and `//` is not hand= led --=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 (#46934): https://edk2.groups.io/g/devel/message/46934 Mute This Topic: https://groups.io/mt/33157543/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-