about summary refs log tree commit diff
path: root/doc
diff options
context:
space:
mode:
authorVincent Laporte <Vincent.Laporte@gmail.com>2022-03-27 15:07:31 +0200
committerVincent Laporte <vbgl@users.noreply.github.com>2022-03-28 07:08:14 +0200
commit87c74b8120980461a9d4ce8f341551ce0fb50728 (patch)
treec1a5f02a9980097a0d61a136af7ab7af414ec42a /doc
parent7cc596593c5cae180024b1322f366847ae764bbe (diff)
User manual: document duneVersion
Diffstat (limited to 'doc')
-rw-r--r--doc/languages-frameworks/ocaml.section.md10
1 files changed, 7 insertions, 3 deletions
diff --git a/doc/languages-frameworks/ocaml.section.md b/doc/languages-frameworks/ocaml.section.md
index e4813d7dd2d4b..c6e40eaa20d00 100644
--- a/doc/languages-frameworks/ocaml.section.md
+++ b/doc/languages-frameworks/ocaml.section.md
@@ -38,8 +38,12 @@ Here is a simple package example.
 
 - It uses the `fetchFromGitHub` fetcher to get its source.
 
-- `useDune2 = true` ensures that Dune version 2 is used for the
-  build (this is the default; set to `false` to use Dune version 1).
+- `duneVersion = "2"` ensures that Dune version 2 is used for the
+  build (this is the default; valid values are `"1"`, `"2"`, and `"3"`);
+  note that there is also a legacy `useDune2` boolean attribute:
+  set to `false` it corresponds to `duneVersion = "1"`; set to `true` it
+  corresponds to `duneVersion = "2"`. If both arguments (`duneVersion` and
+  `useDune2`) are given, the second one (`useDune2`) is silently ignored.
 
 - It sets the optional `doCheck` attribute such that tests will be run with
   `dune runtest -p angstrom` after the build (`dune build -p angstrom`) is
@@ -67,7 +71,7 @@ Here is a simple package example.
 buildDunePackage rec {
   pname = "angstrom";
   version = "0.15.0";
-  useDune2 = true;
+  duneVersion = "2";
 
   minimalOCamlVersion = "4.04";