Add documentation for (include_subdirs qualified) (#8939)

Signed-off-by: Ezra Stevens <[email protected]> Co-authored-by: Ezra Stevens <[email protected]> Co-authored-by: Etienne Millon <[email protected]>
ocaml · Oct 17, 2023 · 7210842 · 7210842
1 parent 6d561e4
commit 7210842
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/doc/stanzas/include_subdirs.rst b/doc/stanzas/include_subdirs.rst
@@ -14,6 +14,7 @@ Where ``<mode>`` maybe be one of:
 
 - ``no``, the default
 - ``unqualified``
+- ``qualified``
 
 When the ``include_subdirs`` stanza isn't present or ``<mode>`` is ``no``, Dune
 considers subdirectories independent. When ``<mode>`` 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 ``<mode>`` 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``