From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mga09.intel.com (mga09.intel.com [134.134.136.24]) by dpdk.org (Postfix) with ESMTP id 9CA09A10 for ; Fri, 3 Jul 2015 12:30:43 +0200 (CEST) Received: from orsmga003.jf.intel.com ([10.7.209.27]) by orsmga102.jf.intel.com with ESMTP; 03 Jul 2015 03:30:43 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.15,399,1432623600"; d="scan'208";a="599522187" Received: from bricha3-mobl3.ger.corp.intel.com ([10.237.208.62]) by orsmga003.jf.intel.com with SMTP; 03 Jul 2015 03:30:39 -0700 Received: by (sSMTP sendmail emulation); Fri, 03 Jul 2015 11:30:38 +0025 Date: Fri, 3 Jul 2015 11:30:38 +0100 From: Bruce Richardson To: "Iremonger, Bernard" Message-ID: <20150703103038.GA7940@bricha3-MOBL3> References: <1435845053-17203-1-git-send-email-john.mcnamara@intel.com> <1435845053-17203-3-git-send-email-john.mcnamara@intel.com> <1986693.jIPruNIANr@xps13> <20150703095424.GB7548@bricha3-MOBL3> <8CEF83825BEC744B83065625E567D7C204A457D3@IRSMSX108.ger.corp.intel.com> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <8CEF83825BEC744B83065625E567D7C204A457D3@IRSMSX108.ger.corp.intel.com> Organization: Intel Shannon Ltd. User-Agent: Mutt/1.5.23 (2014-03-12) Cc: "dev@dpdk.org" Subject: Re: [dpdk-dev] [PATCH 2/3] doc: added guidelines on dpdk documentation X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: patches and discussions about DPDK List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Fri, 03 Jul 2015 10:30:44 -0000 On Fri, Jul 03, 2015 at 11:05:16AM +0100, Iremonger, Bernard wrote: > > -----Original Message----- > > From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Bruce Richardson > > Sent: Friday, July 3, 2015 10:54 AM > > To: Thomas Monjalon > > Cc: dev@dpdk.org > > Subject: Re: [dpdk-dev] [PATCH 2/3] doc: added guidelines on dpdk > > documentation > > > > On Thu, Jul 02, 2015 at 06:20:39PM +0200, Thomas Monjalon wrote: > > > 2015-07-02 14:50, John McNamara: > > > > +* Use one sentence per line in a paragraph, i.e., put a newline > > > > +character > > > > + after each period/full stop. > > > > > > What about adding this? > > > Only blank line will generate a newline. > > > > > > I think breaking lines at end of sentence is more important than > > > wrapping at 80 char, because it will help to keep patches readable. > > > > > +1 to this. I believe that one sentence per line should be the default > > +wrapping > > policy and only wrap if lines are very, very long. The why I like this approach is > > that changes tend to be sentence-based, and so having a sentence per line > > makes for much cleaner diffs when updating - thereby making review easier. > > > > /Bruce > > Hi Bruce, > > I think "very, very long" should be defined. Obviously :-) > When I was working on the rst files previously I wrapped sentences which were greater than 130 characters. > I wrapped long sentences at punctuation points where possible, rather than at the character limit. > Agree. I would suggest wrapping at a suitable punctuation point between 100-120 chars is best. /Bruce