From 811d311f4c04a8a34877ede28d825b374233aea2 Mon Sep 17 00:00:00 2001 From: Nils Gillmann Date: Sun, 21 Oct 2018 13:36:09 +0000 Subject: documentation: Remove usage of version and version2.texi, replace with portable sed. Signed-off-by: Nils Gillmann --- doc/documentation/Makefile.am | 32 ++++++++++++++------------------ doc/documentation/gnunet-c-tutorial.texi | 5 ++--- doc/documentation/gnunet.texi | 6 ++---- doc/documentation/run-gendocs.sh | 4 ++-- 4 files changed, 20 insertions(+), 27 deletions(-) (limited to 'doc') diff --git a/doc/documentation/Makefile.am b/doc/documentation/Makefile.am index 7eed6efb6..cd3fca854 100644 --- a/doc/documentation/Makefile.am +++ b/doc/documentation/Makefile.am @@ -126,6 +126,7 @@ EXTRA_DIST = \ $(gnunet_TEXINFOS) \ $(gnunet_tutorial_examples) \ htmlxref.cnf \ + gversion.texi run-gendocs.sh \ docstyle.css @@ -160,27 +161,20 @@ lego_stack.png: images/lego_stack.svg convert images/lego_stack.svg images/lego_stack.png && pngcrush images/lego_stack.png images/lego_stack.png -# FIXME: The usage of 'date' strings causes a warning. -# version.texi: -# echo "@set UPDATED $(date +'%d %B %Y')" > $@ -# echo "@set UPDATED-MONTH $(date +'%B %Y')" >> $@ -# echo "@set EDITION $(PACKAGE_VERSION)" >> $@ -# echo "@set VERSION $(PACKAGE_VERSION)" >> $@ - -# Workaround for makeinfo error. Which in turn introduces more -# date-related 'warnings' for GNUism. Well. -version2.texi: - echo "@set UPDATED $(date +'%d %B %Y')" > $@ - echo "@set UPDATED-MONTH $(date +'%B %Y')" >> $@ - echo "@set EDITION $(PACKAGE_VERSION)" >> $@ - echo "@set VERSION $(PACKAGE_VERSION)" >> $@ +# XXX: is this sed invocation portable enough? otherwise try tr(1). +version.texi/replacement: version.texi/replacement/revert + @sed -i "s/GPACKAGE_VERSION/$(PACKAGE_VERSION)/g" gversion.texi + +version.texi/replacement/revert: + @echo "@set VERSION GPACKAGE_VERSION" > gversion.texi + @echo "@set EDITION GPACKAGE_VERSION" >> gversion.texi if SECTION7 -gnunet-c-tutorial.7: version2.texi +gnunet-c-tutorial.7: version.texi/replacement @echo Attempting to output an mdoc formatted section 7 document @texi2mdoc -I$(pwd):$(pwd)/chapters gnunet-c-tutorial.texi > ../man/gnunet-c-tutorial.7 -gnunet-documentation.7: version2.texi +gnunet-documentation.7: version.texi/replacement @echo Attempting to output an mdoc formatted section 7 document @texi2mdoc -I$(pwd):$(pwd)/chapters gnunet.texi > ../man/gnunet-documentation.7 @@ -191,6 +185,8 @@ endif #doc-clean: # @rm *.aux *.log *.toc *.cp *.cps +all: version.texi/replacement + doc-all-install: @mkdir -p $(DESTDIR)/$(docdir) @mkdir -p $(DESTDIR)/$(infoimagedir) @@ -208,7 +204,7 @@ doc-gendoc-install: # @cp -r images $(DESTDIR)/$(infoimagedir) -dev-build: version.texi version2.texi +dev-build: version.texi/replacement @makeinfo --pdf gnunet.texi @makeinfo --pdf gnunet-c-tutorial.texi @makeinfo --html gnunet.texi @@ -217,7 +213,7 @@ dev-build: version.texi version2.texi @makeinfo --no-split gnunet-c-tutorial.texi # TODO: Add more to clean. -clean: +clean: version.texi/replacement/revert @rm -f gnunet.pdf @rm -f gnunet.html @rm -f gnunet.info diff --git a/doc/documentation/gnunet-c-tutorial.texi b/doc/documentation/gnunet-c-tutorial.texi index a41075a17..cf42d8e8b 100644 --- a/doc/documentation/gnunet-c-tutorial.texi +++ b/doc/documentation/gnunet-c-tutorial.texi @@ -3,11 +3,10 @@ @setfilename gnunet-c-tutorial.info @documentencoding UTF-8 @settitle GNUnet C Tutorial -@exampleindent 2 +@c @exampleindent 2 @c %**end of header -@c including 'version.texi' makes makeinfo throw errors. -@include version2.texi +@include gversion.texi @copying Copyright @copyright{} 2001-2018 GNUnet e.V. diff --git a/doc/documentation/gnunet.texi b/doc/documentation/gnunet.texi index 3781b866b..003ad8143 100644 --- a/doc/documentation/gnunet.texi +++ b/doc/documentation/gnunet.texi @@ -3,15 +3,14 @@ @setfilename gnunet.info @documentencoding UTF-8 @settitle GNUnet Reference Manual -@exampleindent 2 - -@include version.texi +@c @exampleindent 2 @c Set Versions which might be used in more than one place: @set GNUFTP-URL https://ftp.gnu.org/gnu/gnunet @set PYPI-URL https://pypi.python.org/packages/source @set GNURL-VERSION-CURRENT 7.55.1 @set GNUNET-DIST-URL https://gnunet.org/sites/default/files/ +@include gversion.texi @c @set OPENPGP-SIGNING-KEY-ID @copying @@ -59,7 +58,6 @@ Foundation Web site at @url{http://www.gnu.org/licenses/gpl.html}. @page @vskip 0pt plus 1filll Edition @value{EDITION} @* -@value{UPDATED} @* @insertcopying @end titlepage diff --git a/doc/documentation/run-gendocs.sh b/doc/documentation/run-gendocs.sh index d02570177..5e60a2d0f 100755 --- a/doc/documentation/run-gendocs.sh +++ b/doc/documentation/run-gendocs.sh @@ -1,7 +1,7 @@ #!/bin/sh -make version.texi -make version2.texi +make version.texi/replacement + ./gendocs.sh --email gnunet-developers@gnu.org gnunet-c-tutorial "GNUnet C Tutorial" -o "manual/gnunet-c-tutorial" #cd manual #mkdir gnunet-c-tutorial -- cgit v1.2.3