* [dpdk-stable] [PATCH] doc: fix API index
@ 2020-05-26 20:29 Thomas Monjalon
2020-05-27 12:17 ` David Marchand
0 siblings, 1 reply; 4+ messages in thread
From: Thomas Monjalon @ 2020-05-26 20:29 UTC (permalink / raw)
To: dev
Cc: david.marchand, jerinj, bluca, ktraynor, stable, John McNamara,
Marko Kovacevic
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(+)
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 \
--
2.26.2
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: [dpdk-stable] [PATCH] doc: fix API index
2020-05-26 20:29 [dpdk-stable] [PATCH] doc: fix API index Thomas Monjalon
@ 2020-05-27 12:17 ` David Marchand
2020-05-28 9:14 ` David Marchand
0 siblings, 1 reply; 4+ messages in thread
From: David Marchand @ 2020-05-27 12:17 UTC (permalink / raw)
To: Thomas Monjalon
Cc: dev, Jerin Jacob Kollanukkaran, Luca Boccassi, Kevin Traynor,
dpdk stable, John McNamara, Marko Kovacevic
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
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: [dpdk-stable] [PATCH] doc: fix API index
2020-05-27 12:17 ` David Marchand
@ 2020-05-28 9:14 ` David Marchand
2020-05-28 10:04 ` Luca Boccassi
0 siblings, 1 reply; 4+ messages in thread
From: David Marchand @ 2020-05-28 9:14 UTC (permalink / raw)
To: Thomas Monjalon, Luca Boccassi
Cc: dev, Jerin Jacob Kollanukkaran, Kevin Traynor, dpdk stable,
John McNamara, Marko Kovacevic
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.
--
David Marchand
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: [dpdk-stable] [PATCH] doc: fix API index
2020-05-28 9:14 ` David Marchand
@ 2020-05-28 10:04 ` Luca Boccassi
0 siblings, 0 replies; 4+ messages in thread
From: Luca Boccassi @ 2020-05-28 10:04 UTC (permalink / raw)
To: David Marchand, Thomas Monjalon
Cc: dev, Jerin Jacob Kollanukkaran, Kevin Traynor, dpdk stable,
John McNamara, Marko Kovacevic
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
--
Kind regards,
Luca Boccassi
^ permalink raw reply [flat|nested] 4+ messages in thread
end of thread, other threads:[~2020-05-28 10:04 UTC | newest]
Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-05-26 20:29 [dpdk-stable] [PATCH] doc: fix API index Thomas Monjalon
2020-05-27 12:17 ` David Marchand
2020-05-28 9:14 ` David Marchand
2020-05-28 10:04 ` Luca Boccassi
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).