From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received-SPF: Pass (sender SPF authorized) identity=mailfrom; client-ip=217.140.96.140; helo=cam-smtp0.cambridge.arm.com; envelope-from=evan.lloyd@arm.com; receiver=edk2-devel@lists.01.org Received: from cam-smtp0.cambridge.arm.com (fw-tnat.cambridge.arm.com [217.140.96.140]) (using TLSv1 with cipher AES256-SHA (256/256 bits)) (No client certificate requested) by ml01.01.org (Postfix) with ESMTPS id E836E222A54EA for ; Wed, 3 Jan 2018 03:17:58 -0800 (PST) Received: from E111747.Emea.Arm.com (e111747.emea.arm.com [10.1.27.84]) by cam-smtp0.cambridge.arm.com (8.13.8/8.13.8) with ESMTP id w03BMrgk021422; Wed, 3 Jan 2018 11:22:54 GMT 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 Date: Wed, 3 Jan 2018 11:22:44 +0000 Message-Id: <20180103112248.11880-2-evan.lloyd@arm.com> X-Mailer: git-send-email 2.14.1 In-Reply-To: <20180103112248.11880-1-evan.lloyd@arm.com> References: <20180103112248.11880-1-evan.lloyd@arm.com> Subject: [edk2-CCodingStandardsSpecification PATCH 1/5] Fix Chapter 1 Typos X-BeenThere: edk2-devel@lists.01.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: EDK II Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Wed, 03 Jan 2018 11:17:59 -0000 From: Evan Lloyd 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 --- 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")