From nobody Tue Dec 24 02:02:02 2024 Delivered-To: importer@patchew.org Authentication-Results: mx.zohomail.com; spf=none (zoho.com: 198.145.21.10 is neither permitted nor denied by domain of lists.01.org) smtp.mailfrom=edk2-devel-bounces@lists.01.org Return-Path: Received: from ml01.01.org (ml01.01.org [198.145.21.10]) by mx.zohomail.com with SMTPS id 1514978597820504.69647020920604; Wed, 3 Jan 2018 03:23:17 -0800 (PST) Received: from [127.0.0.1] (localhost [IPv6:::1]) by ml01.01.org (Postfix) with ESMTP id 287D0222A54FC; Wed, 3 Jan 2018 03:18:01 -0800 (PST) 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 X-Original-To: edk2-devel@lists.01.org Received-SPF: none (zoho.com: 198.145.21.10 is neither permitted nor denied by domain of lists.01.org) client-ip=198.145.21.10; envelope-from=edk2-devel-bounces@lists.01.org; helo=ml01.01.org; 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 From: evan.lloyd@arm.com To: edk2-devel@lists.01.org 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] [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: , Cc: "Matteo.Carlini@arm.com"@arm.com, "nd@arm.com"@arm.com, "ard.biesheuvel@linaro.org"@arm.com, "lersek@redhat.com"@arm.com, "jordan.l.justen@intel.com"@arm.com, "liming.gao@intel.com"@arm.com, "leif.lindholm@linaro.org"@arm.com, "michael.d.kinney@intel.com"@arm.com MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Errors-To: edk2-devel-bounces@lists.01.org Sender: "edk2-devel" X-ZohoMail: RSF_4 Z_629925259 SPT_0 Content-Type: text/plain; charset="utf-8" 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..5471a6bf5e94df6dd0c5fd0a4b5= 020c77d1f8ca0 100644 --- a/1_introduction.md +++ b/1_introduction.md @@ -62,7 +62,7 @@ This specification addresses the chronic problem of provi= ding accurate documentation of the code base by embedding the documentation within the c= ode. While this does not guarantee that the documentation will be kept up to da= te, it significantly increases the chances. A document generation system, Doxy= gen, -then produce formatted documentation by extracting information from specia= lly +can produce formatted documentation by extracting information from special= ly formatted comment blocks and the syntactic elements of the code. =20 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 diffi= cult. =20 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 th= at -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 doc= ument +is making you, and those who follow you, more productive. =20 Some of the strict rules for protocol and driver construction may seem ove= rly 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 =20 -These guidelines represent an attempt make you aware of your actions, beca= use +These guidelines represent an attempt to make you aware of your actions, b= ecause those actions affect the future readers and maintainers of the code you pr= oduce. =20 Pre-existing code ported to the EDK II environment does not have to confor= m to --=20 Guid("CE165669-3EF3-493F-B85D-6190EE5B9759") _______________________________________________ edk2-devel mailing list edk2-devel@lists.01.org https://lists.01.org/mailman/listinfo/edk2-devel