From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mail-wj0-f177.google.com (mail-wj0-f177.google.com [209.85.210.177]) by dpdk.org (Postfix) with ESMTP id 72656F91D for ; Mon, 19 Dec 2016 12:10:21 +0100 (CET) Received: by mail-wj0-f177.google.com with SMTP id xy5so145788623wjc.0 for ; Mon, 19 Dec 2016 03:10:21 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=6wind-com.20150623.gappssmtp.com; s=20150623; h=date:from:to:cc:subject:message-id:references:mime-version :content-disposition:in-reply-to; bh=hev2cAVVrloTHtOmhLWTC3n4AktpZG8Fu8fKVLYwtpQ=; b=C20Fk/QjFd0z+wz0ND2g1Cgl5L7TUcMErrt6b8O4uqUWJCObGQVth9uZ5rf3FjeAPM Tmta5k7HGdGxdu/yknaSwo/wR38dZGmtI+IBeyCiaY3gOg+jh8D8pFvvVCkXAWWMnS+s k2RhUzzFHzintOugnNNZkm1MMaQSsIsv24TNVozwtyWSx73/wFIxAPbRrQvxR34BsPcH oJdEvrQ/7r1GiZrL/Ce7hsDpIq2GQEcTi/4u5DMbI6xzi6GBe5iMXD9ejnLcYOJMiebM cWJBTu+JWHeT1RQnb3Ol/hh4F47wYNC1Q9r1sx7ZtIaRmGX/eRqkKhfb84Tq/mIzksEL 56PA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:date:from:to:cc:subject:message-id:references :mime-version:content-disposition:in-reply-to; bh=hev2cAVVrloTHtOmhLWTC3n4AktpZG8Fu8fKVLYwtpQ=; b=aKNMH5u9QbzjnIoWxrUrqwH4XBD+s9cUeO2mGyn1x3QxupeOjxjY10H0OWF9JrBKrQ ier95yrsxfZHTIA9TJMJqPSc1+e0IkhngxzlHKi1IB8bFmjNMaDKfEPQ3KQbADaR2f7E BTddoT2goocOTf4X2pjasgmMhdCOr8eRtJRMUWOfANAl0JtKDpyvffSRNfhkp9njSIBf xRHcZfEjvf6zjRUtwF3ZsNz8RZeK/G6mSD2oLb+ulXXz8uRFlIl8L1JaelrsXXrtHO/Q bYVtBoihUPWr0PVZAigSEw232STpher310ny8J9AG4Iu9agDQSqaAUvs2CqIJvBg3SoS NZLw== X-Gm-Message-State: AIkVDXI9z1pJNcWgWN2Wjuwpvi/XqxgdbJnCoa6GjBRYl+VrjGxX0nL4vmniQZ4A8qFiUDuy X-Received: by 10.194.60.195 with SMTP id j3mr14050687wjr.149.1482145821214; Mon, 19 Dec 2016 03:10:21 -0800 (PST) Received: from 6wind.com (guy78-3-82-239-227-177.fbx.proxad.net. [82.239.227.177]) by smtp.gmail.com with ESMTPSA id ab10sm20152031wjc.45.2016.12.19.03.10.20 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Mon, 19 Dec 2016 03:10:20 -0800 (PST) Date: Mon, 19 Dec 2016 12:10:13 +0100 From: Adrien Mazarguil To: "Mcnamara, John" Cc: "dev@dpdk.org" Message-ID: <20161219111013.GL10340@6wind.com> References: <049b57d5216d8703bc5f2cdd29eabe40c2f09138.1481903839.git.adrien.mazarguil@6wind.com> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: Subject: Re: [dpdk-dev] [PATCH v2 02/25] doc: add rte_flow prog 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: Mon, 19 Dec 2016 11:10:21 -0000 Hi John, On Mon, Dec 19, 2016 at 10:45:32AM +0000, Mcnamara, John wrote: > > -----Original Message----- > > From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Adrien Mazarguil > > Sent: Friday, December 16, 2016 4:25 PM > > To: dev@dpdk.org > > Subject: [dpdk-dev] [PATCH v2 02/25] doc: add rte_flow prog guide > > > > This documentation is based on the latest RFC submission, subsequently > > updated according to feedback from the community. > > Hi, > > Thanks. That is a very good doc. > > A few RST comments. > > Section headers should use the use the following underline formats: > > Level 1 Heading > =============== > > > Level 2 Heading > --------------- > > > Level 3 Heading > ~~~~~~~~~~~~~~~ > > > Level 4 Heading > ^^^^^^^^^^^^^^^ > > See: http://dpdk.org/doc/guides/contributing/documentation.html#rst-guidelines OK, although I do not see any mistake regarding this? > Also, some of the section headers for Attributes, Patterns, Match and Action > are a bit short and it isn't clear what section you are in, especially in the > PDF doc. It might be clearer to add the section name before each item like: > > > Attribute: Group > ~~~~~~~~~~~~~~~~ > > Match: VOID > ~~~~~~~~~~~ > > > Tables should have a reference link and a caption, like this: > > .. _table_qos_pipes: > > .. table:: Sample configuration for QOS pipes. > > +----------+----------+----------+ > | Header 1 | Header 2 | Header 3 | > | | | | > +==========+==========+==========+ > | Text | Text | Text | > +----------+----------+----------+ > | ... | ... | ... | > +----------+----------+----------+ > > > See: http://dpdk.org/doc/guides/contributing/documentation.html#tables > > This will make the tables clearer when there are several in a row and will allow > the text to refer to them with :numref:. > > Also, there is one typo: > > s/unpractically/impractically/ > > > Otherwise, very good work. A good clear document. Thanks, I will fix these and re-submit. -- Adrien Mazarguil 6WIND