Update promotion.rst to explain mode promote #11122
Conversation
|
I've tried to fix the broken link, but not sure if that'll take |
chris-armstrong
force-pushed
the
patch-1
branch
from
fda3530 to
e0984a6
Compare
There was a problem hiding this comment.
Thanks for the changes! I've added a few notes on how to improve the wording and accuracy a little bit.
I've also ran CI and you can see that the link does in fact work: https://dune--11122.org.readthedocs.build/en/11122/concepts/promotion.html
doc/concepts/promotion.rst
Outdated
| Diffing and Promotion | ||
| ===================== | ||
|
|
||
| Diffing and Promotion flows relate to the output files of dune rules and comparing or storing the result in your source tree. |
There was a problem hiding this comment.
I think it would be good to restate that normally Dune outputs to a separate build directory and promotion is one place where this is different (thus "promotion from build tree to source tree").
|
Thanks @Leonidas-from-XIV. Please see my changes above, hopefully these adequately address your comments. |
There was a problem hiding this comment.
Thanks, I've added a few corrections but it's on the right way.
@christinerose can you please take a look at the text and check?
doc/concepts/promotion.rst
Outdated
| -------------------------------------------------------- | ||
|
|
||
| Dune rules support a ``(mode promote)`` directive that will automatically | ||
| copy their output into your source tree. This is more suitable for code or |
There was a problem hiding this comment.
More suitable than what?
I made a few minor grammatical changes and suggested a couple of sentence alteration for readability. See what you think! |
Signed-off-by: Chris Armstrong <[email protected]>
Remove duplication and standardise on "rule targets" and "rule output" Signed-off-by: Chris Armstrong <[email protected]>
Signed-off-by: Christine Rose <[email protected]>
Signed-off-by: Christine Rose <[email protected]>
Signed-off-by: Christine Rose <[email protected]>
|
@chris-armstrong I have rebased the PR. Could you address the remaining comments? I think this PR is almost ready to be merged. |
|
Could you please take another look @maiste, hopefully this is ready to go |
There was a problem hiding this comment.
Thanks for your reactivity! Two small suggestions, but otherwise it looks good to me 👍
@Leonidas-from-XIV could you take another look at it when you have time to?
Co-authored-by: Etienne Marais <[email protected]> Signed-off-by: Chris Armstrong <[email protected]>
Co-authored-by: Etienne Marais <[email protected]> Signed-off-by: Chris Armstrong <[email protected]>
Signed-off-by: Marek Kubica <[email protected]>
There was a problem hiding this comment.
Looks good but is failing the DCO check. @chris-armstrong can you sign off your commits?
|
I don't know how to do what you're asking. Can we just close this PR - this was meant to be a small improvement to the documentation to make it clearer, but it's been back and forth several times over a few months that it seems hardly worth bothering with now. |
|
I'm happy to waive copyright on the changes in this PR if it makes it easier |
|
When accepting contributions we require the contributors to sign off that they possess the right to contribute the code etc. See more about it here. This is achieved via the In your case the easiest way via the The easiest way to add a signature to existing commits is to $ git rebase main --signoff
$ git push --force(This is also what I do when I forget to sign off my commits) |
Explain the difference between diffing and promotion and the use of (mode promote)