From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: <bruce.richardson@intel.com> Received: from mga03.intel.com (mga03.intel.com [134.134.136.65]) by dpdk.org (Postfix) with ESMTP id 8E6062C72 for <dev@dpdk.org>; Fri, 3 Jul 2015 11:54:29 +0200 (CEST) Received: from orsmga001.jf.intel.com ([10.7.209.18]) by orsmga103.jf.intel.com with ESMTP; 03 Jul 2015 02:54:28 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.15,399,1432623600"; d="scan'208";a="722311603" Received: from bricha3-mobl3.ger.corp.intel.com ([10.237.208.62]) by orsmga001.jf.intel.com with SMTP; 03 Jul 2015 02:54:26 -0700 Received: by (sSMTP sendmail emulation); Fri, 03 Jul 2015 10:54:24 +0025 Date: Fri, 3 Jul 2015 10:54:24 +0100 From: Bruce Richardson <bruce.richardson@intel.com> To: Thomas Monjalon <thomas.monjalon@6wind.com> Message-ID: <20150703095424.GB7548@bricha3-MOBL3> References: <1435845053-17203-1-git-send-email-john.mcnamara@intel.com> <1435845053-17203-3-git-send-email-john.mcnamara@intel.com> <1986693.jIPruNIANr@xps13> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <1986693.jIPruNIANr@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] doc: added guidelines on dpdk documentation X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: patches and discussions about DPDK <dev.dpdk.org> List-Unsubscribe: <http://dpdk.org/ml/options/dev>, <mailto:dev-request@dpdk.org?subject=unsubscribe> List-Archive: <http://dpdk.org/ml/archives/dev/> List-Post: <mailto:dev@dpdk.org> List-Help: <mailto:dev-request@dpdk.org?subject=help> List-Subscribe: <http://dpdk.org/ml/listinfo/dev>, <mailto:dev-request@dpdk.org?subject=subscribe> X-List-Received-Date: Fri, 03 Jul 2015 09:54:30 -0000 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