doc: add doxygen documentation for ipsec library
diff mbox series

Message ID 8860a2903b705d2b3e697fe7b9b79064aacaccdf.1570726287.git.vladimir.medvedkin@intel.com
State Accepted
Delegated to: akhil goyal
Headers show
Series
  • doc: add doxygen documentation for ipsec library
Related show

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK

Commit Message

Vladimir Medvedkin Oct. 10, 2019, 4:52 p.m. UTC
Added ipsec API from:
- rte_ipsec.h
- rte_ipsec_sa.h
- rte_ipsec_group.h
- rte_ipsec_sad.h

Signed-off-by: Vladimir Medvedkin <vladimir.medvedkin@intel.com>
---
 doc/api/doxy-api-index.md | 6 ++++++
 doc/api/doxy-api.conf.in  | 1 +
 2 files changed, 7 insertions(+)

Comments

Akhil Goyal Oct. 22, 2019, 8:05 a.m. UTC | #1
> -----Original Message-----
> From: dev <dev-bounces@dpdk.org> On Behalf Of Vladimir Medvedkin
> Sent: Thursday, October 10, 2019 10:22 PM
> To: dev@dpdk.org
> Cc: konstantin.ananyev@intel.com; john.mcnamara@intel.com;
> marko.kovacevic@intel.com
> Subject: [dpdk-dev] [PATCH] doc: add doxygen documentation for ipsec library
> 
> Added ipsec API from:
> - rte_ipsec.h
> - rte_ipsec_sa.h
> - rte_ipsec_group.h
> - rte_ipsec_sad.h
> 
> Signed-off-by: Vladimir Medvedkin <vladimir.medvedkin@intel.com>
> ---
Acked-by: Akhil Goyal <akhil.goyal@nxp.com>

Applied to dpdk-next-crypto

Thanks.
Thomas Monjalon Oct. 24, 2019, 8:23 a.m. UTC | #2
22/10/2019 10:05, Akhil Goyal:
> 
> > -----Original Message-----
> > From: dev <dev-bounces@dpdk.org> On Behalf Of Vladimir Medvedkin
> > Sent: Thursday, October 10, 2019 10:22 PM
> > To: dev@dpdk.org
> > Cc: konstantin.ananyev@intel.com; john.mcnamara@intel.com;
> > marko.kovacevic@intel.com
> > Subject: [dpdk-dev] [PATCH] doc: add doxygen documentation for ipsec library
> > 
> > Added ipsec API from:
> > - rte_ipsec.h
> > - rte_ipsec_sa.h
> > - rte_ipsec_group.h
> > - rte_ipsec_sad.h
> > 
> > Signed-off-by: Vladimir Medvedkin <vladimir.medvedkin@intel.com>
> > ---
> Acked-by: Akhil Goyal <akhil.goyal@nxp.com>
> 
> Applied to dpdk-next-crypto

I am moving the index entries in the "layers" section with other protocols,
while pulling this.

Patch
diff mbox series

diff --git a/doc/api/doxy-api-index.md b/doc/api/doxy-api-index.md
index 6c2d888..d19ffdf 100644
--- a/doc/api/doxy-api-index.md
+++ b/doc/api/doxy-api-index.md
@@ -132,6 +132,12 @@  The public API headers are grouped by topics:
   [tailq]              (@ref rte_tailq.h),
   [bitmap]             (@ref rte_bitmap.h)
 
+- **ipsec**:
+  [ipsec]              (@ref rte_ipsec.h),
+  [ipsec_sa]           (@ref rte_ipsec_sa.h),
+  [ipsec_group]        (@ref rte_ipsec_group.h),
+  [ipsec_sad]          (@ref rte_ipsec_sad.h)
+
 - **packet framework**:
   * [port]             (@ref rte_port.h):
     [ethdev]           (@ref rte_port_ethdev.h),
diff --git a/doc/api/doxy-api.conf.in b/doc/api/doxy-api.conf.in
index 908cee8..d8dafb2 100644
--- a/doc/api/doxy-api.conf.in
+++ b/doc/api/doxy-api.conf.in
@@ -35,6 +35,7 @@  INPUT                   = @TOPDIR@/doc/api/doxy-api-index.md \
                           @TOPDIR@/lib/librte_gso \
                           @TOPDIR@/lib/librte_hash \
                           @TOPDIR@/lib/librte_ip_frag \
+                          @TOPDIR@/lib/librte_ipsec \
                           @TOPDIR@/lib/librte_jobstats \
                           @TOPDIR@/lib/librte_kni \
                           @TOPDIR@/lib/librte_kvargs \