NetCube-Systems-Austria/kumquat-buildroot
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

package/doc-asciidoc: fix build for out-of-tree documents

Browse Source 
The doc-asciidoc infra allows document to define sources and resources,
and those can only be local (there is no download support for documents).
The currently documented way to specify those is to use the $(pkgdir)
macro to point to the document sources and resources when they are along
the .mk.

However, this works only for sources and not for resources.

Indeed, sources are used to generate Makefile dependency rules, so
$(pkgdir) is expanded and evaluated during the call to $(doc-asciidoc),
while resources are expanded and evaluated when the rules are executed,
which always happen after all the parsing has be done, at which point
$(pkgdir) expands to the last Makefile that was parsed, which is always
Buildroot's own manual.

This went unnoticed so far because Buildroot's manual is 1) the last to
be parsed, and 2) not using $(pkgdir) anyway.

Additionally, $(pkgdir) is mostly an internal macro, that is, as this
change demonstrates, difficult to use, and thus should not be used, in
packages or in documents.

We fix that by introducing $(FOO_DOCDIR), similar to $(FOO_PKGDIR),
which points to the document directory. We choose not to name the
variable FOO_PKGDIR, because it semantically is not a package.

As a consequence, the last argument to the doc-asciidoc macro is now
superfluous, so it is removed, which causes a little bit of churn in
the main macro. As a further consequence, the third argument in the
inner macro is no longer needed either, so it too is removed, which
causes a bit more churn yet in the inner macro.

Signed-off-by: Yann E. MORIN <yann.morin@orange.com>
Cc: Frederic GARDES <frederic.gardes@orange.com>
Signed-off-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be>
This commit is contained in:
Yann E. MORIN 2022-02-01 14:49:44 +01:00 committed by Arnout Vandecappelle (Essensium/Mind)
parent 4c2e266817
commit 4f59ababc0
2 changed files with 59 additions and 48 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
docs/manual/adding-packages-asciidoc.txt
View File

@ -39,7 +39,7 @@ Here is an example to render a simple AsciiDoc document.
04: # 04: #
05: ################################################################################ 05: ################################################################################
06: 06:
07: FOO_SOURCES = $(sort $(wildcard $(pkgdir)/*)) 07: FOO_SOURCES = $(sort $(wildcard $(FOO_DOCDIR)/*))
08: $(eval $(call asciidoc-document)) 08: $(eval $(call asciidoc-document))
---- ----
@ -85,6 +85,17 @@ various steps:
* +FOO_CHECK_DEPENDENCIES_<FMT>_HOOKS+, to run additional tests for * +FOO_CHECK_DEPENDENCIES_<FMT>_HOOKS+, to run additional tests for
the specified format +<FMT>+ (see the list of rendered formats, above). the specified format +<FMT>+ (see the list of rendered formats, above).
Buildroot sets the following variable that can be used in the definitions
above:
* +$(FOO_DOCDIR)+, similar to +$(FOO_PKGDIR)+, contains the path to the
directory containing +foo.mk+. It can be used to refer to the document
sources, and can be used in the hooks, especially the post-rsync hook
if parts of the documentation needs to be generated.
* +$(@D)+, as for traditional packages, contains the path to the directory
where the document will be copied and built.
Here is a complete example that uses all variables and all hooks: Here is a complete example that uses all variables and all hooks:
---- ----
@ -94,8 +105,8 @@ Here is a complete example that uses all variables and all hooks:
04: # 04: #
05: ################################################################################ 05: ################################################################################
06: 06:
07: FOO_SOURCES = $(sort $(wildcard $(pkgdir)/*)) 07: FOO_SOURCES = $(sort $(wildcard $(FOO_DOCDIR)/*))
08: FOO_RESOURCES = $(sort $(wildcard $(pkgdir)/ressources)) 08: FOO_RESOURCES = $(sort $(wildcard $(FOO_DOCDIR)/ressources))
09: 09:
10: define FOO_GEN_EXTRA_DOC 10: define FOO_GEN_EXTRA_DOC
11: /path/to/generate-script --outdir=$(@D) 11: /path/to/generate-script --outdir=$(@D)

90
package/doc-asciidoc.mk
View File

@ -42,12 +42,11 @@ BR_ASCIIDOC_CONF = docs/conf/asciidoc.conf
# argument 1 is the name of the document and the top-level asciidoc file must # argument 1 is the name of the document and the top-level asciidoc file must
# have the same name # have the same name
# argument 2 is the uppercase name of the document # argument 2 is the uppercase name of the document
# argument 3 is the directory containing the document # argument 3 is the type of document to generate (-f argument of a2x)
# argument 4 is the type of document to generate (-f argument of a2x) # argument 4 is the document type as used in the make target
# argument 5 is the document type as used in the make target # argument 5 is the output file extension for the document type
# argument 6 is the output file extension for the document type # argument 6 is the human text for the document type
# argument 7 is the human text for the document type # argument 7 (optional) are extra arguments for a2x
# argument 8 (optional) are extra arguments for a2x
# #
# The variable <DOCUMENT_NAME>_SOURCES defines the dependencies. # The variable <DOCUMENT_NAME>_SOURCES defines the dependencies.
# #
@ -55,55 +54,55 @@ BR_ASCIIDOC_CONF = docs/conf/asciidoc.conf
# all variable references except the arguments must be $$-quoted. # all variable references except the arguments must be $$-quoted.
################################################################################ ################################################################################
define ASCIIDOC_INNER define ASCIIDOC_INNER
$(1): $(1)-$(5) $(1): $(1)-$(4)
.PHONY: $(1)-$(5) .PHONY: $(1)-$(4)
$(1)-$(5): $$(O)/docs/$(1)/$(1).$(6) $(1)-$(4): $$(O)/docs/$(1)/$(1).$(5)
asciidoc-check-dependencies-$(5): asciidoc-check-dependencies-$(4):
.PHONY: $(1)-check-dependencies-$(5) .PHONY: $(1)-check-dependencies-$(4)
# Single line, because splitting a foreach is not easy... # Single line, because splitting a foreach is not easy...
$(1)-check-dependencies-$(5): asciidoc-check-dependencies-$(5) $(1)-check-dependencies-$(4): asciidoc-check-dependencies-$(4)
$$(Q)$$(foreach hook,$$($(2)_CHECK_DEPENDENCIES_$$(call UPPERCASE,$(5))_HOOKS),$$(call $$(hook))$$(sep)) $$(Q)$$(foreach hook,$$($(2)_CHECK_DEPENDENCIES_$$(call UPPERCASE,$(4))_HOOKS),$$(call $$(hook))$$(sep))
# Include Buildroot's AsciiDoc configuration first: # Include Buildroot's AsciiDoc configuration first:
# - generic configuration, # - generic configuration,
# - then output-specific configuration # - then output-specific configuration
ifneq ($$(wildcard $$(BR_ASCIIDOC_CONF)),) ifneq ($$(wildcard $$(BR_ASCIIDOC_CONF)),)
$(2)_$(4)_ASCIIDOC_OPTS += -f $$(BR_ASCIIDOC_CONF) $(2)_$(3)_ASCIIDOC_OPTS += -f $$(BR_ASCIIDOC_CONF)
endif endif
BR_$(4)_ASCIIDOC_CONF = docs/conf/asciidoc-$(4).conf BR_$(3)_ASCIIDOC_CONF = docs/conf/asciidoc-$(3).conf
ifneq ($$(wildcard $$(BR_$(4)_ASCIIDOC_CONF)),) ifneq ($$(wildcard $$(BR_$(3)_ASCIIDOC_CONF)),)
$(2)_$(4)_ASCIIDOC_OPTS += -f $$(BR_$(4)_ASCIIDOC_CONF) $(2)_$(3)_ASCIIDOC_OPTS += -f $$(BR_$(3)_ASCIIDOC_CONF)
endif endif
# Then include the document's AsciiDoc configuration: # Then include the document's AsciiDoc configuration:
# - generic configuration, # - generic configuration,
# - then output-specific configuration # - then output-specific configuration
ifneq ($$(wildcard $$($(2)_ASCIIDOC_CONF)),) ifneq ($$(wildcard $$($(2)_ASCIIDOC_CONF)),)
$(2)_$(4)_ASCIIDOC_OPTS += -f $$($(2)_ASCIIDOC_CONF) $(2)_$(3)_ASCIIDOC_OPTS += -f $$($(2)_ASCIIDOC_CONF)
endif endif
$(2)_$(4)_ASCIIDOC_CONF = $(3)/asciidoc-$(4).conf $(2)_$(3)_ASCIIDOC_CONF = $$($(2)_DOCDIR)/asciidoc-$(3).conf
ifneq ($$(wildcard $$($(2)_$(4)_ASCIIDOC_CONF)),) ifneq ($$(wildcard $$($(2)_$(3)_ASCIIDOC_CONF)),)
$(2)_$(4)_ASCIIDOC_OPTS += -f $$($(2)_$(4)_ASCIIDOC_CONF) $(2)_$(3)_ASCIIDOC_OPTS += -f $$($(2)_$(3)_ASCIIDOC_CONF)
endif endif
# Handle a2x warning about --destination-dir option only applicable to HTML # Handle a2x warning about --destination-dir option only applicable to HTML
# based outputs. So: # based outputs. So:
# - use the --destination-dir option if possible (html and split-html), # - use the --destination-dir option if possible (html and split-html),
# - otherwise copy the generated document to the output directory # - otherwise copy the generated document to the output directory
$(2)_$(4)_A2X_OPTS = $(2)_$(3)_A2X_OPTS =
ifneq ($$(filter $(5),html split-html),) ifneq ($$(filter $(4),html split-html),)
$(2)_$(4)_A2X_OPTS += --destination-dir="$$(@D)" $(2)_$(3)_A2X_OPTS += --destination-dir="$$(@D)"
else else
define $(2)_$(4)_INSTALL_CMDS define $(2)_$(3)_INSTALL_CMDS
$$(Q)cp -f $$(BUILD_DIR)/docs/$(1)/$(1).$(6) $$(@D) $$(Q)cp -f $$(BUILD_DIR)/docs/$(1)/$(1).$(5) $$(@D)
endef endef
endif endif
$$(O)/docs/$(1)/$(1).$(6): export TZ=UTC $$(O)/docs/$(1)/$(1).$(5): export TZ=UTC
ifeq ($(6)-$$(GENDOC_XSLTPROC_IS_BROKEN),pdf-y) ifeq ($(5)-$$(GENDOC_XSLTPROC_IS_BROKEN),pdf-y)
$$(O)/docs/$(1)/$(1).$(6): $$(O)/docs/$(1)/$(1).$(5):
$$(warning PDF generation is disabled because of a bug in \ $$(warning PDF generation is disabled because of a bug in \
xsltproc. To be able to generate a PDF, you should \ xsltproc. To be able to generate a PDF, you should \
build xsltproc from the libxslt sources >=1.1.29 and pass it \ build xsltproc from the libxslt sources >=1.1.29 and pass it \
@ -112,20 +111,20 @@ $$(O)/docs/$(1)/$(1).$(6):
else else
# -r $(@D) is there for documents that use external filters; those filters # -r $(@D) is there for documents that use external filters; those filters
# generate code at the same location it finds the document's source files. # generate code at the same location it finds the document's source files.
$$(O)/docs/$(1)/$(1).$(6): $$($(2)_SOURCES) \ $$(O)/docs/$(1)/$(1).$(5): $$($(2)_SOURCES) \
$(1)-check-dependencies \ $(1)-check-dependencies \
$(1)-check-dependencies-$(5) \ $(1)-check-dependencies-$(4) \
$(1)-prepare-sources $(1)-prepare-sources
$$(Q)$$(call MESSAGE,"Generating $(7) $(1)...") $$(Q)$$(call MESSAGE,"Generating $(6) $(1)...")
$$(Q)mkdir -p $$(@D) $$(Q)mkdir -p $$(@D)
$$(Q)a2x $(8) -f $(4) -d book -L \ $$(Q)a2x $(7) -f $(3) -d book -L \
$$(foreach r,$$($(2)_RESOURCES) $$(@D), \ $$(foreach r,$$($(2)_RESOURCES) $$(@D), \
--resource="$$(abspath $$(r))") \ --resource="$$(abspath $$(r))") \
$$($(2)_$(4)_A2X_OPTS) \ $$($(2)_$(3)_A2X_OPTS) \
--asciidoc-opts="$$($(2)_$(4)_ASCIIDOC_OPTS)" \ --asciidoc-opts="$$($(2)_$(3)_ASCIIDOC_OPTS)" \
$$(BUILD_DIR)/docs/$(1)/$(1).txt $$(BUILD_DIR)/docs/$(1)/$(1).txt
# install the generated document # install the generated document
$$($(2)_$(4)_INSTALL_CMDS) $$($(2)_$(3)_INSTALL_CMDS)
endif endif
endef endef
@ -135,13 +134,14 @@ endef
# argument 1 is the lowercase name of the document; the document's main file # argument 1 is the lowercase name of the document; the document's main file
# must have the same name, with the .txt extension # must have the same name, with the .txt extension
# argument 2 is the uppercase name of the document # argument 2 is the uppercase name of the document
# argument 3 is the directory containing the document's sources
# #
# The variable <DOCUMENT_NAME>_SOURCES defines the dependencies. # The variable <DOCUMENT_NAME>_SOURCES defines the dependencies.
# The variable <DOCUMENT_NAME>_RESOURCES defines where the document's # The variable <DOCUMENT_NAME>_RESOURCES defines where the document's
# resources, such as images, are located; must be an absolute path. # resources, such as images, are located; must be an absolute path.
################################################################################ ################################################################################
define ASCIIDOC define ASCIIDOC
$(2)_DOCDIR = $(pkgdir)
# Single line, because splitting a foreach is not easy... # Single line, because splitting a foreach is not easy...
.PHONY: $(1)-check-dependencies .PHONY: $(1)-check-dependencies
$(1)-check-dependencies: asciidoc-check-dependencies $$($(2)_DEPENDENCIES) $(1)-check-dependencies: asciidoc-check-dependencies $$($(2)_DEPENDENCIES)
@ -153,29 +153,29 @@ $(1)-check-dependencies: asciidoc-check-dependencies $$($(2)_DEPENDENCIES)
$$(BUILD_DIR)/docs/$(1)/.stamp_doc_rsynced: $$(BUILD_DIR)/docs/$(1)/.stamp_doc_rsynced:
$$(Q)$$(call MESSAGE,"Preparing the $(1) sources...") $$(Q)$$(call MESSAGE,"Preparing the $(1) sources...")
$$(Q)mkdir -p $$(@D) $$(Q)mkdir -p $$(@D)
$$(Q)rsync -a $(3) $$(@D) $$(Q)rsync -a $$($(2)_DOCDIR) $$(@D)
$$(Q)$$(foreach hook,$$($(2)_POST_RSYNC_HOOKS),$$(call $$(hook))$$(sep)) $$(Q)$$(foreach hook,$$($(2)_POST_RSYNC_HOOKS),$$(call $$(hook))$$(sep))
.PHONY: $(1)-prepare-sources .PHONY: $(1)-prepare-sources
$(1)-prepare-sources: $$(BUILD_DIR)/docs/$(1)/.stamp_doc_rsynced $(1)-prepare-sources: $$(BUILD_DIR)/docs/$(1)/.stamp_doc_rsynced
$(2)_ASCIIDOC_CONF = $(3)/asciidoc.conf $(2)_ASCIIDOC_CONF = $$($(2)_DOCDIR)/asciidoc.conf
$(call ASCIIDOC_INNER,$(1),$(2),$(3),xhtml,html,html,HTML,\ $(call ASCIIDOC_INNER,$(1),$(2),xhtml,html,html,HTML,\
--xsltproc-opts "--stringparam toc.section.depth 1") --xsltproc-opts "--stringparam toc.section.depth 1")
$(call ASCIIDOC_INNER,$(1),$(2),$(3),chunked,split-html,chunked,split HTML,\ $(call ASCIIDOC_INNER,$(1),$(2),chunked,split-html,chunked,split HTML,\
--xsltproc-opts "--stringparam toc.section.depth 1") --xsltproc-opts "--stringparam toc.section.depth 1")
# dblatex needs to pass the '--maxvars ...' option to xsltproc to prevent it # dblatex needs to pass the '--maxvars ...' option to xsltproc to prevent it
# from reaching the template recursion limit when processing the (long) target # from reaching the template recursion limit when processing the (long) target
# package table and bailing out. # package table and bailing out.
$(call ASCIIDOC_INNER,$(1),$(2),$(3),pdf,pdf,pdf,PDF,\ $(call ASCIIDOC_INNER,$(1),$(2),pdf,pdf,pdf,PDF,\
--dblatex-opts "-P latex.output.revhistory=0 -x '--maxvars 100000'") --dblatex-opts "-P latex.output.revhistory=0 -x '--maxvars 100000'")
$(call ASCIIDOC_INNER,$(1),$(2),$(3),text,text,text,text) $(call ASCIIDOC_INNER,$(1),$(2),text,text,text,text)
$(call ASCIIDOC_INNER,$(1),$(2),$(3),epub,epub,epub,ePUB) $(call ASCIIDOC_INNER,$(1),$(2),epub,epub,epub,ePUB)
clean: $(1)-clean clean: $(1)-clean
$(1)-clean: $(1)-clean:
@ -187,4 +187,4 @@ endef
# asciidoc-document -- the target generator macro for asciidoc documents # asciidoc-document -- the target generator macro for asciidoc documents
################################################################################ ################################################################################
asciidoc-document = $(call ASCIIDOC,$(pkgname),$(call UPPERCASE,$(pkgname)),$(pkgdir)) asciidoc-document = $(call ASCIIDOC,$(pkgname),$(call UPPERCASE,$(pkgname)))