Skip to content
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

Merged
merged 1 commit into from
Jul 15, 2024
Merged

doc: split foreign.rst #10718

merged 1 commit into from
Jul 15, 2024

Conversation

emillon
Copy link
Collaborator

@emillon emillon commented Jul 11, 2024

This splits the monolithic foreign.rst into 4 pages:

  • foreign_stubs
  • foreign_archives (and foreign_library)
  • extra_objects
  • flags in foreign code

This is given its own toc in the index, and some xrefs are added.

@emillon emillon added the docs Documentation improvements label Jul 11, 2024
@emillon emillon force-pushed the doc-foreign-split branch from 9d680c4 to 6a5f107 Compare July 12, 2024 08:56
@emillon emillon marked this pull request as ready for review July 12, 2024 08:59
@emillon emillon requested a review from christinerose as a code owner July 12, 2024 08:59
@emillon
Copy link
Collaborator Author

emillon commented Jul 12, 2024

@Leonidas-from-XIV the only content changes are the added xrefs in the flags document and the removed intro in the now-deleted document.

Copy link
Collaborator

@Leonidas-from-XIV Leonidas-from-XIV left a 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.

@emillon
Copy link
Collaborator Author

emillon commented Jul 15, 2024

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 the feedback, there's a balance to find here:

  • on the one hand, the monolithic page was the only place where foreign_stubs (and friends) were documented, and they contain unrelated documentation (if you're looking for the syntax of (foreign_stubs), it's not likely you're interested in knowing about the history of use_standard_c_and_cxx_flags
  • on the other hand, the "here are all your options regarding foreign code in Dune" aspect is now lost.

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?

Signed-off-by: Etienne Millon <[email protected]>
@emillon emillon force-pushed the doc-foreign-split branch from fdbcc86 to 086d7cf Compare July 15, 2024 13:04
@emillon emillon merged commit 9c5969c into ocaml:main Jul 15, 2024
26 of 28 checks passed
@emillon emillon deleted the doc-foreign-split branch July 15, 2024 13:06
anmonteiro pushed a commit to anmonteiro/dune that referenced this pull request Nov 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation improvements
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants