[m-rev.] for review: environment variable documentation

[Fergus Henderson]

On 04-Nov-2002, Simon Taylor <stayl at cs.mu.OZ.AU> wrote:
> 
> doc/user_guide.texi:
> 	Rearrange the environment variables section so that
> 	variables which the user is more likely to want to
> 	set come first.
> 	
> 	Deprecate MERCURY_ALL_C_INCL_DIRS, MERCURY_ALL_MC_C_INCL_DIRS,
> 	MERCURY_INT_DIR, MERCURY_C_LIB_DIR, MERCURY_MOD_LIB_MODS and
> 	MERCURY_TRACE_LIB_MODS.  Their functionality is now available
> 	using the MERCURY_STDLIB_DIR environment variable or the
> 	`--mercury-stdlib-dir' option to the compiler and scripts.
> 
> NEWS:
> 	Document `--mercury-stdlib-dir', the MERCURY_STDLIB_DIR
> 	environment variable and the deprecated environment variables,
> 
> Index: NEWS
> ===================================================================
> RCS file: /home/mercury1/repository/mercury/NEWS,v
> retrieving revision 1.278
> diff -u -u -r1.278 NEWS
> --- NEWS	2 Nov 2002 03:04:43 -0000	1.278
> +++ NEWS	4 Nov 2002 01:31:19 -0000
> @@ -336,6 +336,16 @@
>    directory at the same time.  `--use-grade-subdirs' does not
>    work with Mmake (it does work with `mmc --make').
>  
> +* The compiler and scripts accept a `--mercury-stdlib-dir' option,
> +  which overrides the configured location of the Mercury standard
> +  library.  There is also an environment variable MERCURY_STDLIB_DIR
> +  which has the same effect.

The documentation (and _perhaps_ also the NEWS file) should specify what
happens if both the option and the environment variable are set.

Otherwise that looks fine to me.

-- 
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
--------------------------------------------------------------------------