docs/manual: allow a document to declare where its resources are
authorYann E. MORIN <yann.morin.1998@free.fr>
Fri, 3 Oct 2014 17:01:44 +0000 (19:01 +0200)
committerPeter Korsgaard <peter@korsgaard.com>
Sun, 12 Oct 2014 05:46:27 +0000 (07:46 +0200)
Avoids hard-coding document's resources in GENDOC_INNER, so we can
generate another document with different resources (if any).

Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr>
Cc: Samuel Martin <s.martin49@gmail.com>
Cc: Thomas De Schampheleire <patrickdepinguin@gmail.com>
Reviewed-by: Samuel Martin <s.martin49@gmail.com>
Reviewed-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
docs/manual/manual.mk

index 40bb1b16c6a99cd9f29b9727d7215898cc0272f8..7b06d47e4271a5c9780a40ec30082e4a0f493dc5 100644 (file)
@@ -106,7 +106,8 @@ $$(O)/docs/$(1)/$(1).$(5): $$($(2)_SOURCES) \
                           $(1)-prepare-sources
        $$(Q)$$(call MESSAGE,"Generating $(6) $(1)...")
        $$(Q)mkdir -p $$(@D)
-       $$(Q)a2x $(7) -f $(3) -d book -L -r $$(TOPDIR)/docs/images \
+       $$(Q)a2x $(7) -f $(3) -d book -L \
+               $$(foreach r,$$($(2)_RESOURCES),-r $$(r)) \
                $$($(2)_$(3)_A2X_OPTS) \
                --asciidoc-opts="$$($(2)_$(3)_ASCIIDOC_OPTS)" \
                $$(BUILD_DIR)/docs/$(1)/$(1).txt
@@ -119,6 +120,8 @@ endef
 # GENDOC -- generates the make targets needed to build asciidoc documentation.
 #
 # The variable <DOCUMENT_NAME>_SOURCES defines the dependencies.
+# The variable <DOCUMENT_NAME>_RESOURCES defines where the document's
+# resources, such as images, are located; must be an absolute path.
 ################################################################################
 define GENDOC
 $$(BUILD_DIR)/docs/$(pkgname):
@@ -148,4 +151,5 @@ $(pkgname)-clean:
 endef
 
 MANUAL_SOURCES = $(sort $(wildcard docs/manual/*.txt) $(wildcard docs/images/*))
+MANUAL_RESOURCES = $(TOPDIR)/docs/images
 $(eval $(call GENDOC))