-
Notifications
You must be signed in to change notification settings - Fork 415
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
doc: split foreign.rst #10718
doc: split foreign.rst #10718
Conversation
9d680c4
to
6a5f107
Compare
@Leonidas-from-XIV the only content changes are the added xrefs in the flags document and the removed intro in the now-deleted document. |
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 am not sure splitting the document into multiple pages is an improvement since I liked that the topic of dealing with foreign code was fairly contained on one page, but will defer to your judgement on that.
Thanks for specifying the content changes, that has made it significantly nicer to review! I wrote some comments as I looked through the newly split pages though.
Thanks for the feedback, there's a balance to find here:
What I suggest is creating an issue about creating the following doc: an how-to guide which would be "how to use non-ocaml code in my project", with sections corresponding to foreign_stubs (you're in control of this C code) and foreign_archives with optionally foreign_library (this is already built somewhere / there's another build system in there). How does that sound? |
6a5f107
to
fdbcc86
Compare
Signed-off-by: Etienne Millon <[email protected]>
fdbcc86
to
086d7cf
Compare
Signed-off-by: Etienne Millon <[email protected]>
This splits the monolithic
foreign.rst
into 4 pages:foreign_stubs
foreign_archives
(andforeign_library
)extra_objects
This is given its own toc in the index, and some xrefs are added.