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

[Fergus Henderson]

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.

Otherwise that change looks fine.

P.S.
In the long run we should probably switch from using texi2html and
instead use `makeinfo --html'.

-- 
Fergus Henderson <fjh at cs.mu.oz.au>  |  "I have always known that the pursuit
The University of Melbourne         |  of excellence is a lethal habit"
WWW: <http://www.cs.mu.oz.au/~fjh>  |     -- the last words of T. S. Garp.
--------------------------------------------------------------------------
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
--------------------------------------------------------------------------