[m-rev.] for review: version identifiers in documentation

[Simon Taylor]

On 03-Oct-2001, Fergus Henderson <fjh at cs.mu.OZ.AU> wrote:
> On 03-Oct-2001, Simon Taylor <stayl at cs.mu.OZ.AU> wrote:
> > 
> > Estimated hours taken: 1.5
> > Branches: main, release
> > 
> > Put version identifiers in the documentation.
> > 
> > doc/Mmakefile:
> > 	Preprocess the `.texi' files to produce `.texi_pp' files.
> > 	The `.texi_pp' files contain the contents of the `.texi'
> > 	files with the string VERSION replaced by the value
> > 	of $(VERSION), which is taken from the file VERSION
> > 	in the top-level `mercury' directory.
> 
> That is dangerous, because the string VERSION might appear
> accidentally (e.g. as part of CONVERSION, AVERSION, PERVERSION, etc.,
> or just in some place where the literal string VERSION is wanted).
> 
> Use a more specific pattern, e.g. `<VERSION>' or `@@VERSION@@'
> or something like that.

Done.

Simon

--- Mmakefile	2001/10/03 11:21:43	1.1
+++ Mmakefile	2001/10/03 11:24:49
@@ -73,7 +73,7 @@
 	MERCURY_MKINIT=../util/mkinit \
 	./make_manpage $< > $@
 
-SED_CMD = sed -e "s/VERSION/$(VERSION)/g" < $< > $@
+SED_CMD = sed -e "s/<VERSION>/$(VERSION)/g" < $< > $@
 
 %.texi_pp: %.texi
 	$(SED_CMD)
--- faq.texi	2001/10/03 11:20:23	1.1
+++ faq.texi	2001/10/03 11:21:58
@@ -22,7 +22,7 @@
 @finalout
 @setchapternewpage off
 @ifinfo
-This file is the Mercury Frequently Asked Questions List, version VERSION.
+This file is the Mercury Frequently Asked Questions List, version <VERSION>.
 It contains a list of frequently asked questions about Mercury, with answers.
 
 Copyright (C) 1995-1997 The University of Melbourne.
@@ -49,7 +49,7 @@
 
 @titlepage
 @title The Mercury Frequently Asked Questions List
- at subtitle Version VERSION
+ at subtitle Version <VERSION>
 @author Fergus Henderson
 @author Thomas Conway
 @author Zoltan Somogyi
@@ -74,7 +74,7 @@
 
 @ifinfo
 @node Top,,, (mercury)
- at top The Mercury Frequently Asked Questions List, version VERSION
+ at top The Mercury Frequently Asked Questions List, version <VERSION>
 @menu
 * Programming::     Common programming errors.
 * Unimplemented::   Problems caused by unimplemented Mercury features.
--- library.texi	2001/10/03 11:20:23	1.1
+++ library.texi	2001/10/03 11:22:48
@@ -13,7 +13,7 @@
 @finalout
 @setchapternewpage off
 @ifinfo
-This file documents the Mercury standard library, version VERSION.
+This file documents the Mercury standard library, version <VERSION>.
 
 Copyright (C) 1995-1999 The University of Melbourne.
 
@@ -39,7 +39,7 @@
 
 @titlepage
 @title The Mercury Library Reference Manual
- at subtitle Version VERSION
+ at subtitle Version <VERSION>
 @c @author Fergus Henderson
 @c @author Thomas Conway
 @c @author Zoltan Somogyi
@@ -65,7 +65,7 @@
 
 @ifinfo
 @node Top,,, (mercury)
- at top Mercury Library Reference Manual, version VERSION
+ at top Mercury Library Reference Manual, version <VERSION>
 @end ifinfo
 
 The Mercury standard library contains a variety of modules which we
--- reference_manual.texi	2001/10/03 11:20:23	1.2
+++ reference_manual.texi	2001/10/03 11:23:12
@@ -16,7 +16,7 @@
 @finalout
 @setchapternewpage off
 @ifinfo
-This file documents the Mercury programming language, version VERSION.
+This file documents the Mercury programming language, version <VERSION>.
 
 Copyright (C) 1995-2001 The University of Melbourne.
 
@@ -42,7 +42,7 @@
 
 @titlepage
 @title The Mercury Language Reference Manual
- at subtitle Version VERSION
+ at subtitle Version <VERSION>
 @author Fergus Henderson
 @author Thomas Conway
 @author Zoltan Somogyi
@@ -73,7 +73,7 @@
 
 @ifinfo
 @node Top,,, (mercury)
- at top The Mercury Language Reference Manual, version VERSION
+ at top The Mercury Language Reference Manual, version <VERSION>
 @end ifinfo
 @c XXX Move to after Determinism
 @c * Assertions::        Assertion declarations allow you to declare laws
--- transition_guide.texi	2001/10/03 11:20:23	1.1
+++ transition_guide.texi	2001/10/03 11:23:29
@@ -39,7 +39,7 @@
 
 @titlepage
 @title The Prolog to Mercury transition guide
- at subtitle Version VERSION
+ at subtitle Version <VERSION>
 @author Thomas Conway
 @author Zoltan Somogyi
 @author Fergus Henderson
@@ -64,7 +64,7 @@
 
 @ifinfo
 @node Top,,, (mercury)
- at top The Prolog to Mercury Transition Guide, version VERSION
+ at top The Prolog to Mercury Transition Guide, version <VERSION>
 
 This guide gives some advice about
 translating Prolog programs into Mercury.
--- user_guide.texi	2001/10/03 11:20:23	1.1
+++ user_guide.texi	2001/10/03 11:23:48
@@ -43,7 +43,7 @@
 @c ----------------------------------------------------------------------------
 
 @ifinfo
-This file documents the Mercury implementation, version VERSION.
+This file documents the Mercury implementation, version <VERSION>.
 
 Copyright (C) 1995-2001 The University of Melbourne.
 
@@ -69,7 +69,7 @@
 
 @titlepage
 @title The Mercury User's Guide
- at subtitle Version VERSION
+ at subtitle Version <VERSION>
 @author Fergus Henderson
 @author Thomas Conway
 @author Zoltan Somogyi
@@ -101,7 +101,7 @@
 
 @ifinfo
 @node Top,,, (mercury)
- at top The Mercury User's Guide, version VERSION
+ at top The Mercury User's Guide, version <VERSION>
 
 This guide describes the compilation environment of Mercury ---
 how to build and debug Mercury programs.
--- mercury.html.in	2001/10/03 11:21:43	1.1
+++ mercury.html.in	2001/10/03 11:24:12
@@ -5,7 +5,7 @@
 <TITLE>Mercury documentation</TITLE>
 </HEAD>
 <BODY>
-<H1>Mercury documentation, version VERSION</H1>
+<H1>Mercury documentation, version <VERSION></H1>
 <P>
 <UL>
 <LI><A HREF="reference_manual_toc.html">Mercury Language Reference Manual</A>
--- mercury.info.in	2001/10/03 11:21:43	1.1
+++ mercury.info.in	2001/10/03 11:24:31
@@ -7,7 +7,7 @@
 
 File: mercury.info,  Node: Top,  Up: (DIR)
 
-Mercury Documentation, version VERSION
+Mercury Documentation, version <VERSION>
 ***********************************
 
 * Menu:
--------------------------------------------------------------------------
mercury-reviews mailing list
post:  mercury-reviews at cs.mu.oz.au
administrative address: owner-mercury-reviews at cs.mu.oz.au
unsubscribe: Address: mercury-reviews-request at cs.mu.oz.au Message: unsubscribe
subscribe:   Address: mercury-reviews-request at cs.mu.oz.au Message: subscribe
--------------------------------------------------------------------------