From patchwork Sat Sep 21 11:06:53 2013 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Thomas De Schampheleire X-Patchwork-Id: 276855 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Received: from silver.osuosl.org (silver.osuosl.org [140.211.166.136]) by ozlabs.org (Postfix) with ESMTP id 5EFD52C0159 for ; Sat, 21 Sep 2013 21:08:18 +1000 (EST) Received: from localhost (localhost [127.0.0.1]) by silver.osuosl.org (Postfix) with ESMTP id 54BAB32BEA; Sat, 21 Sep 2013 11:07:59 +0000 (UTC) X-Virus-Scanned: amavisd-new at osuosl.org Received: from silver.osuosl.org ([127.0.0.1]) by localhost (.osuosl.org [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id jzAEGfGweB2f; Sat, 21 Sep 2013 11:07:55 +0000 (UTC) Received: from ash.osuosl.org (ash.osuosl.org [140.211.166.34]) by silver.osuosl.org (Postfix) with ESMTP id AF7BF32BE1; Sat, 21 Sep 2013 11:07:54 +0000 (UTC) X-Original-To: buildroot@lists.busybox.net Delivered-To: buildroot@osuosl.org Received: from whitealder.osuosl.org (whitealder.osuosl.org [140.211.166.138]) by ash.osuosl.org (Postfix) with ESMTP id 2D4E91CE676 for ; Sat, 21 Sep 2013 11:08:09 +0000 (UTC) Received: from localhost (localhost [127.0.0.1]) by whitealder.osuosl.org (Postfix) with ESMTP id 27AAF8CA82 for ; Sat, 21 Sep 2013 11:08:09 +0000 (UTC) X-Virus-Scanned: amavisd-new at osuosl.org Received: from whitealder.osuosl.org ([127.0.0.1]) by localhost (.osuosl.org [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id Sp4kCGAluFuv for ; Sat, 21 Sep 2013 11:08:08 +0000 (UTC) X-Greylist: domain auto-whitelisted by SQLgrey-1.7.6 Received: from mail-ee0-f54.google.com (mail-ee0-f54.google.com [74.125.83.54]) by whitealder.osuosl.org (Postfix) with ESMTPS id 3EF3B8BF29 for ; Sat, 21 Sep 2013 11:08:08 +0000 (UTC) Received: by mail-ee0-f54.google.com with SMTP id e53so761606eek.27 for ; Sat, 21 Sep 2013 04:08:06 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113; h=content-type:mime-version:content-transfer-encoding:subject :message-id:in-reply-to:references:user-agent:date:from:to:cc; bh=4hhdU1OJmkMrzt96OqsRP/voTS0KeTODMUF2bCeA4ag=; b=kFiIF0Ahd2mMZdShYRfe383bG9CMSjsfcJboqtJntwfgLLozIVcUpRb+24q79QtuoT oadtepmbsYuSRuOqGyZbyZNvfqbQBwXwkUDhMtbBbPf4t1aYuOTYiCZd2XEWWoGXl1Cv n0F5Xc2iDWrRG04ydfdBfTKpYkt9duVuEDL3kYJbh3ipJkM0M0szu2TCBKjjETD4sdDq TkSN/kKUrTTuRyITgImchxzwVxLS8d43IvpyyhXn+jJkmFcRza0CAw3XoDMxSNWd1RXK kFsJnUBSQLsY4XZTR7DZ89DpZLC8i+0tFzh5I3J4K6a6LXIhEQHArpsKpVdiBeD8i8DC Z9PQ== X-Received: by 10.14.224.198 with SMTP id x46mr2257299eep.53.1379761686806; Sat, 21 Sep 2013 04:08:06 -0700 (PDT) Received: from [127.0.1.1] (d54C62EEB.access.telenet.be. [84.198.46.235]) by mx.google.com with ESMTPSA id b45sm26166761eef.4.1969.12.31.16.00.00 (version=TLSv1.1 cipher=ECDHE-RSA-RC4-SHA bits=128/128); Sat, 21 Sep 2013 04:08:06 -0700 (PDT) MIME-Version: 1.0 X-Mercurial-Node: f873d24e7a1146f107919ee71071f562366706db Message-Id: In-Reply-To: References: User-Agent: Mercurial-patchbomb/2.2.2 Date: Sat, 21 Sep 2013 13:06:53 +0200 From: Thomas De Schampheleire To: buildroot@busybox.net Cc: thomas.petazzoni@free-electrons.com Subject: [Buildroot] [PATCH 1 of 2 v2] manual generation: check dependencies first X-BeenThere: buildroot@busybox.net X-Mailman-Version: 2.1.14 Precedence: list List-Id: Discussion and development of buildroot List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: buildroot-bounces@busybox.net Sender: buildroot-bounces@busybox.net To generate the manual, you need a few tools. If these are not present, pretty cryptic error messages are given. This patch adds a simple check for these dependencies, before attempting to build the manual. Signed-off-by: Thomas De Schampheleire Acked-by: Samuel Martin Acked-by: Ryan Barnett --- v2: - update manual with the list of tools (comment Ryan) - add check for dblatex and python-argparse (comment Samuel) - check minimal version of asciidoc, using suitable-host-package mechanism docs/manual/make-tips.txt | 3 +-- docs/manual/manual.mk | 30 +++++++++++++++++++++++++++++- docs/manual/prerequisite.txt | 5 ++++- support/dependencies/check-host-asciidoc.sh | 36 ++++++++++++++++++++++++++++++++++++ 4 files changed, 70 insertions(+), 4 deletions(-) diff --git a/docs/manual/make-tips.txt b/docs/manual/make-tips.txt --- a/docs/manual/make-tips.txt +++ b/docs/manual/make-tips.txt @@ -66,9 +66,8 @@ To generate the manual: The manual outputs will be generated in 'output/docs/manual'. .Notes -- +asciidoc+ is required to build the documentation (see: +- A few tools are required to build the documentation (see: xref:requirement-optional[]). -- There is a known issue that you can't build it under Debian Squeeze. .Reseting Buildroot for a new target: diff --git a/docs/manual/manual.mk b/docs/manual/manual.mk --- a/docs/manual/manual.mk +++ b/docs/manual/manual.mk @@ -1,8 +1,32 @@ -manual-update-lists: +manual-update-lists: manual-check-dependencies-lists $(Q)$(call MESSAGE,"Updating the manual lists...") $(Q)BR2_DEFCONFIG="" TOPDIR=$(TOPDIR) O=$(O)/docs/manual/.build \ $(TOPDIR)/support/scripts/gen-manual-lists.py +manual-check-dependencies: + $(Q)if [ -z "$(call suitable-host-package,asciidoc,)" ]; then \ + echo "You need a sufficiently recent asciidoc on your host" \ + "to generate the manual"; \ + exit 1; \ + fi + $(Q)if [ -z "`which w3m 2>/dev/null`" ]; then \ + echo "You need w3m on your host to generate the manual"; \ + exit 1; \ + fi + +manual-check-dependencies-pdf: + $(Q)if [ -z "`which dblatex 2>/dev/null`" ]; then \ + echo "You need dblatex on your host to generate the pdf manual"; \ + 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 + ################################################################################ # GENDOC -- generates the make targets needed to build a specific type of # asciidoc documentation. @@ -22,8 +46,12 @@ define GENDOC_INNER .PHONY: $(1)-$(3) $(1)-$(3): $$(O)/docs/$(1)/$(1).$(4) +manual-check-dependencies-$(3): + $$(O)/docs/$(1)/$(1).$(4): docs/$(1)/$(1).txt \ $$($(call UPPERCASE,$(1))_SOURCES) \ + manual-check-dependencies \ + manual-check-dependencies-$(3) \ manual-update-lists $(Q)$(call MESSAGE,"Generating $(5) $(1)...") $(Q)mkdir -p $$(@D)/.build diff --git a/docs/manual/prerequisite.txt b/docs/manual/prerequisite.txt --- a/docs/manual/prerequisite.txt +++ b/docs/manual/prerequisite.txt @@ -76,4 +76,7 @@ development context (further details: re ** The +jar+ tool * Documentation generation tools: -** +asciidoc+ +** +asciidoc+, version 8.6.3 or higher +** +w3m+ +** +python+ with the +argparse+ module (automatically present in 2.7+ and 3.2+) +** +dblatex+ (required for the pdf manual only) diff --git a/support/dependencies/check-host-asciidoc.sh b/support/dependencies/check-host-asciidoc.sh new file mode 100755 --- /dev/null +++ b/support/dependencies/check-host-asciidoc.sh @@ -0,0 +1,36 @@ +#!/bin/sh + +candidate="$1" #ignored + +asciidoc=`which asciidoc` +if [ ! -x "$asciidoc" ]; then + # echo nothing: no suitable asciidoc found + exit 1 +fi + +# Output of 'asciidoc --version' examples: +# asciidoc 8.6.7 +version=`$asciidoc --version | cut -d\ -f2` +major=`echo "$version" | cut -d. -f1` +minor=`echo "$version" | cut -d. -f2` +bugfix=`echo "$version" | cut -d. -f3` + +# To generate the manual, we need asciidoc >= 8.6.3 +major_min=8 +minor_min=6 +bugfix_min=3 +if [ $major -gt $major_min ]; then + echo $asciidoc +else + if [ $major -eq $major_min -a $minor -ge $minor_min ]; then + echo $asciidoc + else + if [ $major -eq $major_min -a $minor -eq $minor_min \ + -a $bugfix -ge $bugfix_min ]; then + echo $asciidoc + else + # echo nothing: no suitable asciidoc found + exit 1 + fi + fi +fi