Docs: add warning note on ${listnamed:} operator

[users/heiko/exim.git] / doc / doc-docbook / Makefile

diff --git a/doc/doc-docbook/Makefile b/doc/doc-docbook/Makefile
index 14bea8e6bb059d9a741e32829fb05257212b82fc..bc7a9b0ae73e98e8df68e0934c5119a5b78833c2 100644 (file)
--- a/doc/doc-docbook/Makefile
+++ b/doc/doc-docbook/Makefile
@@ -1,17 +1,21 @@
 # Make file for Exim documentation from xfpt source.
 # Make file for Exim documentation from xfpt source.

+# Copyright (c) The Exim Maintainers 2020
+export LC_ALL=C

 
 notarget:;    @echo "** You must specify a target, in the form x.y, where x is 'filter', 'spec',"
 
 notarget:;    @echo "** You must specify a target, in the form x.y, where x is 'filter', 'spec',"

-             @echo "** or 'test', and y is 'xml', 'fo', 'ps', 'pdf', 'html', 'txt', or 'info'."
-             @echo "** One other possible target is 'exim.8'".
+             @echo "** or 'test', and y is 'xml', 'fo', 'ps', 'pdf', 'txt', or 'info'."
+             @echo "** One other possible targets 'exim.8', 'spec.utf8'".

              exit 1
 
              exit 1
 

+# html used to be supported, but is not here since 50023e0551 (2010).
+# The website build script seems to handle it.

 
 ############################# EVERYTHING ###############################
 #
 # Generate all the documentation files...
 #
 ## removed info files as I cannot generate them -  spec.info filter.info
 
 ############################# EVERYTHING ###############################
 #
 # Generate all the documentation files...
 #
 ## removed info files as I cannot generate them -  spec.info filter.info

-## removed html files as superceded by new website code
+## removed html files as superseded by new website code

 everything:            spec.pdf        spec.ps         spec.txt \
                                filter.pdf      filter.ps filter.txt \
                                exim.8
 everything:            spec.pdf        spec.ps         spec.txt \
                                filter.pdf      filter.ps filter.txt \
                                exim.8


@@ -23,9 +27,17 @@ exim.8:       spec.xml x2man
 
 ########################################################################
 
 
 ########################################################################
 

-.PHONY: local_params
-local_params:
-       ./GenLocalParams $@
+# .PHONY doesn't work here, because it forces a rebuild of all dependent
+# targets, always. It sets the internal timestamp of its target to
+# now().
+# But it may happen that local_params does not change
+FORCE:
+local_params: FORCE GenLocalParams
+       @set -e; \
+       trap 'rm -f $$tmp' EXIT; \
+       tmp=`mktemp`; \
+       ./GenLocalParams $$tmp; \
+       cmp -s $@ $$tmp || mv -f $$tmp $@

 
 ############################### FILTER #################################
 
 
 ############################### FILTER #################################
 


@@ -88,7 +100,8 @@ filter.txt:   filter-txt.xml Tidytxt MyStyle-txt-html.xsl MyStyle-html.xsl \
                 MyStyle.xsl
              /bin/rm -rf filter-txt.html
              xmlto -x MyStyle-txt-html.xsl html-nochunks filter-txt.xml
                 MyStyle.xsl
              /bin/rm -rf filter-txt.html
              xmlto -x MyStyle-txt-html.xsl html-nochunks filter-txt.xml

-             w3m -dump filter-txt.html | ./Tidytxt >filter.txt
+             command -v w3m >/dev/null
+             LC_ALL=C w3m -dump filter-txt.html | ./Tidytxt >filter.txt

              ./SanityTestText filter.txt
 
 # I have not found a way of making docbook2texi write its output anywhere
              ./SanityTestText filter.txt
 
 # I have not found a way of making docbook2texi write its output anywhere


@@ -107,7 +120,7 @@ filter.info:  filter-info.xml
 
 ################################ SPEC ##################################
 
 
 ################################ SPEC ##################################
 

-spec.xml:      local_params spec.xfpt
+spec.xml:      spec.xfpt local_params

               xfpt spec.xfpt
 
 spec-pr.xml:   spec.xml Pre-xml
               xfpt spec.xfpt
 
 spec-pr.xml:   spec.xml Pre-xml


@@ -165,13 +178,23 @@ spec.pdf: sdop-spec.pdf
 ###
 ###
 
 ###
 ###
 

-spec.txt:     spec-txt.xml Tidytxt MyStyle-txt-html.xsl MyStyle-html.xsl \
-                MyStyle.xsl
-             /bin/rm -rf spec-txt.html
+spec-txt.html:     spec-txt.xml \
+               MyStyle-txt-html.xsl MyStyle-html.xsl MyStyle.xsl

              xmlto -x MyStyle-txt-html.xsl html-nochunks spec-txt.xml
              xmlto -x MyStyle-txt-html.xsl html-nochunks spec-txt.xml

-             w3m -dump spec-txt.html | ./Tidytxt >spec.txt
+
+spec.utf8:     spec-txt.html Tidytxt
+               @grep -iq 'LC_CTYPE=.*utf-\?8' local_params || { \
+                       echo 'your current locale does not support UTF-8' >&2; \
+                       false; }
+               command -v w3m >/dev/null
+               w3m -dump spec-txt.html | ./Tidytxt -utf8 >$@
+
+spec.txt: spec-txt.html Tidytxt
+             command -v w3m >/dev/null
+             LC_ALL=C w3m -dump spec-txt.html | ./Tidytxt >$@

              ./SanityTestText spec.txt
 
              ./SanityTestText spec.txt
 

+

 # I have not found a way of making docbook2texi write its output anywhere
 # other than the file name that it makes up. The --to-stdout option does not
 # work.
 # I have not found a way of making docbook2texi write its output anywhere
 # other than the file name that it makes up. The --to-stdout option does not
 # work.


@@ -254,6 +277,7 @@ test.txt:     test-txt.xml Tidytxt MyStyle-txt-html.xsl MyStyle-html.xsl \
                 MyStyle.xsl
              /bin/rm -rf test-txt.html
              xmlto -x MyStyle-txt-html.xsl html-nochunks test-txt.xml
                 MyStyle.xsl
              /bin/rm -rf test-txt.html
              xmlto -x MyStyle-txt-html.xsl html-nochunks test-txt.xml

+             command -v w3m >/dev/null

              w3m -dump test-txt.html | Tidytxt >test.txt
 
 # I have not found a way of making docbook2texi write its output anywhere
              w3m -dump test-txt.html | Tidytxt >test.txt
 
 # I have not found a way of making docbook2texi write its output anywhere