From: Ferruh Yigit <ferruh.yigit@intel.com>
To: John McNamara <john.mcnamara@intel.com>
Cc: dev@dpdk.org, Ferruh Yigit <ferruh.yigit@intel.com>
Subject: [dpdk-dev] [PATCH] doc: update examples list for API
Date: Fri, 27 Jan 2017 11:55:41 +0000 [thread overview]
Message-ID: <20170127115541.5472-1-ferruh.yigit@intel.com> (raw)
These files are linked to API documentation as usage samples, added
missing examples files and sorted list alphabetically.
Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>
---
doc/api/examples.dox | 23 +++++++++++++++++++----
1 file changed, 19 insertions(+), 4 deletions(-)
diff --git a/doc/api/examples.dox b/doc/api/examples.dox
index c13e574..2d6b65b 100644
--- a/doc/api/examples.dox
+++ b/doc/api/examples.dox
@@ -12,6 +12,10 @@
@example ethtool/ethtool-app/main.c
@example ethtool/lib/rte_ethtool.c
@example exception_path/main.c
+@example flow_distributor/distributor/args.c
+@example flow_distributor/distributor/init.c
+@example flow_distributor/distributor/main.c
+@example flow_distributor/node/node.c
@example helloworld/main.c
@example ip_fragmentation/main.c
@example ip_pipeline/config_check.c
@@ -20,6 +24,7 @@
@example ip_pipeline/cpu_core_map.c
@example ip_pipeline/init.c
@example ip_pipeline/main.c
+@example ip_pipeline/parser.c
@example ip_pipeline/pipeline/pipeline_common_be.c
@example ip_pipeline/pipeline/pipeline_common_fe.c
@example ip_pipeline/pipeline/pipeline_firewall_be.c
@@ -37,13 +42,27 @@
@example ip_pipeline/thread.c
@example ip_pipeline/thread_fe.c
@example ip_reassembly/main.c
+@example ipsec-secgw/esp.c
+@example ipsec-secgw/ipsec.c
+@example ipsec-secgw/ipsec-secgw.c
+@example ipsec-secgw/parser.c
+@example ipsec-secgw/rt.c
+@example ipsec-secgw/sa.c
+@example ipsec-secgw/sp4.c
+@example ipsec-secgw/sp6.c
@example ipv4_multicast/main.c
@example kni/main.c
+@example l2fwd-cat/cat.c
+@example l2fwd-cat/l2fwd-cat.c
@example l2fwd-crypto/main.c
@example l2fwd-jobstats/main.c
+@example l2fwd-keepalive/ka-agent/main.c
@example l2fwd-keepalive/main.c
+@example l2fwd-keepalive/shm.c
@example l2fwd/main.c
@example l3fwd-acl/main.c
+@example l3fwd/l3fwd_em.c
+@example l3fwd/l3fwd_lpm.c
@example l3fwd/main.c
@example l3fwd-power/main.c
@example l3fwd-vf/main.c
@@ -52,10 +71,6 @@
@example load_balancer/init.c
@example load_balancer/main.c
@example load_balancer/runtime.c
-@example flow_distributor/distributor/args.c
-@example flow_distributor/distributor/init.c
-@example flow_distributor/distributor/main.c
-@example flow_distributor/node/node.c
@example multi_process/client_server_mp/mp_client/client.c
@example multi_process/client_server_mp/mp_server/args.c
@example multi_process/client_server_mp/mp_server/init.c
--
2.9.3
next reply other threads:[~2017-01-27 11:55 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-01-27 11:55 Ferruh Yigit [this message]
2017-01-27 13:11 ` De Lara Guarch, Pablo
2017-01-27 15:56 ` Thomas Monjalon
2017-01-27 17:03 ` Ferruh Yigit
2017-01-27 17:37 ` [dpdk-dev] [PATCH v2] doc: automate examples file list for API doc Ferruh Yigit
2017-02-08 12:08 ` Thomas Monjalon
2017-02-08 17:35 ` Ferruh Yigit
2017-02-08 17:54 ` [dpdk-dev] [PATCH v3] " Ferruh Yigit
2017-02-08 18:12 ` 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=20170127115541.5472-1-ferruh.yigit@intel.com \
--to=ferruh.yigit@intel.com \
--cc=dev@dpdk.org \
--cc=john.mcnamara@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).