From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: 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 9ACBA21A02F37 for ; Mon, 12 Jun 2017 13:58:37 -0700 (PDT) Received: from smtp.corp.redhat.com (int-mx04.intmail.prod.int.phx2.redhat.com [10.5.11.14]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id E75194E048; Mon, 12 Jun 2017 20:59:50 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mx1.redhat.com E75194E048 Authentication-Results: ext-mx09.extmail.prod.ext.phx2.redhat.com; dmarc=none (p=none dis=none) header.from=redhat.com Authentication-Results: ext-mx09.extmail.prod.ext.phx2.redhat.com; spf=pass smtp.mailfrom=lersek@redhat.com DKIM-Filter: OpenDKIM Filter v2.11.0 mx1.redhat.com E75194E048 Received: from lacos-laptop-7.usersys.redhat.com (ovpn-116-168.phx2.redhat.com [10.3.116.168]) by smtp.corp.redhat.com (Postfix) with ESMTP id 927FC4F6C6; Mon, 12 Jun 2017 20:59:49 +0000 (UTC) To: Michael Kinney , edk2-devel@lists.01.org Cc: Liming Gao , Kevin W Shaw References: <1497292581-47804-1-git-send-email-michael.d.kinney@intel.com> <1497292581-47804-2-git-send-email-michael.d.kinney@intel.com> From: Laszlo Ersek Message-ID: Date: Mon, 12 Jun 2017 22:59:48 +0200 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:52.0) Gecko/20100101 Thunderbird/52.1.1 MIME-Version: 1.0 In-Reply-To: <1497292581-47804-2-git-send-email-michael.d.kinney@intel.com> X-Scanned-By: MIMEDefang 2.79 on 10.5.11.14 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.38]); Mon, 12 Jun 2017 20:59:51 +0000 (UTC) Subject: Re: [edk2-CCodingStandardsSpecification PATCH] Clarify format of multi-line function calls X-BeenThere: edk2-devel@lists.01.org X-Mailman-Version: 2.1.22 Precedence: list List-Id: EDK II Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Mon, 12 Jun 2017 20:58:37 -0000 Content-Type: text/plain; charset=utf-8 Content-Language: en-US Content-Transfer-Encoding: 7bit On 06/12/17 20:36, Michael Kinney wrote: > https://bugzilla.tianocore.org/show_bug.cgi?id=425 > > Cc: Laszlo Ersek > Cc: Liming Gao > Cc: Kevin W Shaw > Contributed-under: TianoCore Contribution Agreement 1.1 > Signed-off-by: Michael Kinney > --- > 5_source_files/52_spacing.md | 15 ++++------ > README.md | 69 ++++++++++++++++++++++---------------------- > 2 files changed, 41 insertions(+), 43 deletions(-) > > diff --git a/5_source_files/52_spacing.md b/5_source_files/52_spacing.md > index 01f79b4..677aa41 100644 > --- a/5_source_files/52_spacing.md > +++ b/5_source_files/52_spacing.md > @@ -130,11 +130,13 @@ if (MyVar != 0) { > If ((--MyInteger) > 0) { > ``` > > -#### 5.2.2.4 Subsequent lines of multi-line function calls should line up one or two tabstops from the beginning of the function name > +#### 5.2.2.4 Subsequent lines of multi-line function calls should line up two spaces from the beginning of the function name > > -Use either one or two tab stops to ensure that each parameter is indented at > -least two spaces after the function name. Either of the below examples is > -acceptable: > +If a function call is broken up into multiple lines, then: I'd like to suggest an addition: "... function call or function like macro invocation ..." The primary example being DEBUG. > + > +* One function call argument per line Please add (if you agree, that is): * even the first argument should be on a separate line > +* Indent each argument 2 spaces from the start of the function name Please add: if the function is called through a structure or union member, of type pointer-to-function, then indent each argument 2 spaces from the start of the member name. Thank you, Laszlo > +* Align the close parenthesis with the start of the last argument > > ```c > Status = gBS->AllocatePool ( > @@ -142,11 +144,6 @@ Status = gBS->AllocatePool ( > sizeof (DRIVER_NAME_INSTANCE), > &PrivateData > ); > -Status = gBS->AllocatePool ( > - EfiBootServicesData, > - sizeof (DRIVER_NAME_INSTANCE), > - &PrivateData > - ); > ``` > > #### 5.2.2.5 Always put space after commas or semicolons that separate items > diff --git a/README.md b/README.md > index fb5fb0a..8b9675b 100644 > --- a/README.md > +++ b/README.md > @@ -77,37 +77,38 @@ Copyright (c) 2006-2017, Intel Corporation. All rights reserved. > > ### Revision History > > -| Revision | Revision History | Date | > -| ---------- | ---------------------------------------------------------------------------------------------------- | ---------- | > -| 0.0.1 | First swag. | 6/23/00 | > -| 0.0.2 | Included feedback from team. | 8/3/00 | > -| 0.3 | Add comments. | 8/10/00 | > -| 0.3001 | Pre-vacation update, need to sync with new numbering process. | 9/11/00 | > -| 0.31 | Incorporated Sync 1 learnings. | 12/12/00 | > -| 0.32 | Completed TAT ARs. | 6/8/01 | > -| 0.33 | Added goto rules. | 8/16/01 | > -| 0.34 | Updated to match driver and Runtime Lib. | 11/15/01 | > -| 0.9 | Updated to Intel(R) Platform Innovation Framework for EFI. Added checklist appendix. | 1/8/04 | > -| 0.91 | Completed editing and formatting pass. | 3/3/04 | > -| 0.92 | Updated the structure declaration rules: Added section 4.8 and modified the checklist in Appendix A. | 4/8/04 | > -| 0.93 | Added some minor clarifications in section 3.1, 4.5, 7.1, and 10. | 9/14/04 | > -| 0.94 | Revised to accommodate Doxygen style commenting standards | 3/1/06 | > -| 0.50 | Change to new numbering scheme. Incorporate Review Comments. Editing and formatting. | 4/21/06 | > -| 0.51 | Changed to EDK II. | 7/13/06 | > -| 0.52 | Update rules to clarify areas of misinterpretation. Add copyright formatting rules. | 2/09/2010 | > -| 0.60 | Re-organize document and update to current rules. | 2/15/2010 | > -| 0.70 | Release for Review | 3/1/2010 | > -| 0.95 | Review comments incorporated, Release to Tech Pubs for Finalization | 3/10/2010 | > -| 1.00 | First full release | 3/15/2010 | > -| 1.01 | Restructure into book format. | 12/08/2011 | > -| 1.02 | Incorporate suggestions and trackers | 3/19/2012 | > -| | Release For Review | 4/2/2012 | > -| | Release | 4/16/2012 | > -| 1.03 | Update and incorporate requests and bug fixes. Remove "Intel Confidential" classification. | 9/11/2014 | > -| 1.50 | Release for Review | 9/26/2014 | > -| 1.80 | Incorporate US Review Comments | 10/10/2014 | > -| 1.85 | Incorporate PRC Review Comments | 10/24/2014 | > -| | Release for Extended US & PRC Review | 10/28/2014 | > -| 2.0 | Release | 11/14/2014 | > -| 2.1 | DRAFT for REFORMAT | 10/30/2015 | > -| 2.2 | Convert to Gitbook | April 2017 | > +| Revision | Revision History | Date | > +| -------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | > +| 0.0.1 | First swag. | 6/23/00 | > +| 0.0.2 | Included feedback from team. | 8/3/00 | > +| 0.3 | Add comments. | 8/10/00 | > +| 0.3001 | Pre-vacation update, need to sync with new numbering process. | 9/11/00 | > +| 0.31 | Incorporated Sync 1 learnings. | 12/12/00 | > +| 0.32 | Completed TAT ARs. | 6/8/01 | > +| 0.33 | Added goto rules. | 8/16/01 | > +| 0.34 | Updated to match driver and Runtime Lib. | 11/15/01 | > +| 0.9 | Updated to Intel(R) Platform Innovation Framework for EFI. Added checklist appendix. | 1/8/04 | > +| 0.91 | Completed editing and formatting pass. | 3/3/04 | > +| 0.92 | Updated the structure declaration rules: Added section 4.8 and modified the checklist in Appendix A. | 4/8/04 | > +| 0.93 | Added some minor clarifications in section 3.1, 4.5, 7.1, and 10. | 9/14/04 | > +| 0.94 | Revised to accommodate Doxygen style commenting standards | 3/1/06 | > +| 0.50 | Change to new numbering scheme. Incorporate Review Comments. Editing and formatting. | 4/21/06 | > +| 0.51 | Changed to EDK II. | 7/13/06 | > +| 0.52 | Update rules to clarify areas of misinterpretation. Add copyright formatting rules. | 2/09/2010 | > +| 0.60 | Re-organize document and update to current rules. | 2/15/2010 | > +| 0.70 | Release for Review | 3/1/2010 | > +| 0.95 | Review comments incorporated, Release to Tech Pubs for Finalization | 3/10/2010 | > +| 1.00 | First full release | 3/15/2010 | > +| 1.01 | Restructure into book format. | 12/08/2011 | > +| 1.02 | Incorporate suggestions and trackers | 3/19/2012 | > +| | Release For Review | 4/2/2012 | > +| | Release | 4/16/2012 | > +| 1.03 | Update and incorporate requests and bug fixes. Remove "Intel Confidential" classification. | 9/11/2014 | > +| 1.50 | Release for Review | 9/26/2014 | > +| 1.80 | Incorporate US Review Comments | 10/10/2014 | > +| 1.85 | Incorporate PRC Review Comments | 10/24/2014 | > +| | Release for Extended US & PRC Review | 10/28/2014 | > +| 2.0 | Release | 11/14/2014 | > +| 2.1 | DRAFT for REFORMAT | 10/30/2015 | > +| 2.2 | Convert to Gitbook | June 2017 | > +| | [#425](https://bugzilla.tianocore.org/show_bug.cgi?id=425) [CCS] clarify line breaking and indentation requirements for multi-line function calls | | >