From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mail05.groups.io (mail05.groups.io [45.79.224.7]) by spool.mail.gandi.net (Postfix) with ESMTPS id D9213740032 for ; Tue, 15 Oct 2024 21:12:26 +0000 (UTC) DKIM-Signature: a=rsa-sha256; bh=KMMI4WKYJzRk2CuVksG2MPJfLp0oOE9i6XO2rVIiYXs=; c=relaxed/simple; d=groups.io; h=From:To:CC:Subject:Thread-Topic:Thread-Index:Date:Message-ID:References:In-Reply-To:Accept-Language:MIME-Version:Precedence:List-Subscribe:List-Help:Sender:List-Id:Mailing-List:Delivered-To:Resent-Date:Resent-From:Reply-To:List-Unsubscribe-Post:List-Unsubscribe:Content-Language:Content-Type:Content-Transfer-Encoding; s=20240830; t=1729026746; v=1; x=1729285945; b=rtKB4zi3IN2J+TTivImQYF9J/r13N4D8+EP7AVtUhLUy33B38uWzQwoUScTGrBLWEDKHTzvD 2fx0TFe4kjt38Oy/tbjhjT65jFrK8Jc1RRedgnleDRS5RioUXuG4SSGOkqRByzgoK/9uWC/4coc ygco6X5Cf4bidPkmXNxdjMoTeUIQ2IKz9Tcl/aCbime1pwz9b9I7AnQJ0BNDWnYtqGorXIes4Uq 9HaeX6tDBcubA4C3H1nHc6H1GPpfwP3MzBCn34En6GmqZ4PIfpki4BSu4BvPhtjMTXFyH/hHcou ikfB9JqqFHBS18+gNYfmjAkBLvtNI4PKdUTgrg6rKOWlw== X-Received: by 127.0.0.2 with SMTP id HuKGYY7687511xgCDnvpoIXG; Tue, 15 Oct 2024 14:12:25 -0700 X-Received: from mgamail.intel.com (mgamail.intel.com [192.198.163.8]) by mx.groups.io with SMTP id smtpd.web11.8278.1729026744581025438 for ; Tue, 15 Oct 2024 14:12:24 -0700 X-CSE-ConnectionGUID: xrNmwCjBQjaKWAyM15yn+A== X-CSE-MsgGUID: +F1/946DQ2qq26rka1TlQA== X-IronPort-AV: E=McAfee;i="6700,10204,11225"; a="45947004" X-IronPort-AV: E=Sophos;i="6.11,206,1725346800"; d="scan'208";a="45947004" X-Received: from fmviesa004.fm.intel.com ([10.60.135.144]) by fmvoesa102.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 15 Oct 2024 14:12:24 -0700 X-CSE-ConnectionGUID: B0O4rQ3STuCLneuGRDtnsA== X-CSE-MsgGUID: ifdpRQaMQFqfzCQ4yK7kRw== X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="6.11,206,1725346800"; d="scan'208";a="82674905" X-Received: from fmsmsx602.amr.corp.intel.com ([10.18.126.82]) by fmviesa004.fm.intel.com with ESMTP/TLS/AES256-GCM-SHA384; 15 Oct 2024 14:12:24 -0700 X-Received: from fmsmsx611.amr.corp.intel.com (10.18.126.91) by fmsmsx602.amr.corp.intel.com (10.18.126.82) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.2507.39; Tue, 15 Oct 2024 14:12:23 -0700 X-Received: from fmsmsx610.amr.corp.intel.com (10.18.126.90) by fmsmsx611.amr.corp.intel.com (10.18.126.91) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.2507.39; Tue, 15 Oct 2024 14:12:23 -0700 X-Received: from fmsedg601.ED.cps.intel.com (10.1.192.135) by fmsmsx610.amr.corp.intel.com (10.18.126.90) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.2507.39 via Frontend Transport; Tue, 15 Oct 2024 14:12:23 -0700 X-Received: from NAM10-MW2-obe.outbound.protection.outlook.com (104.47.55.48) by edgegateway.intel.com (192.55.55.70) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.1.2507.39; Tue, 15 Oct 2024 14:12:22 -0700 X-Received: from CO1PR11MB4929.namprd11.prod.outlook.com (2603:10b6:303:6d::19) by CH0PR11MB8144.namprd11.prod.outlook.com (2603:10b6:610:18d::12) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.8048.27; Tue, 15 Oct 2024 21:12:20 +0000 X-Received: from CO1PR11MB4929.namprd11.prod.outlook.com ([fe80::a886:6510:729d:f9d0]) by CO1PR11MB4929.namprd11.prod.outlook.com ([fe80::a886:6510:729d:f9d0%5]) with mapi id 15.20.8069.016; Tue, 15 Oct 2024 21:12:20 +0000 From: "Michael D Kinney" To: Rebecca Cran , "devel@edk2.groups.io" CC: "Kinney, Michael D" Subject: Re: [edk2-devel] [edk2-CCodingStandardsSpecification PATCH 1/1] Prefer use of `static` C keyword over EDK2 type `STATIC` Thread-Topic: [edk2-CCodingStandardsSpecification PATCH 1/1] Prefer use of `static` C keyword over EDK2 type `STATIC` Thread-Index: AQHbG3vetQ9IA49KzEyvyQha/is3jLKIViVA Date: Tue, 15 Oct 2024 21:12:20 +0000 Message-ID: References: <20241011012040.274642-1-rebecca@bsdio.com> In-Reply-To: <20241011012040.274642-1-rebecca@bsdio.com> Accept-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: x-ms-publictraffictype: Email x-ms-traffictypediagnostic: CO1PR11MB4929:EE_|CH0PR11MB8144:EE_ x-ms-office365-filtering-correlation-id: 9100676e-c2c0-4b71-4f61-08dced5e0e51 x-ms-exchange-senderadcheck: 1 x-ms-exchange-antispam-relay: 0 x-microsoft-antispam-message-info: =?us-ascii?Q?ZEAsd0Fhau7kiUGGjCbe6jWjDcSRDPUF+h7/+MutiXRPTrSchl0L6+e1x6A1?= =?us-ascii?Q?WTxbyn9Wyvi5qTtgf/qRx5Xp8triIipmN/gyhnjAPSimf/IOGRNhlfYo6dRH?= =?us-ascii?Q?iijhIEiKNSL+Dy0AumOTymaYc2UL0vF2iOizsZMfUu6H4C0s+4T+qupYk+ps?= =?us-ascii?Q?zRp/twzDYw8cCVe2dyrCjK9VytMUHBZuzpWOeb7DFQOtHIz20uyELAHI9Bf1?= =?us-ascii?Q?wFmbcBEz/7EJ1b6a+DHhMdQrzCqS9tzKanJwZRioP+i0vAzgQUl5iJk/C3Is?= =?us-ascii?Q?0dRlTZwfpD5Y7yZ7lCxBo6T/Ckpq+gUlpg04OINriVCmpqBUyqT2CyHTZGiJ?= =?us-ascii?Q?Qe+tXHvZEgzVtA/ej1M8tg/neVAO9E+Z3XYVUTV6/VW228D+lPQtZP9+sdPs?= =?us-ascii?Q?gRaC/8Ih3q+2nr9ihTfcwnRD34BfLRCUV8ElhG2pNI41UfoqZCJ7jv8rB/eg?= =?us-ascii?Q?o0ZWVYxi8nK3V03WV8KseMclIKnhqp11fjPDB/mKAZZPH4JGCmPRn2O5MAgh?= =?us-ascii?Q?p6UlmhdLv76h1sJMVynTNuXg/cAj+LkwTeP0lrItxQK34ZkJWG8aXpcMEgyq?= =?us-ascii?Q?6b7ci8SBcf+LOSMHCjrrYt50DRUbsW2ZLmyNjtFNKDrHUJ7IozIYTir/BC0X?= =?us-ascii?Q?9rutV/mRyfXO9gAcQeJdQs7ouJ7p+GJUhOPFTLlspKwF4m6vZ0i9Bi9Yuh3I?= =?us-ascii?Q?td51vZQWQjtKA7Xs7uUZ4cXH8lwoCtPVXCLD3M+v1UFj13oo+lXw0C/a/fAk?= =?us-ascii?Q?N+ZLGXHQjZi8cX0LApOHDBPiMZ3uQw795SbZ8K6oM7zCXKzFm1kz3rgOkokq?= =?us-ascii?Q?LSQUI6FMJXbkCfl+PGsOXYJLqd2sHri8nwqcQUGc0+f/KDeB6Y8qPFdWLttL?= =?us-ascii?Q?bJQwhRg35t79ENZ8ssCjfA4CaWdN4gfd1erXYKEAERlYVxICxEGEsCTArlUr?= =?us-ascii?Q?j/f7ATm1AUB/Z7NSqDxnSsbInKu5aNNdtO7wRglNT4pA1TpUvvQiJQ8zb5vv?= =?us-ascii?Q?Ul2EeXzgotoMaqYyOZ91z6QO4KXFOKg1uhwklcCM5mfIJjBWkVxRoI1wASDM?= =?us-ascii?Q?9jKkBotl75XmXK4t5Nhss7w2LciGZSB9ZGWpHdZjUnT7PLLFIqDHDMSA5+ms?= =?us-ascii?Q?UOLCi5OrfalPOYtGGyl3tbRb6uos5d4lUdxrUDEDcGXuMYNFBWs1pD5V7Vke?= =?us-ascii?Q?XHdZokykXwclEKvqWA+pKZ6Rd2rM+nYJKG8MIyUh6RGrKwtieXX4dNbF73ss?= =?us-ascii?Q?Vzt3d2IJFHI2KwnVuQ76f1VbVOjLnpm3Gh+N9DpSqvVqwPXflfbCPPjjjhqB?= =?us-ascii?Q?peg=3D?= x-ms-exchange-antispam-messagedata-chunkcount: 1 x-ms-exchange-antispam-messagedata-0: =?us-ascii?Q?GePp5JDWwoCb7BzJoMt8i0yHZDaUSwMEhIol6hOjjlkVA0CBCndLx4+fdUuS?= =?us-ascii?Q?j9U9LHRBxALAXIJ6Fmm9WtiM/faAYWgxCjYbcL1Xgm36izvzuiQq5Xz6F5Qz?= =?us-ascii?Q?uiuleHL054iuSSmCrX4Oc9spwwTyYyauV0zmMBUqA0fz7ixdCQXLtMcXGZSA?= =?us-ascii?Q?39DfwwPA8K1E0eqWX+JFNkUaI/zXvB/lbRaJeabbusc9cLtrVJMj2hr9UYvw?= =?us-ascii?Q?yKZoJh72uLjI2NzqMUZNu7kattyWIRKWhBoEJY4kNCQTNj2bHmMGmwkm+Pqp?= =?us-ascii?Q?qSeYzJbVriFgyBXRO1qW61FZmKv74Vi5kNIF+7yxpnIwSYP/NFSyq7WyTn9U?= =?us-ascii?Q?S5S58ZFJvMXMQh/ZtjXGO/dR2JUcuqrMrOOSHPxjAIiLc0vg3XApIi6xQZHE?= =?us-ascii?Q?Fw2PtAtRTHMuJSjpXy7OYlXm7LT4GLgPDii7NyjNfGCKbu/sMk6fMxHzZSVY?= =?us-ascii?Q?QkdbiKpd+2DyE24UsN0oikCiHB/zm2KzcONTKAspY92nXmsWVxXRpe4RFc33?= =?us-ascii?Q?mNmHz1Er1cn91XfVsjakJnCdoaXbHJ+JPHJgNyveXm7pki1qVWVWB5Sc7AT0?= =?us-ascii?Q?o0r+uT5821obE04kPC/YGpxB/iV4RAYpPGmnlUXtbRUE/fq9FCYSMaoLtsK5?= =?us-ascii?Q?ejZRiw2okgfzKFx2Gh8JnUZn2aib5iaTYoaym647TC+gzt2qctMex2HDSQei?= =?us-ascii?Q?F794GwkgglAnhp5Jm0b9BMt+wVpNhxHkiPQ46WUWstrF4WzAvsWMR5HHA2LR?= =?us-ascii?Q?7w1bQfSxADBbDcQuCHHoUQ7c7t0Hs167BMixcY2fYIuJnB+sU+enPdVHLD2W?= =?us-ascii?Q?GYO5VBvHnlD+i82IAto2Ft4e89zHealOSOG6jeueKtyjYYgOvWHU3V4g3p6i?= =?us-ascii?Q?XRiHoIKQ90GMCfI4IbpO7Ztsit9qXk+R3r34g/3d8jHKJPxlqgX8N8RGH33W?= =?us-ascii?Q?9kGAUnAeAGYELa7Pr62c+iWNs4WhoAKPZ3tUJ8aLde6a1zE8D/C0tE6jK27K?= =?us-ascii?Q?BK0gEtz8GnnGRLl572alg9XlirzJZJ9zAwq9qol8OlfKyPvf0EdFaHvHeeGu?= =?us-ascii?Q?6E4CpoitovAa+3KVF1qe5tjtqXcPPeYiuoQLnPx8jbVpQAf7h2cfMajtVjUL?= =?us-ascii?Q?R6iWhJhvOVx/7Rndh/NPKiwwcyONq1j4JPrDD8mxTe80UvlRa+1HmrVHoVx1?= =?us-ascii?Q?img8/fpUyK59+wJcTt+98y89Hz0Qk8wxUm70TL7I7LGx7/dZFjXFvw3JMDql?= =?us-ascii?Q?7Qswg59/G313kXjJBNp6XeREef9weOSnqDXQ42CPuzFw2bNmXgp+48zuh8Ml?= =?us-ascii?Q?tlr0YytzW8+NXQoIEUI+H3IJhQRQdNK+MMT6rlE2Nc3uiXoxlmfTlLxskHi1?= =?us-ascii?Q?hEubLPiOBBJWRoKT498wgiB1F4THt31qKGlmcZUTavCKwyY00wC0rhrbK8K5?= =?us-ascii?Q?zaiDGiSZ0W1cBQGd2IvNZJYtRew0ylPyzusMYlyKlqdHBRM23lkBAD9NqpK4?= =?us-ascii?Q?7Yjs1zpsBL3z6anCtTdmdZSsLZ9K1nan4/PFuzD23h78w4sLost8mML8uy/G?= =?us-ascii?Q?eW9xFayqK7rbPF2Y8mzKiaV7uSxHw9pWwEoJ+tL7beAHsFLGT1YTomaQ+7xS?= =?us-ascii?Q?5w=3D=3D?= MIME-Version: 1.0 X-MS-Exchange-CrossTenant-AuthAs: Internal X-MS-Exchange-CrossTenant-AuthSource: CO1PR11MB4929.namprd11.prod.outlook.com X-MS-Exchange-CrossTenant-Network-Message-Id: 9100676e-c2c0-4b71-4f61-08dced5e0e51 X-MS-Exchange-CrossTenant-originalarrivaltime: 15 Oct 2024 21:12:20.2491 (UTC) X-MS-Exchange-CrossTenant-fromentityheader: Hosted X-MS-Exchange-CrossTenant-id: 46c98d88-e344-4ed4-8496-4ed7712e255d X-MS-Exchange-CrossTenant-mailboxtype: HOSTED X-MS-Exchange-CrossTenant-userprincipalname: T6rlDbthGRgfLr0PmusnaVlYvMVHDKTYGVITC5/bfvaqBjJv+kmj1Kj4yAzx9EIlEpyLfUgQmyDB0jwfQS9+0JsKtuzxPhVZudi0tdq2i7s= X-MS-Exchange-Transport-CrossTenantHeadersStamped: CH0PR11MB8144 X-OriginatorOrg: intel.com Precedence: Bulk List-Subscribe: List-Help: Sender: devel@edk2.groups.io List-Id: Mailing-List: list devel@edk2.groups.io; contact devel+owner@edk2.groups.io Resent-Date: Tue, 15 Oct 2024 14:12:24 -0700 Resent-From: michael.d.kinney@intel.com Reply-To: devel@edk2.groups.io,michael.d.kinney@intel.com List-Unsubscribe-Post: List-Unsubscribe=One-Click List-Unsubscribe: X-Gm-Message-State: 3vyr4lmSFwFcGcg0cdFRUOirx7686176AA= Content-Language: en-US Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable X-GND-Status: LEGIT Authentication-Results: spool.mail.gandi.net; dkim=pass header.d=groups.io header.s=20240830 header.b=rtKB4zi3; dmarc=fail reason="SPF not aligned (relaxed), DKIM not aligned (relaxed)" header.from=intel.com (policy=none); spf=pass (spool.mail.gandi.net: domain of bounce@groups.io designates 45.79.224.7 as permitted sender) smtp.mailfrom=bounce@groups.io The draft status is never disabled in the master branch. Please see the release process for documents. https://github.com/tianocore-docs/edk2-TemplateSpecification/wiki/TianoCore= -Documents-Releasing Document changes should be made on the master branch, and then the release = branch is created with no content changes. Mike > -----Original Message----- > From: Rebecca Cran > Sent: Thursday, October 10, 2024 6:21 PM > To: Kinney, Michael D ; devel@edk2.groups.io > Cc: Rebecca Cran > Subject: [edk2-CCodingStandardsSpecification PATCH 1/1] Prefer use of > `static` C keyword over EDK2 type `STATIC` >=20 > A while ago a decision was made on the edk2-devel mailing list that > the `STATIC` EDK2 type should be replaced with the C keyword `static`. >=20 > Update the Coding Specification to match. While here, remove the > outdated section disallowing static functions since they're no longer > a problem. >=20 > Bump the revision to 2.4 and turn off the draft status. >=20 > Signed-off-by: Rebecca Cran > --- > 5_source_files/54_code_file_structure.md | 8 +------- > 5_source_files/56_declarations_and_types.md | 2 +- > README.md | 3 ++- > book.json | 4 ++-- > 4 files changed, 6 insertions(+), 11 deletions(-) >=20 > diff --git a/5_source_files/54_code_file_structure.md > b/5_source_files/54_code_file_structure.md > index 0c4d6a2..6decc60 100644 > --- a/5_source_files/54_code_file_structure.md > +++ b/5_source_files/54_code_file_structure.md > @@ -269,7 +269,7 @@ other than at the top level of a file as specified > by this document. >=20 >=20 > #### 5.4.2.2 Static >=20 >=20 >=20 > -An object declared `STATIC` has either file or block scope. >=20 > +An object declared `static` has either file or block scope. >=20 >=20 >=20 > ##### 5.4.2.2.1 Do not reuse an object or function identifier with > static storage duration. >=20 >=20 >=20 > @@ -277,9 +277,3 @@ Throughout the set of source files defined within a > single .inf file, do not > reuse an identifier with static storage duration. The compiler may not > be >=20 > confused by this, but the user may confuse unrelated variables with the > same >=20 > name. >=20 > - >=20 > -##### 5.4.2.2.2 Functions should not be declared STATIC. >=20 > - >=20 > -Some source-level debuggers are unable to resolve static functions. > Until it >=20 > -can be verified that no one is dependent upon a debugger with this > limitation, >=20 > -it is strongly recommended that functions not be declared static. >=20 > diff --git a/5_source_files/56_declarations_and_types.md > b/5_source_files/56_declarations_and_types.md > index ec1803d..77e3ce9 100644 > --- a/5_source_files/56_declarations_and_types.md > +++ b/5_source_files/56_declarations_and_types.md > @@ -38,7 +38,7 @@ > Any abstract type that is defined must be constructed from other > abstract types >=20 > or from common EFI data types. >=20 >=20 >=20 > -#### 5.6.1.2 The use of int, unsigned, char, void, static, long is a > violation of the coding convention. >=20 > +#### 5.6.1.2 The use of int, unsigned, char, void, long is a violation > of the coding convention. >=20 >=20 >=20 > The corresponding EFI types must be used instead. >=20 >=20 >=20 > diff --git a/README.md b/README.md > index 77cfdc8..b543bcf 100644 > --- a/README.md > +++ b/README.md > @@ -114,4 +114,5 @@ Copyright (c) 2006-2017, Intel Corporation. All > rights reserved. > | | [#425](https://bugzilla.tianocore.org/show_bug.cgi?id=3D425= ) > [CCS] clarify line breaking and indentation requirements for multi-line > function calls | | >=20 > | | > [#1656](https://bugzilla.tianocore.org/show_bug.cgi?id=3D1656) Update all > Wiki pages for the BSD+Patent license change with SPDX identifiers > | | >=20 > | | [#607](https://bugzilla.tianocore.org/show_bug.cgi?id=3D607= ) > Document code comment requirements for spurious variable assignments > | | >=20 > -| 2.3 | Add 4.2 Directory names section and update File names > section for the guidelines of module directory and file naming|September > 2022|| >=20 > +| 2.3 | Add 4.2 Directory names section and update File names > section for the guidelines of module directory and file naming > |September 2022| >=20 > +| 2.4 | The use of the 'static' C keyword is now preferred over > the EDK2 type 'STATIC' > |October 2024| >=20 > diff --git a/book.json b/book.json > index d112b26..3ec7a93 100644 > --- a/book.json > +++ b/book.json > @@ -1,8 +1,8 @@ > { >=20 > "variables" : { >=20 > - "draft" : "yes", >=20 > + "draft" : "no", >=20 > "title" : "EDK II C Coding Standards Specification", >=20 > - "version" : "Revision 2.2" >=20 > + "version" : "Revision 2.4" >=20 > }, >=20 > "plugins": ["puml-aleung"], >=20 > "pluginsConfig": {} >=20 > -- > 2.46.1 -=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 (#120625): https://edk2.groups.io/g/devel/message/120625 Mute This Topic: https://groups.io/mt/108941574/7686176 Group Owner: devel+owner@edk2.groups.io Unsubscribe: https://edk2.groups.io/g/devel/unsub [rebecca@openfw.io] -=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-