aboutsummaryrefslogtreecommitdiff
path: root/lib/envars.mli
diff options
context:
space:
mode:
authorEmilio Jesus Gallego Arias2019-11-21 15:38:39 +0100
committerEmilio Jesus Gallego Arias2019-11-21 15:38:39 +0100
commitd016f69818b30b75d186fb14f440b93b0518fc66 (patch)
tree32cd948273f79a2c01ad27b4ed0244ea60d7e2f9 /lib/envars.mli
parentb680b06b31c27751a7d551d95839aea38f7fbea1 (diff)
[coq] Untabify the whole ML codebase.
We also remove trailing whitespace. Script used: ```bash for i in `find . -name '*.ml' -or -name '*.mli' -or -name '*.mlg'`; do expand -i "$i" | sponge "$i"; sed -e's/[[:space:]]*$//' -i.bak "$i"; done ```
Diffstat (limited to 'lib/envars.mli')
-rw-r--r--lib/envars.mli20
1 files changed, 10 insertions, 10 deletions
diff --git a/lib/envars.mli b/lib/envars.mli
index db904d419d..9f65ef8557 100644
--- a/lib/envars.mli
+++ b/lib/envars.mli
@@ -8,20 +8,20 @@
(* * (see LICENSE file for the text of the license) *)
(************************************************************************)
-(** This file provides a high-level interface to the environment variables
+(** This file provides a high-level interface to the environment variables
needed by Coq to run (such as coqlib). The values of these variables
- may come from different sources (shell environment variables,
+ may come from different sources (shell environment variables,
command line options, options set at the time Coq was build). *)
-(** [expand_path_macros warn s] substitutes environment variables
+(** [expand_path_macros warn s] substitutes environment variables
in a string by their values. This function also takes care of
- substituting path of the form '~X' by an absolute path.
+ substituting path of the form '~X' by an absolute path.
Use [warn] as a message displayer. *)
val expand_path_macros : warn:(string -> unit) -> string -> string
(** [home warn] returns the root of the user directory, depending
- on the OS. This information is usually stored in the $HOME
- environment variable on POSIX shells. If no such variable
+ on the OS. This information is usually stored in the $HOME
+ environment variable on POSIX shells. If no such variable
exists, then other common names are tried (HOMEDRIVE, HOMEPATH,
USERPROFILE). If all of them fail, [warn] is called. *)
val home : warn:(string -> unit) -> string
@@ -47,14 +47,14 @@ val set_user_coqlib : string -> unit
(** [coqbin] is the name of the current executable. *)
val coqbin : string
-(** [coqroot] is the path to [coqbin].
+(** [coqroot] is the path to [coqbin].
The following value only makes sense when executables are running from
- source tree (e.g. during build or in local mode).
+ source tree (e.g. during build or in local mode).
*)
val coqroot : string
-(** [coqpath] is the standard path to coq.
- Notice that coqpath is stored in reverse order, since that is
+(** [coqpath] is the standard path to coq.
+ Notice that coqpath is stored in reverse order, since that is
the order it gets added to the search path. *)
val coqpath : string list