From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mga11.intel.com (mga11.intel.com [192.55.52.93]) by dpdk.org (Postfix) with ESMTP id 50ADB8032 for ; Thu, 4 Dec 2014 12:41:21 +0100 (CET) Received: from fmsmga003.fm.intel.com ([10.253.24.29]) by fmsmga102.fm.intel.com with ESMTP; 04 Dec 2014 03:41:19 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="4.97,862,1389772800"; d="scan'208";a="424998662" Received: from irsmsx109.ger.corp.intel.com ([163.33.3.23]) by FMSMGA003.fm.intel.com with ESMTP; 04 Dec 2014 03:31:00 -0800 Received: from irsmsx108.ger.corp.intel.com ([169.254.11.150]) by IRSMSX109.ger.corp.intel.com ([169.254.13.244]) with mapi id 14.03.0195.001; Thu, 4 Dec 2014 11:41:18 +0000 From: "Iremonger, Bernard" To: "Richardson, Bruce" , Thomas Monjalon Thread-Topic: [dpdk-dev] [PATCH 2/3] docs: adjust line lengths in FreeBSD GSG rst files Thread-Index: AQHQD0LtjqaZWeCkyk24/+CUC2otzZx/TPlQ Date: Thu, 4 Dec 2014 11:41:18 +0000 Message-ID: <8CEF83825BEC744B83065625E567D7C2049B7EC9@IRSMSX108.ger.corp.intel.com> References: <1416839034-26652-1-git-send-email-bruce.richardson@intel.com> <1416844136-4604-1-git-send-email-bruce.richardson@intel.com> <2191619.2K2FXEFzNY@xps13> <20141203145422.GC2396@bricha3-MOBL3> In-Reply-To: <20141203145422.GC2396@bricha3-MOBL3> Accept-Language: en-GB, en-US Content-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: x-originating-ip: [163.33.239.182] Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 Cc: "dev@dpdk.org" Subject: Re: [dpdk-dev] [PATCH 2/3] docs: adjust line lengths in FreeBSD GSG rst files X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: patches and discussions about DPDK List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Thu, 04 Dec 2014 11:41:21 -0000 Hi Bruce, Thomas, > Subject: Re: [dpdk-dev] [PATCH 2/3] docs: adjust line lengths in FreeBSD = GSG rst files >=20 > 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 sou= rce 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 patc= hes. > > 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 d= oc. > > > > -- > > Thomas >=20 > 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 somethig= n between 80-90 depending > on wording, since a hard-80 I feel is too extreme. >=20 > /Bruce When converting the documents originally I chose to wrap sentences that wer= e longer than 120-130 characters. I normally wrapped at a punctuation point for readability. So a long senten= ce 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. Bernard.