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.

Sign up for GitHub

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

Jump to bottom

feature: mdx 0.4 stanza with support for mld files out of the box #7582

Merged
merged 1 commit into from
Apr 24, 2023
Merged

feature: mdx 0.4 stanza with support for mld files out of the box #7582

merged 1 commit into from
Apr 24, 2023

Conversation

Leonidas-from-XIV
Copy link
Collaborator

@Leonidas-from-XIV Leonidas-from-XIV commented Apr 19, 2023 •
edited
Loading

MDX 2.3.0 added support for MLD files, the mdx 0.4 stanza adds *.mld to the default globs.

Probably it would make sense to add a version check for this and it would be good to land #7569 beforehand.

@rgrinberg rgrinberg requested a review from emillon April 20, 2023 04:53
rgrinberg
rgrinberg reviewed Apr 20, 2023
View reviewed changes
src/dune_rules/mdx.ml Outdated Show resolved Hide resolved
rgrinberg
rgrinberg reviewed Apr 20, 2023
View reviewed changes
src/dune_rules/mdx.ml Outdated Show resolved Hide resolved
@emillon
Copy link
Collaborator

emillon commented Apr 20, 2023

it would make sense to add a version check for this

what do you mean by this?

can you add a test for this (in addition to #7569)?

Also, can you update the docs of the mdx stanza? it should mention the new default. You can upgrade the 0.2 version in the example and suggest the new recommended version of mdx.

Thanks!

@Leonidas-from-XIV
Copy link
Collaborator Author

what do you mean by this?

I mean, at the moment there is code that checks that MDX is at least version 1.6, but for newer mdx stanzas (0.4 in this case) we need the user to have MDX 2.3 at least, otherwise the build will fail.

can you add a test for this (in addition to #7569)?

Yes, will rebase once that is merged and add it there.

@emillon
Copy link
Collaborator

emillon commented Apr 20, 2023

that checks that MDX is at least version 1.6

oh, there is? what is the failure more?

I'm not sure that it's actually possible to use the mdx stanza with mdx 1.6. It would be interesting to update these bounds.

@rgrinberg rgrinberg added the mdx label Apr 20, 2023
@rgrinberg
Copy link
Member

Needs a CHANGES entry

emillon
emillon reviewed Apr 20, 2023
View reviewed changes
src/dune_rules/mdx.ml Outdated Show resolved Hide resolved
@rgrinberg rgrinberg added this to the 3.8.0 milestone Apr 20, 2023
@Leonidas-from-XIV Leonidas-from-XIV marked this pull request as ready for review April 20, 2023 15:02
@Leonidas-from-XIV
Copy link
Collaborator Author

I'm not sure that it's actually possible to use the mdx stanza with mdx 1.6. It would be interesting to update these bounds.

It actually doesn't do any version checks, it tries ocaml-mdx deps and if that fails for whatever reason it displays an error message suggesting to use mdx.1.6.0.

Maybe doing version checks of MDX depending on the stanza version would make sense (as the docs state, 0.2 needs mdx.1.9.0 and 0.4 needs 2.3.0), though if you think that's a sensible addition I would suggest adding that in a separate PR.

@emillon
Copy link
Collaborator

emillon commented Apr 21, 2023

I don't think that version checks (in the "error if not fulfilled") are too useful, but I'd love to have a way to push a mdx dependency to the opam generation layer ((using mdx 0.4) would auto-generate mdx (>= 2.3.0)). I tried to do that some time ago but it was harder than I expected. You can revisit that idea if you think that the experience is not great (in a different PR of course).

@Leonidas-from-XIV
Copy link
Collaborator Author

I haven't thought of this but pushing the dependency to the opam file as a test dependency is indeed a much nicer UX than just falling over and telling people to install a newer MDX!

@Leonidas-from-XIV Leonidas-from-XIV changed the title mdx 0.4 stanza with support for mld files out of the box feature: mdx 0.4 stanza with support for mld files out of the box Apr 21, 2023
emillon
emillon reviewed Apr 21, 2023
View reviewed changes
src/dune_rules/mdx.ml Outdated Show resolved Hide resolved
src/dune_rules/mdx.ml Outdated Show resolved Hide resolved
src/dune_rules/mdx.ml Show resolved Hide resolved
emillon
emillon reviewed Apr 21, 2023
View reviewed changes
src/dune_rules/mdx.ml Outdated Show resolved Hide resolved
@Leonidas-from-XIV
feature: Add mdx 0.4 stanza
abdafe4 
This adds the `mdx` 0.4 stanza that extends the default glob for files
to include `.mld` files.

Signed-off-by: Marek Kubica <marek@tarides.com>
@rgrinberg rgrinberg merged commit 7b5dcf0 into ocaml:main Apr 24, 2023
@Leonidas-from-XIV Leonidas-from-XIV deleted the mdx-mld branch April 25, 2023 07:45
@emillon emillon mentioned this pull request May 3, 2023
Closed
emillon added a commit to emillon/opam-repository that referenced this pull request May 3, 2023
@emillon
[new release] dune (15 packages) (3.8.0~alpha2)
4d05b56 
CHANGES:

- Correctly set `MANPATH` in `dune exec`. Previously, we would use the `bin/`
  directory of the context. (ocaml/dune#7655, @rgrinberg)

- Allow overriding the `ocaml` binary with findlib configuration (ocaml/dune#7648,
  @rgrinberg)

- Modules that were declared in `(modules_without_implementation)`,
  `(private_modules)` or `(virtual_modules)` but not declared in `(modules)`
  will cause Dune to emit a warning which will become an error in 3.9. (ocaml/dune#7608,
  fixes ocaml/dune#7026, @Alizter)

- Dune can now detect Coq theories from outside the workspace. This allows for
  composition with installed theories (not necessarily installed with Dune).
  (ocaml/dune#7047, @Alizter, @ejgallego)

- Fix regression where Merlin was unable to handle filenames with uppercase
  letters under Windows. (ocaml/dune#7577, @nojb)

- On nix+macos, pass `-f` to the codesign hook to avoid errors when the binary
  is already signed (ocaml/dune#7183, fixes ocaml/dune#6265, @greedy)

- Fix bug where RPC clients built with dune-rpc-lwt would crash when closing
  their connection to the server (ocaml/dune#7581, @gridbugs)

- Introduce mdx stanza 0.4 requiring mdx >= 2.3.0 which updates the default
  list of files to include `*.mld` files (ocaml/dune#7582, @Leonidas-from-XIV)

- Fix RPC server on Windows (used for OCaml-LSP). (ocaml/dune#7666, @nojb)

- In `(executable)`, `(public_name -)` is now equivalent to no `(public_name)`.
  This is consistent with how `(executables)` handles this field.
  (ocaml/dune#7576 , fixes ocaml/dune#5852, @emillon)

- Change directory of odoc assets to `odoc.support` (was `_odoc_support`) so
  that it works with Github Pages out of the box. (ocaml/dune#7588, fixes ocaml/dune#7364,
  @emillon)
@emillon emillon mentioned this pull request May 23, 2023
Merged
emillon added a commit to emillon/opam-repository that referenced this pull request May 23, 2023
@emillon
[new release] dune (15 packages) (3.8.0)
df1ab22 
CHANGES:

- Fix string quoting in the json file written by `--trace-file` (ocaml/dune#7773,
  @rleshchinskiy)

- Read `pkg-config` arguments from the `PKG_CONFIG_ARGN` environment variable
  (ocaml/dune#1492, ocaml/dune#7734, @anmonteiro)

- Correctly set `MANPATH` in `dune exec`. Previously, we would use the `bin/`
  directory of the context. (ocaml/dune#7655, @rgrinberg)

- Allow overriding the `ocaml` binary with findlib configuration (ocaml/dune#7648,
  @rgrinberg)

- merlin: ignore instrumentation settings for preprocessing. (ocaml/dune#7606, fixes
  ocaml/dune#7465, @Alizter)

- When a rule's action is interrupted, delete any leftover directory targets.
  This is consistent with how we treat file targets. (ocaml/dune#7564, @rgrinberg)

- Fix plugin loading with findlib. The functionality was broken in 3.7.0.
  (ocaml/dune#7556, @anmonteiro)

- Introduce a `public_headers` field on libraries. This field is like
  `install_c_headers`, but it allows to choose the extension and choose the
  paths for the installed headers. (ocaml/dune#7512, @rgrinberg)

- Load the host context `findlib.conf` when cross-compiling (ocaml/dune#7428, fixes
  ocaml/dune#1701, @rgrinberg, @anmonteiro)

- Add a `coqdoc_flags` field to the `coq.theory` stanza allowing the user to
  pass extra arguments to `coqdoc`. (ocaml/dune#7676, fixes ocaml/dune#7954 @Alizter)

- Resolve `ppx_runtime_libraries` in the target context when cross compiling
  (ocaml/dune#7450, fixes ocaml/dune#2794, @anmonteiro)

- Use `$PKG_CONFIG`, when set, to find the `pkg-config` binary  (ocaml/dune#7469, fixes
  ocaml/dune#2572, @anmonteiro)

- Modules that were declared in `(modules_without_implementation)`,
  `(private_modules)` or `(virtual_modules)` but not declared in `(modules)`
  will cause Dune to emit a warning which will become an error in 3.9. (ocaml/dune#7608,
  fixes ocaml/dune#7026, @Alizter)

- Preliminary support for Coq compiled intefaces (`.vos` files) enabled via
  `(mode vos)` in `coq.theory` stanzas. This can be used in combination with
  `dune coq top` to obtain fast re-building of dependencies (with no checking
  of proofs) prior to stepping into a file. (ocaml/dune#7406, @rlepigre)

- Fix dune crashing on MacOS in watch mode whenever `$PATH` contains `$PWD`
  (ocaml/dune#7441, fixes ocaml/dune#6907, @rgrinberg)

- Fix `dune install` when cross compiling (ocaml/dune#7410, fixes ocaml/dune#6191, @anmonteiro,
  @rizo)

- Find `pps` dependencies in the host context when cross-compiling,  (ocaml/dune#7410,
  fixes ocaml/dune#4156, @anmonteiro)

- Dune in watch mode no longer builds concurrent rules in serial (ocaml/dune#7395
  @rgrinberg, @jchavarri)

- Dune can now detect Coq theories from outside the workspace. This allows for
  composition with installed theories (not necessarily installed with Dune).
  (ocaml/dune#7047, @Alizter, @ejgallego)

- `dune coq top` now correctly respects the project root when called from a
  subdirectory. However, absolute filenames passed to `dune coq top` are no
  longer supported (due to being buggy) (ocaml/dune#7357, fixes ocaml/dune#7344, @rlepigre and
  @Alizter)

- Added a `--no-build` option to `dune coq top` for avoiding rebuilds (ocaml/dune#7380,
  fixes ocaml/dune#7355, @Alizter)

- RPC: Ignore SIGPIPE when clients suddenly disconnect (ocaml/dune#7299, ocaml/dune#7319, fixes
  ocaml/dune#6879, @rgrinberg)

- Always clean up the UI on exit. (ocaml/dune#7271, fixes ocaml/dune#7142 @rgrinberg)

- Bootstrap: remove reliance on shell. Previously, we'd use the shell to get
  the number of processors. (ocaml/dune#7274, @rgrinberg)

- Bootstrap: correctly detect the number of processors by allowing `nproc` to be
  looked up in `$PATH` (ocaml/dune#7272, @Alizter)

- Speed up file copying on macos by using `clonefile` when available
  (@rgrinberg, ocaml/dune#7210)

- Adds support for loading plugins in toplevels (ocaml/dune#6082, fixes ocaml/dune#6081,
  @ivg, @richardlford)

- Support commands that output 8-bit and 24-bit colors in the terminal (ocaml/dune#7188,
  @Alizter)

- Speed up rule generation for libraries and executables with many modules
  (ocaml/dune#7187, @jchavarri)

- Add `--watch-exclusions` to Dune build options (ocaml/dune#7216, @jonahbeckford)

- Do not re-render UI on every frame if the UI doesn't change (ocaml/dune#7186, fix
  ocaml/dune#7184, @rgrinberg)

- Make coq_db creation in scope lazy (@ejgallego, ocaml/dune#7133)

- Non-user proccesses such as version control or config checking are now run
  silently. (ocaml/dune#6994, fixes ocaml/dune#4066, @Alizter)

- Add the `--display-separate-messages` flag to separate the error messages
  produced by commands with a blank line. (ocaml/dune#6823, fixes ocaml/dune#6158, @esope)

- Accept the Ordered Set Language for the `modes` field in `library` stanzas
  (ocaml/dune#6611, @anmonteiro).

- dune install now respects --display quiet mode (ocaml/dune#7116, fixes ocaml/dune#4573, fixes
  ocaml/dune#7106, @Alizter)

- Stub shared libraries (dllXXX_stubs.so) in Dune-installed libraries could not
  be used as dependencies of libraries in the workspace (eg when compiling to
  bytecode and/or Javascript).  This is now fixed. (ocaml/dune#7151, @nojb)

- Allow the main module of a library with `(stdlib ...)` to depend on other
  libraries (ocaml/dune#7154, @anmonteiro).

- Bytecode executables built for JSOO are linked with `-noautolink` and no
  longer depend on the shared stubs of their dependent libraries (ocaml/dune#7156, @nojb)

- Added a new user action `(concurrent )` which is like `(progn )` but runs the
  actions concurrently. (ocaml/dune#6933, @Alizter)

- Allow `(stdlib ...)` to be used with `(wrapped false)` in library stanzas
  (ocaml/dune#7139, @anmonteiro).

- Allow parallel execution of inline tests partitions (ocaml/dune#7012, @hhugo)

- Support `(link_flags ...)` in `(cinaps ...)` stanza. (ocaml/dune#7423, fixes ocaml/dune#7416,
  @nojb)

- Allow `(package ...)` in any position within `(rule ...)` stanza (ocaml/dune#7445,
  @Leonidas-from-XIV)

- Always include `opam` files in the generated `.install` file. Previously, it
  would not be included whenever `(generate_opam_files true)` was set and the
  `.install` file wasn't yet generated. (ocaml/dune#7547, @rgrinberg)

- Fix regression where Merlin was unable to handle filenames with uppercase
  letters under Windows. (ocaml/dune#7577, @nojb)

- On nix+macos, pass `-f` to the codesign hook to avoid errors when the binary
  is already signed (ocaml/dune#7183, fixes ocaml/dune#6265, @greedy)

- Fix bug where RPC clients built with dune-rpc-lwt would crash when closing
  their connection to the server (ocaml/dune#7581, @gridbugs)

- Introduce mdx stanza 0.4 requiring mdx >= 2.3.0 which updates the default
  list of files to include `*.mld` files (ocaml/dune#7582, @Leonidas-from-XIV)

- Fix RPC server on Windows (used for OCaml-LSP). (ocaml/dune#7666, @nojb)

- Coq language versions less 0.8 are deprecated, and will be removed
  in an upcoming Dune version. All users are required to migrate to
  `(coq lang 0.8)` which provides the right semantics for theories
  that have been globally installed, such as those coming from opam
  (@ejgallego, @Alizter)

- Bump minimum version of the dune language for the melange syntax extension
  from 3.7 to 3.8 (ocaml/dune#7665, @jchavarri)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@emillon emillon emillon approved these changes

@rgrinberg rgrinberg Awaiting requested review from rgrinberg

Assignees
No one assigned
Labels
mdx
Projects
None yet
Milestone
3.8.0
Development

Successfully merging this pull request may close these issues.
3 participants
@Leonidas-from-XIV @emillon @rgrinberg