From mboxrd@z Thu Jan 1 00:00:00 1970 From: "Yigit, Ferruh" Subject: Re: [PATCH] doc: minor correction in document Date: Tue, 2 Feb 2016 12:59:34 +0000 Message-ID: <20160202125934.GA11000@sivlogin002.ir.intel.com> References: <1454062308-19758-1-git-send-email-ferruh.yigit@intel.com> Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii Cc: "dev@dpdk.org" To: "Mcnamara, John" Return-path: Received: from mga09.intel.com (mga09.intel.com [134.134.136.24]) by dpdk.org (Postfix) with ESMTP id EEEDB95D5 for ; Tue, 2 Feb 2016 13:59:37 +0100 (CET) Content-Disposition: inline In-Reply-To: List-Id: patches and discussions about DPDK List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" On Mon, Feb 01, 2016 at 04:02:05PM +0000, Mcnamara, John wrote: > > -----Original Message----- > > From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Ferruh Yigit > > Sent: Friday, January 29, 2016 10:12 AM > > To: dev@dpdk.org > > Subject: [dpdk-dev] [PATCH] doc: minor correction in document > > > > ... > > > > * html output converts "--" to "-", this is wrong when explaining the > > command arguments, used "option list" to fix this: > > > > http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#option- > > lists > > Hi Ferruh, > > That is interesting. I wasn't aware of that option. That would make the documentation > of commandline options very clean. > > However, it doesn't render as wrapped text in the Html output and has scroll bars instead. > This make it a little hard to read. > > Maybe as a workaround we could just use fixed width quotes like other places in the docs. > Like this: > > > * ``--proc-type``: for specifying a given process ... > * ``--file-prefix``: to allow processes that do not ... > Thank you for the workaround, I will update according. Thanks, ferruh