From 721084289c7b8e179d84be76a774f4119d5cf580 Mon Sep 17 00:00:00 2001 From: ezrast Date: Tue, 17 Oct 2023 02:39:12 -0700 Subject: [PATCH] Add documentation for (include_subdirs qualified) (#8939) Signed-off-by: Ezra Stevens Co-authored-by: Ezra Stevens Co-authored-by: Etienne Millon --- doc/stanzas/include_subdirs.rst | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/doc/stanzas/include_subdirs.rst b/doc/stanzas/include_subdirs.rst index a65520048af..354cf600bae 100644 --- a/doc/stanzas/include_subdirs.rst +++ b/doc/stanzas/include_subdirs.rst @@ -14,6 +14,7 @@ Where ```` maybe be one of: - ``no``, the default - ``unqualified`` +- ``qualified`` When the ``include_subdirs`` stanza isn't present or ```` is ``no``, Dune considers subdirectories independent. When ```` is ``unqualified``, Dune @@ -23,7 +24,9 @@ directories when looking for OCaml/Reason files. This allows you to split a library between several directories. ``unqualified`` means that modules in subdirectories are seen as if they were all in the same directory. In particular, you cannot have two modules with the same name in two different -directories. We plan to add a ``qualified`` mode in the future. +directories. When ```` is ``qualified``, each subdirectory's files will +be grouped into submodules of the library module, mirroring the directory +structure. Note that subdirectories are included recursively; however, the recursion will stop when encountering a subdirectory that contains another ``include_subdirs``