From: Peter Korsgaard <jacmet@uclibc.org>
To: buildroot@busybox.net
Subject: [Buildroot] [PATCH 1 of 2 v2] manual generation: check dependencies first
Date: Sun, 06 Oct 2013 22:29:36 +0200 [thread overview]
Message-ID: <87wqlqcfdb.fsf@dell.be.48ers.dk> (raw)
In-Reply-To: <f873d24e7a1146f10791.1379761613@argentina> (Thomas De Schampheleire's message of "Sat, 21 Sep 2013 13:06:53 +0200")
>>>>> "Thomas" == Thomas De Schampheleire <patrickdepinguin@gmail.com> writes:
Thomas> To generate the manual, you need a few tools. If these are not present,
Thomas> pretty cryptic error messages are given.
Thomas> This patch adds a simple check for these dependencies, before attempting to
Thomas> build the manual.
Thomas> Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
Thomas> ---
Thomas> v2:
Thomas> - update manual with the list of tools (comment Ryan)
Thomas> - add check for dblatex and python-argparse (comment Samuel)
Thomas> - check minimal version of asciidoc, using suitable-host-package mechanism
Thomas> docs/manual/make-tips.txt | 3 +--
Thomas> docs/manual/manual.mk | 30 +++++++++++++++++++++++++++++-
Thomas> docs/manual/prerequisite.txt | 5 ++++-
Thomas> support/dependencies/check-host-asciidoc.sh | 36 ++++++++++++++++++++++++++++++++++++
Thomas> 4 files changed, 70 insertions(+), 4 deletions(-)
Thomas> diff --git a/docs/manual/make-tips.txt b/docs/manual/make-tips.txt
Thomas> --- a/docs/manual/make-tips.txt
Thomas> +++ b/docs/manual/make-tips.txt
Thomas> @@ -66,9 +66,8 @@ To generate the manual:
Thomas> The manual outputs will be generated in 'output/docs/manual'.
Thomas> .Notes
Thomas> -- +asciidoc+ is required to build the documentation (see:
Thomas> +- A few tools are required to build the documentation (see:
Thomas> xref:requirement-optional[]).
Thomas> -- There is a known issue that you can't build it under Debian Squeeze.
Thomas> .Reseting Buildroot for a new target:
Thomas> diff --git a/docs/manual/manual.mk b/docs/manual/manual.mk
Thomas> --- a/docs/manual/manual.mk
Thomas> +++ b/docs/manual/manual.mk
Thomas> @@ -1,8 +1,32 @@
Thomas> -manual-update-lists:
Thomas> +manual-update-lists: manual-check-dependencies-lists
Thomas> $(Q)$(call MESSAGE,"Updating the manual lists...")
Thomas> $(Q)BR2_DEFCONFIG="" TOPDIR=$(TOPDIR) O=$(O)/docs/manual/.build \
Thomas> $(TOPDIR)/support/scripts/gen-manual-lists.py
Thomas> +manual-check-dependencies:
Thomas> + $(Q)if [ -z "$(call suitable-host-package,asciidoc,)" ]; then \
Thomas> + echo "You need a sufficiently recent asciidoc on your host" \
Thomas> + "to generate the manual"; \
Thomas> + exit 1; \
Thomas> + fi
This breaks 'make release' as it is a noconfig_target, so we don't
include dependencies.mk for the suitable-host-package.
You don't really need to use suitable-host-package, perhaps you could
directly call check-host-asciidoc.sh instead?
--
Bye, Peter Korsgaard
next prev parent reply other threads:[~2013-10-06 20:29 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2013-09-21 11:06 [Buildroot] [PATCH 0 of 2 v2] manual generation: misc changes Thomas De Schampheleire
2013-09-21 11:06 ` [Buildroot] [PATCH 1 of 2 v2] manual generation: check dependencies first Thomas De Schampheleire
2013-09-22 8:50 ` Samuel Martin
2013-09-23 13:29 ` Ryan Barnett
2013-10-06 20:29 ` Peter Korsgaard [this message]
2013-09-21 11:06 ` [Buildroot] [PATCH 2 of 2 v2] manual generation: rename manual-txt into manual-text Thomas De Schampheleire
2013-09-22 8:27 ` Thomas Petazzoni
2013-09-22 9:19 ` Samuel Martin
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87wqlqcfdb.fsf@dell.be.48ers.dk \
--to=jacmet@uclibc.org \
--cc=buildroot@busybox.net \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox