doc: fix API index
diff mbox series

Message ID 20200526202921.70718-1-thomas@monjalon.net
State Accepted
Delegated to: David Marchand
Headers show
Series
  • doc: fix API index
Related show

Checks

Context Check Description
ci/travis-robot success Travis build: passed
ci/checkpatch success coding style OK

Commit Message

Thomas Monjalon May 26, 2020, 8:29 p.m. UTC
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@dpdk.org

Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
---
 doc/api/doxy-api.conf.in | 1 +
 1 file changed, 1 insertion(+)

Comments

David Marchand May 27, 2020, 12:17 p.m. UTC | #1
On Tue, May 26, 2020 at 10:29 PM Thomas Monjalon <thomas@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@dpdk.org
>
> Signed-off-by: Thomas Monjalon <thomas@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@redhat.com>
David Marchand May 28, 2020, 9:14 a.m. UTC | #2
On Wed, May 27, 2020 at 2:17 PM David Marchand
<david.marchand@redhat.com> 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@dpdk.org
> >
> > Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
> Tested-by: David Marchand <david.marchand@redhat.com>

Applied, thanks.

Luca, I saw you marked 76fb8fc486f9 ("doc: fix build with doxygen
1.8.18") for 19.11.3.
So this current patch is a candidate for 19.11.3 too.
Luca Boccassi May 28, 2020, 10:04 a.m. UTC | #3
On Thu, 2020-05-28 at 11:14 +0200, David Marchand wrote:
> On Wed, May 27, 2020 at 2:17 PM David Marchand
> <david.marchand@redhat.com> 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@dpdk.org
> > > 
> > > Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
> > Tested-by: David Marchand <david.marchand@redhat.com>
> 
> Applied, thanks.
> 
> Luca, I saw you marked 76fb8fc486f9 ("doc: fix build with doxygen
> 1.8.18") for 19.11.3.
> So this current patch is a candidate for 19.11.3 too.

Already applied on suggestion from Thomas, thanks

Patch
diff mbox series

diff --git a/doc/api/doxy-api.conf.in b/doc/api/doxy-api.conf.in
index 92122125ae..9b55b7500c 100644
--- a/doc/api/doxy-api.conf.in
+++ b/doc/api/doxy-api.conf.in
@@ -3,6 +3,7 @@ 
 
 PROJECT_NAME            = DPDK
 PROJECT_NUMBER          = @VERSION@
+USE_MDFILE_AS_MAINPAGE  = @TOPDIR@/doc/api/doxy-api-index.md
 INPUT                   = @TOPDIR@/doc/api/doxy-api-index.md \
                           @TOPDIR@/drivers/bus/vdev \
                           @TOPDIR@/drivers/crypto/scheduler \