From a6090630f4e5583f6057993a792bc21df0d0bfed Mon Sep 17 00:00:00 2001 From: Ferruh Yigit Date: Wed, 8 Feb 2017 17:54:55 +0000 Subject: [PATCH] doc: automate examples file list for API These files are linked to API documentation as usage samples, list of files created automatically during doc creation. Remove manually updated old one. Signed-off-by: Ferruh Yigit Acked-by: Thomas Monjalon --- doc/api/doxy-api.conf | 1 - doc/api/examples.dox | 115 ------------------------------------------ mk/rte.sdkdoc.mk | 12 ++++- 3 files changed, 11 insertions(+), 117 deletions(-) delete mode 100644 doc/api/examples.dox diff --git a/doc/api/doxy-api.conf b/doc/api/doxy-api.conf index b8a5fd87cf..fdcf13c76f 100644 --- a/doc/api/doxy-api.conf +++ b/doc/api/doxy-api.conf @@ -30,7 +30,6 @@ PROJECT_NAME = DPDK INPUT = doc/api/doxy-api-index.md \ - doc/api/examples.dox \ drivers/net/bonding \ drivers/net/i40e \ drivers/net/ixgbe \ diff --git a/doc/api/examples.dox b/doc/api/examples.dox deleted file mode 100644 index 9a48f5f445..0000000000 --- a/doc/api/examples.dox +++ /dev/null @@ -1,115 +0,0 @@ -/** -@page examples DPDK Example Programs - -@example bond/main.c -@example cmdline/commands.c -@example cmdline/main.c -@example cmdline/parse_obj_list.c -@example distributor/main.c -@example dpdk_qat/crypto.c -@example dpdk_qat/main.c -@example ethtool/ethtool-app/ethapp.c -@example ethtool/ethtool-app/main.c -@example ethtool/lib/rte_ethtool.c -@example exception_path/main.c -@example helloworld/main.c -@example ip_fragmentation/main.c -@example ip_pipeline/config_check.c -@example ip_pipeline/config_parse.c -@example ip_pipeline/config_parse_tm.c -@example ip_pipeline/cpu_core_map.c -@example ip_pipeline/init.c -@example ip_pipeline/main.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 -@example ip_pipeline/pipeline/pipeline_firewall.c -@example ip_pipeline/pipeline/pipeline_flow_actions_be.c -@example ip_pipeline/pipeline/pipeline_flow_actions.c -@example ip_pipeline/pipeline/pipeline_flow_classification_be.c -@example ip_pipeline/pipeline/pipeline_flow_classification.c -@example ip_pipeline/pipeline/pipeline_master_be.c -@example ip_pipeline/pipeline/pipeline_master.c -@example ip_pipeline/pipeline/pipeline_passthrough_be.c -@example ip_pipeline/pipeline/pipeline_passthrough.c -@example ip_pipeline/pipeline/pipeline_routing_be.c -@example ip_pipeline/pipeline/pipeline_routing.c -@example ip_pipeline/thread.c -@example ip_pipeline/thread_fe.c -@example ip_reassembly/main.c -@example ipv4_multicast/main.c -@example kni/main.c -@example l2fwd-crypto/main.c -@example l2fwd-jobstats/main.c -@example l2fwd-keepalive/main.c -@example l2fwd/main.c -@example l3fwd-acl/main.c -@example l3fwd/main.c -@example l3fwd-power/main.c -@example l3fwd-vf/main.c -@example link_status_interrupt/main.c -@example load_balancer/config.c -@example load_balancer/init.c -@example load_balancer/main.c -@example load_balancer/runtime.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 -@example multi_process/client_server_mp/mp_server/main.c -@example multi_process/l2fwd_fork/flib.c -@example multi_process/l2fwd_fork/main.c -@example multi_process/simple_mp/main.c -@example multi_process/simple_mp/mp_commands.c -@example multi_process/symmetric_mp/main.c -@example netmap_compat/bridge/bridge.c -@example netmap_compat/lib/compat_netmap.c -@example packet_ordering/main.c -@example performance-thread/common/arch/x86/ctx.c -@example performance-thread/common/lthread.c -@example performance-thread/common/lthread_cond.c -@example performance-thread/common/lthread_diag.c -@example performance-thread/common/lthread_mutex.c -@example performance-thread/common/lthread_sched.c -@example performance-thread/common/lthread_tls.c -@example performance-thread/l3fwd-thread/main.c -@example performance-thread/pthread_shim/main.c -@example performance-thread/pthread_shim/pthread_shim.c -@example ptpclient/ptpclient.c -@example qos_meter/main.c -@example qos_meter/rte_policer.c -@example qos_sched/app_thread.c -@example qos_sched/args.c -@example qos_sched/cfg_file.c -@example qos_sched/cmdline.c -@example qos_sched/init.c -@example qos_sched/main.c -@example qos_sched/stats.c -@example quota_watermark/qw/args.c -@example quota_watermark/qwctl/commands.c -@example quota_watermark/qwctl/qwctl.c -@example quota_watermark/qw/init.c -@example quota_watermark/qw/main.c -@example rxtx_callbacks/main.c -@example server_node_efd/server/args.c -@example server_node_efd/server/init.c -@example server_node_efd/server/main.c -@example server_node_efd/node/node.c -@example skeleton/basicfwd.c -@example tep_termination/main.c -@example tep_termination/vxlan.c -@example tep_termination/vxlan_setup.c -@example timer/main.c -@example vhost/main.c -@example vhost_xen/main.c -@example vhost_xen/vhost_monitor.c -@example vhost_xen/xenstore_parse.c -@example vmdq_dcb/main.c -@example vmdq/main.c -@example vm_power_manager/channel_manager.c -@example vm_power_manager/channel_monitor.c -@example vm_power_manager/guest_cli/main.c -@example vm_power_manager/guest_cli/vm_power_cli_guest.c -@example vm_power_manager/main.c -@example vm_power_manager/power_manager.c -@example vm_power_manager/vm_power_cli.c -*/ diff --git a/mk/rte.sdkdoc.mk b/mk/rte.sdkdoc.mk index 21d9bdf2aa..39c67a9261 100644 --- a/mk/rte.sdkdoc.mk +++ b/mk/rte.sdkdoc.mk @@ -54,6 +54,8 @@ RTE_PDF_DPI ?= 300 RTE_GUIDES := $(filter %/, $(wildcard $(RTE_SDK)/doc/guides/*/)) +API_EXAMPLES := $(RTE_OUTPUT)/doc/html/examples.dox + .PHONY: help help: @cat $(RTE_SDK)/doc/build-sdk-quick.txt @@ -66,12 +68,13 @@ all: api-html guides-html guides-pdf clean: api-html-clean guides-html-clean guides-pdf-clean guides-man-clean .PHONY: api-html -api-html: api-html-clean +api-html: api-html-clean $(API_EXAMPLES) @echo 'doxygen for API...' $(Q)mkdir -p $(RTE_OUTPUT)/doc/html $(Q)(cat $(RTE_SDK)/doc/api/doxy-api.conf && \ printf 'PROJECT_NUMBER = ' && \ $(MAKE) -rR showversion && \ + echo INPUT += $(API_EXAMPLES) && \ echo OUTPUT_DIRECTORY = $(RTE_OUTPUT)/doc && \ echo HTML_OUTPUT = html/api && \ echo GENERATE_HTML = YES && \ @@ -85,6 +88,13 @@ api-html-clean: $(Q)rm -f $(RTE_OUTPUT)/doc/html/api/* $(Q)rmdir -p --ignore-fail-on-non-empty $(RTE_OUTPUT)/doc/html/api 2>&- || true +$(API_EXAMPLES): + $(Q)mkdir -p $(RTE_OUTPUT)/doc/html + @printf '/**\n' > $(API_EXAMPLES) + @printf '@page examples DPDK Example Programs\n\n' >> $(API_EXAMPLES) + @find examples -type f -name '*.c' -printf '@example %p\n' >> $(API_EXAMPLES) + @printf '*/\n' >> $(API_EXAMPLES) + guides-pdf-clean: guides-pdf-img-clean guides-pdf-img-clean: $(Q)rm -f $(RTE_SDK)/doc/guides/*/img/*.pdf -- 2.20.1