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 1B4E621D091A7 for ; Wed, 26 Jul 2017 12:11:41 -0700 (PDT) Received: from smtp.corp.redhat.com (int-mx03.intmail.prod.int.phx2.redhat.com [10.5.11.13]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id 447DF3E2A8; Wed, 26 Jul 2017 19:13:43 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mx1.redhat.com 447DF3E2A8 Authentication-Results: ext-mx06.extmail.prod.ext.phx2.redhat.com; dmarc=none (p=none dis=none) header.from=redhat.com Authentication-Results: ext-mx06.extmail.prod.ext.phx2.redhat.com; spf=fail smtp.mailfrom=lersek@redhat.com Received: from lacos-laptop-7.usersys.redhat.com (ovpn-116-75.phx2.redhat.com [10.3.116.75]) by smtp.corp.redhat.com (Postfix) with ESMTP id 13A1A60C14; Wed, 26 Jul 2017 19:13:41 +0000 (UTC) To: Jordan Justen , "Kinney, Michael D" , "edk2-devel@lists.01.org" Cc: Leif Lindholm , Andrew Fish References: <20170724234516.12552-1-michael.d.kinney@intel.com> <20170724234516.12552-4-michael.d.kinney@intel.com> <150100419707.16362.3894920649442321083@jljusten-skl> <150108874474.30351.16986605600876589470@jljusten-skl> <150109325462.31268.6113839391102286199@jljusten-skl> From: Laszlo Ersek Message-ID: <2157b4b5-e3e3-13f8-03fd-120cda82ce33@redhat.com> Date: Wed, 26 Jul 2017 21:13:41 +0200 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:52.0) Gecko/20100101 Thunderbird/52.2.1 MIME-Version: 1.0 In-Reply-To: <150109325462.31268.6113839391102286199@jljusten-skl> X-Scanned-By: MIMEDefang 2.79 on 10.5.11.13 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.30]); Wed, 26 Jul 2017 19:13:43 +0000 (UTC) Subject: Re: [Patch v4 3/6] edk2: Update to TianoCore Contribution Agreement 1.1 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: Wed, 26 Jul 2017 19:11:41 -0000 Content-Type: text/plain; charset=utf-8 Content-Language: en-US Content-Transfer-Encoding: 7bit On 07/26/17 20:20, Jordan Justen wrote: > On 2017-07-26 10:45:41, Kinney, Michael D wrote: >> Hi Jordan, >> >> Not sure I understand the 'whitespace' usage. > > Previously I had given some examples of the style guide: > > * whitespace: Change indentation to 5 spaces > > * case: All functions must now use StUdLyCaPs > > If it was instead: > > * ch5: Change indentation to 5 spaces > > * ch8: All functions must now use StUdLyCaPs > > I don't think we are getting much value in adding the chapter number. > You'd have to go look up what chapter 5 and 8 are to get the context. > Also, what if a chapter is inserted or deleted? Then looking back > through the log may require even more investigation to determine the > context. I also commented on this earlier elsewhere. I think that the chapter/section should be identified if possible, but not by numbering. Let me make up some examples for the coding std spec: intro/glossary: define FOOBAR principles/recommendations: don't drink and drive quickref/formatting: never say never naming/general: add "init, uninit" to common opposites Some examples for the INF spec: overview/binaries: document LIB filetype BuildOptions: correct typo in BNF etc. Thanks Laszlo