>From: Mcnamara, John >Sent: Thursday, October 12, 2017 4:29 PM >To: Kavanagh, Mark B <mark.b.kavan...@intel.com>; dev@dpdk.org >Cc: Hu, Jiayu <jiayu...@intel.com>; Tan, Jianfeng <jianfeng....@intel.com>; >Ananyev, Konstantin <konstantin.anan...@intel.com>; Yigit, Ferruh ><ferruh.yi...@intel.com>; tho...@monjalon.net; Kavanagh, Mark B ><mark.b.kavan...@intel.com> >Subject: RE: [dpdk-dev] [PATCH] doc: minor fixes for GSO prog_guide > > > >> -----Original Message----- >> From: dev [mailto:dev-boun...@dpdk.org] On Behalf Of Mark Kavanagh >> Sent: Thursday, October 12, 2017 2:46 PM >> To: dev@dpdk.org >> Cc: Hu, Jiayu <jiayu...@intel.com>; Tan, Jianfeng >> <jianfeng....@intel.com>; Ananyev, Konstantin >> <konstantin.anan...@intel.com>; Yigit, Ferruh <ferruh.yi...@intel.com>; >> tho...@monjalon.net; Kavanagh, Mark B <mark.b.kavan...@intel.com> >> 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 <mark.b.kavan...@intel.com> > > > >> +.. _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 > >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 close >to the referring text. I've moved the note back to its original position, but corrected the indentation, so this target can be removed. > >Also, the note isn't indented to the level of the bullet point. I don't know >if that is intentional or not but I would say there should be an additional >3 spaces indentation from ..note:: to the end of the note. As above (the syntax highlighting of my editor shows indented 'note' tags as incorrect, which is why indentation was incorrect in the first place!). > >With or without these changes: > >Acked-by: John McNamara <john.mcnam...@intel.com> > >
