From mboxrd@z Thu Jan  1 00:00:00 1970
From: "Iremonger, Bernard" <bernard.iremonger@intel.com>
Subject: Re: [PATCH v1] doc: change doc line length limit
	in	contributors guide
Date: Thu, 11 May 2017 17:31:01 +0000
Message-ID: <8CEF83825BEC744B83065625E567D7C224D5D178@IRSMSX108.ger.corp.intel.com>
References: <1494511780-5732-1-git-send-email-john.mcnamara@intel.com>
 <6951954.sJVyEfo4GT@xps>
 <B27915DBBA3421428155699D51E4CFE2332DB84E@IRSMSX104.ger.corp.intel.com>
 <3737023.yBcUv04Hz8@xps>
Mime-Version: 1.0
Content-Type: text/plain; charset="us-ascii"
Content-Transfer-Encoding: quoted-printable
Cc: "dev@dpdk.org" <dev@dpdk.org>
To: Thomas Monjalon <thomas@monjalon.net>, "Mcnamara, John"
 <john.mcnamara@intel.com>
Return-path: <dev-bounces@dpdk.org>
Received: from mga01.intel.com (mga01.intel.com [192.55.52.88])
 by dpdk.org (Postfix) with ESMTP id 888F147CE
 for <dev@dpdk.org>; Thu, 11 May 2017 19:31:05 +0200 (CEST)
In-Reply-To: <3737023.yBcUv04Hz8@xps>
Content-Language: en-US
List-Id: DPDK patches and discussions <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>
Errors-To: dev-bounces@dpdk.org
Sender: "dev" <dev-bounces@dpdk.org>


> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Thomas Monjalon
> Sent: Thursday, May 11, 2017 6:18 PM
> To: Mcnamara, John <john.mcnamara@intel.com>
> Cc: dev@dpdk.org
> Subject: Re: [dpdk-dev] [PATCH v1] doc: change doc line length limit in
> contributors guide
>=20
> 11/05/2017 18:11, Mcnamara, John:
> > From: Thomas Monjalon [mailto:thomas@monjalon.net]
> > >
> > > ...
> > > > -* The recommended style for the DPDK documentation is to put
> > > > sentences
> > > on separate lines.
> > > > -  This allows for easier reviewing of patches.
> > > > -  Multiple sentences which are not separated by a blank line are
> > > > joined
> > > automatically into paragraphs, for example::
> > > > +* Lines in sentences should be less than 80 characters and
> > > > +wrapped at
> > > > +  words. Multiple sentences which are not separated by a blank
> > > > +line are joined
> > > > +  automatically into paragraphs.
> > >
> > > Why not keep the recommendation of separating sentences?
> >
> > This isn't a recommendation. It is just pointing out that lines and
> > sentences are joined into paragraphs. Maybe that is obvious and
> > doesn't need to be stated.
>=20
> I'm talking about "The recommended style for the DPDK documentation is to
> put sentences on separate lines."
> I like this recommendation.

+1 for this recommendation

>=20
> > > > +     testpmd -l 2-3 -n 4 \
> > > > +             --vdev=3Dvirtio_user0,path=3D/dev/vhost-
> > > net,queues=3D2,queue_size=3D1024 \
> > > > +             -- -i --txqflags=3D0x0 --disable-hw-vlan --enable-lro=
 \
> > > > +             --enable-rx-cksum --txq=3D2 --rxq=3D2 --rxd=3D1024
> > > > + --txd=3D1024
> > >
> > > Garbage?
> >
> > I hope not. I took it from one of the examples in the docs to
> > demonstrate how a long command could be wrapped and still be
> > functional. Should I clarify that more, or remove it?
>=20
> Ah sorry, misreading the patch.

Regards,

Bernard.