[v1] doc: fix ip6 node API doxygen generation

Message ID 20230620095549.2668868-1-jerinj@marvell.com (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers
Series [v1] doc: fix ip6 node API doxygen generation |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/loongarch-compilation success Compilation OK
ci/loongarch-unit-testing success Unit Testing PASS
ci/Intel-compilation success Compilation OK
ci/intel-Testing success Testing PASS
ci/iol-mellanox-Performance success Performance Testing PASS
ci/github-robot: build success github build: passed
ci/iol-abi-testing success Testing PASS
ci/iol-aarch-unit-testing success Testing PASS
ci/iol-unit-testing success Testing PASS
ci/intel-Functional success Functional PASS
ci/iol-intel-Performance success Performance Testing PASS
ci/iol-x86_64-compile-testing success Testing PASS
ci/iol-broadcom-Functional success Functional Testing PASS
ci/iol-broadcom-Performance success Performance Testing PASS
ci/iol-intel-Functional success Functional Testing PASS
ci/iol-aarch64-compile-testing success Testing PASS
ci/iol-testing success Testing PASS
ci/iol-x86_64-unit-testing success Testing PASS

Commit Message

Jerin Jacob Kollanukkaran June 20, 2023, 9:55 a.m. UTC
  From: Jerin Jacob <jerinj@marvell.com>

Add ip6 node public API to doxygen list.

Fixes: 20365d793e45 ("node: add IPv6 lookup node")
Cc: Sunil Kumar Kori <skori@marvell.com>
Cc: Amit Prakash Shukla <amitprakashs@marvell.com>
Cc: Nithin Dabilpuram <ndabilpuram@marvell.com>

Signed-off-by: Jerin Jacob <jerinj@marvell.com>
---
 doc/api/doxy-api-index.md | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)
  

Comments

Sunil Kumar Kori June 20, 2023, 5:22 p.m. UTC | #1
> -----Original Message-----
> From: jerinj@marvell.com <jerinj@marvell.com>
> Sent: Tuesday, June 20, 2023 3:26 PM
> To: dev@dpdk.org; Nithin Kumar Dabilpuram <ndabilpuram@marvell.com>;
> Amit Prakash Shukla <amitprakashs@marvell.com>; Sunil Kumar Kori
> <skori@marvell.com>
> Cc: Jerin Jacob Kollanukkaran <jerinj@marvell.com>
> Subject: [dpdk-dev] [PATCH v1] doc: fix ip6 node API doxygen generation
> 
> From: Jerin Jacob <jerinj@marvell.com>
> 
> Add ip6 node public API to doxygen list.
> 
> Fixes: 20365d793e45 ("node: add IPv6 lookup node")
> Cc: Sunil Kumar Kori <skori@marvell.com>
> Cc: Amit Prakash Shukla <amitprakashs@marvell.com>
> Cc: Nithin Dabilpuram <ndabilpuram@marvell.com>
> 
> Signed-off-by: Jerin Jacob <jerinj@marvell.com>
> ---
>  doc/api/doxy-api-index.md | 3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)
> 

Acked-by: Sunil Kumar Kori <skori@marvell.com>
  
Thomas Monjalon June 28, 2023, 12:15 a.m. UTC | #2
> > Add ip6 node public API to doxygen list.
> > 
> > Fixes: 20365d793e45 ("node: add IPv6 lookup node")
> > Cc: Sunil Kumar Kori <skori@marvell.com>
> > Cc: Amit Prakash Shukla <amitprakashs@marvell.com>
> > Cc: Nithin Dabilpuram <ndabilpuram@marvell.com>
> > 
> > Signed-off-by: Jerin Jacob <jerinj@marvell.com>
> > ---
> >  doc/api/doxy-api-index.md | 3 ++-
> >  1 file changed, 2 insertions(+), 1 deletion(-)
> 
> Acked-by: Sunil Kumar Kori <skori@marvell.com>

Applied, thanks.
  

Patch

diff --git a/doc/api/doxy-api-index.md b/doc/api/doxy-api-index.md
index 32bf7b72b2..3bc8778981 100644
--- a/doc/api/doxy-api-index.md
+++ b/doc/api/doxy-api-index.md
@@ -208,7 +208,8 @@  The public API headers are grouped by topics:
     [graph_worker](@ref rte_graph_worker.h)
   * graph_nodes:
     [eth_node](@ref rte_node_eth_api.h),
-    [ip4_node](@ref rte_node_ip4_api.h)
+    [ip4_node](@ref rte_node_ip4_api.h),
+    [ip6_node](@ref rte_node_ip6_api.h)
 
 - **basic**:
   [bitops](@ref rte_bitops.h),