Patchwork [1,of,2,v2] manual generation: check dependencies first

login
register
mail settings
Submitter Thomas De Schampheleire
Date Sept. 21, 2013, 11:06 a.m.
Message ID <f873d24e7a1146f10791.1379761613@argentina>
Download mbox | patch
Permalink /patch/276855/
State Changes Requested
Headers show

Comments

Thomas De Schampheleire - Sept. 21, 2013, 11:06 a.m.
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 <thomas.de.schampheleire@gmail.com>

---
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(-)
Samuel Martin - Sept. 22, 2013, 8:50 a.m.
2013/9/21 Thomas De Schampheleire <patrickdepinguin@gmail.com>

> 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 <thomas.de.schampheleire@gmail.com>
>
Acked-by: Samuel Martin <s.martin49@gmail.com>


> ---
> 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
>


Regards,
Ryan Barnett - Sept. 23, 2013, 1:29 p.m.
Thomas De Schampheleire <patrickdepinguin@gmail.com> wrote on 09/21/2013 
06:06:53 AM:

> 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 
<thomas.de.schampheleire@gmail.com>
> 
> ---
> 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
> 
Acked-by: Ryan Barnett <rjbarnet@rockwellcollins.com>
Peter Korsgaard - Oct. 6, 2013, 8:29 p.m.
>>>>> "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?

Patch

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