diff mbox

[dpdk-dev] doc: update examples list for API

Message ID 20170127115541.5472-1-ferruh.yigit@intel.com (mailing list archive)
State Superseded, archived
Headers

Checks

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

Commit Message

Ferruh Yigit Jan. 27, 2017, 11:55 a.m. UTC 
  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(-)

Comments

De Lara Guarch, Pablo Jan. 27, 2017, 1:11 p.m. UTC | #1 
Hi Ferruh,

> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Ferruh Yigit
> Sent: Friday, January 27, 2017 11:56 AM
> To: Mcnamara, John
> Cc: dev@dpdk.org; Yigit, Ferruh
> Subject: [dpdk-dev] [PATCH] doc: update examples list for API
> 
> 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

I am renaming this sample app in this patch (http://dpdk.org/dev/patchwork/patch/19931/)
and I am moving the new sample files in the right order.

Thanks,
Pablo
Thomas Monjalon Jan. 27, 2017, 3:56 p.m. UTC | #2 
2017-01-27 11:55, Ferruh Yigit:
> 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>

Why not replacing this list with a "find examples -type f" in mk/rte.sdkdoc.mk?
Ferruh Yigit Jan. 27, 2017, 5:03 p.m. UTC | #3 
On 1/27/2017 3:56 PM, Thomas Monjalon wrote:
> 2017-01-27 11:55, Ferruh Yigit:
>> 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>
> 
> Why not replacing this list with a "find examples -type f" in mk/rte.sdkdoc.mk?

Yes it is good idea, I will try.
diff mbox

Patch

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