d/numam-dpdk
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

mk: use script to generate examples.dox

Browse Source 
This will make it possible to generate the file in the same way from
Meson as well.

Signed-off-by: Luca Boccassi <bluca@debian.org>
Acked-by: Bruce Richardson <bruce.richardson@intel.com>
This commit is contained in:
Luca Boccassi 2018-09-11 21:42:33 +01:00 committed by Thomas Monjalon
parent 77a5e7cdb2
commit 8260f4f98c
2 changed files with 13 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
doc/api/generate_examples.sh Executable file
View File

@ -0,0 +1,12 @@
#! /bin/sh -e
# SPDX-License-Identifier: BSD-3-Clause
# Copyright 2018 Luca Boccassi <bluca@debian.org>
EXAMPLES_DIR=$1
API_EXAMPLES=$2
exec > "${API_EXAMPLES}"
printf '/**\n'
printf '@page examples DPDK Example Programs\n\n'
find "${EXAMPLES_DIR}" -type f -name '*.c' -printf '@example examples/%P\n' | LC_ALL=C sort
printf '*/\n'

5
mk/rte.sdkdoc.mk
View File

@ -63,10 +63,7 @@ api-html-clean:
$(API_EXAMPLES): api-html-clean
$(Q)mkdir -p $(@D)
@printf '/**\n' > $(API_EXAMPLES)
@printf '@page examples DPDK Example Programs\n\n' >> $(API_EXAMPLES)
@find examples -type f -name '*.c' -printf '@example %p\n' | LC_ALL=C sort >> $(API_EXAMPLES)
@printf '*/\n' >> $(API_EXAMPLES)
$(Q)doc/api/generate_examples.sh examples $(API_EXAMPLES)
guides-pdf-clean: guides-pdf-img-clean
guides-pdf-img-clean: