From mboxrd@z Thu Jan 1 00:00:00 1970 From: "Mcnamara, John" Subject: Re: [PATCH v1] doc: change doc line length limit in contributors guide Date: Thu, 11 May 2017 16:11:40 +0000 Message-ID: References: <1494511780-5732-1-git-send-email-john.mcnamara@intel.com> <6951954.sJVyEfo4GT@xps> Mime-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable Cc: "dev@dpdk.org" To: Thomas Monjalon Return-path: Received: from mga07.intel.com (mga07.intel.com [134.134.136.100]) by dpdk.org (Postfix) with ESMTP id 5B0DD14EC for ; Thu, 11 May 2017 18:11:43 +0200 (CEST) In-Reply-To: <6951954.sJVyEfo4GT@xps> Content-Language: en-US List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" > -----Original Message----- > From: Thomas Monjalon [mailto:thomas@monjalon.net] > Sent: Thursday, May 11, 2017 4:23 PM > To: Mcnamara, John > Cc: dev@dpdk.org > Subject: Re: [dpdk-dev] [PATCH v1] doc: change doc line length limit in > contributors guide >=20 > ... > > -* 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 joine= d > 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. >=20 > Why not keep the recommendation of separating sentences? This isn't a recommendation. It is just pointing out that lines and sentenc= es are joined into paragraphs. Maybe that is obvious and doesn't need to be stated. >=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 >=20 > 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? John