7b118dfb4b
This patch reworks the manual source preparation by: - moving the build directory under $(BUILD_DIR)/, this keeps consistency with the other Buildroot infrastructures; - adding a couple of targets: 'manual-rsync' and 'manual-prepare-sources', to deal more efficiently with the manual sources and avoid rsync-ing them on every single manual-* target. The 'manual-rsync' target only copies the manual sources under git, while the 'manual-prepare-sources' also takes care of the generated ones. These targets are now run only once, and the manual build is no longer cleaned after each manual format generation. Now, the 'manual-clean' target only remove the manual build directory, but keeps the output one $(O)/output/doc/manual unchanged. Doing so (moving the manual build directory and keeping it between 2 manual format generation) ensures that all generated sources are taken in account when generating the manual [1]. [1] http://lists.busybox.net/pipermail/buildroot/2014-August/104421.html Cc: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Signed-off-by: Samuel Martin <s.martin49@gmail.com> [yann.morin.1998@free.fr: moved into $(BUILD_DIR)/docs/manual as per Thomas P. suggestion] Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
111 lines
4.3 KiB
Makefile
111 lines
4.3 KiB
Makefile
$(BUILD_DIR)/docs/$(pkgname):
|
|
$(Q)mkdir -p $@
|
|
|
|
manual-rsync: $(BUILD_DIR)/docs/$(pkgname)
|
|
$(Q)$(call MESSAGE,"Preparing the manual sources...")
|
|
$(Q)rsync -a docs/$(pkgname)/ $(BUILD_DIR)/docs/$(pkgname)
|
|
|
|
# Packages included in BR2_EXTERNAL are not part of buildroot, so they
|
|
# should not be included in the manual.
|
|
manual-update-lists: manual-check-dependencies-lists $(BUILD_DIR)/docs/$(pkgname)
|
|
$(Q)$(call MESSAGE,"Updating the manual lists...")
|
|
$(Q)BR2_DEFCONFIG="" TOPDIR=$(TOPDIR) O=$(BUILD_DIR)/docs/$(pkgname) \
|
|
BR2_EXTERNAL=$(TOPDIR)/support/dummy-external \
|
|
python -B $(TOPDIR)/support/scripts/gen-manual-lists.py
|
|
|
|
manual-prepare-sources: manual-rsync manual-update-lists
|
|
|
|
# we can't use suitable-host-package here because that's not available in
|
|
# the context of 'make release'
|
|
manual-check-dependencies:
|
|
$(Q)if [ -z "$(shell support/dependencies/check-host-asciidoc.sh)" ]; then \
|
|
echo "You need a sufficiently recent asciidoc on your host" \
|
|
"to generate the manual"; \
|
|
exit 1; \
|
|
fi
|
|
$(Q)if [ -z "`which w3m 2>/dev/null`" ]; then \
|
|
echo "You need w3m on your host to generate the manual"; \
|
|
exit 1; \
|
|
fi
|
|
|
|
manual-check-dependencies-pdf:
|
|
$(Q)if [ -z "`which dblatex 2>/dev/null`" ]; then \
|
|
echo "You need dblatex on your host to generate the pdf manual"; \
|
|
exit 1; \
|
|
fi
|
|
|
|
manual-check-dependencies-lists:
|
|
$(Q)if ! python -c "import argparse" >/dev/null 2>&1 ; then \
|
|
echo "You need python with argparse on your host to generate" \
|
|
"the list of packages in the manual"; \
|
|
exit 1; \
|
|
fi
|
|
|
|
################################################################################
|
|
# GENDOC_INNER -- generates the make targets needed to build a specific type of
|
|
# asciidoc documentation.
|
|
#
|
|
# argument 1 is the name of the document and must be a subdirectory of docs/;
|
|
# the top-level asciidoc file must have the same name
|
|
# argument 2 is the type of document to generate (-f argument of a2x)
|
|
# argument 3 is the document type as used in the make target
|
|
# argument 4 is the output file extension for the document type
|
|
# argument 5 is the human text for the document type
|
|
# argument 6 (optional) are extra arguments for a2x
|
|
#
|
|
# The variable <DOCUMENT_NAME>_SOURCES defines the dependencies.
|
|
#
|
|
# Since this function will be called from within an $(eval ...)
|
|
# all variable references except the arguments must be $$-quoted.
|
|
################################################################################
|
|
define GENDOC_INNER
|
|
$(1): $(1)-$(3)
|
|
.PHONY: $(1)-$(3)
|
|
$(1)-$(3): $$(O)/docs/$(1)/$(1).$(4)
|
|
|
|
manual-check-dependencies-$(3):
|
|
|
|
MANUAL_$(2)_ASCIIDOC_CONF = docs/$(1)/asciidoc-$(2).conf
|
|
ifneq ($$(wildcard $$(MANUAL_$(2)_ASCIIDOC_CONF)),)
|
|
MANUAL_$(2)_ASCIIDOC_OPTS += -f $$(MANUAL_$(2)_ASCIIDOC_CONF)
|
|
endif
|
|
|
|
$$(O)/docs/$(1)/$(1).$(4): docs/$(1)/$(1).txt \
|
|
$$($$(call UPPERCASE,$(1))_SOURCES) \
|
|
manual-check-dependencies \
|
|
manual-check-dependencies-$(3) \
|
|
manual-prepare-sources
|
|
$$(Q)$$(call MESSAGE,"Generating $(5) $(1)...")
|
|
$$(Q)mkdir -p $$(@D)
|
|
$$(Q)a2x $(6) -f $(2) -d book -L -r $$(TOPDIR)/docs/images \
|
|
--asciidoc-opts="$$(MANUAL_$(2)_ASCIIDOC_OPTS)" \
|
|
-D $$(@D) \
|
|
$$(BUILD_DIR)/docs/$(1)/$(1).txt
|
|
endef
|
|
|
|
################################################################################
|
|
# GENDOC -- generates the make targets needed to build asciidoc documentation.
|
|
#
|
|
# argument 1 is the name of the document and must be a subdirectory of docs/;
|
|
# the top-level asciidoc file must have the same name
|
|
#
|
|
# The variable <DOCUMENT_NAME>_SOURCES defines the dependencies.
|
|
################################################################################
|
|
define GENDOC
|
|
$(call GENDOC_INNER,$(pkgname),xhtml,html,html,HTML,\
|
|
--xsltproc-opts "--stringparam toc.section.depth 1")
|
|
$(call GENDOC_INNER,$(pkgname),chunked,split-html,chunked,split HTML,\
|
|
--xsltproc-opts "--stringparam toc.section.depth 1")
|
|
$(call GENDOC_INNER,$(pkgname),pdf,pdf,pdf,PDF,\
|
|
--dblatex-opts "-P latex.output.revhistory=0")
|
|
$(call GENDOC_INNER,$(pkgname),text,text,text,text)
|
|
$(call GENDOC_INNER,$(pkgname),epub,epub,epub,ePUB)
|
|
clean: $(pkgname)-clean
|
|
$(pkgname)-clean:
|
|
$$(Q)$$(RM) -rf $$(BUILD_DIR)/docs/$(pkgname)
|
|
.PHONY: $(pkgname) $(pkgname)-clean manual-update-lists
|
|
endef
|
|
|
|
MANUAL_SOURCES = $(sort $(wildcard docs/manual/*.txt) $(wildcard docs/images/*))
|
|
$(eval $(call GENDOC))
|