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 5042F8032 for ; Wed, 3 Dec 2014 20:44:28 +0100 (CET) Received: from orsmga001.jf.intel.com ([10.7.209.18]) by fmsmga102.fm.intel.com with ESMTP; 03 Dec 2014 08:45:53 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.07,508,1413270000"; d="scan'208";a="617946639" Received: from bricha3-mobl3.ger.corp.intel.com ([10.243.20.33]) by orsmga001.jf.intel.com with SMTP; 03 Dec 2014 06:54:23 -0800 Received: by (sSMTP sendmail emulation); Wed, 03 Dec 2014 14:54:23 +0025 Date: Wed, 3 Dec 2014 14:54:23 +0000 From: Bruce Richardson To: Thomas Monjalon Message-ID: <20141203145422.GC2396@bricha3-MOBL3> References: <1416839034-26652-1-git-send-email-bruce.richardson@intel.com> <1416844136-4604-1-git-send-email-bruce.richardson@intel.com> <2191619.2K2FXEFzNY@xps13> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <2191619.2K2FXEFzNY@xps13> Organization: Intel Shannon Ltd. User-Agent: Mutt/1.5.23 (2014-03-12) 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: Wed, 03 Dec 2014 19:44:28 -0000 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