All of lore.kernel.org
 help / color / mirror / Atom feed
From: Thomas Monjalon <thomas@monjalon.net>
To: "Mcnamara, John" <john.mcnamara@intel.com>
Cc: dev@dpdk.org
Subject: Re: [PATCH v1] doc: change doc line length limit in contributors guide
Date: Thu, 11 May 2017 19:18:07 +0200	[thread overview]
Message-ID: <3737023.yBcUv04Hz8@xps> (raw)
In-Reply-To: <B27915DBBA3421428155699D51E4CFE2332DB84E@IRSMSX104.ger.corp.intel.com>

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.

  reply	other threads:[~2017-05-11 17:18 UTC|newest]

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-05-11 14:09 [PATCH v1] doc: change doc line length limit in contributors guide John McNamara
2017-05-11 15:23 ` Thomas Monjalon
2017-05-11 16:11   ` Mcnamara, John
2017-05-11 17:18     ` Thomas Monjalon [this message]
2017-05-11 17:31       ` Iremonger, Bernard
2017-05-12  9:10         ` Mcnamara, John
2017-05-12  9:23           ` Thomas Monjalon
2017-05-16 14:20             ` Mcnamara, John
2017-05-16 14:37               ` Thomas Monjalon
2017-05-22  6:44               ` Yuanhan Liu
2017-06-04 10:26                 ` Thomas Monjalon
2017-05-12 12:34 ` Shreyansh Jain

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=3737023.yBcUv04Hz8@xps \
    --to=thomas@monjalon.net \
    --cc=dev@dpdk.org \
    --cc=john.mcnamara@intel.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.