From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <bernard.iremonger@intel.com>
Received: from mga11.intel.com (mga11.intel.com [192.55.52.93])
 by dpdk.org (Postfix) with ESMTP id DA4145FEB
 for <dev@dpdk.org>; Fri,  3 Jul 2015 12:05:19 +0200 (CEST)
Received: from orsmga003.jf.intel.com ([10.7.209.27])
 by fmsmga102.fm.intel.com with ESMTP; 03 Jul 2015 03:05:18 -0700
X-ExtLoop1: 1
X-IronPort-AV: E=Sophos;i="5.15,399,1432623600"; d="scan'208";a="599512809"
Received: from irsmsx154.ger.corp.intel.com ([163.33.192.96])
 by orsmga003.jf.intel.com with ESMTP; 03 Jul 2015 03:05:17 -0700
Received: from irsmsx108.ger.corp.intel.com ([169.254.11.201]) by
 IRSMSX154.ger.corp.intel.com ([169.254.12.91]) with mapi id 14.03.0224.002;
 Fri, 3 Jul 2015 11:05:17 +0100
From: "Iremonger, Bernard" <bernard.iremonger@intel.com>
To: "Richardson, Bruce" <bruce.richardson@intel.com>, Thomas Monjalon
 <thomas.monjalon@6wind.com>
Thread-Topic: [dpdk-dev] [PATCH 2/3] doc: added guidelines on dpdk
 documentation
Thread-Index: AQHQtXZTs3hZ7DSkhUmq6aUiCXRrJ53Jg0VA
Date: Fri, 3 Jul 2015 10:05:16 +0000
Message-ID: <8CEF83825BEC744B83065625E567D7C204A457D3@IRSMSX108.ger.corp.intel.com>
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>
In-Reply-To: <20150703095424.GB7548@bricha3-MOBL3>
Accept-Language: en-GB, en-US
Content-Language: en-US
X-MS-Has-Attach: 
X-MS-TNEF-Correlator: 
x-originating-ip: [163.33.239.180]
Content-Type: text/plain; charset="us-ascii"
Content-Transfer-Encoding: quoted-printable
MIME-Version: 1.0
Cc: "dev@dpdk.org" <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 <dev.dpdk.org>
List-Unsubscribe: <http://dpdk.org/ml/options/dev>,
 <mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://dpdk.org/ml/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <http://dpdk.org/ml/listinfo/dev>,
 <mailto:dev-request@dpdk.org?subject=subscribe>
X-List-Received-Date: Fri, 03 Jul 2015 10:05:20 -0000

> -----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
>=20
> 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 ap=
proach 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=
.
>=20
> /Bruce

Hi Bruce,

I think "very, very long" should be defined.
When I was working on the rst files previously  I wrapped sentences which w=
ere  greater than 130 characters.
I wrapped long sentences at punctuation points where possible, rather than =
at the character limit.

Regards,

Bernard.