public inbox for devel@edk2.groups.io
 help / color / mirror / Atom feed
From: "Laszlo Ersek" <lersek@redhat.com>
To: devel@edk2.groups.io, hernan_gutierrez@hp.com
Subject: Re: [edk2-devel] EDK2 code standard question
Date: Mon, 22 Jun 2020 17:35:07 +0200	[thread overview]
Message-ID: <0bdca40c-f4a3-f486-d125-d785d25ce9b4@redhat.com> (raw)
In-Reply-To: <CS1PR8401MB07288CD92DE102C180862B8A99980@CS1PR8401MB0728.NAMPRD84.PROD.OUTLOOK.COM>

On 06/19/20 19:25, Hernan via groups.io wrote:
> Hi,
> 
> I am a new to this group and I found something I think it is a problem in the documentation for code standards of edk2.
> Can you help me understand who/how I can request a revision on such detail in the documentation?
> 
> https://edk2-docs.gitbook.io/edk-ii-c-coding-standards-specification/5_source_files/57_c_programming
> 
> Section 5.7.1.10, specifically.

(1) Please register in the tianocore bugzilla at
<https://bugzilla.tianocore.org/>, and then file a new bug with the
following details:

- product: EDK2
- Component: documentation
- package: N/A
- Tianocore documents: EDK II C Coding Standards

In case you'd like to post patches too:

(2) You can clone the source repository for the document from:

- repo URL:
https://github.com/tianocore-docs/edk2-CCodingStandardsSpecification.git

- web UI:
https://github.com/tianocore-docs/edk2-CCodingStandardsSpecification

(3) Once you push your patches to your personal fork on github.com, you
can also sign up at <https://www.gitbook.com/>, and configure
integration with github.com. This will let you check a rendered view of
your changes before posting the patches. IIRC you can select, on
gitbook.com, the branch whose HEAD you'd like to render.

(4) For posting patches, please use the subject prefix "PATCH
edk2-CCodingStandardsSpecification" or "PATCH edk2-CCSS".

Thanks
Laszlo


      reply	other threads:[~2020-06-22 15:35 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-06-19 17:25 EDK2 code standard question Hernan
2020-06-22 15:35 ` Laszlo Ersek [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=0bdca40c-f4a3-f486-d125-d785d25ce9b4@redhat.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