Add documentation for depexts (#13657)#13831
Conversation
Leonidas-from-XIV
left a comment
There was a problem hiding this comment.
Thanks for starting the documentation on depexts.
Leonidas-from-XIV
left a comment
There was a problem hiding this comment.
We discussed this at standup and I was asked to re-review it. So my conclusion is that to merge it still needs a bit of rework:
- It needs a ticket to track that there should be a way to declare depexts without having to go through
.opam.templatefiles. Projects usingdune pkgdon't even need to generate.opamfiles usually so forcing these files onto the projects becausedune-projectdoes not support depexts is really unfortunate. - It is not a reference. It's an explanation or maybe a howto and thus should be moved accordingly. The reference part of this is very short or even non-existent because the feature we'd want to document (specifying the depexts of my project) doesn't exist (see my first point).
- @sabine, you need to sign off the commits (to pass the DCO check) and possibly rebase. I don't think the CI failures are related to the documentation but it would still be good to have this PR pass CI successfully.
|
Ah sorry for dropping the ball on this.
I don't see anything right now that could be done to make this clearer, so I estimate this needs a final review (especially the new How To document)? I'm waiting for CI to finish to fix any remaining errors if any. |
Leonidas-from-XIV
left a comment
There was a problem hiding this comment.
Thanks for picking it up again. Looks good overall, I only have a few small comments to clarify.
CI looks good now, the benchmarking failure can probably be disregarded.
Add a new standalone reference page documenting external system dependencies (depexts): declaration in opam files, lock directory format (standard and portable), the dune show depexts command, platform variables with environment overrides, and build failure hints. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: sabine <6594573+sabine@users.noreply.github.com>
- Rename title to "External System Dependencies (depexts)" - Remove warning banner and versionadded markers (docs ship in sync) - Remove Lock Directory Format section (implementation detail) - Remove Platform Variables section (not user-facing) - Remove portable/standard lock directory terminology - Clarify depexts come from opam files, link to opam manual - Note that dependency solving can happen automatically, not just via dune pkg lock - Add opam Manual link to seealso section - Add verification comment for error message example Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: sabine <6594573+sabine@users.noreply.github.com>
The standalone reference page didn't fit because Dune doesn't have a native depexts feature yet. Move the explanation content into the package management explanation doc and create a how-to guide for declaring, querying, and diagnosing depexts. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> Signed-off-by: sabine <6594573+sabine@users.noreply.github.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> Signed-off-by: sabine <6594573+sabine@users.noreply.github.com>
Not relevant for the vast majority of users. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> Signed-off-by: sabine <6594573+sabine@users.noreply.github.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> Signed-off-by: sabine <6594573+sabine@users.noreply.github.com>
Leonidas-from-XIV
left a comment
There was a problem hiding this comment.
Thanks! Undraft once you think it is ready to be merged.
Add a new reference page documenting external system dependencies (
depexts):This is a first PR to lay the groundwork (reference docs) for #13657. There will be one or more followups to add the remaining new pages (tutorial, how to), and to make the addition to the existing doc.