OCamlverse/ocamlverse.github.io

dune-workspace: keep the notion and eliminate the dune-workspace file?

RogerTarani opened this issue · 4 comments

I understand the difference between a dune workspace and a dune project.
workspace: the workspace is the subtree starting from the root. It can contain any number of projects that will be built simultaneously by dune
project: a project is a source tree, maybe containing one or more packages.
See https://jbuilder.readthedocs.io/en/latest/terminology.html

Suggestion of improvement for the definition of project: a project is located in a dune workspace. If there is only one dune project defined with a dune-project file, the workspace is implicitly defined by this dune project.

Suggestion of improvement about dune workspace: wouldn't it be simple and useful to enforce the definition of a workspace with a dune-workspace file? Or much better: simply keep the notion of dune workspace but eliminate the dune-workspace file, so that the root will be flexibly defined by the higher dune-file when projects are modified?

See https://jbuilder.readthedocs.io/en/latest/usage.html#dune-workspace

I'm not sure what it is exactly that you wish for us to do? This is not a general help location for OCaml, this is just the issue tracker for bugs on the OCamlverse web site.

From the Dune documentation at https://jbuilder.readthedocs.io/en/latest/terminology.html, the Edit on GitHub link gets to https://github.com/OCamlverse/ocamlverse.github.io/blob/master/content/learning.md.
There, Issues is a natural place to provide improvement suggestions for Dune documentation.
Where else am I supposed to to do it?

From the Dune documentation at https://jbuilder.readthedocs.io/en/latest/terminology.html, the Edit on GitHub link gets to https://github.com/OCamlverse/ocamlverse.github.io/blob/master/content/learning.md.

I'm afraid when I click on the one I don't get to the other, and frankly I would have been shocked if I had, as the repositories are unconnected. I'd suggest that if you have problems with the Dune documentation, you should talk to the Dune developers. OCamlverse has nothing to do with Dune development.

EDIT:
it seems that the Edit on Github link on the Dune documentation page has been changed in the meantime (it is now in 404; it wasn't yesterday). I could also be tired and made a additional mistake.
The Dune issue has been reported to the right place: Dune Documentation #1349
Thanks.