From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from out4-smtp.messagingengine.com (out4-smtp.messagingengine.com [66.111.4.28]) by dpdk.org (Postfix) with ESMTP id 75AB2282 for ; Thu, 11 May 2017 17:23:02 +0200 (CEST) Received: from compute1.internal (compute1.nyi.internal [10.202.2.41]) by mailout.nyi.internal (Postfix) with ESMTP id B45CB20821; Thu, 11 May 2017 11:23:01 -0400 (EDT) Received: from frontend1 ([10.202.2.160]) by compute1.internal (MEProxy); Thu, 11 May 2017 11:23:01 -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=1geMWp+CjKOgl0p /XiHv8Su7bMIC86MAFqpR1SfCSRA=; b=KMZQX+hcTPuPfg6kRX1j2W2bJIBNfrw zftPRQB1ZgpcXy8iUj765WDt2gxXk6w6W2Dy2DSaF6QH/B3jUzvtuo7k71KCYaUo IwNaMcYO/Dh4K9fLFhhy7gPPnsFLvuaPAoOwF5RIQXfo0LkSX1qDhpi3T5IHsTih 4ylGv7yRtu8A= 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=1geMWp+CjKOgl0p/XiHv8Su7bMIC86MAFqpR1SfCSRA=; b=crwJxI9Q m8k3Hd1KHJZwJlvCnn21ZLw09Wv5R2oYZr6LdTTmybOeIe6EL/Q1L2nSFd2kEhke H1o+v84MnayuNPfPJirSlPQ8PkJKJv7zSqTILZr5RqOF0OJqQD43QX31uLefeUsV GfZoK4WcNesu5gloX39ewIVCG6qAhMPbBC0Qz63Rofj9Ys2OcUDCCXssQmQCGaWp cXlkkWCSpqJ9SRXQzZs6Wo13A4kO0Sc8KNorYD57+bVvlhqStUeQogRQpdpivqwr 1qCbrRUJZ85d7fLdcoz3mcZxspmnqZb/hxMO58SXInZrtXAOF/JjYtBngOev3uK2 mfNI4hdnCjvUWw== X-ME-Sender: X-Sasl-enc: RHxrTCBEymbAZx8tolXA+HVFf+gc6pcy3Hi217wxsZYL 1494516181 Received: from xps.localnet (184.203.134.77.rev.sfr.net [77.134.203.184]) by mail.messagingengine.com (Postfix) with ESMTPA id 63B6D7E8BA; Thu, 11 May 2017 11:23:01 -0400 (EDT) From: Thomas Monjalon To: John McNamara Cc: dev@dpdk.org Date: Thu, 11 May 2017 17:23:00 +0200 Message-ID: <6951954.sJVyEfo4GT@xps> In-Reply-To: <1494511780-5732-1-git-send-email-john.mcnamara@intel.com> References: <1494511780-5732-1-git-send-email-john.mcnamara@intel.com> 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: Thu, 11 May 2017 15:23:02 -0000 11/05/2017 16:09, John McNamara: > The DPDK documentation guidelines state that lines should be wrapped as > follows: > > * The recommended style for the DPDK documentation is to put sentences on > separate lines. This allows for easier reviewing of patches. ... > * Long sentences should be wrapped at 120 characters +/- 10 characters. > They should be wrapped at words. > > http://dpdk.org/doc/guides/contributing/documentation.html#line-length > > However, in practice, users almost never submit doc patches in this format. > Instead most users wrap their doc patches at 80 characters. > > This patch updates the documentation contributors guide to reflect this > as the recommended guideline. > > Signed-off-by: John McNamara > --- > --- a/doc/guides/contributing/documentation.rst > +++ b/doc/guides/contributing/documentation.rst > @@ -282,33 +282,21 @@ The additional guidelines below reiterate or expand upon those guidelines. > Line Length > ~~~~~~~~~~~ > > -* The recommended style for the DPDK documentation is to put sentences on separate lines. > - This allows for easier reviewing of patches. > - Multiple sentences which are not separated by a blank line are joined automatically into paragraphs, for example:: > +* Lines in sentences should be less than 80 characters and wrapped at > + words. Multiple sentences which are not separated by a blank line are joined > + automatically into paragraphs. Why not keep the recommendation of separating sentences? > + testpmd -l 2-3 -n 4 \ > + --vdev=virtio_user0,path=/dev/vhost-net,queues=2,queue_size=1024 \ > + -- -i --txqflags=0x0 --disable-hw-vlan --enable-lro \ > + --enable-rx-cksum --txq=2 --rxq=2 --rxd=1024 --txd=1024 Garbage?