docs/manual/manual.mk

   1 # Packages included in BR2_EXTERNAL are not part of buildroot, so they
   2 # should not be included in the manual.
   3 manual-update-lists: manual-check-dependencies-lists
   4         $(Q)$(call MESSAGE,"Updating the manual lists...")
   5         $(Q)BR2_DEFCONFIG="" TOPDIR=$(TOPDIR) O=$(O)/docs/manual/.build \
   6                 BR2_EXTERNAL=$(TOPDIR)/support/dummy-external \
   7                 python -B $(TOPDIR)/support/scripts/gen-manual-lists.py
   8
   9 # we can't use suitable-host-package here because that's not available in
  10 # the context of 'make release'
  11 manual-check-dependencies:
  12         $(Q)if [ -z "$(shell support/dependencies/check-host-asciidoc.sh)" ]; then \
  13                 echo "You need a sufficiently recent asciidoc on your host" \
  14                         "to generate the manual"; \
  15                 exit 1; \
  16         fi
  17         $(Q)if [ -z "`which w3m 2>/dev/null`" ]; then \
  18                 echo "You need w3m on your host to generate the manual"; \
  19                 exit 1; \
  20         fi
  21
  22 manual-check-dependencies-pdf:
  23         $(Q)if [ -z "`which dblatex 2>/dev/null`" ]; then \
  24                 echo "You need dblatex on your host to generate the pdf manual"; \
  25                 exit 1; \
  26         fi
  27
  28 manual-check-dependencies-lists:
  29         $(Q)if ! python -c "import argparse" >/dev/null 2>&1 ; then \
  30                 echo "You need python with argparse on your host to generate" \
  31                         "the list of packages in the manual"; \
  32                 exit 1; \
  33         fi
  34
  35 ################################################################################
  36 # GENDOC -- generates the make targets needed to build a specific type of
  37 #           asciidoc documentation.
  38 #
  39 #  argument 1 is the name of the document and must be a subdirectory of docs/;
  40 #             the top-level asciidoc file must have the same name
  41 #  argument 2 is the type of document to generate (-f argument of a2x)
  42 #  argument 3 is the document type as used in the make target
  43 #  argument 4 is the output file extension for the document type
  44 #  argument 5 is the human text for the document type
  45 #  argument 6 (optional) are extra arguments for a2x
  46 #
  47 # The variable <DOCUMENT_NAME>_SOURCES defines the dependencies.
  48 ################################################################################
  49 define GENDOC_INNER
  50 $(1): $(1)-$(3)
  51 .PHONY: $(1)-$(3)
  52 $(1)-$(3): $$(O)/docs/$(1)/$(1).$(4)
  53
  54 manual-check-dependencies-$(3):
  55
  56 $$(O)/docs/$(1)/$(1).$(4): docs/$(1)/$(1).txt \
  57                            $$($(call UPPERCASE,$(1))_SOURCES) \
  58                            manual-check-dependencies \
  59                            manual-check-dependencies-$(3) \
  60                            manual-update-lists
  61         $(Q)$(call MESSAGE,"Generating $(5) $(1)...")
  62         $(Q)mkdir -p $$(@D)/.build
  63         $(Q)rsync -au docs/$(1)/*.txt $$(@D)/.build
  64         $(Q)a2x $(6) -f $(2) -d book -L -r $(TOPDIR)/docs/images \
  65                 -D $$(@D) $$(@D)/.build/$(1).txt
  66         -$(Q)rm -rf $$(@D)/.build
  67 endef
  68
  69 ################################################################################
  70 # GENDOC -- generates the make targets needed to build asciidoc documentation.
  71 #
  72 #  argument 1 is the name of the document and must be a subdirectory of docs/;
  73 #             the top-level asciidoc file must have the same name
  74 #
  75 # The variable <DOCUMENT_NAME>_SOURCES defines the dependencies.
  76 ################################################################################
  77 define GENDOC
  78 $(call GENDOC_INNER,$(1),xhtml,html,html,HTML,--xsltproc-opts "--stringparam toc.section.depth 2")
  79 $(call GENDOC_INNER,$(1),chunked,split-html,chunked,split HTML,--xsltproc-opts "--stringparam toc.section.depth 2")
  80 $(call GENDOC_INNER,$(1),pdf,pdf,pdf,PDF,--dblatex-opts "-P latex.output.revhistory=0")
  81 $(call GENDOC_INNER,$(1),text,text,text,text)
  82 $(call GENDOC_INNER,$(1),epub,epub,epub,ePUB)
  83 clean: $(1)-clean
  84 $(1)-clean:
  85         $(Q)$(RM) -rf $(O)/docs/$(1)
  86 .PHONY: $(1) $(1)-clean manual-update-lists
  87 endef
  88
  89 MANUAL_SOURCES = $(sort $(wildcard docs/manual/*.txt) $(wildcard docs/images/*))
  90 $(eval $(call GENDOC,manual))