[dpdk-stable] [PATCH] doc: fix API index

David Marchand david.marchand at redhat.com
Wed May 27 14:17:12 CEST 2020


On Tue, May 26, 2020 at 10:29 PM Thomas Monjalon <thomas at monjalon.net> wrote:
>
> With Doxygen 1.8.18, a warning appears when tagging
> the main markdown header with {#index}.
> That's why the tag has been removed from the API index in DPDK 20.05.
> Unfortunately it makes the index page classified as a standard
> "related page" instead of being the "main page".
>
> The tag {#mainpage} could be used instead of {#index}.
> Another solution, chosen here, is to specify the main page file
> in the Doxygen configuration with the variable USE_MDFILE_AS_MAINPAGE.
>
> Fixes: 76fb8fc486f9 ("doc: fix build with doxygen 1.8.18")
> Cc: stable at dpdk.org
>
> Signed-off-by: Thomas Monjalon <thomas at monjalon.net>

I don't have a system with 1.8.18.
With 1.8.15 (fc31), api/index.html is again populated with this page
and links to this page are restored.

Tested-by: David Marchand <david.marchand at redhat.com>


-- 
David Marchand



More information about the stable mailing list