From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mga11.intel.com (mga11.intel.com [192.55.52.93]) by dpdk.org (Postfix) with ESMTP id DDA101B5DB for ; Thu, 12 Oct 2017 17:57:00 +0200 (CEST) Received: from orsmga003.jf.intel.com ([10.7.209.27]) by fmsmga102.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 12 Oct 2017 08:56:59 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.43,366,1503385200"; d="scan'208";a="1024521862" Received: from irsmsx152.ger.corp.intel.com ([163.33.192.66]) by orsmga003.jf.intel.com with ESMTP; 12 Oct 2017 08:56:58 -0700 Received: from irsmsx101.ger.corp.intel.com ([169.254.1.22]) by IRSMSX152.ger.corp.intel.com ([169.254.6.87]) with mapi id 14.03.0319.002; Thu, 12 Oct 2017 16:56:54 +0100 From: "Kavanagh, Mark B" To: "Mcnamara, John" , "dev@dpdk.org" CC: "Hu, Jiayu" , "Tan, Jianfeng" , "Ananyev, Konstantin" , "Yigit, Ferruh" , "thomas@monjalon.net" Thread-Topic: [dpdk-dev] [PATCH] doc: minor fixes for GSO prog_guide Thread-Index: AQHTQ2B66RF8WYYMlE+kVnIDoUPBkaLgRgoAgAASlLA= Date: Thu, 12 Oct 2017 15:56:54 +0000 Message-ID: References: <1507815955-23275-1-git-send-email-mark.b.kavanagh@intel.com> In-Reply-To: Accept-Language: en-IE, en-US Content-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: x-ctpclassification: CTP_IC x-titus-metadata-40: eyJDYXRlZ29yeUxhYmVscyI6IiIsIk1ldGFkYXRhIjp7Im5zIjoiaHR0cDpcL1wvd3d3LnRpdHVzLmNvbVwvbnNcL0ludGVsMyIsImlkIjoiZjMwN2Q5ODQtNGQ5ZC00ZmM5LTgxYjEtNGZjMjNmOGU0ZTg4IiwicHJvcHMiOlt7Im4iOiJDVFBDbGFzc2lmaWNhdGlvbiIsInZhbHMiOlt7InZhbHVlIjoiQ1RQX0lDIn1dfV19LCJTdWJqZWN0TGFiZWxzIjpbXSwiVE1DVmVyc2lvbiI6IjE1LjkuNi42IiwiVHJ1c3RlZExhYmVsSGFzaCI6IkpRMUNQREp5ZWg4U1p5MEhKMGdFekdyV002a3Z4NVllUWdYVUxcL1JNS1lVPSJ9 dlp-product: dlpe-windows dlp-version: 11.0.0.116 dlp-reaction: no-action x-originating-ip: [163.33.239.182] Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 Subject: Re: [dpdk-dev] [PATCH] doc: minor fixes for GSO 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: Thu, 12 Oct 2017 15:57:01 -0000 >From: Mcnamara, John >Sent: Thursday, October 12, 2017 4:29 PM >To: Kavanagh, Mark B ; dev@dpdk.org >Cc: Hu, Jiayu ; Tan, Jianfeng = ; >Ananyev, Konstantin ; Yigit, Ferruh >; thomas@monjalon.net; Kavanagh, Mark B > >Subject: RE: [dpdk-dev] [PATCH] doc: minor fixes for GSO prog_guide > > > >> -----Original Message----- >> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Mark Kavanagh >> Sent: Thursday, October 12, 2017 2:46 PM >> To: dev@dpdk.org >> Cc: Hu, Jiayu ; Tan, Jianfeng >> ; Ananyev, Konstantin >> ; Yigit, Ferruh ; >> thomas@monjalon.net; Kavanagh, Mark B >> Subject: [dpdk-dev] [PATCH] doc: minor fixes for GSO prog_guide >> >> Correct two minor issues in the GSO programmer's guide: >> - a note is rendered incorrectly in the middle of an unordered list; >> this results in the remainder of the list appearing inside the note. >> Move note to end of the list to resolve same. >> - two minor visual artifacts are present in the 'three-part-output- >> segment' >> diagram. Remove same. >> >> Fixes: f6010c7 ("doc: add GSO programmer's guide") >> >> Signed-off-by: Mark Kavanagh > > > >> +.. _note: >> +.. note:: >> + >> + An application may use the same pool for both direct and indirect >> + buffers. However, since indirect mbufs simply store a pointer, the > >Hi Mark, Hey John, Thanks for the feedback - responses inline. I'll post v2 now, and carry forward your Ack. Cheers, Mark=20 > >The _note target should be more specific since the these targets are used >across all the documentation. So something like _gso_note would be better. >Or alternatively leave out the target and just say something in the text >like "See the note below.", without the link, since the note is quite clos= e >to the referring text. I've moved the note back to its original position, but corrected the indent= ation, so this target can be removed. > >Also, the note isn't indented to the level of the bullet point. I don't kn= ow >if that is intentional or not but I would say there should be an additiona= l >3 spaces indentation from ..note:: to the end of the note. As above (the syntax highlighting of my editor shows indented 'note' tags a= s incorrect, which is why indentation was incorrect in the first place!). > >With or without these changes: > >Acked-by: John McNamara > >