[spp] SPP documentation update on dpdk.org
Yasufumi Ogawa
ogawa.yasufumi at lab.ntt.co.jp
Wed Dec 12 07:22:04 CET 2018
> 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.
>
> 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
Thanks,
Yasufumi
>
> I fixed all above 3 issues, sent the patch, and updated the doc on dpdk.org.
More information about the spp
mailing list