[Buildroot] [PATCH 0 of 4] manual generation: misc changes

[Buildroot] [PATCH 0 of 4] manual generation: misc changes

[Thomas De Schampheleire]

Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>

---
 Makefile              |   4 ++--
 docs/manual/manual.mk |  17 ++++++++++++++---
 2 files changed, 16 insertions(+), 5 deletions(-)

[Buildroot] [PATCH 1 of 4] manual generation: change capitalization of messages

[Thomas De Schampheleire]

When generating the manual, you see following messages:

>>>   Generating HTML manual...
>>>   Generating Split HTML manual...
>>>   Generating PDF manual...
>>>   Generating Text manual...
>>>   Generating EPUB manual...

and with this patch the capitalization is changed so that it becomes:

>>>   Generating HTML manual...
>>>   Generating split HTML manual...
>>>   Generating PDF manual...
>>>   Generating text manual...
>>>   Generating ePUB manual...

Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>

---
 docs/manual/manual.mk |  6 +++---
 1 files changed, 3 insertions(+), 3 deletions(-)

diff --git a/docs/manual/manual.mk b/docs/manual/manual.mk
--- a/docs/manual/manual.mk
+++ b/docs/manual/manual.mk
@@ -43,10 +43,10 @@ endef
 ################################################################################
 define GENDOC
 $(call GENDOC_INNER,$(1),xhtml,html,html,HTML,--xsltproc-opts "--stringparam toc.section.depth 4")
-$(call GENDOC_INNER,$(1),chunked,split-html,chunked,Split HTML,--xsltproc-opts "--stringparam toc.section.depth 4")
+$(call GENDOC_INNER,$(1),chunked,split-html,chunked,split HTML,--xsltproc-opts "--stringparam toc.section.depth 4")
 $(call GENDOC_INNER,$(1),pdf,pdf,pdf,PDF,--dblatex-opts "-P latex.output.revhistory=0")
-$(call GENDOC_INNER,$(1),text,txt,text,Text)
-$(call GENDOC_INNER,$(1),epub,epub,epub,EPUB)
+$(call GENDOC_INNER,$(1),text,txt,text,text)
+$(call GENDOC_INNER,$(1),epub,epub,epub,ePUB)
 clean: $(1)-clean
 $(1)-clean:
 	$(Q)$(RM) -rf $(O)/docs/$(1)

[Buildroot] [PATCH 2 of 4] manual generation: update help

[Thomas De Schampheleire]

The 'make help' lines for generating the manual did not consider ePub correctly.
Instead of providing a limitative list for 'make manual', the text is changed
into 'all formats'.

Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>

---
 Makefile |  2 +-
 1 files changed, 1 insertions(+), 1 deletions(-)

diff --git a/Makefile b/Makefile
--- a/Makefile
+++ b/Makefile
@@ -811,7 +811,7 @@ ifeq ($(BR2_TARGET_BAREBOX),y)
 endif
 	@echo
 	@echo 'Documentation:'
-	@echo '  manual                 - build manual in HTML, split HTML, PDF and txt'
+	@echo '  manual                 - build manual in all formats'
 	@echo '  manual-html            - build manual in HTML'
 	@echo '  manual-split-html      - build manual in split HTML'
 	@echo '  manual-pdf             - build manual in PDF'

[Buildroot] [PATCH 3 of 4] manual generation: check dependencies first

[Thomas De Schampheleire]

To generate the manual, you need asciidoc and w3m. 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>

---
 docs/manual/manual.mk |  11 +++++++++++
 1 files changed, 11 insertions(+), 0 deletions(-)

diff --git a/docs/manual/manual.mk b/docs/manual/manual.mk
--- a/docs/manual/manual.mk
+++ b/docs/manual/manual.mk
@@ -3,6 +3,16 @@ manual-update-lists:
 	$(Q)BR2_DEFCONFIG="" TOPDIR=$(TOPDIR) O=$(O)/docs/manual/.build \
 		$(TOPDIR)/support/scripts/gen-manual-lists.py
 
+manual-check-dependencies:
+	$(Q)if [ -z "`which a2x 2>/dev/null`" ]; then \
+		echo "You need asciidoc on your host to generate the manual"; \
+		false; \
+	fi
+	$(Q)if [ -z "`which w3m 2>/dev/null`" ]; then \
+		echo "You need w3m on your host to generate the manual"; \
+		false; \
+	fi
+
 ################################################################################
 # GENDOC -- generates the make targets needed to build a specific type of
 #           asciidoc documentation.
@@ -24,6 +34,7 @@ define GENDOC_INNER
 
 $$(O)/docs/$(1)/$(1).$(4): docs/$(1)/$(1).txt \
 			   $$($(call UPPERCASE,$(1))_SOURCES) \
+			   manual-check-dependencies \
 			   manual-update-lists
 	$(Q)$(call MESSAGE,"Generating $(5) $(1)...")
 	$(Q)mkdir -p $$(@D)/.build

[Buildroot] [PATCH 4 of 4] manual generation: rename manual-txt into manual-text

[Thomas De Schampheleire]

The output extension and the generation messages refer to 'text', but the make
target was confusingly 'txt'. This patch changes the make target for
consistency.

Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>

---
 docs/manual/manual.mk |  2 +-
 1 files changed, 1 insertions(+), 1 deletions(-)

diff --git a/Makefile b/Makefile
--- a/Makefile
+++ b/Makefile
@@ -815,7 +815,7 @@ endif
 	@echo '  manual-html            - build manual in HTML'
 	@echo '  manual-split-html      - build manual in split HTML'
 	@echo '  manual-pdf             - build manual in PDF'
-	@echo '  manual-txt             - build manual in txt'
+	@echo '  manual-text            - build manual in text'
 	@echo '  manual-epub            - build manual in ePub'
 	@echo
 	@echo 'Miscellaneous:'
diff --git a/docs/manual/manual.mk b/docs/manual/manual.mk
--- a/docs/manual/manual.mk
+++ b/docs/manual/manual.mk
@@ -56,7 +56,7 @@ define GENDOC
 $(call GENDOC_INNER,$(1),xhtml,html,html,HTML,--xsltproc-opts "--stringparam toc.section.depth 4")
 $(call GENDOC_INNER,$(1),chunked,split-html,chunked,split HTML,--xsltproc-opts "--stringparam toc.section.depth 4")
 $(call GENDOC_INNER,$(1),pdf,pdf,pdf,PDF,--dblatex-opts "-P latex.output.revhistory=0")
-$(call GENDOC_INNER,$(1),text,txt,text,text)
+$(call GENDOC_INNER,$(1),text,text,text,text)
 $(call GENDOC_INNER,$(1),epub,epub,epub,ePUB)
 clean: $(1)-clean
 $(1)-clean:

[Buildroot] [PATCH 3 of 4] manual generation: check dependencies first

[Samuel Martin]

Thomas, all,

2013/9/19 Thomas De Schampheleire <patrickdepinguin@gmail.com>

> To generate the manual, you need asciidoc and w3m. 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>
>
> ---
>  docs/manual/manual.mk |  11 +++++++++++
>  1 files changed, 11 insertions(+), 0 deletions(-)
>
> diff --git a/docs/manual/manual.mk b/docs/manual/manual.mk
> --- a/docs/manual/manual.mk
> +++ b/docs/manual/manual.mk
> @@ -3,6 +3,16 @@ manual-update-lists:
>         $(Q)BR2_DEFCONFIG="" TOPDIR=$(TOPDIR) O=$(O)/docs/manual/.build \
>                 $(TOPDIR)/support/scripts/gen-manual-lists.py
>
> +manual-check-dependencies:
> +       $(Q)if [ -z "`which a2x 2>/dev/null`" ]; then \
> +               echo "You need asciidoc on your host to generate the
> manual"; \
> +               false; \
> +       fi
> +       $(Q)if [ -z "`which w3m 2>/dev/null`" ]; then \
> +               echo "You need w3m on your host to generate the manual"; \
> +               false; \
> +       fi
>
To generate the pdf manual, you need dblatex too.
Also, to update the lists of the manual, you need python with argparse
package.


> +
>
>  ################################################################################
>  # GENDOC -- generates the make targets needed to build a specific type of
>  #           asciidoc documentation.
> @@ -24,6 +34,7 @@ define GENDOC_INNER
>
>  $$(O)/docs/$(1)/$(1).$(4): docs/$(1)/$(1).txt \
>                            $$($(call UPPERCASE,$(1))_SOURCES) \
> +                          manual-check-dependencies \
>                            manual-update-lists
>         $(Q)$(call MESSAGE,"Generating $(5) $(1)...")
>         $(Q)mkdir -p $$(@D)/.build
>


Regards,


-- 
Samuel
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.busybox.net/pipermail/buildroot/attachments/20130919/e84d53e4/attachment.html>

[Buildroot] [PATCH 3 of 4] manual generation: check dependencies first

[Thomas De Schampheleire]

On Thu, Sep 19, 2013 at 1:43 PM, Samuel Martin <s.martin49@gmail.com> wrote:
> Thomas, all,
>
[..]
>
> To generate the pdf manual, you need dblatex too.

dblatex was installed by default, it seems, on my Ubuntu-based system.
How would you like to check this? We can add it to the proposed
manual-check-dependencies rule, but this means that even if you're
only interested in the text manual you need to install dblatex.
Alternatively, we can add an explicit dependency like:
manual-pdf: manual-check-pdf-dependency
but this kind of conflicts with the generic gendoc principle currently used.

> Also, to update the lists of the manual, you need python with argparse
> package.
>

For python, should we check and bail out, or rather skip the package
list generation? In fact, why is the package list generation coupled
to the manual?
If we do want to check for python, should we simply check for the
python version 2.7+ or 3.2+ in which argparse was introduced, or are
you thinking about a more elaborate check on argparse?

Thanks,
Thomas

[Buildroot] [PATCH 3 of 4] manual generation: check dependencies first

[Ryan Barnett]

Thomas De Schampheleire,

Thomas De Schampheleire <patrickdepinguin@gmail.com> wrote on 09/19/2013 
08:30:25 AM:
> On Thu, Sep 19, 2013 at 1:43 PM, Samuel Martin <s.martin49@gmail.com> 
wrote:
> > Thomas, all,
> >
> [..]
> >
> > To generate the pdf manual, you need dblatex too.
> 
> dblatex was installed by default, it seems, on my Ubuntu-based system.
> How would you like to check this? We can add it to the proposed
> manual-check-dependencies rule, but this means that even if you're
> only interested in the text manual you need to install dblatex.
> Alternatively, we can add an explicit dependency like:
> manual-pdf: manual-check-pdf-dependency
> but this kind of conflicts with the generic gendoc principle currently 
used.

I was also going to to add to the documentation the versions of the Ubuntu
packages that I got the manual to build with. Ubuntu version + package 
version so that way in the manual we can give a reference system 
configuration that we say builds the manual. For Ubuntu 10.04 I was having
issues building the manual but with Ubuntu 12.04 I could successfully 
build
everything. 

I haven't had a chance to get around to doing this yet so I don't know if
you want to add your Ubuntu configuration as a reference configuration for
generating the manual under Section 3.2? Maybe this warrants a subsection 
(3.2.1) in manual for generating the manual? If you don't get around to
doing this, I will when I get around to adding some documentation to the
regarding SELinux and information about patch reviews.

> > Also, to update the lists of the manual, you need python with argparse
> > package.
> >
> 
> For python, should we check and bail out, or rather skip the package
> list generation? In fact, why is the package list generation coupled
> to the manual?
> If we do want to check for python, should we simply check for the
> python version 2.7+ or 3.2+ in which argparse was introduced, or are
> you thinking about a more elaborate check on argparse?
> 
> Thanks,
> Thomas

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.busybox.net/pipermail/buildroot/attachments/20130919/44b897bc/attachment.html>

[Buildroot] [PATCH 3 of 4] manual generation: check dependencies first

[Thomas De Schampheleire]

Hi Ryan,

On Thu, Sep 19, 2013 at 4:28 PM, Ryan Barnett
<rjbarnet@rockwellcollins.com> wrote:
>
>
> I was also going to to add to the documentation the versions of the Ubuntu
> packages that I got the manual to build with. Ubuntu version + package
> version so that way in the manual we can give a reference system
> configuration that we say builds the manual. For Ubuntu 10.04 I was having
> issues building the manual but with Ubuntu 12.04 I could successfully build
> everything.
>
> I haven't had a chance to get around to doing this yet so I don't know if
> you want to add your Ubuntu configuration as a reference configuration for
> generating the manual under Section 3.2? Maybe this warrants a subsection
> (3.2.1) in manual for generating the manual? If you don't get around to
> doing this, I will when I get around to adding some documentation to the
> regarding SELinux and information about patch reviews.

I'm wondering whether this is very useful. A user will not install
another Linux distribution just to build the buildroot manual, so the
Ubuntu version doesn't seem necessary to me. The package version only
seems relevant in case we know that some versions give problems for
building the manual. But unless we have some more info on that, I
would not add such info to the manual (also because it is very quickly
out-of-date).

For the problems you saw on Ubuntu 10.04, there may be a solution with
asciidoc 8.6.3, as I just posted in your original thread. If this
could be verified, then we could update the manual with just that.

Best regards,
Thomas

[Buildroot] [PATCH 3 of 4] manual generation: check dependencies first

[Ryan Barnett]

Thomas,

Thomas De Schampheleire <patrickdepinguin@gmail.com> wrote on 09/19/2013 
10:08:03 AM:
 
> Hi Ryan,
> 
> On Thu, Sep 19, 2013 at 4:28 PM, Ryan Barnett
> <rjbarnet@rockwellcollins.com> wrote:
> >
> >
> > I was also going to to add to the documentation the versions of the 
Ubuntu
> > packages that I got the manual to build with. Ubuntu version + package
> > version so that way in the manual we can give a reference system
> > configuration that we say builds the manual. For Ubuntu 10.04 I was 
having
> > issues building the manual but with Ubuntu 12.04 I could successfully 
build
> > everything.
> >
> > I haven't had a chance to get around to doing this yet so I don't know 
if
> > you want to add your Ubuntu configuration as a reference configuration 
for
> > generating the manual under Section 3.2? Maybe this warrants a 
subsection
> > (3.2.1) in manual for generating the manual? If you don't get around 
to
> > doing this, I will when I get around to adding some documentation to 
the
> > regarding SELinux and information about patch reviews.
> 
> I'm wondering whether this is very useful. A user will not install
> another Linux distribution just to build the buildroot manual, so the
> Ubuntu version doesn't seem necessary to me. The package version only
> seems relevant in case we know that some versions give problems for
> building the manual. But unless we have some more info on that, I
> would not add such info to the manual (also because it is very quickly
> out-of-date).

I'm sorry I misspoke and I do agree with you that we should just give the
version of asciidoc/w3m/(don't remember the other packages). After I sent
the previous message I figured that wasn't good idea. But I still think
that it would be helpful to have the versions of the tools that are used
and the version for which they are known to work for.
 
> For the problems you saw on Ubuntu 10.04, there may be a solution with
> asciidoc 8.6.3, as I just posted in your original thread. If this
> could be verified, then we could update the manual with just that.

Thanks - I never really had time to track down the solution or what
version issue was fixed at. I've replied with the information to the email
on that original thread.

> 
> Best regards,
> Thomas

Thanks,
-Ryan



-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.busybox.net/pipermail/buildroot/attachments/20130919/cdd4943d/attachment.html>

[Buildroot] [PATCH 1 of 4] manual generation: change capitalization of messages

[Thomas Petazzoni]

Dear Thomas De Schampheleire,

On Thu, 19 Sep 2013 12:47:13 +0200, Thomas De Schampheleire wrote:
> When generating the manual, you see following messages:
> 
> >>>   Generating HTML manual...
> >>>   Generating Split HTML manual...
> >>>   Generating PDF manual...
> >>>   Generating Text manual...
> >>>   Generating EPUB manual...
> 
> and with this patch the capitalization is changed so that it becomes:
> 
> >>>   Generating HTML manual...
> >>>   Generating split HTML manual...
> >>>   Generating PDF manual...
> >>>   Generating text manual...
> >>>   Generating ePUB manual...
> 
> Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>

Acked-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
-- 
Thomas Petazzoni, Free Electrons
Kernel, drivers, real-time and embedded Linux
development, consulting, training and support.
http://free-electrons.com

[Buildroot] [PATCH 2 of 4] manual generation: update help

[Thomas Petazzoni]

Dear Thomas De Schampheleire,

On Thu, 19 Sep 2013 12:47:14 +0200, Thomas De Schampheleire wrote:
> The 'make help' lines for generating the manual did not consider ePub correctly.
> Instead of providing a limitative list for 'make manual', the text is changed
> into 'all formats'.
> 
> Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>

Acked-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
-- 
Thomas Petazzoni, Free Electrons
Kernel, drivers, real-time and embedded Linux
development, consulting, training and support.
http://free-electrons.com

[Buildroot] [PATCH 3 of 4] manual generation: check dependencies first

[Thomas Petazzoni]

Dear Thomas De Schampheleire,

On Thu, 19 Sep 2013 15:30:25 +0200, Thomas De Schampheleire wrote:

> For python, should we check and bail out, or rather skip the package
> list generation? In fact, why is the package list generation coupled
> to the manual?

Because the package list is used in the manual only, and the best
moment to generate is when building the manual?

When would you want to generate it?

Thomas
-- 
Thomas Petazzoni, Free Electrons
Kernel, drivers, real-time and embedded Linux
development, consulting, training and support.
http://free-electrons.com

[Buildroot] [PATCH 4 of 4] manual generation: rename manual-txt into manual-text

[Thomas Petazzoni]

Dear Thomas De Schampheleire,

On Thu, 19 Sep 2013 12:47:16 +0200, Thomas De Schampheleire wrote:
> The output extension and the generation messages refer to 'text', but the make
> target was confusingly 'txt'. This patch changes the make target for
> consistency.
> 
> Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>

That's a change in the Buildroot interface, but I believe it's ok.
However, you're not updating another occurrence of manual-txt in the
main Makefile (see the release target).

Thanks,

Thomas
-- 
Thomas Petazzoni, Free Electrons
Kernel, drivers, real-time and embedded Linux
development, consulting, training and support.
http://free-electrons.com

[Buildroot] [PATCH 4 of 4] manual generation: rename manual-txt into manual-text

[Thomas De Schampheleire]

Hi Thomas,

On Thu, Sep 19, 2013 at 5:40 PM, Thomas Petazzoni
<thomas.petazzoni@free-electrons.com> wrote:
> Dear Thomas De Schampheleire,
>
> On Thu, 19 Sep 2013 12:47:16 +0200, Thomas De Schampheleire wrote:
>> The output extension and the generation messages refer to 'text', but the make
>> target was confusingly 'txt'. This patch changes the make target for
>> consistency.
>>
>> Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
>
> That's a change in the Buildroot interface, but I believe it's ok.

True. I figured that the manual is built only rarely (many people are
using the release tarballs), let alone that manual-txt is explicitly
called. People that do build manual-txt are often buildroot
developers, and hopefully they are flexible enough :-)

> However, you're not updating another occurrence of manual-txt in the
> main Makefile (see the release target).

Ai, sorry, I didn't think of that. Will fix.

Thanks for your feedback,
Thomas

[Buildroot] [PATCH 3 of 4] manual generation: check dependencies first

[Thomas De Schampheleire]

On Thu, Sep 19, 2013 at 5:39 PM, Thomas Petazzoni
<thomas.petazzoni@free-electrons.com> wrote:
> Dear Thomas De Schampheleire,
>
> On Thu, 19 Sep 2013 15:30:25 +0200, Thomas De Schampheleire wrote:
>
>> For python, should we check and bail out, or rather skip the package
>> list generation? In fact, why is the package list generation coupled
>> to the manual?
>
> Because the package list is used in the manual only, and the best
> moment to generate is when building the manual?
>
> When would you want to generate it?

I was thinking it could become a separate build target. But at that
time I didn't fully realize (and didn't check) that these lists are
actually included in the manual. So, that question is void now.

Remains: how should we check for python argparse? Module argparse is
included from python-2.7 and python-3.2 onwards. It seems that Ubuntu
has been providing python-argparse for older python versions as well,
but IMO it is not needed to check for this explicitly. If you ask me,
I would simply check for python 2.7+ and 3.2+, but I'm open for
discussion.

Thanks,
Thomas

[Buildroot] [PATCH 3 of 4] manual generation: check dependencies first

[Thomas Petazzoni]

Dear Thomas De Schampheleire,

On Thu, 19 Sep 2013 18:27:34 +0200, Thomas De Schampheleire wrote:

> I was thinking it could become a separate build target. But at that
> time I didn't fully realize (and didn't check) that these lists are
> actually included in the manual. So, that question is void now.

No problem :)

> Remains: how should we check for python argparse? Module argparse is
> included from python-2.7 and python-3.2 onwards. It seems that Ubuntu
> has been providing python-argparse for older python versions as well,
> but IMO it is not needed to check for this explicitly. If you ask me,
> I would simply check for python 2.7+ and 3.2+, but I'm open for
> discussion.

if ! python -c "import argparse" >/dev/null 2>&1 ; then
	echo "No Python, or argparse not available"
	exit 1
fi

something like that, no? It would cover both cases were argparse is
part of the default Python installation and the cases were argparse was
installed separately.

Thomas
-- 
Thomas Petazzoni, Free Electrons
Kernel, drivers, real-time and embedded Linux
development, consulting, training and support.
http://free-electrons.com

[Buildroot] [PATCH 3 of 4] manual generation: check dependencies first

[Arnout Vandecappelle]

On 19/09/13 20:57, Thomas Petazzoni wrote:
> Dear Thomas De Schampheleire,
>
> On Thu, 19 Sep 2013 18:27:34 +0200, Thomas De Schampheleire wrote:
>
>> I was thinking it could become a separate build target. But at that
>> time I didn't fully realize (and didn't check) that these lists are
>> actually included in the manual. So, that question is void now.
>
> No problem :)
>
>> Remains: how should we check for python argparse? Module argparse is
>> included from python-2.7 and python-3.2 onwards. It seems that Ubuntu
>> has been providing python-argparse for older python versions as well,
>> but IMO it is not needed to check for this explicitly. If you ask me,
>> I would simply check for python 2.7+ and 3.2+, but I'm open for
>> discussion.
>
> if ! python -c "import argparse" >/dev/null 2>&1 ; then
> 	echo "No Python, or argparse not available"
> 	exit 1
> fi
>
> something like that, no? It would cover both cases were argparse is
> part of the default Python installation and the cases were argparse was
> installed separately.

  You could also download https://argparse.googlecode.com/hg/argparse.py 
if needed, or include it in buildroot and at the following to the python 
script:

try:
	import argparse
except:
	import compat_argparse as argparse

  Unfortunately that only works down to python 2.5 - argparse.py is not 
compatible with 2.4 or earlier.


  Or, you could convert the script to optparse :-)


  Regards,
  Arnout
-- 
Arnout Vandecappelle                          arnout at mind be
Senior Embedded Software Architect            +32-16-286500
Essensium/Mind                                http://www.mind.be
G.Geenslaan 9, 3001 Leuven, Belgium           BE 872 984 063 RPR Leuven
LinkedIn profile: http://www.linkedin.com/in/arnoutvandecappelle
GPG fingerprint:  7CB5 E4CC 6C2E EFD4 6E3D A754 F963 ECAB 2450 2F1F

[Buildroot] [PATCH 3 of 4] manual generation: check dependencies first

[Arnout Vandecappelle]

On 19/09/13 12:47, Thomas De Schampheleire wrote:
> To generate the manual, you need asciidoc and w3m. 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>
>
> ---
>   docs/manual/manual.mk |  11 +++++++++++
>   1 files changed, 11 insertions(+), 0 deletions(-)
>
> diff --git a/docs/manual/manual.mk b/docs/manual/manual.mk
> --- a/docs/manual/manual.mk
> +++ b/docs/manual/manual.mk
> @@ -3,6 +3,16 @@ manual-update-lists:
>   	$(Q)BR2_DEFCONFIG="" TOPDIR=$(TOPDIR) O=$(O)/docs/manual/.build \
>   		$(TOPDIR)/support/scripts/gen-manual-lists.py
>
> +manual-check-dependencies:
> +	$(Q)if [ -z "`which a2x 2>/dev/null`" ]; then \
> +		echo "You need asciidoc on your host to generate the manual"; \
> +		false; \

  I don't think this works. I think you need "exit 1;".

  Regards,
  Arnout

> +	fi
> +	$(Q)if [ -z "`which w3m 2>/dev/null`" ]; then \
> +		echo "You need w3m on your host to generate the manual"; \
> +		false; \
> +	fi
> +
>   ################################################################################
>   # GENDOC -- generates the make targets needed to build a specific type of
>   #           asciidoc documentation.
> @@ -24,6 +34,7 @@ define GENDOC_INNER
>
>   $$(O)/docs/$(1)/$(1).$(4): docs/$(1)/$(1).txt \
>   			   $$($(call UPPERCASE,$(1))_SOURCES) \
> +			   manual-check-dependencies \
>   			   manual-update-lists
>   	$(Q)$(call MESSAGE,"Generating $(5) $(1)...")
>   	$(Q)mkdir -p $$(@D)/.build
> _______________________________________________
> buildroot mailing list
> buildroot at busybox.net
> http://lists.busybox.net/mailman/listinfo/buildroot
>


-- 
Arnout Vandecappelle                          arnout at mind be
Senior Embedded Software Architect            +32-16-286500
Essensium/Mind                                http://www.mind.be
G.Geenslaan 9, 3001 Leuven, Belgium           BE 872 984 063 RPR Leuven
LinkedIn profile: http://www.linkedin.com/in/arnoutvandecappelle
GPG fingerprint:  7CB5 E4CC 6C2E EFD4 6E3D A754 F963 ECAB 2450 2F1F

[Buildroot] [PATCH 1 of 4] manual generation: change capitalization of messages

[Peter Korsgaard]

>>>>> "Thomas" == Thomas De Schampheleire <patrickdepinguin@gmail.com> writes:

 Thomas> When generating the manual, you see following messages:
 >>>> Generating HTML manual...
 >>>> Generating Split HTML manual...
 >>>> Generating PDF manual...
 >>>> Generating Text manual...
 >>>> Generating EPUB manual...

 Thomas> and with this patch the capitalization is changed so that it becomes:

 >>>> Generating HTML manual...
 >>>> Generating split HTML manual...
 >>>> Generating PDF manual...
 >>>> Generating text manual...
 >>>> Generating ePUB manual...

 Thomas> Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>

Committed, thanks.

-- 
Bye, Peter Korsgaard

[Buildroot] [PATCH 2 of 4] manual generation: update help

[Peter Korsgaard]

>>>>> "Thomas" == Thomas De Schampheleire <patrickdepinguin@gmail.com> writes:

 Thomas> The 'make help' lines for generating the manual did not consider ePub correctly.
 Thomas> Instead of providing a limitative list for 'make manual', the text is changed
 Thomas> into 'all formats'.

 Thomas> Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>

Committed, thanks.

-- 
Bye, Peter Korsgaard

[Buildroot] [PATCH 3 of 4] manual generation: check dependencies first

[Thomas De Schampheleire]

Hi Arnout,

On Thu, Sep 19, 2013 at 9:30 PM, Arnout Vandecappelle <arnout@mind.be> wrote:
> On 19/09/13 12:47, Thomas De Schampheleire wrote:

>> +manual-check-dependencies:
>> +       $(Q)if [ -z "`which a2x 2>/dev/null`" ]; then \
>> +               echo "You need asciidoc on your host to generate the
>> manual"; \
>> +               false; \
>
>
>  I don't think this works. I think you need "exit 1;".
>

It does work in fact, because the return code of the if statement is
false (the last statement within it) and the two ifs are not chained
in one subshell. Hence, make stops at the first failing command (the
first failing if).

But it's a fragile construction, because if someone later decides to
chain both ifs in one subshell, then it stops working. So I will
indeed change it to exit 1.

Best regards,
Thomas