DPDK patches and discussions
 help / color / mirror / Atom feed
From: Bruce Richardson <bruce.richardson@intel.com>
To: "Iremonger, Bernard" <bernard.iremonger@intel.com>
Cc: "dev@dpdk.org" <dev@dpdk.org>
Subject: Re: [dpdk-dev] [PATCH 2/3] doc: added guidelines on dpdk documentation
Date: Fri, 3 Jul 2015 11:30:38 +0100	[thread overview]
Message-ID: <20150703103038.GA7940@bricha3-MOBL3> (raw)
In-Reply-To: <8CEF83825BEC744B83065625E567D7C204A457D3@IRSMSX108.ger.corp.intel.com>

On Fri, Jul 03, 2015 at 11:05:16AM +0100, Iremonger, Bernard wrote:
> > -----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
> > 
> > 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 approach 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.
> > 
> > /Bruce
> 
> Hi Bruce,
> 
> I think "very, very long" should be defined.
Obviously :-)

> When I was working on the rst files previously  I wrapped sentences which were  greater than 130 characters.
> I wrapped long sentences at punctuation points where possible, rather than at the character limit.
>
Agree. I would suggest wrapping at a suitable punctuation point between 100-120 chars is best.

/Bruce

  reply	other threads:[~2015-07-03 10:30 UTC|newest]

Thread overview: 18+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-07-02 13:50 [dpdk-dev] [PATCH 0/3] " John McNamara
2015-07-02 13:50 ` [dpdk-dev] [PATCH 1/3] doc: set the default literal block format John McNamara
2015-07-02 13:50 ` [dpdk-dev] [PATCH 2/3] doc: added guidelines on dpdk documentation John McNamara
2015-07-02 16:20   ` Thomas Monjalon
2015-07-03  9:54     ` Bruce Richardson
2015-07-03 10:05       ` Iremonger, Bernard
2015-07-03 10:30         ` Bruce Richardson [this message]
2015-07-10 15:39     ` Mcnamara, John
2015-07-02 17:31   ` Mcnamara, John
2015-07-02 13:50 ` [dpdk-dev] [PATCH 3/3] doc: moved doxygen section to the doc guidelines John McNamara
2015-07-10 15:45 ` [dpdk-dev] [PATCH v2 0/3] doc: added guidelines on dpdk documentation John McNamara
2015-07-10 15:45   ` [dpdk-dev] [PATCH v2 1/3] doc: set the default literal block format John McNamara
2015-08-05 14:15     ` Bruce Richardson
2015-07-10 15:45   ` [dpdk-dev] [PATCH v2 2/3] doc: added guidelines on dpdk documentation John McNamara
2015-08-05 14:26     ` Bruce Richardson
2015-07-10 15:45   ` [dpdk-dev] [PATCH v2 3/3] doc: moved doxygen section to the doc guidelines John McNamara
2015-08-05 14:26     ` Bruce Richardson
2015-08-11 10:36   ` [dpdk-dev] [PATCH v2 0/3] doc: added guidelines on dpdk documentation Thomas Monjalon

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=20150703103038.GA7940@bricha3-MOBL3 \
    --to=bruce.richardson@intel.com \
    --cc=bernard.iremonger@intel.com \
    --cc=dev@dpdk.org \
    /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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).