From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received-SPF: Pass (sender SPF authorized) identity=mailfrom; client-ip=209.132.183.28; helo=mx1.redhat.com; envelope-from=lersek@redhat.com; receiver=edk2-devel@lists.01.org Received: from mx1.redhat.com (mx1.redhat.com [209.132.183.28]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ml01.01.org (Postfix) with ESMTPS id 9DB44222A54C9 for ; Wed, 3 Jan 2018 08:46:02 -0800 (PST) Received: from smtp.corp.redhat.com (int-mx05.intmail.prod.int.phx2.redhat.com [10.5.11.15]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id 925DAC024FE6; Wed, 3 Jan 2018 16:51:05 +0000 (UTC) Received: from lacos-laptop-7.usersys.redhat.com (ovpn-123-216.rdu2.redhat.com [10.10.123.216]) by smtp.corp.redhat.com (Postfix) with ESMTP id 9285262691; Wed, 3 Jan 2018 16:51:02 +0000 (UTC) To: evan.lloyd@arm.com, 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 References: <20180103112248.11880-1-evan.lloyd@arm.com> <20180103112248.11880-2-evan.lloyd@arm.com> From: Laszlo Ersek Message-ID: <82d4da0c-2bc6-6383-26ee-729a01297f7a@redhat.com> Date: Wed, 3 Jan 2018 17:51:01 +0100 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:52.0) Gecko/20100101 Thunderbird/52.5.0 MIME-Version: 1.0 In-Reply-To: <20180103112248.11880-2-evan.lloyd@arm.com> X-Scanned-By: MIMEDefang 2.79 on 10.5.11.15 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.32]); Wed, 03 Jan 2018 16:51:05 +0000 (UTC) Subject: Re: [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 16:46:03 -0000 Content-Type: text/plain; charset=utf-8 Content-Language: en-US Content-Transfer-Encoding: 7bit On 01/03/18 12:22, evan.lloyd@arm.com wrote: > 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 OK, a risky observation from non-native speaker to native speaker: To my knowledge, it's "conform to", not "conform with". Thus, an update to this paragraph looks unnecessary to me, but I'm more than prepared to be corrected :) (Also, I'd replace "help you to avoid" with "help you avoid", i.e. drop the "to". But, that's a separate thing, and the same caveat about being a non-native speaker applies :) ) Looks fine to me otherwise. Thanks! Laszlo > @@ -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 >