From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mga07.intel.com (mga07.intel.com [134.134.136.100]) by dpdk.org (Postfix) with ESMTP id 5B0DD14EC for ; Thu, 11 May 2017 18:11:43 +0200 (CEST) Received: from orsmga003.jf.intel.com ([10.7.209.27]) by orsmga105.jf.intel.com with ESMTP; 11 May 2017 09:11:43 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.38,325,1491289200"; d="scan'208";a="967331946" Received: from irsmsx153.ger.corp.intel.com ([163.33.192.75]) by orsmga003.jf.intel.com with ESMTP; 11 May 2017 09:11:41 -0700 Received: from irsmsx111.ger.corp.intel.com (10.108.20.4) by IRSMSX153.ger.corp.intel.com (163.33.192.75) with Microsoft SMTP Server (TLS) id 14.3.319.2; Thu, 11 May 2017 17:11:41 +0100 Received: from irsmsx104.ger.corp.intel.com ([169.254.5.170]) by irsmsx111.ger.corp.intel.com ([169.254.2.58]) with mapi id 14.03.0319.002; Thu, 11 May 2017 17:11:41 +0100 From: "Mcnamara, John" To: Thomas Monjalon CC: "dev@dpdk.org" Thread-Topic: [dpdk-dev] [PATCH v1] doc: change doc line length limit in contributors guide Thread-Index: AQHSymB8CvYtn21PPkmv5QFUK8JrN6HvL24AgAAdU6A= Date: Thu, 11 May 2017 16:11:40 +0000 Message-ID: References: <1494511780-5732-1-git-send-email-john.mcnamara@intel.com> <6951954.sJVyEfo4GT@xps> In-Reply-To: <6951954.sJVyEfo4GT@xps> Accept-Language: en-GB, en-US Content-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: x-ctpclassification: CTP_IC x-titus-metadata-40: eyJDYXRlZ29yeUxhYmVscyI6IiIsIk1ldGFkYXRhIjp7Im5zIjoiaHR0cDpcL1wvd3d3LnRpdHVzLmNvbVwvbnNcL0ludGVsMyIsImlkIjoiNjMzODQ0YTgtNTRlNy00NGUxLWIwMjYtYTBiNTI4YjdmNzQxIiwicHJvcHMiOlt7Im4iOiJDVFBDbGFzc2lmaWNhdGlvbiIsInZhbHMiOlt7InZhbHVlIjoiQ1RQX0lDIn1dfV19LCJTdWJqZWN0TGFiZWxzIjpbXSwiVE1DVmVyc2lvbiI6IjE1LjkuNi42IiwiVHJ1c3RlZExhYmVsSGFzaCI6IkpwOE1BemtzZFBERGdQdkZVRkZBN01LaHgzbUNMcWpQNlBlbFAzWHVBcVE9In0= dlp-product: dlpe-windows dlp-version: 10.0.102.7 dlp-reaction: no-action x-originating-ip: [163.33.239.181] Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 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 16:11:44 -0000 > -----Original Message----- > From: Thomas Monjalon [mailto:thomas@monjalon.net] > Sent: Thursday, May 11, 2017 4:23 PM > To: Mcnamara, John > Cc: dev@dpdk.org > Subject: Re: [dpdk-dev] [PATCH v1] doc: change doc line length limit in > contributors guide >=20 > ... > > -* 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 joine= d > 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. >=20 > Why not keep the recommendation of separating sentences? This isn't a recommendation. It is just pointing out that lines and sentenc= es are joined into paragraphs. Maybe that is obvious and doesn't need to be stated. >=20 > > + testpmd -l 2-3 -n 4 \ > > + --vdev=3Dvirtio_user0,path=3D/dev/vhost- > net,queues=3D2,queue_size=3D1024 \ > > + -- -i --txqflags=3D0x0 --disable-hw-vlan --enable-lro \ > > + --enable-rx-cksum --txq=3D2 --rxq=3D2 --rxd=3D1024 --txd= =3D1024 >=20 > Garbage? I hope not. I took it from one of the examples in the docs to demonstrate how a long command could be wrapped and still be functional. Should I clarify that more, or remove it? John