From: "Michael D Kinney" <michael.d.kinney@intel.com>
To: "devel@edk2.groups.io" <devel@edk2.groups.io>,
"lersek@redhat.com" <lersek@redhat.com>,
"rebecca@nuviainc.com" <rebecca@nuviainc.com>,
"Kinney, Michael D" <michael.d.kinney@intel.com>
Cc: Leif Lindholm <leif@nuviainc.com>, Andrew Fish <afish@apple.com>
Subject: Re: [edk2-devel] [edk2-CCodingStandardsSpecification PATCH 1/1] Update the Name Space Rules page examples to follow the coding standard
Date: Tue, 8 Dec 2020 21:39:31 +0000 [thread overview]
Message-ID: <BL0PR11MB32369B0F002B6F33DBF669BBD2CD0@BL0PR11MB3236.namprd11.prod.outlook.com> (raw)
In-Reply-To: <b89bf30b-1a84-a48d-d0f2-9d8cc310ad99@redhat.com>
Pushed
https://github.com/tianocore-docs/edk2-CCodingStandardsSpecification/commit/0d88b4742209c162c37f5dab282a1c5990e15aa8
Mike
> -----Original Message-----
> From: devel@edk2.groups.io <devel@edk2.groups.io> On Behalf Of Laszlo Ersek
> Sent: Monday, December 7, 2020 6:32 PM
> To: devel@edk2.groups.io; rebecca@nuviainc.com; Kinney, Michael D <michael.d.kinney@intel.com>
> Cc: Leif Lindholm <leif@nuviainc.com>; Andrew Fish <afish@apple.com>
> Subject: Re: [edk2-devel] [edk2-CCodingStandardsSpecification PATCH 1/1] Update the Name Space Rules page examples to
> follow the coding standard
>
> Hi Rebecca,
>
> On 12/07/20 03:25, Rebecca Cran wrote:
> > The examples in the 45_name_space_rules.md files doesn't follow the
> > coding standard in the following ways:
> >
> > - Only use UEFI data types. Use of standard C data types is prohibited.
> > - Identifiers shall contain mixed upper- and lower-case text.
> >
> > Signed-off-by: Rebecca Cran <rebecca@nuviainc.com>
> > Contributed-under: TianoCore Contribution Agreement 1.1
> > ---
> > 4_naming_conventions/45_name_space_rules.md | 14 +++++++-------
> > 1 file changed, 7 insertions(+), 7 deletions(-)
> >
> > diff --git a/4_naming_conventions/45_name_space_rules.md b/4_naming_conventions/45_name_space_rules.md
> > index 1234250756cc..ecdebbe28339 100644
> > --- a/4_naming_conventions/45_name_space_rules.md
> > +++ b/4_naming_conventions/45_name_space_rules.md
> > @@ -53,9 +53,9 @@ tags may be reused only for union types.
> >
> > ```c
> > typedef struct MyStruct {
> > - int one;
> > - int two;
> > - int three;
> > + UINT32 One;
> > + UINT32 Two;
> > + UINT32 Three;
> > } MY_STRUCT;
> > ```
>
> Style-wise, the update looks good.
>
> Code wise, I can't tell from this context whether changing from int to
> UINT32 makes any difference. I guess using INT32 rather than UINT32
> would fix the style, and also keep the C language meaning identical.
>
> So please consider going with INT32, but if it doesn't matter (again, I
> can't tell from this context), then feel free to keep the UINT32.
>
> Either way:
>
> Reviewed-by: Laszlo Ersek <lersek@redhat.com>
>
> Mike, can you please push this?
>
> Thanks!
> Laszlo
>
> >
> > @@ -68,14 +68,14 @@ Exceptions are structure member and union member names.
> >
> > ```c
> > typedef struct StructOne {
> > - INT32 one;
> > - INT16 two;
> > + INT32 One;
> > + INT16 Two;
> > struct StructOne *MySelf;
> > } STRUCT_ONE;
> >
> > typedef struct StructTwo {
> > - INT16 one;
> > - INT8 *two;
> > + INT16 One;
> > + INT8 *Two;
> > struct StructTwo *MySelf;
> > } STRUCT_TWO;
> >
> >
>
>
>
>
>
>
prev parent reply other threads:[~2020-12-08 21:39 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-12-07 2:25 [edk2-CCodingStandardsSpecification PATCH 1/1] Update the Name Space Rules page examples to follow the coding standard Rebecca Cran
2020-12-07 21:39 ` Michael D Kinney
2020-12-08 2:31 ` [edk2-devel] " Laszlo Ersek
2020-12-08 21:39 ` Michael D Kinney [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-list from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=BL0PR11MB32369B0F002B6F33DBF669BBD2CD0@BL0PR11MB3236.namprd11.prod.outlook.com \
--to=devel@edk2.groups.io \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox