Commit 3789bafc authored by Yann E. MORIN's avatar Yann E. MORIN Committed by Peter Korsgaard
Browse files

docs/manual: properly separate rules specific for our manual 



Move the rules specific to our own manual, so that they do not interfere
with the generic rules of GENDOC.

Separate them with a shiny header. ;-)

Signed-off-by: default avatar"Yann E. MORIN" <yann.morin.1998@free.fr>
Cc: Samuel Martin <s.martin49@gmail.com>
Cc: Thomas De Schampheleire <patrickdepinguin@gmail.com>
Acked-by: default avatarThomas De Schampheleire <thomas.de.schampheleire@gmail.com>
Acked-by: default avatarSamuel Martin <s.martin49@gmail.com>
Signed-off-by: default avatarPeter Korsgaard <peter@korsgaard.com>
parent 995f9bf4

docs/manual/manual.mk

+23 −18
Original line number Diff line number Diff line 
# Packages included in BR2_EXTERNAL are not part of buildroot, so they

# should not be included in the manual.

.PHONY: manual-update-lists

manual-update-lists: manual-check-dependencies-lists $(BUILD_DIR)/docs/$(pkgname)

	$(Q)$(call MESSAGE,"Updating the manual lists...")

	$(Q)BR2_DEFCONFIG="" TOPDIR=$(TOPDIR) O=$(BUILD_DIR)/docs/$(pkgname) \

		BR2_EXTERNAL=$(TOPDIR)/support/dummy-external \

		python -B $(TOPDIR)/support/scripts/gen-manual-lists.py



manual-prepare-sources: manual-update-lists



# we can't use suitable-host-package here because that's not available in

# the context of 'make release'

manual-check-dependencies:
@@ -28,13 +17,6 @@ manual-check-dependencies-pdf: 
		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



# PDF generation is broken because of a bug in xsltproc program provided

# by libxslt <=1.1.28, which does not honor an option we need to set.

# Fortunately, this bug is already fixed upstream:
@@ -156,6 +138,29 @@ $(pkgname)-clean: 
.PHONY: $(pkgname) $(pkgname)-clean

endef



################################################################################

# The Buildroot manual

################################################################################



# Our manual needs to generate lists

manual-prepare-sources: manual-update-lists



# Packages included in BR2_EXTERNAL are not part of buildroot, so they

# should not be included in the manual.

.PHONY: manual-update-lists

manual-update-lists: manual-check-dependencies-lists $(BUILD_DIR)/docs/$(pkgname)

	$(Q)$(call MESSAGE,"Updating the manual lists...")

	$(Q)BR2_DEFCONFIG="" TOPDIR=$(TOPDIR) O=$(BUILD_DIR)/docs/$(pkgname) \

		BR2_EXTERNAL=$(TOPDIR)/support/dummy-external \

		python -B $(TOPDIR)/support/scripts/gen-manual-lists.py



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



MANUAL_SOURCES = $(sort $(wildcard docs/manual/*.txt) $(wildcard docs/images/*))

MANUAL_RESOURCES = $(TOPDIR)/docs/images

$(eval $(call GENDOC))