Stream: Dune devs & users

Topic: Improving Dune documentation


view this post on Zulip Ali Caglayan (Jun 01 2022 at 12:23):

Hello, I have been spending time improving the Dune documentation on Coq support. There is currently a PR open: https://github.com/ocaml/dune/pull/5755. I would appreciate any comments. :)

view this post on Zulip Li-yao (Jun 01 2022 at 13:39):

I thought "composition" was a dune idiom but now that I try to look it up in the documentation I only see the word used in the context of Coq, and not defined anywhere. What does "composition" actually mean, e.g., in "we only support composition with libraries defined in the same scope..."?

view this post on Zulip Paolo Giarrusso (Jun 01 2022 at 13:55):

You can compose descriptions of builds before starting the build

view this post on Zulip Paolo Giarrusso (Jun 01 2022 at 13:56):

so if you have libraries A B C, with deps A <- B <- C, you can ask to build a file in C and dune will only build files in A and B as needed

view this post on Zulip Paolo Giarrusso (Jun 01 2022 at 13:57):

so if you build everything in parallel, dune won't wait to be done with A and B before starting C

view this post on Zulip Paolo Giarrusso (Jun 01 2022 at 13:57):

with full support for composition (which is there for OCaml), library A can be installed instead of part of your source tree.

view this post on Zulip Paolo Giarrusso (Jun 01 2022 at 13:58):

this begs questions such as "what's the dune jargon for 'source tree'" and "what's the English name for dune's 'scope'"

view this post on Zulip Ali Caglayan (Jun 01 2022 at 14:01):

Li-yao said:

I thought "composition" was a dune idiom but now that I try to look it up in the documentation I only see the word used in the context of Coq, and not defined anywhere. What does "composition" actually mean, e.g., in "we only support composition with libraries defined in the same scope..."?

I wrote a nice long reply to Jim who had the same question here: https://github.com/ocaml/dune/pull/5755#issuecomment-1143503764


Last updated: Jan 30 2023 at 18:04 UTC