From c8cc7a6901edf80638e7fcb4a9d22173e9523c96 Mon Sep 17 00:00:00 2001 From: Emilio Jesus Gallego Arias Date: Thu, 6 Sep 2018 21:31:09 +0200 Subject: [dune] [doc] Document `dune utop $lib` --- .github/CODEOWNERS | 1 + .ocamlinit | 1 + dev/doc/build-system.dune.md | 11 +++++++++++ 3 files changed, 13 insertions(+) create mode 100644 .ocamlinit diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 65c971ce76..274a0001b1 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -258,6 +258,7 @@ ########## Dune ########## +/.ocamlinit @ejgallego /Makefile.dune @ejgallego /tools/coq_dune* @ejgallego /dune* @ejgallego diff --git a/.ocamlinit b/.ocamlinit new file mode 100644 index 0000000000..3771334e12 --- /dev/null +++ b/.ocamlinit @@ -0,0 +1 @@ +#rectypes;; diff --git a/dev/doc/build-system.dune.md b/dev/doc/build-system.dune.md index 0b3e414513..85aaf317ef 100644 --- a/dev/doc/build-system.dune.md +++ b/dev/doc/build-system.dune.md @@ -39,6 +39,17 @@ In order to build a single package, you can do `dune build $PACKAGE.install`. Dune also provides targets for documentation and testing, see below. +## Developer shell + +You can create a developer shell with `dune utop $library`, where +`$library` can be any directory in the current workspace. For example, +`dune utop engine` or `dune utop plugins/ltac` will launch `utop` with +the right libraries already loaded. + +Note that you must invoke the `#rectypes;;` toplevel flag in order to +use Coq libraries. The provided `.ocamlinit` file does this +automatically. + ## Compositionality, developer and release modes. By default [in "developer mode"], Dune will compose all the packages -- cgit v1.2.3