Skip to content

Commit 95ca20d

Browse files
Update promotion.rst in response to PR comments
Signed-off-by: Chris Armstrong <[email protected]>
1 parent 454d17f commit 95ca20d

File tree

1 file changed

+8
-9
lines changed

1 file changed

+8
-9
lines changed

doc/concepts/promotion.rst

+8-9
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,15 @@
22
Diffing and Promotion
33
=====================
44

5-
Dune writes its build output to a separate directory from your source code tree
6-
(usually ``_build/<profile_name>``). You can use Diffing and Promotion flows
7-
to compare your build output with your source tree and/or copy the result of
8-
rule output into your source tree to store the changes.
5+
You can use Diffing and Promotion flows to compare your build output with
6+
your source tree and/or copy the result of rule output into your source
7+
tree to store the changes.
98

109
Diffing
1110
=======
1211

1312
You can use the ``(diff <file1> <file2>)`` directive in a rule to compare
14-
the output of the rule with a copy in your source tree. It is useful when
13+
its output with the version in your source tree. It is useful when
1514
your tests produce a file output and you want to make sure that output has
1615
not changed.
1716

@@ -102,10 +101,10 @@ Automatically Promoting Rule Output Into the Source Tree
102101
--------------------------------------------------------
103102

104103
Dune rules support a ``(mode promote)`` directive that will automatically
105-
copy their output into your source tree. This is more suitable for code or
106-
documentation generation flows where you want to check in the output to make
107-
it easier to browse or to remove dependencies on the code generation step for
108-
packaging in opam.
104+
copy their output into your source tree. This approach suits code
105+
documentation generation flows where output needs to be committed to source
106+
code control to enable easier browsing, or eliminate dependencies on a code
107+
generation step during opam package installation.
109108

110109
More information, including customising when the source is copied, can be found
111110
in :doc:`../reference/dune/rule`.

0 commit comments

Comments
 (0)