DPDK patches and discussions
 help / color / mirror / Atom feed
From: "Iremonger, Bernard" <bernard.iremonger@intel.com>
To: "Richardson, Bruce" <bruce.richardson@intel.com>,
	Thomas Monjalon <thomas.monjalon@6wind.com>
Cc: "dev@dpdk.org" <dev@dpdk.org>
Subject: Re: [dpdk-dev] [PATCH 2/3] docs: adjust line lengths in FreeBSD GSG rst files
Date: Thu, 4 Dec 2014 11:41:18 +0000	[thread overview]
Message-ID: <8CEF83825BEC744B83065625E567D7C2049B7EC9@IRSMSX108.ger.corp.intel.com> (raw)
In-Reply-To: <20141203145422.GC2396@bricha3-MOBL3>

Hi Bruce, Thomas,

> Subject: Re: [dpdk-dev] [PATCH 2/3] docs: adjust line lengths in FreeBSD GSG rst files
> On Wed, Dec 03, 2014 at 02:23:44PM +0100, Thomas Monjalon wrote:
> > 2014-11-24 15:48, Bruce Richardson:
> > > The FreeBSD GSG rst files had very inconsistent line lengths for
> > > text within paragraph blocks. Sometimes a line would be very short,
> > > while often lines would be quite long.
> > > This patch adjusts the formatting of the rst files so that lines
> > > break at approx the 80-character mark, as is standard in the DPDK source code.
> >
> > I'm not sure we should be strict with line lengths in the doc.
> > The most important thing is to limit the wrapping impact of future patches.
> > Starting a new sentence at the beginning of the line is often a good
> > way to keep context lines unchanged when updating only one sentence.
> > Don't forget that a carriage return in rst has no impact on generated doc.
> >
> > --
> > Thomas
> Hi Thomas,
> I agree that we shouldn't be strict, but the variance in line length was really huge, and shorter lines are
> always easier to read. Even my patch just limited line length to somethign between 80-90 depending
> on wording, since a hard-80 I feel is too extreme.
> /Bruce

When converting the documents originally I chose to wrap sentences that were longer than 120-130 characters.
I normally wrapped at a punctuation point for readability. So a long sentence might wrap over several lines.
Sentences shorter than 130 characters were given a separate line.
I don't think there is anything to be gained by reworking the line lengths as it has no effect on the generated  HTML.


  reply	other threads:[~2014-12-04 11:41 UTC|newest]

Thread overview: 13+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2014-11-24 14:23 [dpdk-dev] [PATCH 0/3] docs: update FreeBSD GSG for 1.8 Bruce Richardson
2014-11-24 14:23 ` [dpdk-dev] [PATCH 1/3] docs: change hardcoded date to auto-generated Bruce Richardson
2014-11-26 10:38   ` Iremonger, Bernard
2014-11-24 14:43 ` [dpdk-dev] [PATCH 0/3] docs: update FreeBSD GSG for 1.8 Bruce Richardson
2014-11-24 15:25   ` Thomas Monjalon
2014-11-24 15:45     ` Bruce Richardson
2014-11-24 15:48 ` [dpdk-dev] [PATCH 2/3] docs: adjust line lengths in FreeBSD GSG rst files Bruce Richardson
2014-11-26 10:42   ` Iremonger, Bernard
2014-12-03 13:23   ` Thomas Monjalon
2014-12-03 14:54     ` Bruce Richardson
2014-12-04 11:41       ` Iremonger, Bernard [this message]
2014-11-24 15:50 ` [dpdk-dev] [PATCH 3/3] docs: update FreeBSD GSG to document ports install Bruce Richardson
2014-11-26 10:44   ` Iremonger, Bernard

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:

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

  git send-email \
    --in-reply-to=8CEF83825BEC744B83065625E567D7C2049B7EC9@IRSMSX108.ger.corp.intel.com \
    --to=bernard.iremonger@intel.com \
    --cc=bruce.richardson@intel.com \
    --cc=dev@dpdk.org \
    --cc=thomas.monjalon@6wind.com \


* 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).