melange - add `melange.emit` targets to `@all` alias as well by default #7926

haochenx · 2023-06-09T07:36:21Z

It is confusing that dune build does not build targets specified by a melange.emit stanza by default.
This PR intends to address this by adding melange.emit targets to @all alias as well as (the current default) @melange alias by default.

This stems from the discussion of #7924.
more specifically, this PR implements the suggestion in #7924 (comment)

related: doc/melange.rst - make the alias attachment behavior of melange.emit clearer #7924
- implementing (1) in doc/melange.rst - make the alias attachment behavior of melange.emit clearer #7924 (comment)

Subtasks

adding melange.emit stanza targets to @all alias by default (in addition to the @melange alias)
add test cases
~~[ ] fix existing test cases if necessary~~ (update: does not seem to break any existing test)
change log entry

anmonteiro

This not what I had in mind. We want to keep the melange implicit alias, and additionally add the melange rules to the default one.

I tried to explain the required changes in #7924 (comment), how can I help clarify?

haochenx · 2023-06-09T08:15:45Z

This not what I had in mind. We want to keep the melange implicit alias, and additionally add the melange rules to the default one.

ah, I see. i'll try that approach.

haochenx · 2023-06-09T08:44:26Z

@anmonteiro i have just revised the approach. please check whether this matches your expectation

src/dune_rules/melange/melange_rules.ml

test/blackbox-tests/test-cases/melange/aliases.t

anmonteiro

I think we also want to attach the rules to the default alias, even if the user specifies (alias foo).

My mental model:

rules are unconditionally attached to the default alias
if (alias foo) is specified, additionally attach them to the foo alias; otherwise attach them to the implicit alias.

haochenx · 2023-06-10T06:10:18Z

@anmonteiro I have addressed your last comments. PTAL

Also I'm not sure what to put in the change log. Could you please help with that?

test/blackbox-tests/test-cases/melange/aliases.t

anmonteiro

Just a few small suggestions, otherwise starting to look good. Ends up being a nice cleanup.

test/blackbox-tests/test-cases/melange/aliases.t

anmonteiro · 2023-06-10T06:28:04Z

src/dune_rules/melange/melange_rules.ml

           ; Dep src
           ]))

+(** attach [deps] to the specified [alias] AND the (dune default) [all] alias.


Suggested change

(** attach [deps] to the specified [alias] AND the (dune default) [all] alias.

(* attach [deps] to the specified [alias] AND the (dune default) [all] alias.

reflected in 7c49c1d

src/dune_rules/melange/melange_rules.ml

anmonteiro

LGTM, thanks for working on this, @haochenx!

anmonteiro · 2023-06-10T16:31:46Z

For the changelog entry, how about:

attach melange rules to the default alias

haochenx · 2023-06-10T17:29:08Z

I've rebased with the main and added Changelog as per @anmonteiro suggested.

@anmonteiro @Alizter Thank you for your guidance!

I'm not sure what's the procedure for the closure of a PR here (especially who's to resolve discussions and how to ask the maintainer for a consider of merge). Please advice how to proceed.

anmonteiro · 2023-06-10T22:28:44Z

I'm not sure what's the procedure for the closure of a PR here (especially who's to resolve discussions and how to ask the maintainer for a consider of merge). Please advice how to proceed.

I made a few small edits to test / changes. PR is approved from my perspective, but I'd like to have @rgrinberg take a final look. Thanks!

rgrinberg

LGTM

test/blackbox-tests/test-cases/melange/aliases.t

Signed-off-by: Haochen Kotoi-Xie <[email protected]> Signed-off-by: Antonio Nuno Monteiro <[email protected]>

anmonteiro · 2023-06-11T22:00:02Z

Thanks!

Signed-off-by: Haochen Kotoi-Xie <[email protected]>

…` clearer (#7924) * doc/melange.rst - make default target alias clear in introduction Signed-off-by: Haochen Kotoi-Xie <[email protected]> * reflect reviewer's comments and changes by #7926 Signed-off-by: Haochen Kotoi-Xie <[email protected]> * fix formatting Signed-off-by: Haochen Kotoi-Xie <[email protected]> * reflect reviewer's comments Signed-off-by: Haochen Kotoi-Xie <[email protected]> * Update doc/melange.rst Signed-off-by: Antonio Nuno Monteiro <[email protected]> --------- Signed-off-by: Haochen Kotoi-Xie <[email protected]> Signed-off-by: Antonio Nuno Monteiro <[email protected]> Co-authored-by: Antonio Nuno Monteiro <[email protected]>

@3Rafal

CHANGES: - Validate file extension for `$ dune ocaml top-module`. (ocaml/dune#8005, fixes ocaml/dune#8004, @3Rafal) - Include the time it takes to read/write state files when `--trace-file` is enabled (ocaml/dune#7960, @rgrinberg) - Add `dune show` command group which is an alias of `dune describe`. (ocaml/dune#7946, @Alizter) - Include source tree scans in the traces produced by `--trace-file` (ocaml/dune#7937, @rgrinberg) - Cinaps: The promotion rules for cinaps would only offer one file at a time no matter how many promotions were available. Now we offer all the promotions at once (ocaml/dune#7901, @rgrinberg) - Do not re-run OCaml syntax files on every iteration of the watch mode. This is too memory consuming. (ocaml/dune#7894, fix ocaml/dune#6900, @rgrinberg) - Remove some compatibility code for old version of dune that generated `.merlin` files. Now dune will never remove `.merlin` files automatically (ocaml/dune#7562) - Add `dune show env` command and make `dune printenv` an alias of it. (ocaml/dune#7985, @Alizter) - Add additional metadata to the traces provided by `--trace-file` whenever `--trace-extended` is passed (ocaml/dune#7778, @rleshchinskiy) - Extensions used in `(dialect)` can contain periods (e.g., `cppo.ml`). (ocaml/dune#7782, fixes ocaml/dune#7777, @nojb) - Allow `(include_subdirs qualified)` to be used when libraries define a `(modules ...)` field (ocaml/dune#7797, fixes ocaml/dune#7597, @anmonteiro) - `$ dune describe` is now a command group, so arguments to subcommands must be passed after subcommand itself. (ocaml/dune#7919, @Alizter) - The `interface` and `implementation` fields of a `(dialect)` are now optional (ocaml/dune#7757, @gpetiot) - Add commands `dune show targets` and `dune show aliases` that display all the available targets and aliases in a given directory respectively. (ocaml/dune#7770, grants ocaml/dune#265, @Alizter) - Allow multiple globs in library's `(stdlib (internal_modules ..))` (@anmonteiro, ocaml/dune#7878) - Attach melange rules to the default alias (ocaml/dune#7926, @haochenx) - In opam constraints, reject `(and)` and `(or)` with no arguments at parse time (ocaml/dune#7730, @emillon) - Compute digests and manage sandboxes in background threads (ocaml/dune#7947, @rgrinberg) - Add `(build_if)` to the `(test)` stanza. When it evaluates to false, the executable is not built. (ocaml/dune#7899, fixes ocaml/dune#6938, @emillon) - Add necessary parentheses in generated opam constraints (ocaml/dune#7682, fixes ocaml/dune#3431, @Lucccyo)

@3Rafal

CHANGES: - Validate file extension for `$ dune ocaml top-module`. (ocaml/dune#8005, fixes ocaml/dune#8004, @3Rafal) - Include the time it takes to read/write state files when `--trace-file` is enabled (ocaml/dune#7960, @rgrinberg) - Add `dune show` command group which is an alias of `dune describe`. (ocaml/dune#7946, @Alizter) - Include source tree scans in the traces produced by `--trace-file` (ocaml/dune#7937, @rgrinberg) - Cinaps: The promotion rules for cinaps would only offer one file at a time no matter how many promotions were available. Now we offer all the promotions at once (ocaml/dune#7901, @rgrinberg) - Do not re-run OCaml syntax files on every iteration of the watch mode. This is too memory consuming. (ocaml/dune#7894, fix ocaml/dune#6900, @rgrinberg) - Add `--all` option to `dune rpc status` to show all Dune RPC servers running. (ocaml/dune#8011, fix ocaml/dune#7902, @Alizter) - Remove some compatibility code for old version of dune that generated `.merlin` files. Now dune will never remove `.merlin` files automatically (ocaml/dune#7562) - Add `dune show env` command and make `dune printenv` an alias of it. (ocaml/dune#7985, @Alizter) - Add additional metadata to the traces provided by `--trace-file` whenever `--trace-extended` is passed (ocaml/dune#7778, @rleshchinskiy) - Extensions used in `(dialect)` can contain periods (e.g., `cppo.ml`). (ocaml/dune#7782, fixes ocaml/dune#7777, @nojb) - Allow `(include_subdirs qualified)` to be used when libraries define a `(modules ...)` field (ocaml/dune#7797, fixes ocaml/dune#7597, @anmonteiro) - `$ dune describe` is now a command group, so arguments to subcommands must be passed after subcommand itself. (ocaml/dune#7919, @Alizter) - The `interface` and `implementation` fields of a `(dialect)` are now optional (ocaml/dune#7757, @gpetiot) - Add commands `dune show targets` and `dune show aliases` that display all the available targets and aliases in a given directory respectively. (ocaml/dune#7770, grants ocaml/dune#265, @Alizter) - Allow multiple globs in library's `(stdlib (internal_modules ..))` (@anmonteiro, ocaml/dune#7878) - Attach melange rules to the default alias (ocaml/dune#7926, @haochenx) - In opam constraints, reject `(and)` and `(or)` with no arguments at parse time (ocaml/dune#7730, @emillon) - Compute digests and manage sandboxes in background threads (ocaml/dune#7947, @rgrinberg) - Add `(build_if)` to the `(test)` stanza. When it evaluates to false, the executable is not built. (ocaml/dune#7899, fixes ocaml/dune#6938, @emillon) - Add necessary parentheses in generated opam constraints (ocaml/dune#7682, fixes ocaml/dune#3431, @Lucccyo)

haochenx force-pushed the melange-default-alias branch from b6e0713 to 6097e46 Compare June 9, 2023 07:39

anmonteiro reviewed Jun 9, 2023

View reviewed changes

This comment was marked as outdated.

Sign in to view

haochenx force-pushed the melange-default-alias branch from 6097e46 to 75182b4 Compare June 9, 2023 08:28

haochenx requested a review from anmonteiro June 9, 2023 08:31

haochenx force-pushed the melange-default-alias branch from 75182b4 to eacdc82 Compare June 9, 2023 08:43

haochenx force-pushed the melange-default-alias branch 2 times, most recently from 013da4a to f5823c7 Compare June 9, 2023 09:01

This comment was marked as outdated.

Sign in to view

haochenx marked this pull request as ready for review June 9, 2023 09:13

haochenx force-pushed the melange-default-alias branch from 613a4c7 to b14c82b Compare June 9, 2023 09:13

haochenx mentioned this pull request Jun 9, 2023

doc/melange.rst - make the alias attachment behavior of melange.emit clearer #7924

Merged

haochenx changed the title ~~melange - change default alias to @all~~ melange - add melange.emit targets to 'all' alias as well by default Jun 9, 2023

haochenx changed the title ~~melange - add melange.emit targets to 'all' alias as well by default~~ melange - add melange.emit targets to @all alias as well by default Jun 9, 2023

rgrinberg added the melange Melange rules and generator label Jun 9, 2023

rgrinberg marked this pull request as draft June 9, 2023 12:47

haochenx force-pushed the melange-default-alias branch from 6326d7b to cefc8e0 Compare June 9, 2023 15:33

Alizter reviewed Jun 9, 2023

View reviewed changes

src/dune_rules/melange/melange_rules.ml Outdated Show resolved Hide resolved

Alizter reviewed Jun 9, 2023

View reviewed changes

src/dune_rules/melange/melange_rules.ml Outdated Show resolved Hide resolved

haochenx force-pushed the melange-default-alias branch from de52b52 to e213c26 Compare June 9, 2023 17:57