54456cc698
The inner-xxx-targets in the buildroot package infrastructures are
evaluated using $(eval) which causes variable references to be a bit
different than in regular make code. As we want most references to be
expanded only at the time of the $(eval) we should not use standard
references $(VAR) but rather use double dollar signs $$(VAR). This includes
function references like $(call), $(subst), etc. The only exception is the
reference to pkgdir/pkgname and numbered variables, which are parameters to
the inner block: $(1), $(2), etc.
This patch introduces consistent usage of double-dollar signs throughout the
different inner-xxx-targets blocks.
In some cases, this would potentially cause circular references, in
particular when the value of HOST_FOO_VAR would be obtained from the
corresponding FOO_VAR if HOST_FOO_VAR is not defined. In these cases, a test
is added to check for a host package (the only case where such constructions
are relevant; these are not circular).
Benefits of these changes are:
- behavior of variables is now again as expected. For example, setting
$(2)_VERSION = virtual in pkg-virtual.mk will effectively work, while
originally it would cause very odd results.
- The output of 'make printvars' is now much more useful. This target shows
the value of all variables, and the expression that led to that value.
However, if the expression was coming from an inner-xxx-targets block, and
was using single dollar signs, it would show in printvars as
VAR = value (value)
while if double dollar signs are used, it would effectively look like
VAR = value (actual expression)
as is intended.
This improvement is for example effective for FOO_DL_VERSION, FOO_RAWNAME,
FOO_SITE_METHOD and FOO_MAKE.
The correctness of this patch has been verified using 'make printvars',
'make manual' and 'make legal-info' before and after applying this patch,
and comparing the output.
Insight-provided-by: Arnout Vandecappelle <arnout@mind.be>
Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
94 lines
3.7 KiB
Makefile
94 lines
3.7 KiB
Makefile
# 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
|
|
$(Q)$(call MESSAGE,"Updating the manual lists...")
|
|
$(Q)BR2_DEFCONFIG="" TOPDIR=$(TOPDIR) O=$(O)/docs/manual/.build \
|
|
BR2_EXTERNAL=$(TOPDIR)/support/dummy-external \
|
|
python -B $(TOPDIR)/support/scripts/gen-manual-lists.py
|
|
|
|
# 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):
|
|
|
|
$$(O)/docs/$(1)/$(1).$(4): docs/$(1)/$(1).txt \
|
|
$$($$(call UPPERCASE,$(1))_SOURCES) \
|
|
manual-check-dependencies \
|
|
manual-check-dependencies-$(3) \
|
|
manual-update-lists
|
|
$$(Q)$$(call MESSAGE,"Generating $(5) $(1)...")
|
|
$$(Q)mkdir -p $$(@D)/.build
|
|
$$(Q)rsync -au docs/$(1)/*.txt $$(@D)/.build
|
|
$$(Q)a2x $(6) -f $(2) -d book -L -r $$(TOPDIR)/docs/images \
|
|
-D $$(@D) $$(@D)/.build/$(1).txt
|
|
-$$(Q)rm -rf $$(@D)/.build
|
|
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,$(1),xhtml,html,html,HTML,--xsltproc-opts "--stringparam toc.section.depth 2")
|
|
$(call GENDOC_INNER,$(1),chunked,split-html,chunked,split HTML,--xsltproc-opts "--stringparam toc.section.depth 2")
|
|
$(call GENDOC_INNER,$(1),pdf,pdf,pdf,PDF,--dblatex-opts "-P latex.output.revhistory=0")
|
|
$(call GENDOC_INNER,$(1),text,text,text,text)
|
|
$(call GENDOC_INNER,$(1),epub,epub,epub,ePUB)
|
|
clean: $(1)-clean
|
|
$(1)-clean:
|
|
$$(Q)$$(RM) -rf $$(O)/docs/$(1)
|
|
.PHONY: $(1) $(1)-clean manual-update-lists
|
|
endef
|
|
|
|
MANUAL_SOURCES = $(sort $(wildcard docs/manual/*.txt) $(wildcard docs/images/*))
|
|
$(eval $(call GENDOC,manual))
|