[dpdk-dev] [PATCH] mk: build examples list before each doxygen run

[dpdk-dev] [PATCH] mk: build examples list before each doxygen run

[Thomas Monjalon]

The file examples.dox was not re-generated when a file
is added or removed from examples/.
It is now removed on clean operation.
The ordering of operations (clean before generation) is also
better defined.

Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com>
---
 mk/rte.sdkdoc.mk | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

diff --git a/mk/rte.sdkdoc.mk b/mk/rte.sdkdoc.mk
index 39c67a9..fb8f915 100644
--- a/mk/rte.sdkdoc.mk
+++ b/mk/rte.sdkdoc.mk
@@ -68,7 +68,7 @@ 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_EXAMPLES)
+api-html: $(API_EXAMPLES)
 	@echo 'doxygen for API...'
 	$(Q)mkdir -p $(RTE_OUTPUT)/doc/html
 	$(Q)(cat $(RTE_SDK)/doc/api/doxy-api.conf     && \
@@ -85,11 +85,12 @@ api-html: api-html-clean $(API_EXAMPLES)
 
 .PHONY: api-html-clean
 api-html-clean:
+	$(Q)rm -f $(API_EXAMPLES)
 	$(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
+$(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' >> $(API_EXAMPLES)
-- 
2.7.0

Re: [dpdk-dev] [PATCH] mk: build examples list before each doxygen run

[Thomas Monjalon]

2017-04-06 14:57, Thomas Monjalon:
> The file examples.dox was not re-generated when a file
> is added or removed from examples/.
> It is now removed on clean operation.
> The ordering of operations (clean before generation) is also
> better defined.
> 
> Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com>

Applied quickly, it is required to avoid a doxygen error
when merging the next-crypto tree.