public inbox for devel@edk2.groups.io
 help / color / mirror / Atom feed
From: "Kinney, Michael D" <michael.d.kinney@intel.com>
To: "Gao, Liming" <liming.gao@intel.com>,
	"edk2-devel@lists.01.org" <edk2-devel@lists.01.org>,
	"Kinney, Michael D" <michael.d.kinney@intel.com>
Subject: Re: [Patch] MdePkg Base.h: Update field name in VERIFY_UINTXX_ENUM_SIZE to follow style
Date: Fri, 11 Nov 2016 20:47:33 +0000	[thread overview]
Message-ID: <E92EE9817A31E24EB0585FDF735412F564843787@ORSMSX113.amr.corp.intel.com> (raw)
In-Reply-To: <1478835172-32372-1-git-send-email-liming.gao@intel.com>

Liming,

I agree enums should start with [A-Z].

These enums are only use to verify compiler config is right
and I wanted to make sure the enum names did not conflict
with any other names that might be used.  This is why
I added '__' to the beginning of these enum names.  These
enums would never be used my any code after the verify 
operation in the same .h file.

I don't expect name collisions without the '__', so I am
ok with this patch.

But, we could also consider adding a comment that the '__'
is on purpose.

Mike

> -----Original Message-----
> From: Gao, Liming
> Sent: Thursday, November 10, 2016 7:33 PM
> To: edk2-devel@lists.01.org
> Cc: Kinney, Michael D <michael.d.kinney@intel.com>
> Subject: [Patch] MdePkg Base.h: Update field name in VERIFY_UINTXX_ENUM_SIZE to
> follow style
> 
> For field name in structure, its first character should be upper case.
> 
> Cc: Michael Kinney <michael.d.kinney@intel.com>
> Contributed-under: TianoCore Contribution Agreement 1.0
> Signed-off-by: Liming Gao <liming.gao@intel.com>
> ---
>  MdePkg/Include/Base.h | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/MdePkg/Include/Base.h b/MdePkg/Include/Base.h
> index 5e24b5d..749c275 100644
> --- a/MdePkg/Include/Base.h
> +++ b/MdePkg/Include/Base.h
> @@ -64,15 +64,15 @@ VERIFY_SIZE_OF (CHAR8, 1);
>  VERIFY_SIZE_OF (CHAR16, 2);
> 
>  typedef enum {
> -  __VerifyUint8EnumValue = 0xff
> +  VerifyUint8EnumValue = 0xff
>  } __VERIFY_UINT8_ENUM_SIZE;
> 
>  typedef enum {
> -  __VerifyUint16EnumValue = 0xffff
> +  VerifyUint16EnumValue = 0xffff
>  } __VERIFY_UINT16_ENUM_SIZE;
> 
>  typedef enum {
> -  __VerifyUint32EnumValue = 0xffffffff
> +  VerifyUint32EnumValue = 0xffffffff
>  } __VERIFY_UINT32_ENUM_SIZE;
> 
>  VERIFY_SIZE_OF (__VERIFY_UINT8_ENUM_SIZE, 4);
> --
> 2.8.0.windows.1



  reply	other threads:[~2016-11-11 20:47 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-11-11  3:32 [Patch] MdePkg Base.h: Update field name in VERIFY_UINTXX_ENUM_SIZE to follow style Liming Gao
2016-11-11 20:47 ` Kinney, Michael D [this message]
2016-11-14  2:24 ` [PATCH v2] " Liming Gao

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=E92EE9817A31E24EB0585FDF735412F564843787@ORSMSX113.amr.corp.intel.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