-
Notifications
You must be signed in to change notification settings - Fork 469
dev meeting 2026 02 04
Marek Kubica edited this page Feb 5, 2026
·
2 revisions
- odoc3 support
- bump minimal version to 4.14 (Ali)
Attendees: @jonludlam @Leonidas-from-XIV @shonfeder @rgrinberg @sudha247 @punchagan @Alizter Ahukwuma Akunyili
- There is a PR for Odoc 3 rules
- Currently links to other packages are broken
- There is
@doc-newbut it doesn't always work as it can reference non-existing libraries - Odoc 3 fixed a lot if these issues
- External packages now link to ocaml.org
- Caching has been fixed
- Error reporting now only reports on things that the documentation author can fix
- New PR fixes
@docwhich works like the old@doc - There is also
@doc-full- Circular dependencies can be an issue
-
@doc-fullneeds to get all dependencies -
@doc-fullbuilds the sherlocode database - The sherlocode database does not have incrementality, has to be built in one go
- Link to the
odoc-config.sexpPR, which defines which packages to depend on - The
postflag is important to avoid circular dependencies. Previously there was a special field in OPAM butpostdependencies obsoleted that field - It is crucial that Dune supports
postdependencies - Why shouldn't
odocbe markedwith-doc? - @jonludlam likes the current semantic of just picking
dependswhich have:with-doc, also adding:postmanually is fine - Conflicting rules: odoc is currently generating
odoc-config.sexpwhich conflicts if Dune generates the same file- We can avoid generating the file if the file is going to have no meaningful configuration
- There is an issue with Angstrom which installs subpackages for Lwt & Async
- They are separate packages but the main package still installs some bits
- What should Angstrom actually do? Probably stop doing this
- Could lead to breaking changes if
@docbreaks on Angstrom - These failures are unlikely to be detected in OPAM CI because the OPAM CI does not build documentation
- Can we add
:with-doctesting to the OPAM Repo CI?- Compute is not that expensive, Jon and Mark tried on a single machine and it took 6h for all packages
- Can a test be written to exhibit the same issue as Angstrom has, but without requiring Angstrom?
- @jonludlam is not too worried about this particular issue, more about currently unknown unknowns
-
@doc-newcan be removed. It is not used and people won't miss it if@docis strictly better - There is a PR about Markdown support, the Dune team will prioritize merging it
- It requires odoc 3 anyway
- It's been a long time in the making
- Will be a painful rebase but someone will have to rebase anyway
- Caching is on by default but odoc rules are possibly buggy
- Better to enable sandboxing. It's slower but leads to more reliable rules
- odoc plugins
- Need to manually depend on the relevant plugins, there is no autodiscovery
- Better do it after the 3.22 release
- @rgrinberg expects pushback from users
- @Alizter created a PR to do so
- Users can use the
secondary-compilerto use Dune on older OCaml compilers, if we have 4.14 as secondary compiler - Eventually we want to move to OCaml 5 only
- We should start with the release process soon
- There is an OpenBSD issue in 3.21, should we do a point release for 3.21 or better to just continue rolling with 3.22
- Opam-Repo CI added support for OpenBSD just as we broke support for OpenBSD in 3.21
- @rgrinberg would like to make sure the trace events make 3.22
- @shonfeder would like to make sure that parametric libraries in JSOO make it for 3.22
- However, that code hasn't been reviewed yet
- It could be delayed
- Deadline for 3.22 in two weeks
- Creating patch releases also takes a lot of time, probably better used making 3.22