diff mbox series

doc: fix build with doxygen 1.8.18

Message ID 20200520135524.1177975-1-thomas@monjalon.net (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers
Series doc: fix build with doxygen 1.8.18 |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/travis-robot success Travis build: passed
ci/Intel-compilation fail Compilation issues

Commit Message

Thomas Monjalon May 20, 2020, 1:55 p.m. UTC 
  Having an explicit "index" anchor looks forbidden:

doc/api/doxy-api-index.md:1: warning:
multiple use of section label 'index' for main page

Anyway this anchor was not used, it can be removed.

Fixes: 9bf486e606b0 ("doc: generate HTML for API with doxygen")
Cc: stable@dpdk.org

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

Comments

Jerin Jacob May 20, 2020, 6:15 p.m. UTC | #1 
On Wed, May 20, 2020 at 7:26 PM Thomas Monjalon <thomas@monjalon.net> wrote:
>
> Having an explicit "index" anchor looks forbidden:
>
> doc/api/doxy-api-index.md:1: warning:
> multiple use of section label 'index' for main page
>
> Anyway this anchor was not used, it can be removed.
>
> Fixes: 9bf486e606b0 ("doc: generate HTML for API with doxygen")
> Cc: stable@dpdk.org
>
> Signed-off-by: Thomas Monjalon <thomas@monjalon.net>

Tested with Doxygen 1.8,13.

Tested-by: Jerin Jacob <jerinj@marvell.com>



> ---
>  doc/api/doxy-api-index.md | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/doc/api/doxy-api-index.md b/doc/api/doxy-api-index.md
> index 93f0d933b1..f597663237 100644
> --- a/doc/api/doxy-api-index.md
> +++ b/doc/api/doxy-api-index.md
> @@ -1,4 +1,4 @@
> -API {#index}
> +API
>  ===
>
>  <!--
> --
> 2.26.2
>
Thomas Monjalon May 21, 2020, 1:43 p.m. UTC | #2 
20/05/2020 20:15, Jerin Jacob:
> On Wed, May 20, 2020 at 7:26 PM Thomas Monjalon <thomas@monjalon.net> wrote:
> >
> > Having an explicit "index" anchor looks forbidden:
> >
> > doc/api/doxy-api-index.md:1: warning:
> > multiple use of section label 'index' for main page
> >
> > Anyway this anchor was not used, it can be removed.
> >
> > Fixes: 9bf486e606b0 ("doc: generate HTML for API with doxygen")
> > Cc: stable@dpdk.org
> >
> > Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
> 
> Tested with Doxygen 1.8,13.
> 
> Tested-by: Jerin Jacob <jerinj@marvell.com>

Applied
diff mbox series

Patch

diff --git a/doc/api/doxy-api-index.md b/doc/api/doxy-api-index.md
index 93f0d933b1..f597663237 100644
--- a/doc/api/doxy-api-index.md
+++ b/doc/api/doxy-api-index.md
@@ -1,4 +1,4 @@ 
-API {#index}
+API
 ===
 
 <!--