aboutsummaryrefslogtreecommitdiff
path: root/INSTALL.md
diff options
context:
space:
mode:
authorEnrico Tassi2020-12-04 10:10:14 +0100
committerEnrico Tassi2020-12-04 11:27:50 +0100
commit1b39124d33f609740bb601ee5468f39470ba540b (patch)
tree6d7c96f472fbb717c37fc1b26cec633768d5ec95 /INSTALL.md
parent4c4715bf3224f6750e8d63005ff0c554015db45e (diff)
[doc] coq_environment.txt
Diffstat (limited to 'INSTALL.md')
-rw-r--r--INSTALL.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/INSTALL.md b/INSTALL.md
index f672bb45d3..74f4091134 100644
--- a/INSTALL.md
+++ b/INSTALL.md
@@ -99,3 +99,13 @@ dependencies...) as Coq. Distribution of pre-compiled plugins and
Coq version compiled with the same OCaml toolchain. An OCaml setup
mismatch is the most probable cause for an `Error while loading ...:
implementation mismatch on ...`.
+
+coq_environment.txt
+-------------------
+Coq binaries which honor environment variables, such as `COQLIB`, can
+be seeded values for these variables by placing a text file named
+`coq_environment.txt` next to them. The file can contain assignments
+like `COQLIB="some path"`, that is a variable name followed by `=` and
+a string that follows OCaml's escaping conventions. This feature can be
+used by installers of binary package to make Coq aware of its installation
+path.