Skip to content

Commit 43187e2

Browse files
marc-hbnashif
authored andcommitted
doc Makefile: convert to a real Makefile to get rid of duplication
Zero user interface or functional change. Also change undocumented cmake -H option to documented -S https://stackoverflow.com/questions/31090821/what-does-the-h-option-means-for-cmake Signed-off-by: Marc Herbert <[email protected]>
1 parent 2fd1d3c commit 43187e2

File tree

1 file changed

+13
-8
lines changed

1 file changed

+13
-8
lines changed

Makefile

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,20 +5,25 @@
55
BUILDDIR ?= doc/_build
66
DOC_TAG ?= development
77
SPHINXOPTS ?= -q
8+
KCONFIG_TURBO_MODE ?= 0
89

910
# Documentation targets
1011
# ---------------------------------------------------------------------------
1112
clean:
1213
rm -rf ${BUILDDIR}
1314

14-
htmldocs:
15-
mkdir -p ${BUILDDIR} && cmake -GNinja -DDOC_TAG=${DOC_TAG} -DSPHINXOPTS=${SPHINXOPTS} -B${BUILDDIR} -Hdoc/ && ninja -C ${BUILDDIR} htmldocs
16-
1715
htmldocs-fast:
18-
mkdir -p ${BUILDDIR} && cmake -GNinja -DKCONFIG_TURBO_MODE=1 -DDOC_TAG=${DOC_TAG} -DSPHINXOPTS=${SPHINXOPTS} -B${BUILDDIR} -Hdoc/ && ninja -C ${BUILDDIR} htmldocs
16+
${MAKE} htmldocs KCONFIG_TURBO_MODE=1
17+
18+
htmldocs pdfdocs doxygen: configure
19+
cmake --build ${BUILDDIR} -- $@ # -v # VERBOSE=1
1920

20-
pdfdocs:
21-
mkdir -p ${BUILDDIR} && cmake -GNinja -DDOC_TAG=${DOC_TAG} -DSPHINXOPTS=${SPHINXOPTS} -B${BUILDDIR} -Hdoc/ && ninja -C ${BUILDDIR} pdfdocs
21+
# Run CMake every time cause it's quick and re-configures TURBO_MODE if
22+
# needed
23+
.PHONY: configure
24+
configure:
25+
cmake -GNinja -B${BUILDDIR} -Sdoc/ -DDOC_TAG=${DOC_TAG} \
26+
-DSPHINXOPTS=${SPHINXOPTS} \
27+
-DKCONFIG_TURBO_MODE=${KCONFIG_TURBO_MODE}
2228

23-
doxygen:
24-
mkdir -p ${BUILDDIR} && cmake -GNinja -DDOC_TAG=${DOC_TAG} -DSPHINXOPTS=${SPHINXOPTS} -B${BUILDDIR} -Hdoc/ && ninja -C ${BUILDDIR} doxygen
29+
.PHONY: clean htmldocs htmldocs-fast pdfdocs doxygen

0 commit comments

Comments
 (0)