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 3B66674004A for ; Mon, 21 Oct 2024 14:49:40 +0000 (UTC) DKIM-Signature: a=rsa-sha256; bh=AeYFRyAbLxrA4uYKIJwgkD48WLJOknJNk5rKg+aklYM=; c=relaxed/simple; d=groups.io; h=Feedback-ID:Message-ID:Date:MIME-Version:User-Agent:Subject:To:References:From:In-Reply-To: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=1729522179; v=1; x=1729781378; b=wbegaNPQrCuuh6vGbbA2+7p7yMrQ/XwHOKULa0Mg0u0jNzp5CrmaBhO32anv7r+NdZ+d6ysN faMCUkuCiuwE0XZAuGZZOaQbrUFqFKkY2p9Uvw9r1tgVVfo3l/IKjow3YrIJM0qKfB05ExwQUR7 0s7GJ3DV3P+fVi+71TREIp1xSR07fktIiDvfxZ65HHI7MY1S/ZudeIoRuYYo4u/Q2pnaSOurneu BEIoGXeHKI40E4T/R/Cb1LcBhm4ryec7tgy7erhCk1WS46SmaP2EaO+rJKMK1A9HNysLLRAQyze cJqcEk/1j2u9WdR4lNYvWErt7dKbLWnOzLSpR/2yhdmRQ== X-Received: by 127.0.0.2 with SMTP id JzpmYY7687511xNI6oZndYPI; Mon, 21 Oct 2024 07:49:38 -0700 X-Received: from fhigh-a1-smtp.messagingengine.com (fhigh-a1-smtp.messagingengine.com [103.168.172.152]) by mx.groups.io with SMTP id smtpd.web10.48391.1729522177663898718 for ; Mon, 21 Oct 2024 07:49:37 -0700 X-Received: from phl-compute-08.internal (phl-compute-08.phl.internal [10.202.2.48]) by mailfhigh.phl.internal (Postfix) with ESMTP id D3C3111402A2; Mon, 21 Oct 2024 10:49:36 -0400 (EDT) X-Received: from phl-mailfrontend-01 ([10.202.2.162]) by phl-compute-08.internal (MEProxy); Mon, 21 Oct 2024 10:49:36 -0400 X-ME-Sender: X-ME-Received: X-ME-Proxy-Cause: gggruggvucftvghtrhhoucdtuddrgeeftddrvdehledgkeduucetufdoteggodetrfdotf fvucfrrhhofhhilhgvmecuhfgrshhtofgrihhlpdggtfgfnhhsuhgsshgtrhhisggvpdfu rfetoffkrfgpnffqhgenuceurghilhhouhhtmecufedttdenucesvcftvggtihhpihgvnh htshculddquddttddmnecujfgurhepkfffgggfuffvfhfhjggtgfesthejredttddvjeen ucfhrhhomheptfgvsggvtggtrgcuvehrrghnuceorhgvsggvtggtrgessghsughiohdrtg homheqnecuggftrfgrthhtvghrnhepvdelkefhudeiffekveeuhefhheegieetffehffef leelhedtgeduudelfeeiudeunecuffhomhgrihhnpehgihhthhhusgdrtghomhdpthhirg hnohgtohhrvgdrohhrghenucevlhhushhtvghrufhiiigvpedtnecurfgrrhgrmhepmhgr ihhlfhhrohhmpehrvggsvggttggrsegsshguihhordgtohhmpdhnsggprhgtphhtthhope dvpdhmohguvgepshhmthhpohhuthdprhgtphhtthhopehmihgthhgrvghlrdgurdhkihhn nhgvhiesihhnthgvlhdrtghomhdprhgtphhtthhopeguvghvvghlsegvughkvddrghhroh huphhsrdhioh X-ME-Proxy: Feedback-ID: i5b994698:Fastmail X-Received: by mail.messagingengine.com (Postfix) with ESMTPA; Mon, 21 Oct 2024 10:49:36 -0400 (EDT) Message-ID: Date: Mon, 21 Oct 2024 08:49:14 -0600 MIME-Version: 1.0 User-Agent: Mozilla Thunderbird Subject: Re: [edk2-devel] [edk2-CCodingStandardsSpecification PATCH 1/1] Prefer use of `static` C keyword over EDK2 type `STATIC` To: "Kinney, Michael D" , "devel@edk2.groups.io" References: <20241011012040.274642-1-rebecca@bsdio.com> From: "Rebecca Cran" In-Reply-To: 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: Mon, 21 Oct 2024 07:49:37 -0700 Resent-From: rebecca@bsdio.com Reply-To: devel@edk2.groups.io,rebecca@bsdio.com List-Unsubscribe-Post: List-Unsubscribe=One-Click List-Unsubscribe: X-Gm-Message-State: b38HKAp30NqyYDrxiN5W9btvx7686176AA= Content-Language: en-US Content-Type: text/plain; charset=UTF-8; format=flowed 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=wbegaNPQ; dmarc=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 Thanks, I'll fix it. Could you confirm whether the change from STATIC to static is something=20 we want to go ahead with, or do we want to keep STATIC to allow=20 GoogleTest to work? --=20 Rebecca On 10/15/24 3:12 PM, Kinney, Michael D wrote: > 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/TianoCo= re-Documents-Releasing > > Document changes should be made on the master branch, and then the releas= e 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` >> >> 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`. >> >> Update the Coding Specification to match. While here, remove the >> outdated section disallowing static functions since they're no longer >> a problem. >> >> Bump the revision to 2.4 and turn off the draft status. >> >> 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(-) >> >> 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. >> >> >> #### 5.4.2.2 Static >> >> >> >> -An object declared `STATIC` has either file or block scope. >> >> +An object declared `static` has either file or block scope. >> >> >> >> ##### 5.4.2.2.1 Do not reuse an object or function identifier with >> static storage duration. >> >> >> >> @@ -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 >> >> confused by this, but the user may confuse unrelated variables with th= e >> same >> >> name. >> >> - >> >> -##### 5.4.2.2.2 Functions should not be declared STATIC. >> >> - >> >> -Some source-level debuggers are unable to resolve static functions. >> Until it >> >> -can be verified that no one is dependent upon a debugger with this >> limitation, >> >> -it is strongly recommended that functions not be declared static. >> >> 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 >> >> or from common EFI data types. >> >> >> >> -#### 5.6.1.2 The use of int, unsigned, char, void, static, long is a >> violation of the coding convention. >> >> +#### 5.6.1.2 The use of int, unsigned, char, void, long is a violation >> of the coding convention. >> >> >> >> The corresponding EFI types must be used instead. >> >> >> >> 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=3D4= 25) >> [CCS] clarify line breaking and indentation requirements for multi-line >> function calls | | >> >> | | >> [#1656](https://bugzilla.tianocore.org/show_bug.cgi?id=3D1656) Update al= l >> Wiki pages for the BSD+Patent license change with SPDX identifiers >> | | >> >> | | [#607](https://bugzilla.tianocore.org/show_bug.cgi?id=3D6= 07) >> Document code comment requirements for spurious variable assignments >> | | >> >> -| 2.3 | Add 4.2 Directory names section and update File names >> section for the guidelines of module directory and file naming|September >> 2022|| >> >> +| 2.3 | Add 4.2 Directory names section and update File names >> section for the guidelines of module directory and file naming >> |September 2022| >> >> +| 2.4 | The use of the 'static' C keyword is now preferred over >> the EDK2 type 'STATIC' >> |October 2024| >> >> diff --git a/book.json b/book.json >> index d112b26..3ec7a93 100644 >> --- a/book.json >> +++ b/book.json >> @@ -1,8 +1,8 @@ >> { >> >> "variables" : { >> >> - "draft" : "yes", >> >> + "draft" : "no", >> >> "title" : "EDK II C Coding Standards Specification", >> >> - "version" : "Revision 2.2" >> >> + "version" : "Revision 2.4" >> >> }, >> >> "plugins": ["puml-aleung"], >> >> "pluginsConfig": {} >> >> -- >> 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 (#120633): https://edk2.groups.io/g/devel/message/120633 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-