From: "Kavanagh, Mark B" <mark.b.kavanagh@intel.com>
To: "Mcnamara, John" <john.mcnamara@intel.com>,
"dev@dpdk.org" <dev@dpdk.org>
Cc: "Hu, Jiayu" <jiayu.hu@intel.com>,
"Tan, Jianfeng" <jianfeng.tan@intel.com>,
"Ananyev, Konstantin" <konstantin.ananyev@intel.com>,
"Yigit, Ferruh" <ferruh.yigit@intel.com>,
"thomas@monjalon.net" <thomas@monjalon.net>
Subject: Re: [dpdk-dev] [PATCH] doc: minor fixes for GSO prog_guide
Date: Thu, 12 Oct 2017 15:56:54 +0000 [thread overview]
Message-ID: <DC5AD7FA266D86499789B1BCAEC715F8D3A270B4@IRSMSX101.ger.corp.intel.com> (raw)
In-Reply-To: <B27915DBBA3421428155699D51E4CFE23EDCE262@IRSMSX103.ger.corp.intel.com>
>From: Mcnamara, John
>Sent: Thursday, October 12, 2017 4:29 PM
>To: Kavanagh, Mark B <mark.b.kavanagh@intel.com>; dev@dpdk.org
>Cc: Hu, Jiayu <jiayu.hu@intel.com>; Tan, Jianfeng <jianfeng.tan@intel.com>;
>Ananyev, Konstantin <konstantin.ananyev@intel.com>; Yigit, Ferruh
><ferruh.yigit@intel.com>; thomas@monjalon.net; Kavanagh, Mark B
><mark.b.kavanagh@intel.com>
>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 <jiayu.hu@intel.com>; Tan, Jianfeng
>> <jianfeng.tan@intel.com>; Ananyev, Konstantin
>> <konstantin.ananyev@intel.com>; Yigit, Ferruh <ferruh.yigit@intel.com>;
>> thomas@monjalon.net; Kavanagh, Mark B <mark.b.kavanagh@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.kavanagh@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.mcnamara@intel.com>
>
>
next prev parent reply other threads:[~2017-10-12 15:57 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-10-12 13:45 Mark Kavanagh
2017-10-12 15:28 ` Mcnamara, John
2017-10-12 15:56 ` Kavanagh, Mark B [this message]
2017-10-12 15:59 ` [dpdk-dev] [PATCH V2] " Mark Kavanagh
2017-10-12 16:05 ` [dpdk-dev] [PATCH V3] " Mark Kavanagh
2017-10-14 0:08 ` Ferruh Yigit
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=DC5AD7FA266D86499789B1BCAEC715F8D3A270B4@IRSMSX101.ger.corp.intel.com \
--to=mark.b.kavanagh@intel.com \
--cc=dev@dpdk.org \
--cc=ferruh.yigit@intel.com \
--cc=jianfeng.tan@intel.com \
--cc=jiayu.hu@intel.com \
--cc=john.mcnamara@intel.com \
--cc=konstantin.ananyev@intel.com \
--cc=thomas@monjalon.net \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).