From: Yasufumi Ogawa <ogawa.yasufumi@lab.ntt.co.jp>
To: Thomas Monjalon <thomas@monjalon.net>
Cc: Ferruh Yigit <ferruh.yigit@intel.com>, dpdk-web <web@dpdk.org>,
dpdk-spp <spp@dpdk.org>
Subject: Re: [dpdk-web] SPP documentation update on dpdk.org
Date: Thu, 13 Dec 2018 04:18:19 +0900 [thread overview]
Message-ID: <dc156b44-038b-9b9d-660b-34958e5c7e5e@lab.ntt.co.jp> (raw)
In-Reply-To: <1704380.LblYpThBnZ@xps>
>>> Hi,
>>>
>>> 10/12/2018 17:52, Yasufumi Ogawa:
>>>>> Hi Thomas,
>>>>>
>>>>> Yasufumi was asking how to update SPP documentation on dpdk.or
>>>>> (https://doc.dpdk.org/spp/).
>>>>>
>>>>> Is there something triggered automatically when a document patch applied? Or is
>>>>> it needs to be done manually? How can we manage this doc update?
>>>> Hi Ferruh, Thomas,
>>>>
>>>> Thanks Ferruh for your support! I aske Thomas for documentation and he kindly told me how it is updated with his script. It
>>>> might be my fault because of some of compilation errors of documentation.
>>>>
>>>> I have tried to fix the errors and push to it with new version tag.
>> Thomas,
>>
>> Thank you so much for fixing my problems!
>>>
>>> First issue I see is the error number:
>>> in v18.08 it is defined as VERSION := 18.05.1
>>>
>>> Second issue:
>>> WARNING: The config value `version' has type `bytes', defaults to `str'.
>>> WARNING: The config value `release' has type `bytes', defaults to `str'.
>>>
>>> There is a third issue with the output of the make command:
>>> make: Entering directory '...'
>>> 18.08
>>> make: Leaving directory '...'
>> I was curious `make showversion` because make command told me that `-r` is illegal even if giving options same as DPDK and no
>> warnings for compiling DPDK's documentation.
>>
>> By the way, do you use python3 for sphinx-build? I am using python2 and there are no warnings in the second issue while docs
>> compilation. If so, I should update to python3 to be the same environment as yours.
>
> I use python3 but the server dpdk.org uses python2.
I understood that it is not depend on the versions.
>
>>> Last but not the least, the doc will be generated only when you push an annotated tag:
>>> git tag -am spp-18.08 v18.08
>> I understand pushing tag is also incorrect. I simply added the tag and pushed.
>> $ git tag v18.08
>> $ git push origin v18.08
>
> This does not trigger compilation of the doc.
> You must use *annotated* tags.
OK. I should take care about it, and giving exact version number. Thanks!
>
>> Thanks,
>> Yasufumi
>>>
>>> I fixed all above 3 issues, sent the patch, and updated the doc on dpdk.org.
next prev parent reply other threads:[~2018-12-12 19:20 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-12-10 11:26 Ferruh Yigit
2018-12-10 16:52 ` Yasufumi Ogawa
2018-12-11 6:42 ` Thomas Monjalon
2018-12-12 6:22 ` Yasufumi Ogawa
2018-12-12 10:17 ` Thomas Monjalon
2018-12-12 19:18 ` Yasufumi Ogawa [this message]
2018-12-17 7:33 ` Yasufumi Ogawa
2018-12-17 9:42 ` Thomas Monjalon
2018-12-17 10:03 ` Yasufumi Ogawa
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=dc156b44-038b-9b9d-660b-34958e5c7e5e@lab.ntt.co.jp \
--to=ogawa.yasufumi@lab.ntt.co.jp \
--cc=ferruh.yigit@intel.com \
--cc=spp@dpdk.org \
--cc=thomas@monjalon.net \
--cc=web@dpdk.org \
/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).