-
Notifications
You must be signed in to change notification settings - Fork 409
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Explain how to override default entry point #11092
Conversation
Signed-off-by: Benjamin Sigonneau <benjamin.sigonneau@sandboxaq.com>
e19bfe8
to
6568af3
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the contribution! 👍
We are trying to rely more and more on the Diátaxis framework to improve the Dune documentation. In this situation, I would move this to the How-to guide section in the Dune documentation.
@Leonidas-from-XIV, what is your two cents on this?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree with @maiste, it's definitely more a howto, as it doesn't cover any particular advanced topic about Dune, more about how C stubs work but this has more to do with OCaml than Dune.
Still, we can definitely include it in the documentation.
Moved to the howto section, thanks for the suggestion! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it could have a bit of a "this is how the result works" section, otherwise it looks good from my point of view.
@christinerose could you please take a look at the text if it is ok that way?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, the update looks good! I have just one comment and, otherwise, as @Leonidas-from-XIV said, I let @christinerose do her magic (thanks in advance for having a look at this 🙏 )
Also, you need to update your commit to comply with the DCO (see the information).
Signed-off-by: Benjamin Sigonneau <benjamin.sigonneau@sandboxaq.com>
794aa9e
to
74f812c
Compare
Signed-off-by: Benjamin Sigonneau <benjamin.sigonneau@sandboxaq.com>
Signed-off-by: Christine Rose <christinerose@users.noreply.github.com>
Signed-off-by: Benjamin Sigonneau <benjamin.sigonneau@sandboxaq.com>
Just a quick comment: OCaml doesn't have a notion of "entry point" since basically everything is run in order. Therefore calling it the "C Entrypoint" might be better. This might be clearer to new users who might think that OCaml has entry points. |
I edited the document accordingly, thanks a lot for bringing up this point! |
Signed-off-by: Benjamin Sigonneau <benjamin.sigonneau@sandboxaq.com>
2691916
to
f67187e
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM 👍
The error in the CI is completely unrelated with the PR (as it just modifies the documentation). I think we can merge it. |
This PR adds a page in the "Advanced Topics" section of the doc. This new page explains how to override the default entry point in C and have dune compile everything.
For more context on why this could be useful, you can check the Wildcard expansion on Windows topic on the Ocaml Discourse.