public inbox for devel@edk2.groups.io
 help / color / mirror / Atom feed
From: "Rebecca Cran" <rebecca@nuviainc.com>
To: devel@edk2.groups.io
Cc: Rebecca Cran <rebecca@nuviainc.com>,
	Michael D Kinney <michael.d.kinney@intel.com>,
	Leif Lindholm <leif@nuviainc.com>,
	Laszlo Ersek <lersek@redhat.com>, Andrew Fish <afish@apple.com>
Subject: [edk2-CCodingStandardsSpecification PATCH 1/1] Update the Name Space Rules page examples to follow the coding standard
Date: Sun,  6 Dec 2020 19:25:20 -0700	[thread overview]
Message-ID: <20201207022520.7963-1-rebecca@nuviainc.com> (raw)

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;
 ```
 
@@ -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;
 
-- 
2.26.2


             reply	other threads:[~2020-12-07 18:23 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-12-07  2:25 Rebecca Cran [this message]
2020-12-07 21:39 ` [edk2-CCodingStandardsSpecification PATCH 1/1] Update the Name Space Rules page examples to follow the coding standard Michael D Kinney
2020-12-08  2:31 ` [edk2-devel] " Laszlo Ersek
2020-12-08 21:39   ` Michael D Kinney

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=20201207022520.7963-1-rebecca@nuviainc.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