Skip to content

[new release] odoc (2.0.0) #19694

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

Merged
merged 8 commits into from
Oct 6, 2021
Merged

[new release] odoc (2.0.0) #19694

merged 8 commits into from
Oct 6, 2021

Conversation

jonludlam
Copy link
Member

OCaml documentation generator

CHANGES:

Breaking changes

Additions

Bugs fixed

CHANGES:

Breaking changes
- Remove odoc-parser into a separate repository (@jonludlam, ocaml/odoc#700)

Additions
- OCaml 4.13 support (@Octachron, ocaml/odoc#687, ocaml/odoc#689)
- Better errors/warnings (@Julow, ocaml/odoc#692, ocaml/odoc#717, ocaml/odoc#720, ocaml/odoc#732)
- ModuleType 'Alias' support (@jonludlam, ocaml/odoc#703)
- Improved test suite (@lubega-simon, ocaml/odoc#697)
- Improved documentation (@lubega-simon, @jonludlam, ocaml/odoc#702, ocaml/odoc#733)
- Strengthen module types (@jonludlam, ocaml/odoc#731)

Bugs fixed
- `uwt` now can be documented (@jonludlam, ocaml/odoc#708)
- Fix resolution involving deeply nested substitutions (@jonludlam, ocaml/odoc#727)
- Fix off-by-one error in error reporting (@asavahista, ocaml/odoc#736)
"odoc-parser" {>= "0.9.0"}
"astring"
"cmdliner"
"cppo" {build}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"cppo" {build}
"cppo" {build & >= "1.1.0"}

This is when the -V flag was introduced

]

build: [
["dune" "subst"] {pinned}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
["dune" "subst"] {pinned}
["dune" "subst"] {dev}

@jonludlam
Copy link
Member Author

ah, thanks @mseri! was just looking up the '-V' thing :-)

@mseri
Copy link
Member

mseri commented Oct 5, 2021

The remaining lower bound issue is related to a missing lower bound/conflict in logs.
We only need to add the relevant upper bounds to mdx and ocamlformat, then is good to merge!

@jonludlam
Copy link
Member Author

Great!

@jonludlam
Copy link
Member Author

jonludlam commented Oct 5, 2021

It's part of a fix for this build failure: https://opam.ci.ocaml.org/github/ocaml/opam-repository/commit/4dc4b7d1f3111293c80245d75e589ef88b49ff41/variant/opam-2.1,compilers,4.02,odoc.2.0.0,lower-bounds - pconv was introduced in cmdliner 1.0.0

@mseri
Copy link
Member

mseri commented Oct 5, 2021

Oh I see, I had missed the pconv failure!

@jonludlam
Copy link
Member Author

OK looks to me like all the failures are down to other things now.

@mseri
Copy link
Member

mseri commented Oct 6, 2021

Let's fix the remaining lower bound issues on mdx and ocamlformat-rpc given that we are here. I can spend some time suggesting the fix tomorrow

@jonludlam
Copy link
Member Author

Looks like logs.fmt turned up in logs.0.5.0 (mentioned here: https://v3.ocaml.org/p/logs/0.5.0), Ast_408 is in migrate_parsetree 1.3.0, Odoc_model was in odoc 1.5.0, Re.Glob is 1.8.0.

v3.ocaml.org/packages is very useful in figuring out these constraint problems!

@mseri
Copy link
Member

mseri commented Oct 6, 2021

Oh cool, thanks! I should really start using it. Having to crawl git tags of all the repos each time is quite a nightmare

@jonludlam
Copy link
Member Author

It's not perfect because v3 doesn't build with all depopts, but it's definitely easier than faffing with tags!

ocaml-migrate-parsetree.1.4.0 no longer exposes a module `Misc`
which was getting `include`ed in `migrate_ast.ml` causing shadowing
of `misc.ml`
@mseri
Copy link
Member

mseri commented Oct 6, 2021

Thanks a lot!
Last question, to @gpetiot and @Leonidas-from-XIV then I merge.
Is mdx 1.8 - 1.10 incompatible with ocaml 4.13? Can you have a look at the CI failures, e.g. https://opam.ci.ocaml.org/github/ocaml/opam-repository/commit/2a51dfa06784cb005cf79a554a3dad90b0219610/variant/opam-2.1,compilers,4.13,mdx.1.10.0?

@gpetiot
Copy link
Contributor

gpetiot commented Oct 6, 2021

Regarding the ocamlformat issues, apparently there is now a fixed dependency in bisect_ppx to ocamlformat since bisect_ppx.2.6.0. I'm not sure it's a good practice to make any package depend on ocamlformat, but it's a test dependency.

We can change the dependency to bisect_ppx to:
"bisect_ppx" {with-test & = "2.5.0"} in ocamlformat's opam files.
An even better solution would be to just remove this dependency.

@mseri
Copy link
Member

mseri commented Oct 6, 2021

The remaining failures will need to be addressed separately. I think it is better to release some resources and deal with them on the side

@mseri mseri merged commit 916468d into ocaml:master Oct 6, 2021
@mseri
Copy link
Member

mseri commented Oct 6, 2021

@gpetiot thanks for the clarification.
As per mdx the upper bound on 4.13 has just been added in #19637

@Leonidas-from-XIV
Copy link
Contributor

@mseri mdx 1.10.1 adds support for 4.13

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants