aboutsummaryrefslogtreecommitdiff
path: root/dev/doc
diff options
context:
space:
mode:
authorEmilio Jesus Gallego Arias2018-09-27 16:39:39 +0200
committerEmilio Jesus Gallego Arias2018-09-27 19:58:54 +0200
commitf0c7587ea53b855ca58ce73d3e25f7e81215a722 (patch)
tree18fd5983cf0ac2f23c35e5b31e43b1ff1f0d215a /dev/doc
parent64a8f3cbb2fa278ed9d7bf2e5567d4e2b9bfa9dc (diff)
[dune] [merlin] Fix some usability issues.
As suggested on Gitter by @maximedenes we improve documentation and update Kernel's `.merlin` so it actually reports on the stricter set of warnings. We also set the language version to the proper one so users will get a better error message [the fact that we can use `(env_var ...)` with the wrong Dune version is a Dune bug indeed].
Diffstat (limited to 'dev/doc')
-rw-r--r--dev/doc/build-system.dune.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/dev/doc/build-system.dune.md b/dev/doc/build-system.dune.md
index 85aaf317ef..36d5e5841b 100644
--- a/dev/doc/build-system.dune.md
+++ b/dev/doc/build-system.dune.md
@@ -3,6 +3,23 @@ Dune-based build system. If you want to enhance the build system
itself (or are curious about its implementation details), see
build-system.dev.txt, and in particular its initial HISTORY section.
+Quick Start
+===========
+
+You need Dune >= 1.2.1 ; just type `dune build` to build the base Coq
+libraries. No `./configure` step is needed.
+
+Dune will get confused if it finds leftovers of in-tree compilation,
+so please be sure your tree is clean from objects files generated by
+the make-based system.
+
+If you want to build the standard libraries and plugins you should
+call `make -f Makefile.dune voboot`. It is usually enough to do that
+once per-session.
+
+More helper targets are availabe in `Makefile.dune`, `make -f
+Makefile.dune` will display help.
+
Dune
====