[spp] SPP documentation update on dpdk.org

Thomas Monjalon thomas at monjalon.net
Tue Dec 11 07:42:56 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.

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 '...'

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 fixed all above 3 issues, sent the patch, and updated the doc on dpdk.org.




More information about the spp mailing list