DPDK patches and discussions
 help / color / mirror / Atom feed
From: Vladimir Medvedkin <vladimir.medvedkin@intel.com>
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
Date: Thu, 10 Oct 2019 17:52:14 +0100	[thread overview]
Message-ID: <8860a2903b705d2b3e697fe7b9b79064aacaccdf.1570726287.git.vladimir.medvedkin@intel.com> (raw)

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(+)

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 \
-- 
2.7.4


             reply	other threads:[~2019-10-10 16:52 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-10-10 16:52 Vladimir Medvedkin [this message]
2019-10-22  8:05 ` Akhil Goyal
2019-10-24  8:23   ` Thomas Monjalon

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:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

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

  git send-email \
    --in-reply-to=8860a2903b705d2b3e697fe7b9b79064aacaccdf.1570726287.git.vladimir.medvedkin@intel.com \
    --to=vladimir.medvedkin@intel.com \
    --cc=dev@dpdk.org \
    --cc=john.mcnamara@intel.com \
    --cc=konstantin.ananyev@intel.com \
    --cc=marko.kovacevic@intel.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).