patches for DPDK stable branches
 help / color / mirror / Atom feed
From: Thomas Monjalon <>
	John McNamara <>,
	Marko Kovacevic <>
Subject: [dpdk-stable] [PATCH] doc: fix API index
Date: Tue, 26 May 2020 22:29:20 +0200
Message-ID: <> (raw)

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")

Signed-off-by: Thomas Monjalon <>
 doc/api/ | 1 +
 1 file changed, 1 insertion(+)

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

             reply	other threads:[~2020-05-26 20:29 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-05-26 20:29 Thomas Monjalon [this message]
2020-05-27 12:17 ` David Marchand
2020-05-28  9:14   ` David Marchand
2020-05-28 10:04     ` Luca Boccassi

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \ \ \ \ \ \ \ \ \ \ \

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

patches for DPDK stable branches

This inbox may be cloned and mirrored by anyone:

	git clone --mirror stable/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 stable stable/ \
	public-inbox-index stable

Example config snippet for mirrors.
Newsgroup available over NNTP:

AGPL code for this site: git clone