Doc & CHANGES

Signed-off-by: Rudi Grinberg <me@rgrinberg.com>
ocaml · Mar 30, 2020 · a9ae11f · a9ae11f
1 parent 39d22c4
commit a9ae11f
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 0 deletions.
diff --git a/CHANGES.md b/CHANGES.md
@@ -38,6 +38,9 @@ Unreleased
 
 - Allow per-package `version` in generated `opam` files (#3287, @toots)
 
+- Add a `(chdir ..)` stanza to allow evaluating stanzas in sub directories.
+  (#3268, @rgrinberg)
+
 2.4.0 (06/03/2020)
 ------------------
 

diff --git a/doc/dune-files.rst b/doc/dune-files.rst
@@ -1497,6 +1497,21 @@ run this toplevel with:
 
    $ dune exec ./tt.exe
 
+chdir
+-----
+
+The ``chdir`` stanza can be used to evaluate stanzas in sub directories. This is
+useful for generated files or to override stanzas in vendored direcotries
+without editing vendored dune files.
+
+In this example, a ``bar`` target is created in the ``foo`` directory, and a bar
+target will be created in ``a/b/bar``:
+
+.. code:: scheme
+
+   (chdir foo (rule (with-stdout-to bar (echo baz))))
+   (chdir a/b (rule (with-stdout-to bar (echo baz))))
+
 external_variant
 -----------------