Skip to content

Commit c68f38b

Browse files
authored
Minor documentation fixes (#11642)
* Enhance documentation around `dirs` * Add documentation warning about include_subdirs and lexer/parsers Signed-off-by: Raphaël Monat <[email protected]>
1 parent 0f79e32 commit c68f38b

File tree

2 files changed

+17
-0
lines changed

2 files changed

+17
-0
lines changed

doc/reference/dune/dirs.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,3 +27,14 @@ Dune will not scan a directory that isn't included in this stanza. Any contained
2727
``dune`` (or other special) files won't be interpreted either and will be
2828
treated as raw data. It is however possible to depend on files inside ignored
2929
subdirectories.
30+
31+
.. warning::
32+
33+
Directory names should not contain any trailing slashes.
34+
35+
If you want to exclude a subdirectory, such as `foo/bar`, you need to use the
36+
:doc:`/reference/dune/subdir` stanza:
37+
38+
.. code:: dune
39+
40+
(subdir foo (dirs :standard \ bar)) ;; exclude foo/bar

doc/reference/dune/include_subdirs.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,3 +35,9 @@ following stanzas:
3535
- ``library``
3636
- ``executable(s)``
3737
- ``test(s)``
38+
39+
.. warning::
40+
41+
Currently the `(ocamllex)`, `(ocamlyacc)` and `(menhir)` stanzas do not work
42+
well in combination with `(include_subdirs qualified)`. See `this issue
43+
<https://github.com/ocaml/dune/issues/11119>`_ for more information.

0 commit comments

Comments
 (0)