docs/manual/manual.mk

   1 ################################################################################
   2 #
   3 # The Buildroot manual
   4 #
   5 ################################################################################
   6
   7 MANUAL_SOURCES = $(sort $(wildcard docs/manual/*.txt) $(wildcard docs/images/*))
   8 MANUAL_RESOURCES = $(TOPDIR)/docs/images
   9
  10 # Our manual needs to generate lists
  11 # Packages included in BR2_EXTERNAL are not part of buildroot, so they
  12 # should not be included in the manual.
  13 define MANUAL_GEN_LISTS
  14         $(Q)$(call MESSAGE,"Updating the manual lists...")
  15         $(Q)$(COMMON_CONFIG_ENV) \
  16                 BR2_DEFCONFIG="" \
  17                 BR2_EXTERNAL=$(TOPDIR)/support/dummy-external \
  18                 TOPDIR=$(TOPDIR) \
  19                 O=$(@D) \
  20                 python -B $(TOPDIR)/support/scripts/gen-manual-lists.py
  21 endef
  22 MANUAL_POST_RSYNC_HOOKS += MANUAL_GEN_LISTS
  23
  24 # Our list-generating script requires argparse
  25 define MANUAL_CHECK_LISTS_DEPS
  26         $(Q)if ! python -c "import argparse" >/dev/null 2>&1 ; then \
  27                 echo "You need python with argparse on your host to generate" \
  28                         "the list of packages in the manual"; \
  29                 exit 1; \
  30         fi
  31 endef
  32 MANUAL_CHECK_DEPENDENCIES_HOOKS += MANUAL_CHECK_LISTS_DEPS
  33
  34 $(eval $(call asciidoc-document))