From 281c0d9fa86f1a51c920bd1c092510c68030e0f9 Mon Sep 17 00:00:00 2001 From: "David B. Kinder" Date: Mon, 17 Jun 2019 10:59:53 -0700 Subject: [PATCH] doc: tweak doxygen precondition label The doxygen-collected API information about function preconditions has a uninspired title of "pre". This change tweaks that to be "preconditions" in the generated HTML output by editing the generated xml output before it is processed by Sphinx/Breathe. Signed-off-by: David B. Kinder --- doc/Makefile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/Makefile b/doc/Makefile index 8adaf5b6e..558a04900 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -40,6 +40,7 @@ help: doxy: $(Q)(cat acrn.doxyfile) | doxygen - > doc.log 2>&1 + $(Q)find doxygen/xml/* | xargs sed -i 's/simplesect kind="pre"/simplesect kind="preconditions"/' content: $(Q)scripts/extract_content.py . tools @@ -51,7 +52,6 @@ kconfig: pullsource: $(Q)scripts/pullsource.sh - html: doxy content kconfig -$(Q)$(SPHINXBUILD) -t $(DOC_TAG) -b html -d $(BUILDDIR)/doctrees $(SOURCEDIR) $(BUILDDIR)/html $(SPHINXOPTS) $(OPTS) >> doc.log 2>&1 $(Q)./scripts/filter-doc-log.sh doc.log