From: Yasufumi Ogawa <ogawa.yasufumi@lab.ntt.co.jp>
To: Nakamura Hioryuki <nakamura.hiroyuki@po.ntt-tx.co.jp>,
Thomas Monjalon <thomas@monjalon.net>,
spp@dpdk.org
Cc: Ferruh Yigit <ferruh.yigit@intel.com>,
srv-apl-arch@lab.ntt.co.jp, x-fn-spp@sl.ntt-tx.co.jp
Subject: Re: [spp] [srv-apl-arch:9031] Re: [spp 02114] Re: Proposal for RST documentation support
Date: Fri, 2 Feb 2018 18:43:49 +0900 [thread overview]
Message-ID: <9333dc40-53f9-472c-8155-49e8be0ed2b5@lab.ntt.co.jp> (raw)
In-Reply-To: <201802020918.w129IBVm024328@ccmail03.silk.ntt-tx.co.jp>
On 2018/02/02 18:18, Nakamura Hioryuki wrote:
>> 01/02/2018 13:50, Ferruh Yigit:
>>> On 2/1/2018 4:00 AM, Yasufumi Ogawa wrote:
>>>> Hi, all
>>>>
>>>> SPP documentation is currently provided as markdown format. Although it
>>>> is convenience for hosting on github, I think we need to prepare an
>>>> official documentation as similar to other DPDK projects considering
>>>> users. In addition, current documents are not so organized well and some
>>>> of documents are poor for explanation and should be updated.
>>>>
>>>> I would like to send patches for replacing markdown documents to RST. It
>>>> also includes make command support for compiling and cleaning html
>>>> documents.
>>>> $ make doc-html # compile html
>>>> $ make doc-clean # clean generated documents
>>>>
>>>> As a trial, I have uploaded RST documents on readthedocs.io to be reviewed.
>>>> http://spp.readthedocs.io/en/doc_rst/index.html
>>>
>>> I think this is good idea, I check the docs and looks pretty good.
>>>
>>>>
>>>> If it is accpted, I would like to propose DPDK community to add a link
>>>> to https://dpdk.org/doc as similar as pktgen-dpdk, or hosting it on
>>>> dpdk.org.
>>>
>>> And I think this is good idea, cc'ed Thomas for comment.
>>
>> Yes we can host it on dpdk.org and automate the generation at each tag.
Thanks, all! Good new for SPP to be hosted on the documentation's site.
I will proceed to migrate documents to RST format.
Hiroyuki, I would like to also migrate your SPP_VF documents.
Thanks,
Yasufumi
>
> Thanks Ferruh, Thomas and Yasufumi
>
> We all agree.
>
--
Yasufumi Ogawa
NTT Network Service Systems Labs
next prev parent reply other threads:[~2018-02-02 9:45 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-02-01 4:00 [spp] " Yasufumi Ogawa
2018-02-01 12:50 ` Ferruh Yigit
2018-02-01 13:10 ` Thomas Monjalon
2018-02-02 9:27 ` [spp] [spp 02114] " Nakamura Hioryuki
[not found] ` <201802020918.w129IBVm024328@ccmail03.silk.ntt-tx.co.jp>
2018-02-02 9:43 ` Yasufumi Ogawa [this message]
2018-08-31 18:47 ` [spp] " Thomas Monjalon
2018-09-03 8:46 ` Yasufumi Ogawa
2018-09-04 11:51 ` Ferruh Yigit
2018-09-04 11:53 ` Ferruh Yigit
2018-09-04 12:49 ` Thomas Monjalon
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=9333dc40-53f9-472c-8155-49e8be0ed2b5@lab.ntt.co.jp \
--to=ogawa.yasufumi@lab.ntt.co.jp \
--cc=ferruh.yigit@intel.com \
--cc=nakamura.hiroyuki@po.ntt-tx.co.jp \
--cc=spp@dpdk.org \
--cc=srv-apl-arch@lab.ntt.co.jp \
--cc=thomas@monjalon.net \
--cc=x-fn-spp@sl.ntt-tx.co.jp \
/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).