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

[Simon Taylor]

Estimated hours taken: 0.5
Branches: main

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 environment variables which were
+  previously used to override the location of the standard library
+  (MERCURY_ALL_C_INCL_DIRS, MERCURY_ALL_MC_C_INCL_DIRS, MERCURY_INT_DIR,
+  MERCURY_C_LIB_DIR, MERCURY_MOD_LIB_MODS, MERCURY_TRACE_LIB_MODS) are
+  now deprecated, and will be removed in a future release.
+  MERCURY_C_INCL_DIR has already been removed.
+
 * We've added a new compiler option `--warn-non-tail-recursion', which
   causes the compiler to issue a warning about any directly recursive
   call that is not a tail call.
Index: doc/user_guide.texi
===================================================================
RCS file: /home/mercury1/repository/mercury/doc/user_guide.texi,v
retrieving revision 1.338
diff -u -u -r1.338 user_guide.texi
--- doc/user_guide.texi	3 Nov 2002 07:14:33 -0000	1.338
+++ doc/user_guide.texi	4 Nov 2002 00:19:42 -0000
@@ -6523,45 +6523,6 @@
 variables are set the value of MERCURY_STDLIB_DIR will be ignored.
 
 @sp 1
- at item MERCURY_ALL_C_INCL_DIRS
- at vindex MERCURY_ALL_C_INCL_DIRS
-A list of options for the C compiler that specifies
-all the directories the C compiler should search for the C header files
-of the Mercury runtime system and garbage collector.
-The default value of this variable is @samp{-I$MERCURY_STDLIB_DIR/inc},
-since usually all these header files are installed in one directory.
-This environment variable is used by @samp{mgnuc};
-it should generally be kept in sync with
- at code{MERCURY_ALL_MC_C_INCL_DIRS}, which is used by @samp{mmc}.
-
- at sp 1
- at item MERCURY_ALL_MC_C_INCL_DIRS
- at vindex MERCURY_ALL_MC_C_INCL_DIRS
-A list of options for mmc that specifies
-all the directories it should search for the C header files
-of the Mercury runtime system and garbage collector.
-The default value of this variable is
- at samp{--c-include-directory $MERCURY_STDLIB_DIR/inc},
-since usually all these header files are installed in one directory.
-This environment variable is used by @samp{mmc};
-it should generally be kept in sync with
- at code{MERCURY_ALL_C_INCL_DIRS}, which is used by @samp{mgnuc}.
-
- at sp 1
- at item MERCURY_INT_DIR
- at vindex MERCURY_INT_DIR
-Directory for the Mercury library interface
-files (@file{*.int}, @file{*.int2}, @file{*.int3} and @file{*.opt}).
-
- at sp 1
- at item MERCURY_C_LIB_DIR
- at vindex MERCURY_C_LIB_DIR
-Base directory containing the Mercury libraries (@file{libmer_*.a} and
-possibly @file{libmer_*.so}) for each configuration and grade.
-The libraries for each configuration and grade should
-be in the subdirectory @var{config}/@var{grade} of @code{$MERCURY_C_LIB_DIR}.
-
- at sp 1
 @item MERCURY_NONSHARED_LIB_DIR
 @vindex MERCURY_NONSHARED_LIB_DIR
 For IRIX 5, this environment variable can be used to specify a
@@ -6569,32 +6530,6 @@
 @samp{-mno-abicalls}.  See the file @samp{README.IRIX-5} in the Mercury
 source distribution.
 
- at item MERCURY_MOD_LIB_MODS
- at vindex MERCURY_MOD_LIB_MODS
-The names of the .init files in the Mercury library.
-
- at item MERCURY_TRACE_LIB_MODS
- at vindex MERCURY_TRACE_LIB_MODS
-The names of the .init files in the Mercury library which should
-only be used when tracing is enabled.
-
- at sp 1
- at item MERCURY_COMPILER
- at vindex MERCURY_COMPILER
-Filename of the Mercury Compiler.
-
- at sp 1
- at item MERCURY_MKINIT
- at vindex MERCURY_MKINIT
-Filename of the program to create the @file{*_init.c} file.
-
- at sp 1
- at item MERCURY_DEBUGGER_INIT
- at vindex MERCURY_DEBUGGER_INIT
-Name of a file that contains startup commands for the Mercury debugger.
-This file should contain documentation for the debugger command set,
-and possibly a set of default aliases.
-
 @sp 1
 @item MERCURY_OPTIONS
 @vindex MERCURY_OPTIONS
@@ -6774,6 +6709,78 @@
 @c not documented here.
 
 @end table
+
+ at sp 1
+ at item MERCURY_COMPILER
+ at vindex MERCURY_COMPILER
+Filename of the Mercury Compiler.
+
+ at sp 1
+ at item MERCURY_MKINIT
+ at vindex MERCURY_MKINIT
+Filename of the program to create the @file{*_init.c} file.
+
+ at sp 1
+ at item MERCURY_DEBUGGER_INIT
+ at vindex MERCURY_DEBUGGER_INIT
+Name of a file that contains startup commands for the Mercury debugger.
+This file should contain documentation for the debugger command set,
+and possibly a set of default aliases.
+
+ at end table
+
+The following environment variables are deprecated, and may
+be ignored by future releases.
+
+ at table @code
+
+ at sp 1
+ at item MERCURY_ALL_C_INCL_DIRS
+ at vindex MERCURY_ALL_C_INCL_DIRS
+A list of options for the C compiler that specifies
+all the directories the C compiler should search for the C header files
+of the Mercury runtime system and garbage collector.
+The default value of this variable is @samp{-I$MERCURY_STDLIB_DIR/inc},
+since usually all these header files are installed in one directory.
+This environment variable is used by @samp{mgnuc};
+it should generally be kept in sync with
+ at code{MERCURY_ALL_MC_C_INCL_DIRS}, which is used by @samp{mmc}.
+
+ at sp 1
+ at item MERCURY_ALL_MC_C_INCL_DIRS
+ at vindex MERCURY_ALL_MC_C_INCL_DIRS
+A list of options for mmc that specifies
+all the directories it should search for the C header files
+of the Mercury runtime system and garbage collector.
+The default value of this variable is
+ at samp{--c-include-directory $MERCURY_STDLIB_DIR/inc},
+since usually all these header files are installed in one directory.
+This environment variable is used by @samp{mmc};
+it should generally be kept in sync with
+ at code{MERCURY_ALL_C_INCL_DIRS}, which is used by @samp{mgnuc}.
+
+ at sp 1
+ at item MERCURY_INT_DIR
+ at vindex MERCURY_INT_DIR
+Directory for the Mercury library interface
+files (@file{*.int}, @file{*.int2}, @file{*.int3} and @file{*.opt}).
+
+ at sp 1
+ at item MERCURY_C_LIB_DIR
+ at vindex MERCURY_C_LIB_DIR
+Base directory containing the Mercury libraries (@file{libmer_*.a} and
+possibly @file{libmer_*.so}) for each configuration and grade.
+The libraries for each configuration and grade should
+be in the subdirectory @var{config}/@var{grade} of @code{$MERCURY_C_LIB_DIR}.
+
+ at item MERCURY_MOD_LIB_MODS
+ at vindex MERCURY_MOD_LIB_MODS
+The names of the .init files in the Mercury library.
+
+ at item MERCURY_TRACE_LIB_MODS
+ at vindex MERCURY_TRACE_LIB_MODS
+The names of the .init files in the Mercury library which should
+only be used when tracing is enabled.
 
 @end table
 
--------------------------------------------------------------------------
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
--------------------------------------------------------------------------