From: evan.lloyd@arm.com
To: edk2-devel@lists.01.org
Cc: "ard.biesheuvel@linaro.org"@arm.com,
"leif.lindholm@linaro.org"@arm.com,
"Matteo.Carlini@arm.com"@arm.com, "lersek@redhat.com"@arm.com,
"liming.gao@intel.com"@arm.com,
"michael.d.kinney@intel.com"@arm.com,
"jordan.l.justen@intel.com"@arm.com, "nd@arm.com"@arm.com
Subject: [edk2-CCodingStandardsSpecification PATCH 1/5] Fix Chapter 1 Typos
Date: Wed, 3 Jan 2018 11:22:44 +0000 [thread overview]
Message-ID: <20180103112248.11880-2-evan.lloyd@arm.com> (raw)
In-Reply-To: <20180103112248.11880-1-evan.lloyd@arm.com>
From: Evan Lloyd <evan.lloyd@arm.com>
1.1 Abstract - replace "then" with "can" (to make meaningful)
1.2 Rationale - change
"commit to conforming to standards of this specification"
to commit to conforming with the standards of this specification
1.3 Scope - add missing "to" in "an attempt make you aware of your
actions"
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Evan Lloyd <evan.lloyd@arm.com>
---
1_introduction.md | 12 ++++++------
1 file changed, 6 insertions(+), 6 deletions(-)
diff --git a/1_introduction.md b/1_introduction.md
index c22c04c9f76d2352e4f294c0e70f5ebf787f7054..5471a6bf5e94df6dd0c5fd0a4b5020c77d1f8ca0 100644
--- a/1_introduction.md
+++ b/1_introduction.md
@@ -62,7 +62,7 @@ This specification addresses the chronic problem of providing accurate
documentation of the code base by embedding the documentation within the code.
While this does not guarantee that the documentation will be kept up to date,
it significantly increases the chances. A document generation system, Doxygen,
-then produce formatted documentation by extracting information from specially
+can produce formatted documentation by extracting information from specially
formatted comment blocks and the syntactic elements of the code.
This specification presents protocol standards that will ensure that the
@@ -97,10 +97,10 @@ wide support. On the downside in that each developer's C code could
lack of uniformity makes understanding and maintaining the code very difficult.
Uniformity is the key theme of these rules. You may disagree with some of our
-decisions. Nevertheless, we ask that you commit to conforming to standards of
-this specification. Also, there are pitfalls inherent in the C language that
-this style guide may help you to avoid. The goal of this document is making
-you, and those who follow you, more productive.
+decisions. Nevertheless, we ask that you commit to conforming with the
+standards of this specification. Also, there are pitfalls inherent in the C
+language that this style guide may help you to avoid. The goal of this document
+is making you, and those who follow you, more productive.
Some of the strict rules for protocol and driver construction may seem overly
onerous. Don't panic - there is a method to our madness - we intend to
@@ -161,7 +161,7 @@ Topics covered in this coding standard include:
* Commenting rules
* Doxygen
-These guidelines represent an attempt make you aware of your actions, because
+These guidelines represent an attempt to make you aware of your actions, because
those actions affect the future readers and maintainers of the code you produce.
Pre-existing code ported to the EDK II environment does not have to conform to
--
Guid("CE165669-3EF3-493F-B85D-6190EE5B9759")
next prev parent reply other threads:[~2018-01-03 11:17 UTC|newest]
Thread overview: 14+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-01-03 11:22 [edk2-CCodingStandardsSpecification PATCH 0/5] Typographic Corrections evan.lloyd
2018-01-03 11:22 ` evan.lloyd [this message]
2018-01-03 16:51 ` [edk2-CCodingStandardsSpecification PATCH 1/5] Fix Chapter 1 Typos Laszlo Ersek
2018-01-04 19:40 ` Evan Lloyd
2018-01-03 11:22 ` [edk2-CCodingStandardsSpecification PATCH 2/5] Fix Chapter 2 Typos evan.lloyd
2018-01-03 16:52 ` Laszlo Ersek
2018-01-03 11:22 ` [edk2-CCodingStandardsSpecification PATCH 3/5] Fix Chapter 3 Typos evan.lloyd
2018-01-03 16:53 ` Laszlo Ersek
2018-01-03 11:22 ` [edk2-CCodingStandardsSpecification PATCH 4/5] Fix Chapter 4 Typo evan.lloyd
2018-01-03 16:56 ` Laszlo Ersek
2018-01-08 18:31 ` Evan Lloyd
2018-01-03 11:22 ` [edk2-CCodingStandardsSpecification PATCH 5/5] Fix Chapter 5 Typos evan.lloyd
2018-01-03 17:07 ` Laszlo Ersek
2018-01-08 18:26 ` Evan Lloyd
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=20180103112248.11880-2-evan.lloyd@arm.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