From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from out1-smtp.messagingengine.com (out1-smtp.messagingengine.com [66.111.4.25]) by dpdk.org (Postfix) with ESMTP id B8F552986 for ; Tue, 16 May 2017 16:37:25 +0200 (CEST) Received: from compute1.internal (compute1.nyi.internal [10.202.2.41]) by mailout.nyi.internal (Postfix) with ESMTP id 1E81120BDF; Tue, 16 May 2017 10:37:25 -0400 (EDT) Received: from frontend1 ([10.202.2.160]) by compute1.internal (MEProxy); Tue, 16 May 2017 10:37:25 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=monjalon.net; h= cc:content-transfer-encoding:content-type:date:from:in-reply-to :message-id:mime-version:references:subject:to:x-me-sender :x-me-sender:x-sasl-enc:x-sasl-enc; s=mesmtp; bh=Aj9nXBFxKU72aWU aD0ZrHk80qr3rMHbxpCfMlusKiMA=; b=TaR9S9UwMGM44PGoi6ue2XNQSlG2swu NIgM/wf1e4Uc1N1JnfBdcqsbTNp+9n7JGnXcAud14zInoUY3DXWCZ2xm+M5slFdf IZBxbAmk5PWB6cRXpQyy1ZPlQD5KPKQP4NM28y/Bso2OLOsqseHUHstFxQX98nPW MdLtDqBFpQhQ= DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d= messagingengine.com; h=cc:content-transfer-encoding:content-type :date:from:in-reply-to:message-id:mime-version:references :subject:to:x-me-sender:x-me-sender:x-sasl-enc:x-sasl-enc; s= fm1; bh=Aj9nXBFxKU72aWUaD0ZrHk80qr3rMHbxpCfMlusKiMA=; b=bUUkOrL4 xT2Uner9xje3Ec+35GfM36fDJ+7DnJ9EwU8MbLBWweYvY5xhzMNxkOwLUzhz5GpK yZzkUwt0OpEA7xE3xX/URLVHl8jSgv4tjsuqs/Fg9+IezzEkM1KoqVxZwKMnas+X gY0NEr6PE4fk20NB/x6VlMRzdF/ey1n1ayactA8A8ILYaTNLOqxiQL2/kfJgAbLP QyCujsVzh2/bSrpsKr4+R+phTAsZptSju6K84GJgHRwOTj2P5KV0//+pRjfcnjqZ kYkm9Oimacw7PqkDPFZbJRq+YfGzachEpKCEp0loxPbNGh/mYG8p5DD8BTJJY+nj yiul9/pGeFAQPQ== X-ME-Sender: X-Sasl-enc: jjK/iXeI69i1+Upv8vjjJahM3NkMrv4BIVrAqzjQeWAb 1494945444 Received: from xps.localnet (184.203.134.77.rev.sfr.net [77.134.203.184]) by mail.messagingengine.com (Postfix) with ESMTPA id CBE707E98D; Tue, 16 May 2017 10:37:24 -0400 (EDT) From: Thomas Monjalon To: "Mcnamara, John" Cc: "Iremonger, Bernard" , dev@dpdk.org Date: Tue, 16 May 2017 16:37:24 +0200 Message-ID: <2214405.r0ci9WgVl6@xps> In-Reply-To: References: <1494511780-5732-1-git-send-email-john.mcnamara@intel.com> <5820031.igZ32l5vOD@xps> MIME-Version: 1.0 Content-Transfer-Encoding: 7Bit Content-Type: text/plain; charset="us-ascii" Subject: Re: [dpdk-dev] [PATCH v1] doc: change doc line length limit in contributors guide X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Tue, 16 May 2017 14:37:26 -0000 16/05/2017 16:20, Mcnamara, John: > > > -----Original Message----- > > From: Thomas Monjalon [mailto:thomas@monjalon.net] > > Sent: Friday, May 12, 2017 10:24 AM > > ,,, > > > > > The current DPDK "single sentence per line plus wrap at ~120 characters" > > > guideline is unusual, not supported by editors and, with rare > > > exceptions, not followed by anyone. > > > > > > As such I think the guidelines should reflect how people actually > > > write docs and submit patches, which is wrapping at 80 characters. > > > > I am OK with 80 characters. > > However, I think we should keep trying to explain that it is better to > > wrap at the end of a sentence. > > > > Example: > > This long sentence with a lot of words which does not mean anything will > > wrap at 80 characters and continue on the second line. Then a new sentence > > starts and ends on the third line. > > > > It would be better like that: > > This long sentence with a lot of words which does not mean anything will > > wrap at 80 characters and continue on the second line. > > Then a new sentence starts and ends on the third line. > > This is essentially the same problem as the current guideline: that this > is an artificial way of writing text, it isn't supported by editors, > and is unlikely to be followed in practice. > > The first example is the way people write text and the way text is submitted > in patches so the guidelines should reflect this. You are the doc maintainer, it's your call :)