From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from EUR04-VI1-obe.outbound.protection.outlook.com (EUR04-VI1-obe.outbound.protection.outlook.com [40.107.8.82]) by mx.groups.io with SMTP id smtpd.web10.9857.1589969958114786284 for ; Wed, 20 May 2020 03:19:19 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@armh.onmicrosoft.com header.s=selector2-armh-onmicrosoft-com header.b=oq7ziw/L; spf=pass (domain: arm.com, ip: 40.107.8.82, mailfrom: samer.el-haj-mahmoud@arm.com) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=armh.onmicrosoft.com; s=selector2-armh-onmicrosoft-com; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=wpE0ax7icJFHm/BUubeHZm+XdHIuCYU9aBSBEv3NT/U=; b=oq7ziw/LkCFAc4iCTTxmi1LSw4oRslYD5doCEX+wAT8nhMbZSPzAoXJRM048g4A5yiW+UlfZqe1pgpCx1vy4K+hx8gv1s6sjWdWmm1m5XxeLg77RSr+pxvaz7q4CcyylCO2uW+MN05g71C4mZhxJKXo7mrecHWCy4Lj7ifKylNs= Received: from DB8PR03CA0036.eurprd03.prod.outlook.com (2603:10a6:10:be::49) by AM0PR08MB4034.eurprd08.prod.outlook.com (2603:10a6:208:12e::11) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.3000.20; Wed, 20 May 2020 10:19:15 +0000 Received: from DB5EUR03FT038.eop-EUR03.prod.protection.outlook.com (2603:10a6:10:be:cafe::59) by DB8PR03CA0036.outlook.office365.com (2603:10a6:10:be::49) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.3021.23 via Frontend Transport; Wed, 20 May 2020 10:19:15 +0000 X-MS-Exchange-Authentication-Results: spf=pass (sender IP is 63.35.35.123) smtp.mailfrom=arm.com; edk2.groups.io; dkim=pass (signature was verified) header.d=armh.onmicrosoft.com;edk2.groups.io; dmarc=bestguesspass action=none header.from=arm.com; Received-SPF: Pass (protection.outlook.com: domain of arm.com designates 63.35.35.123 as permitted sender) receiver=protection.outlook.com; client-ip=63.35.35.123; helo=64aa7808-outbound-1.mta.getcheckrecipient.com; Received: from 64aa7808-outbound-1.mta.getcheckrecipient.com (63.35.35.123) by DB5EUR03FT038.mail.protection.outlook.com (10.152.21.84) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.3021.23 via Frontend Transport; Wed, 20 May 2020 10:19:14 +0000 Received: ("Tessian outbound facc38080784:v57"); Wed, 20 May 2020 10:19:14 +0000 X-CR-MTA-TID: 64aa7808 Received: from ceed5bb5fd57.2 by 64aa7808-outbound-1.mta.getcheckrecipient.com id 7B37D4ED-AF3B-470A-9D38-1440D5DCA756.1; Wed, 20 May 2020 10:19:09 +0000 Received: from EUR05-VI1-obe.outbound.protection.outlook.com by 64aa7808-outbound-1.mta.getcheckrecipient.com with ESMTPS id ceed5bb5fd57.2 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384); Wed, 20 May 2020 10:19:09 +0000 ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=PTqqcu5LTfJ9U5hQgHFVqietsaJAnHtEDj5y2/KE1TZN6Qsi3PJm0/UpvG5v9PhSoZY/xiHLKfNZXAcNPBOy4yh/6LQo7xFMIZ2SsHF9kA89Nw2gI3kC6FP4uiQsMmDgv9gH8sN6hMCqVP4ZrZQNVuc0NN4O+op7QV28CBfJ5ucxDKe5E9I+/Xgw31mD9LOl6s7fA7NDu3qyASDRyNg8DmeHaP5QYwbvMA6+1gIEb79Avsb/Zddu9n09tjh0IZLCo8ojUpCjrXNB0ywWg0DIZD022ThHTPMeS+qGFkc9WpBHrdPxV7kJmzxA/c3Vjz+HYqu808at8LvstlzPpv8DtQ== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector9901; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=wpE0ax7icJFHm/BUubeHZm+XdHIuCYU9aBSBEv3NT/U=; b=DGUOCwVNPhHNt1QoCqWUEDICFDmZAyCqt0L2CDmtWEYNA8jYVbubNAXpK6nyAnOXt8hYWFYPmM3XpH6cJG72tot7yYq3kf3spIuVbJrOpawB20OHX3KgY2UjrCs9L6Xrf7M7VnbcVIfamKjURqsUXAAV4FYvLxXRHS10NPAuSklPRh+K2KQLBhJPyDF7WrBI8tCjcPwvA8DjkcEdzmkcIpzRN4YD5rBMjRS0VY6JqmTf5e7KRJJLuuihAoLxUiynwsyan14XbHC1lKuI/elomBaiQHdo0bLtTn+HD0nt5JclozY1LcaWtT6SgIF+bS93Y27W7zAJjLuXyJ+hy5qTxA== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass smtp.mailfrom=arm.com; dmarc=pass action=none header.from=arm.com; dkim=pass header.d=arm.com; arc=none DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=armh.onmicrosoft.com; s=selector2-armh-onmicrosoft-com; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=wpE0ax7icJFHm/BUubeHZm+XdHIuCYU9aBSBEv3NT/U=; b=oq7ziw/LkCFAc4iCTTxmi1LSw4oRslYD5doCEX+wAT8nhMbZSPzAoXJRM048g4A5yiW+UlfZqe1pgpCx1vy4K+hx8gv1s6sjWdWmm1m5XxeLg77RSr+pxvaz7q4CcyylCO2uW+MN05g71C4mZhxJKXo7mrecHWCy4Lj7ifKylNs= Received: from DB7PR08MB3260.eurprd08.prod.outlook.com (2603:10a6:5:21::23) by DB7PR08MB3772.eurprd08.prod.outlook.com (2603:10a6:10:73::15) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.3000.24; Wed, 20 May 2020 10:19:04 +0000 Received: from DB7PR08MB3260.eurprd08.prod.outlook.com ([fe80::990e:ed79:bec0:9dac]) by DB7PR08MB3260.eurprd08.prod.outlook.com ([fe80::990e:ed79:bec0:9dac%7]) with mapi id 15.20.3000.034; Wed, 20 May 2020 10:19:04 +0000 From: "Samer El-Haj-Mahmoud" To: "rfc@edk2.groups.io" , Samer El-Haj-Mahmoud , "ray.ni@intel.com" , "leif@nuviainc.com" , "devel@edk2.groups.io" CC: "Felixp@ami.com" , "Doran, Mark" , Andrew Fish , Laszlo Ersek , "Kinney, Michael D" , Samer El-Haj-Mahmoud Subject: Re: [edk2-rfc] [RFCv2] code-first process for UEFI-forum specifications Thread-Topic: [edk2-rfc] [RFCv2] code-first process for UEFI-forum specifications Thread-Index: AdYp7wte1clxxO15QnuNQF4AmoltLwEoMOlA Date: Wed, 20 May 2020 10:19:04 +0000 Message-ID: References: <160F0156FEDC6091.6323@groups.io> In-Reply-To: <160F0156FEDC6091.6323@groups.io> Accept-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: x-ts-tracking-id: a5bc35de-ed08-47ea-8147-d62643795065.1 x-checkrecipientchecked: true Authentication-Results-Original: edk2.groups.io; dkim=none (message not signed) header.d=none;edk2.groups.io; dmarc=none action=none header.from=arm.com; x-originating-ip: [99.132.126.10] x-ms-publictraffictype: Email X-MS-Office365-Filtering-HT: Tenant X-MS-Office365-Filtering-Correlation-Id: 170f2bcc-12e7-4238-485e-08d7fca73f64 x-ms-traffictypediagnostic: DB7PR08MB3772:|AM0PR08MB4034: x-ld-processed: f34e5979-57d9-4aaa-ad4d-b122a662184d,ExtAddr x-ms-exchange-transport-forked: True X-Microsoft-Antispam-PRVS: x-checkrecipientrouted: true nodisclaimer: true x-ms-oob-tlc-oobclassifiers: OLM:10000;OLM:10000; x-forefront-prvs: 04097B7F7F X-MS-Exchange-SenderADCheck: 1 X-Microsoft-Antispam-Untrusted: BCL:0; X-Microsoft-Antispam-Message-Info-Original: EvMJwjWlWSRKNjvAHUlND/7BbyKm6etgzb5ziSm0AScSKVJzEDXeg80aiWfvm5tbXbD80vEXa1ZNR2bDUSMeiIMlg8V3nSVfChGuKF20b8comBpPlgNUZnW5gYtIP75G2Ir/Ln4OwWOOJL4Hyj37GjBO0KIsnqaRl+s6PN8scAEAd7R5+w2u53LYaaI3VLzmQgbHsUty/5Lpvp6qEP1FWzp8gJvRSSeasio1ggHsatvX8xYwpWaJUeDlQu/Z7OwRChJAWImdgOXKen+qCx9l3RB/HGPf1/raU1VOeNTSfX3aaK8b3eZqc5DW1rvTIImOtQQwayrz4IW1RaB6bgEpQONDg2GRJXMc9OZfzRP0fAq7XyTzX3KFAhE5PHL/7KXVDMpicFa0HQAqrwB5/c8j3kyxByxe7GVcAxj7LYxMOa8orZDQ2n1GEYCm3ghQlembNj6aqsdNTprvE9oa/8fiEMRjWOCE+t/ajVanAkNVjNOVgorKg3hWvVunMwZoynLGrkvMnP7ophYsCF64RvlvHg== X-Forefront-Antispam-Report-Untrusted: CIP:255.255.255.255;CTRY:;LANG:en;SCL:1;SRV:;IPV:NLI;SFV:NSPM;H:DB7PR08MB3260.eurprd08.prod.outlook.com;PTR:;CAT:NONE;SFTY:;SFS:(4636009)(136003)(346002)(396003)(376002)(366004)(39860400002)(8936002)(9686003)(316002)(8676002)(55016002)(86362001)(110136005)(71200400001)(2906002)(33656002)(54906003)(7696005)(52536014)(76116006)(64756008)(66446008)(66556008)(66946007)(6506007)(66476007)(26005)(4326008)(5660300002)(478600001)(966005)(186003)(53546011);DIR:OUT;SFP:1101; x-ms-exchange-antispam-messagedata: c79P3x0tKcJMc82ZmTXrNahA0ywgUkvG1UTtzdnj2Z1CVp932/OHy5WD5OjMuLnKRrHUrTNTQ+z1yuWbCZNs6eNe9B//9kFc83v2Q9ofGrfvS68qD5LYSL92ohPw7hOXuJS7xFNke3sbRAdF5kNDuB4Dp8IuQ17/BfgVb7Ue1LBSpkFvxpScSm5H+lNP0ap5kxHDJopoQ7iJvP0gFRP5+aWvDAhKpsKmm9gyE3OFWOLEsAmAwJA5Or31Ks4wTnzwvVzl4hVlcUYysKKk22Fol/FqugAqi1YLAmffji6vtUaSmcUpSpliuQMUu43YjtZVYTHshaFWMwSr29OTgKztar3iBUsvLYydJLgr54fTh4Fuj5OQqQNP2B0XEG9t5Qu+BYsQgplI4gqy3qq3IYItDhW16LQNWzvEZn9vLSAkqnqSsUjSPkwvZd4jSqftKvgBmFyUzG5LHkhpvbyDP6UPxlP4heY2b12YkrrI6Btoks253BLn9sYB6GCoUMzuNQL6 MIME-Version: 1.0 X-MS-Exchange-Transport-CrossTenantHeadersStamped: DB7PR08MB3772 Original-Authentication-Results: edk2.groups.io; dkim=none (message not signed) header.d=none;edk2.groups.io; dmarc=none action=none header.from=arm.com; Return-Path: Samer.El-Haj-Mahmoud@arm.com X-EOPAttributedMessage: 0 X-MS-Exchange-Transport-CrossTenantHeadersStripped: DB5EUR03FT038.eop-EUR03.prod.protection.outlook.com X-Forefront-Antispam-Report: CIP:63.35.35.123;CTRY:IE;LANG:en;SCL:1;SRV:;IPV:CAL;SFV:NSPM;H:64aa7808-outbound-1.mta.getcheckrecipient.com;PTR:ec2-63-35-35-123.eu-west-1.compute.amazonaws.com;CAT:NONE;SFTY:;SFS:(4636009)(396003)(39860400002)(136003)(376002)(346002)(46966005)(70586007)(81166007)(86362001)(54906003)(316002)(110136005)(356005)(82310400002)(82740400003)(47076004)(966005)(33656002)(478600001)(52536014)(8936002)(5660300002)(186003)(9686003)(450100002)(7696005)(70206006)(8676002)(53546011)(336012)(2906002)(4326008)(55016002)(26005)(6506007);DIR:OUT;SFP:1101; X-MS-Office365-Filtering-Correlation-Id-Prvs: bf61f430-0527-4a8b-9046-08d7fca73958 X-Forefront-PRVS: 04097B7F7F X-Microsoft-Antispam: BCL:0; X-Microsoft-Antispam-Message-Info: K0au1T8wXY4DqrMSHKFrWf2TPwvSpAjz9DMsq+alVYu8c01Mvb5AWhWbCd8ygdUqkJ0xbiiT/ccDjmwSerY97vFJH6zrDhWX6r/E0zxIIqMISLe1xgY7VcINYlQcIecaoVF7Z9mZ8NAwcZx0+C7DRV+H2Kd2YMoSDx+55EARAwc2YG6sc+NCIJ/72tVr3leJseMHQgnGeaYXa49EbJWVLmWrt2wQ2A1b1kpr0fDqcA8N1ALJTl6nTavt86Aah2al0OKgF0M5jRUK08BeApJxw8XxSf8pdZloUyDqILgcyn0ZF6w5q1XmFiQA3eBr24kYZiX/axD2d28g+FqCQ6z/7UFcUu8K8iv9QUt/tQSC8MqLUmDGzAs00F3T74j6lmT0vjSxHbfpnfl1m+LZYPNNHuCP0R+TcR0S0D/PkMePoAMScNcT4YkdUlIoe/mk4VtMtmE8DAzuWQoy7Inbmw8xerRHGdSE8M/1HBzH854FACgAuvCRDxyDuMxyYiFZGR8aox+iT0ZjGBSthEo6at0E8BmKQe2xoGda4bWWQM2npT+VJMmwnLfeVK0xp8Rx/18kAfdxlxtIT6482YueZ9UqFA== X-OriginatorOrg: arm.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 20 May 2020 10:19:14.9249 (UTC) X-MS-Exchange-CrossTenant-Network-Message-Id: 170f2bcc-12e7-4238-485e-08d7fca73f64 X-MS-Exchange-CrossTenant-Id: f34e5979-57d9-4aaa-ad4d-b122a662184d X-MS-Exchange-CrossTenant-OriginalAttributedTenantConnectingIp: TenantId=f34e5979-57d9-4aaa-ad4d-b122a662184d;Ip=[63.35.35.123];Helo=[64aa7808-outbound-1.mta.getcheckrecipient.com] X-MS-Exchange-CrossTenant-FromEntityHeader: HybridOnPrem X-MS-Exchange-Transport-CrossTenantHeadersStamped: AM0PR08MB4034 Content-Language: en-US Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable Are there any additional comments on the code first process for UEFI specif= ications? When should we expect the process to *actually* start being used? Thanks, --Samer > -----Original Message----- > From: rfc@edk2.groups.io On Behalf Of Samer El-Haj- > Mahmoud via groups.io > Sent: Thursday, May 14, 2020 5:11 PM > To: rfc@edk2.groups.io; ray.ni@intel.com; leif@nuviainc.com; > devel@edk2.groups.io > Cc: Felixp@ami.com; Doran, Mark ; Andrew Fish > ; Laszlo Ersek ; Kinney, Michael D > ; Samer El-Haj-Mahmoud Mahmoud@arm.com> > Subject: Re: [edk2-rfc] [RFCv2] code-first process for UEFI-forum > specifications > > Leif, Ray, > > I have not seen any discussion on this thread since March(!)... > > Please see my comments below. > > > > -----Original Message----- > > From: rfc@edk2.groups.io On Behalf Of Ni, Ray via > > Groups.Io > > Sent: Wednesday, March 25, 2020 1:15 AM > > To: rfc@edk2.groups.io; leif@nuviainc.com; devel@edk2.groups.io > > Cc: Felixp@ami.com; Doran, Mark ; Andrew Fish > > ; Laszlo Ersek ; Kinney, Michael D > > > > Subject: Re: [edk2-rfc] [RFCv2] code-first process for UEFI-forum > > specifications > > > > > > > > ## Github > > > New repositories will be added for holding the text changes and the > > > source > > code. > > > > > > Specification text changes will be held within the affected source > > > repository, in the Github flavour of markdown, in a file (or split > > > across several files) with .md suffix. > > > > What's the case when multiple .MD files are needed? > > > > > (This one may break down where we have a specification change > > > affecting multiple specifications, but at that point we can track it > > > with multiple BZ entries) > > > > > > > > > > > ## Source code > > > In order to ensure draft code does not accidentally leak into > > > production use, and to signify when the changeover from draft to > > > final happens, *all* new or modified[1] identifiers need to be > > > prefixed with the > > relevant BZ####. > > > > > > [1] Modified in a non-backwards-compatible way. If, for example, a > > statically > > > sized array is grown - this does not need to be prefixed. But a > > > tag in a comment would be *highly* recommended. > > > > If a protocol is enhanced to provide more interfaces with increased > > revision number, would you like the protocol name to be prefixed with > BZ####? > > Or just the new interfaces added to the protocol are prefixed the BZ##= ##? > > I think just prefixing the new interfaces can meet the purpose. > > > > I think pre-fixing the new interfaces is sufficient. Otherwise, you need= to > modify all code using the existing interfaces (for build verification) > > > > But the protocol definition is changed, it also needs to be prefixed > > according to this flow. > > Can you clarify a bit more? > > > > A changed protocol definition is not backwards compatible, and typically > results in a new protocol GUID. In that case, it really becomes a new > definition and need to be pre-fixed per this rule. Right? > > > > > > > ### File names > > > New public header files need the prefix. I.e. > > > `Bz1234MyNewProtocol.h` Private header files do not need the prefix. > > > > > > ### Contents > > > > > > The tagging must follow the coding style used by each affected codeb= ase. > > > Examples: > > > > > > | Released in spec | Draft version in tree | Comment = | > > > | --- | --- | --- = | > > > | `FunctionName` | `Bz1234FunctionName` | = | > > > | `HEADER_MACRO` | `BZ1234_HEADER_MACRO` | = | > > > > If FunctionName or HEADER_MACRO is defined in non-public header files, > > I don't think they require the prefix. Do you agree? > > > > > For data structures or enums, any new or non-backwards-compatible > > > structs or fields require a prefix. As above, growing an existing > > > array in an existing struct requires no prefix. > > > > > > | `typedef SOME_STRUCT` | `BZ1234_SOME_STRUCT` | Typedef only > > [2] | > > > | `StructField` | `Bz1234StructField` | In existing = struct[3] | > > > | `typedef SOME_ENUM` | `BZ1234_SOME_ENUM` | Typedef only > > [2] | > > > > > > [2] If the struct or enum definition is separate from the typedef in > > > the > > public > > > header, the definition does not need the prefix. > > > > What does "separate" mean? > > Does it mean "struct or enum in the public header BzXXX.h don't need > > the prefix"? > > If yes, then I think macros defined in BzXXX.h also don't need the pre= fix. > > > > > [3] Individual fields in newly added typedefd struct do not need pre= fix, > the > > > struct already carried the prefix. > > > > > > Variable prefixes indicating global scope ('g' or 'm') go before the= BZ > prefix. > > > > > > | `gSomeGuid` | `gBz1234SomeGuid` | = | > > > > > > Local identifiers, including module-global ones (m-prefixed) do not > > > require a BZ prefix. > > > > I think only the names (struct type name, enum type name, interface > > name, protocol/ppi name) defined in public header files need the BZ > > prefix when the public header doesn't have prefix. > > Right? > > > > The way I read it, *all* new (and non-backward modified) identifiers > (typedef struct, typedef enum, and new structfield in existing struct) n= eed to > be pre-fixed, regardless if the filename is prefixed or not. > Correct? > > > > > > > IMPORTANT NOTICE: The contents of this email and any attachments are > confidential and may also be privileged. If you are not the intended rec= ipient, > please notify the sender immediately and do not disclose the contents to= any > other person, use it for any purpose, or store or copy the information i= n any > medium. Thank you. > >=20 IMPORTANT NOTICE: The contents of this email and any attachments are confi= dential and may also be privileged. If you are not the intended recipient, = please notify the sender immediately and do not disclose the contents to an= y other person, use it for any purpose, or store or copy the information in= any medium. Thank you.