Message ID | 20200526202921.70718-1-thomas@monjalon.net (mailing list archive) |
---|---|
State | Accepted, archived |
Delegated to: | David Marchand |
Headers |
Return-Path: <dev-bounces@dpdk.org> X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id 25ABFA04A4; Tue, 26 May 2020 22:29:35 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id C57C71D6FF; Tue, 26 May 2020 22:29:34 +0200 (CEST) Received: from wout4-smtp.messagingengine.com (wout4-smtp.messagingengine.com [64.147.123.20]) by dpdk.org (Postfix) with ESMTP id 75A101B91B; Tue, 26 May 2020 22:29:33 +0200 (CEST) Received: from compute7.internal (compute7.nyi.internal [10.202.2.47]) by mailout.west.internal (Postfix) with ESMTP id 9D96212D8; Tue, 26 May 2020 16:29:31 -0400 (EDT) Received: from mailfrontend1 ([10.202.2.162]) by compute7.internal (MEProxy); Tue, 26 May 2020 16:29:32 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=monjalon.net; h= from:to:cc:subject:date:message-id:mime-version :content-transfer-encoding; s=fm1; bh=TljSjQt+MpU2jQO/q+9OneJpnL RWxbMN5HEeAsqQjIE=; b=HwjDzdgOJLjRdriW3Rh5womPSadvhJQiCt6zlF75XN sSZBvfbij86XbE9YzlxmfArofmts1ykPUZc9NTE+apPWFWDfTNydHgekjICAJYdf eBsUkkWoqAAYUK7gWmbhJ8QHfWfQtlMGR8TlPwHhphpJLJTBbVBX2B1K/q9LFBbo xNXiHmBvjl/mryaeINcbNgJnZBlDi3buFydvY2zaExFJDh/jSzY9ILMu+3fuWWEr WtBqc+rOJySp2SrlRM1LIokFBFyVABerVIZp59uzyANU39ZrQ5eGClrcGE+stGVD qRnKWnSKFJRGEX5lVhNWKKG2rv4KDkNuMHH7LzBg163A== DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d= messagingengine.com; h=cc:content-transfer-encoding:date:from :message-id:mime-version:subject:to:x-me-proxy:x-me-proxy :x-me-sender:x-me-sender:x-sasl-enc; s=fm2; bh=TljSjQt+MpU2jQO/q +9OneJpnLRWxbMN5HEeAsqQjIE=; b=rtc7Lk4RdSyMjEzSAF/EYAC0i9EmXR5FZ 1NtHLjXC57GECMTCeREvotBqKJFat06jaf4jDwWBvyJ+f7teGaE/b0bTSgtgpPEH g1m4wExNayeexIT0UYaw51rOJOe+rI6vG2oes5LAyZgkTTZLETFasDDCABMIutxv DDFxpmnNYDJyuiW/9BYBFjVuIHmxx2Ax8YQCRNhaOHDJ7lWksbYrykF3eES17dLN jeK+ZftetZ0Y2KymZ3Lcmr0BrcqXQiR3FdwTOcj133DriKYlwdwsAGt5346pGVEw 4rAKCT4ek0JO8LBJswm9RNiUwZUxUOFs5GHtgL5whM60T0mdUAulw== X-ME-Sender: <xms:KnzNXuFo-VIyxn0cYT3iP4DNY8FfO7-Slrp42yksCqcOFnV8rKmk7A> X-ME-Proxy-Cause: gggruggvucftvghtrhhoucdtuddrgeduhedruddvvddgudeghecutefuodetggdotefrod ftvfcurfhrohhfihhlvgemucfhrghsthforghilhdpqfgfvfdpuffrtefokffrpgfnqfgh necuuegrihhlohhuthemuceftddtnecusecvtfgvtghiphhivghnthhsucdlqddutddtmd enucfjughrpefhvffufffkofgggfestdekredtredttdenucfhrhhomhepvfhhohhmrghs ucfoohhnjhgrlhhonhcuoehthhhomhgrshesmhhonhhjrghlohhnrdhnvghtqeenucggtf frrghtthgvrhhnpefhkeduiedtffekueegkeehvdfhfeekffekveejtddvhfelgffgffel ueeuleejgeenucffohhmrghinheptghonhhfrdhinhenucfkphepjeejrddufeegrddvtd efrddukeegnecuvehluhhsthgvrhfuihiivgeptdenucfrrghrrghmpehmrghilhhfrhho mhepthhhohhmrghssehmohhnjhgrlhhonhdrnhgvth X-ME-Proxy: <xmx:KnzNXvXpzX38-Kiw_wHc5QcWrrJoyY7fEgATGxk7RKyQtN0-Whwnww> <xmx:KnzNXoITG6wAZsrEa8fdCO2_MjwBNHtvCGApKoHPLhAl4-d-8UIYOQ> <xmx:KnzNXoGGyZc58sm2UiwIXKIJK55h6u94aHhIE00kJ0SYAaaCrvH-vw> <xmx:K3zNXizLen1McHk7gNYW8xmF4xVOO0NZKeOk7HWOw0X5O1xmatBL9A> Received: from xps.monjalon.net (184.203.134.77.rev.sfr.net [77.134.203.184]) by mail.messagingengine.com (Postfix) with ESMTPA id 5D8FF328005E; Tue, 26 May 2020 16:29:29 -0400 (EDT) From: Thomas Monjalon <thomas@monjalon.net> To: dev@dpdk.org Cc: david.marchand@redhat.com, jerinj@marvell.com, bluca@debian.org, ktraynor@redhat.com, stable@dpdk.org, John McNamara <john.mcnamara@intel.com>, Marko Kovacevic <marko.kovacevic@intel.com> Date: Tue, 26 May 2020 22:29:20 +0200 Message-Id: <20200526202921.70718-1-thomas@monjalon.net> X-Mailer: git-send-email 2.26.2 MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Subject: [dpdk-dev] [PATCH] doc: fix API index X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions <dev.dpdk.org> List-Unsubscribe: <https://mails.dpdk.org/options/dev>, <mailto:dev-request@dpdk.org?subject=unsubscribe> List-Archive: <http://mails.dpdk.org/archives/dev/> List-Post: <mailto:dev@dpdk.org> List-Help: <mailto:dev-request@dpdk.org?subject=help> List-Subscribe: <https://mails.dpdk.org/listinfo/dev>, <mailto:dev-request@dpdk.org?subject=subscribe> Errors-To: dev-bounces@dpdk.org Sender: "dev" <dev-bounces@dpdk.org> |
Series |
doc: fix API index
|
|
Checks
Context | Check | Description |
---|---|---|
ci/checkpatch | success | coding style OK |
ci/travis-robot | success | Travis build: passed |
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
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>
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.
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
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 \