[dpdk-dev] [PATCH v2 0/6] improve building docs

Thomas Monjalon thomas at monjalon.net
Wed Sep 30 16:32:27 CEST 2020


> When building the documentation, a lot of text is output, meaning that
> any warnings can be missed in all the text. Unfortunately, ninja merges
> both stderr and stdout of all tasks so one cannot just redirect stdout to
> a separate location as part of the build command to rectify that.
> Therefore, since we rarely care about the output of the doc builds, only
> output the stderr text and write the standard output text to a log file
> in the relevant build folder (i.e. build/doc/guides or build/doc/api)
> 
> Related to this, we can catch documentation bugs earlier by setting
> WARN_AS_ERRORS for doxygen, meaning the build will fail if any API
> documentation warnings as encountered. Rather than setting this globally,
> we can link it to the global build --werror setting.

Applied with suggested minor change, and without ethdev fix. Thanks




More information about the dev mailing list