|
2 | 2 | Diffing and Promotion
|
3 | 3 | =====================
|
4 | 4 |
|
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. |
9 | 8 |
|
10 | 9 | Diffing
|
11 | 10 | =======
|
12 | 11 |
|
13 | 12 | 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 |
15 | 14 | your tests produce a file output and you want to make sure that output has
|
16 | 15 | not changed.
|
17 | 16 |
|
@@ -102,10 +101,10 @@ Automatically Promoting Rule Output Into the Source Tree
|
102 | 101 | --------------------------------------------------------
|
103 | 102 |
|
104 | 103 | 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. |
109 | 108 |
|
110 | 109 | More information, including customising when the source is copied, can be found
|
111 | 110 | in :doc:`../reference/dune/rule`.
|
0 commit comments