[dpdk-dev] [PATCH] doc: fix PDF build of bbdev prog guide

Chautru, Nicolas nicolas.chautru at intel.com
Thu Jul 18 15:33:46 CEST 2019


From: Thomas Monjalon [mailto:thomas at monjalon.net] 
>Some machine (like on dpdk.org) may fail to build the prog guide PDF because of the complex table inserted in the bbdev chapter.
>
>Fixes: 3f3f608142cf ("doc: update bbdev guide for 5GNR operations")
>Cc: nicolas.chautru at intel.com
>
>Signed-off-by: Thomas Monjalon <thomas at monjalon.net>
>---
>Anyway all the documentation about the API details should be removed.
>The guide is expected to give an understanding of the whole design, not replacing the details maintained in the doxygen comments.

Thanks Thomas. 
These tables are arguably useful on that page with the related contextual verbose information aside which provide more context usage. Still I am reformatting into simpler table structure. 
I have just pushed a parallel patch here : https://patches.dpdk.org/patch/56715/

>While at refactoring this chapter, the hardcoded references to some section or figure numbers must be replaced by dynamic references.

I have seen a couple of hardcoded figure numbers which I fixed. Let me know in case I missed some. 
Thanks


More information about the dev mailing list