[cocci] [PATCH 0/2] docs: updates to hevea handling

[cocci] [PATCH 0/2] docs: updates to hevea handling

[Wolfram Sang]

When compiling coccinelle on my own, I didn't have hevea installed.
Since it is not needed for the PDF docs I was interested in, I rewrote
the Makefile a little in patch 1 to move its dependency to HTML docs
only. In patch 2, I added it hevea to install.txt as optional for HTML.

Wolfram Sang (2):
  docs/manual/Makefile: check xxdate only for HTML builds
  install.txt: mention 'hevea' as dependency for HTML docs

 docs/manual/Makefile | 17 +++++++++--------
 install.txt          |  2 ++
 2 files changed, 11 insertions(+), 8 deletions(-)

-- 
2.43.0

[cocci] [PATCH 1/2] docs/manual/Makefile: check xxdate only for HTML builds

[Wolfram Sang]

This allows PDF documentation to be built without hevea installed.

Signed-off-by: Wolfram Sang <wsa+renesas@sang-engineering.com>
---
 docs/manual/Makefile | 17 +++++++++--------
 1 file changed, 9 insertions(+), 8 deletions(-)

diff --git a/docs/manual/Makefile b/docs/manual/Makefile
index 7a0e001a..04894c2a 100644
--- a/docs/manual/Makefile
+++ b/docs/manual/Makefile
@@ -6,12 +6,6 @@ ifneq ($(MAKECMDGOALS),distclean)
 include ../../Makefile.config
 -include ../../Makefile.local
 endif
-HEVEA = hevea
-HEVEA_XXDATE := $(shell ./find-xxdate)
-
-$(if $(HEVEA_XXDATE),,$(error Hevea: Unable to find xxdate.exe))
-
-HEVEA_CMD := $(HEVEA) -exec $(HEVEA_XXDATE)
 
 MAINSRC=main.tex
 SRC=$(wildcard *.tex)
@@ -69,17 +63,24 @@ distclean:: clean
 ##############################################################################
 # Html version
 ##############################################################################
-.PHONY: html check
+.PHONY: html check checkxxdate
 
 .SUFFIXES: .html .tex
 
+HEVEA = hevea
+HEVEA_XXDATE := $(shell ./find-xxdate)
+HEVEA_CMD := $(HEVEA) -exec $(HEVEA_XXDATE)
+
 TEX=main_grammar.tex
 WEBBASE?=~/website
 WEBDOCS=$(WEBBASE)/docs
 
 HTML=$(TEX:.tex=.html)
 
-html: $(HTML)
+checkxxdate:
+	$(if $(HEVEA_XXDATE),,$(error Hevea: Unable to find xxdate.exe))
+
+html: checkxxdate $(HTML)
 
 clean::
 	rm -f *.aux *.dvi *.pdf *.html *.haux *.htoc *.log *.out *~
-- 
2.43.0

[cocci] [PATCH 2/2] install.txt: mention 'hevea' as dependency for HTML docs

[Wolfram Sang]

Signed-off-by: Wolfram Sang <wsa+renesas@sang-engineering.com>
---
 install.txt | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/install.txt b/install.txt
index d55b7b2b..ba5d1127 100644
--- a/install.txt
+++ b/install.txt
@@ -19,6 +19,7 @@ On Debian/Ubuntu, install the following packages
  - libpcre-ocaml-dev (optional, bundled)
  - libparmap-ocaml-dev (optional, bundled)
  - texlive-fonts-extra (for the documentation)
+ - hevea (for HTML documentation)
 
 On Fedora, install the following packages
  - pkgconfig (optional, but strongly recommended)
@@ -29,6 +30,7 @@ On Fedora, install the following packages
  - ocaml-ocamldoc
  - ocaml-menhir (optional, bundled)
  - ocaml-pcre-devel (optional, bundled)
+ - hevea (for HTML documentation)
 
 It may be necessary to install libpython2.7-dev
 
-- 
2.43.0

Re: [cocci] [PATCH 1/2] docs/manual/Makefile: check xxdate only for HTML builds

[Markus Elfring]

…
> +++ b/docs/manual/Makefile
> @@ -6,12 +6,6 @@ ifneq ($(MAKECMDGOALS),distclean)
…

How do you think about to improve the software build system accordingly?
https://gitlab.inria.fr/coccinelle/coccinelle/-/commits/master/configure.ac?ref_type=heads

Would you like to support any additional build options?

See also:
Choosing package options
https://www.gnu.org/savannah-checkouts/gnu/autoconf/manual/autoconf-2.72/html_node/Package-Options.html

Regards,
Markus

Re: [cocci] [PATCH 1/2] docs/manual/Makefile: check xxdate only for HTML builds

[Wolfram Sang]

[-- Attachment #1: Type: text/plain, Size: 364 bytes --]

Hi Markus,

> How do you think about to improve the software build system accordingly?

I also thought it would be a good idea...

> Would you like to support any additional build options?

... but I refrained from doing so since it exceeds my autotool-foo and I
have no bandwidth to improve it.

So, this task stays for someone else.

Happy hacking,

   Wolfram


[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]