From: "Michael D Kinney" <michael.d.kinney@intel.com>
To: Rebecca Cran <rebecca@nuviainc.com>,
"devel@edk2.groups.io" <devel@edk2.groups.io>,
"Kinney, Michael D" <michael.d.kinney@intel.com>
Cc: Leif Lindholm <leif@nuviainc.com>,
Laszlo Ersek <lersek@redhat.com>, Andrew Fish <afish@apple.com>
Subject: Re: [edk2-CCodingStandardsSpecification PATCH 1/1] Function example in Chapter 5 C Programming has extraneous semicolon
Date: Wed, 9 Dec 2020 17:31:49 +0000 [thread overview]
Message-ID: <BYAPR11MB3238AECD6DA94BB8015D25B7D2CC0@BYAPR11MB3238.namprd11.prod.outlook.com> (raw)
In-Reply-To: <BYAPR11MB32381BCF9C2B940D3A9D1DC0D2CC0@BYAPR11MB3238.namprd11.prod.outlook.com>
Rebecca,
Looks like a BZ was opened for this issue too:
https://bugzilla.tianocore.org/show_bug.cgi?id=1606
Mike
> -----Original Message-----
> From: Kinney, Michael D <michael.d.kinney@intel.com>
> Sent: Wednesday, December 9, 2020 8:41 AM
> To: Rebecca Cran <rebecca@nuviainc.com>; devel@edk2.groups.io; Kinney, Michael D <michael.d.kinney@intel.com>
> Cc: Leif Lindholm <leif@nuviainc.com>; Laszlo Ersek <lersek@redhat.com>; Andrew Fish <afish@apple.com>
> Subject: RE: [edk2-CCodingStandardsSpecification PATCH 1/1] Function example in Chapter 5 C Programming has extraneous
> semicolon
>
> Hi Rebecca,
>
> Reviewed-by: Michael D Kinney <michael.d.kinney@intel.com>
>
> I see this was a GitHub issue entered in 2019.
>
> We should be using TianoCore Bugzilla to enter specification issues. I appreciate you
> noticing this GitHub issue and generating a patch to get this fixed.
>
> There are also recommendations for the Revision History to be updated for each change
> with cross links between Revision History, git commit messages, and TianoCore Bugzilla.
>
> https://github.com/tianocore-docs/edk2-TemplateSpecification/wiki/TianoCore-Documents-Editing
>
>
> There are some examples of this at the end of the Revision History of the EDK II Build Specification.
>
> Ideally, the Revision History contains a link to the TianoCore Bugzilla. A few examples:
>
> | | [#465](https://bugzilla.tianocore.org/show_bug.cgi?id=465) DEC spec: document private definitions
> | |
>
> | | [#1110](https://bugzilla.tianocore.org/show_bug.cgi?id=1110) Extend exclamation statement's keyword to
> case-insensitive | |
> | | [#598](https://bugzilla.tianocore.org/show_bug.cgi?id=598) update supported operators in 8.2.4.6
> Expressions | |
> | 1.29 | [#1453](https://bugzilla.tianocore.org/show_bug.cgi?id=1453) Update Build spec to remove EDK related
> contents | Mar 2019 |
> | 1.30 | [#1952](https://bugzilla.tianocore.org/show_bug.cgi?id=1952) Update Build spec to support HOST_APPLICATION
> MODULE_TYPE | July 2019 |
>
> The TianoCore Bugzilla should be updated when the issue is Fixed/Resolved with links to the
> GitHub commits for the specification changes.
>
> With this cross linking, when a specification is opened, the reader can review the Revision History,
> follow the link to the TianoCore Bugzilla with a discussion of the specification change and see
> the links to the final commits. The reader can then follow the links to GitHub commits and see
> the text changed rendered with by GitHub with green (add), red (delete), yellow (change) highlight
> when the "Display as rich diff" button is selected.
>
> For example, BZ 465
>
> https://bugzilla.tianocore.org/show_bug.cgi?id=465
>
> This BZ contains the full link to the GitHub commits:
>
> https://github.com/tianocore-docs/edk2-BuildSpecification/commit/afb505572de767fa05ca6348d36015faae387df9
>
> If you clink on the "Display as rich diff" button, it will show a more readable version of the change:
>
> https://github.com/tianocore-docs/edk2-
> BuildSpecification/commit/afb505572de767fa05ca6348d36015faae387df9?short_path=3d47f51#diff-
> 3d47f517e576e84d4c7bf02e39d31d597e39821a99fa4fbe08a91f6e03e56961
>
> With the addition of the GitBook Action, you can also create a fork of a document in your personal
> GitHub area and provide links to a branch with the proposed document changes that can be viewed
> using the "Display as rich diff" for easier/faster community review of document changed. If you
> enable the GitBook Action on your personal fork of a document, you can also provide links to the
> published versions of the document with the proposed changes.
>
> This full process makes sense for larger changes. Does not seem to make sense for simple typos.
>
> Thanks,
>
> Mike
>
> > -----Original Message-----
> > From: Rebecca Cran <rebecca@nuviainc.com>
> > Sent: Wednesday, December 9, 2020 7:16 AM
> > To: devel@edk2.groups.io
> > Cc: Rebecca Cran <rebecca@nuviainc.com>; Kinney, Michael D <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] Function example in Chapter 5 C Programming has extraneous
> > semicolon
> >
> > https://github.com/tianocore-docs/edk2-CCodingStandardsSpecification/issues/1
> >
> > "Section 5.7.1.10, there is a semicolon after the function paramters.
> > Probably a copy-paste error from the header file."
> >
> > Contributed-under: TianoCore Contribution Agreement 1.1
> > Signed-off-by: Rebecca Cran <rebecca@nuviainc.com>
> > ---
> > 5_source_files/57_c_programming.md | 2 +-
> > 1 file changed, 1 insertion(+), 1 deletion(-)
> >
> > diff --git a/5_source_files/57_c_programming.md b/5_source_files/57_c_programming.md
> > index 8b9db584eea7..8b4111bfac29 100644
> > --- a/5_source_files/57_c_programming.md
> > +++ b/5_source_files/57_c_programming.md
> > @@ -102,7 +102,7 @@ FooName (
> > IN UINTN Arg2, OPTIONAL
> > OUT UINTN *Arg3,
> > IN OUT UINTN *Arg4
> > - );
> > + )
> > {
> > UINTN Local;
> > ...
> > --
> > 2.26.2
next prev parent reply other threads:[~2020-12-09 17:31 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-12-09 15:16 [edk2-CCodingStandardsSpecification PATCH 1/1] Function example in Chapter 5 C Programming has extraneous semicolon Rebecca Cran
2020-12-09 16:40 ` Michael D Kinney
2020-12-09 17:31 ` Michael D Kinney [this message]
2020-12-11 19:41 ` 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=BYAPR11MB3238AECD6DA94BB8015D25B7D2CC0@BYAPR11MB3238.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