Re: [dpdk-dev] [PATCH v1] doc: change doc line length limit in contributors guide

[Thomas Monjalon <thomas@monjalon.net>]

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.

I'm talking about "The recommended style for the DPDK documentation is
to put sentences on separate lines."
I like this recommendation.

> > > +     testpmd -l 2-3 -n 4 \
> > > +             --vdev=virtio_user0,path=/dev/vhost-
> > net,queues=2,queue_size=1024 \
> > > +             -- -i --txqflags=0x0 --disable-hw-vlan --enable-lro \
> > > +             --enable-rx-cksum --txq=2 --rxq=2 --rxd=1024  --txd=1024
> > 
> > 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?

Ah sorry, misreading the patch.