allow `dune describe workspace` to accept directories as arguments #6107

esope · 2022-08-26T18:19:42Z

The provided directories restrict the worskpace description to those
directories. Note that the transitive dependencies of the discovered
executables and libraries are always printed.

If no argument is provided, then the behavior is unchanged.
If . is provided as argument, then only the part of the workspace
that is reachable from the current directory is printed (which makes
a difference if the command is run from a subdirectory).

This fixes issue #3893.

rgrinberg · 2022-08-29T06:41:41Z

Without looking closely at the source, does this respect running dune describe from sub directories?

esope · 2022-08-29T08:05:35Z

I don't think so. I had not thought about this.
Do you know some other place in dune's codebase, where this is done already?

nojb · 2022-08-29T08:08:59Z

Do you know some other place in dune's codebase, where this is done already?

dune build?

esope · 2022-08-29T15:04:20Z

When adding tests to run dune describe from a subdirectory, I currently get the following warning:

Warning: No dune-project file has been found. A default one is assumed but
the project might break when dune is upgraded. Please create a dune-project
file.
Hint: generate the project file with: $ dune init project <name>

And the source root is incorrectly detected as being ..
This is surprising, since there is a valid dune-project file in the parent directory.
Any idea about what could be going on?

rgrinberg · 2022-08-29T20:47:23Z

You're running into the special behavior of root discovery being turned off when running tests. Just set the root manually with --root

esope · 2022-08-30T10:02:05Z

It seems that setting the workspace root using --root also has as a side effect to cd to this root before doing anything, as witnessed by the Entering directory '..' messages.
This is not what I would like to test.
I must admit I am stuck.

esope · 2022-08-30T13:07:12Z

The code seems to work correctly now, even when it is called from a subdirectory.
However, I was not able to add tests for the "run from a subdirectory" behavior.

rgrinberg · 2022-08-30T17:24:23Z

bin/describe.ml

-      | Error `Already_reported | Ok None -> ()
+      | Error `Already_reported ->
+        flush_all ();
+        exit 1


Why do we need this exit and the flush?

I can remove them if you want.
I added them to partially fix a behavior I am surprised with: if an error is raised (using User_error.raise) then dune describe still exits with errno 0. And do not see the standard error in my terminal, although when I redirect it to a file, this file contains the correct error message.
I do not observe this behavior with the released version of dune. Has anything changed in between?
EDIT: the call to flush_all does not fix the "silent stderr" issue. I also checked that my terminal is properly working, as it correctly displays stderr if I use, say, output_string stderr "XXX" in the implementation.

I can remove this code entirely and use Build_system.run_exn instead of Build_system.run if you think this is a better solution.
EDIT: done in the last force-push.

Thanks. The issue is likely from my change to output messages in a separate thread. Could you create an issue for this?

Sure. Reported in #6115

allow `dune describe workspace` to accept directories as arguments The provided directories restrict the worskpace description to those directories. Note that the transitive dependencies of the discovered executables and libraries are always printed. If no argument is provided, or if `.` is provided, then the behavior is unchanged. This fixes issue#3893. Signed-off-by: Benoît Montagu <[email protected]>

@rgrinberg

…ne-site, dune-rpc, dune-rpc-lwt, dune-private-libs, dune-glob, dune-configurator, dune-build-info, dune-action-plugin and chrome-trace (3.5.0~alpha1) CHANGES: - Sandbox running cinaps actions starting from cinaps 1.1 (ocaml/dune#6176, @rgrinberg) - Add a `runtime_deps` field in the `cinaps` stanza to specify runtime dependencies for running the cinaps preprocessing action (ocaml/dune#6175, @rgrinberg) - Shadow alias module `Foo__` when building a library `Foo` (ocaml/dune#6126, @rgrinberg) - Extend dune describe to include the root path of the workspace and the relative path to the build directory. (ocaml/dune#6136, @reubenrowe) - Allow dune describe workspace to accept directories as arguments. The provided directories restrict the worskpace description to those directories. (ocaml/dune#6107, fixes ocaml/dune#3893, @esope) - Add a terminal persistence mode that attempts to clear the terminal history. It is enabled by setting terminal persistence to `clear-on-rebuild-and-flush-history` (ocaml/dune#6065, @rgrinberg) - Disallow generating targets in sub direcories in inferred rules. The check to forbid this was accidentally done only for manually specified targets (ocaml/dune#6031, @rgrinberg) - Do not ignore rules marked `(promote (until-clean))` when `--ignore-promoted-rules` (or `-p`) is passed. (ocaml/dune#6010, fixes ocaml/dune#4401, @emillon) - Dune no longer considers .aux files as targets during Coq compilation. This means that .aux files are no longer cached. (ocaml/dune#6024, fixes ocaml/dune#6004, @Alizter) - Cinaps actions are now sandboxed by default (ocaml/dune#6062, @rgrinberg) - Allow rules producing directory targets to be not sandboxed (ocaml/dune#6056, @rgrinberg) - Introduce a `dirs` field in the `install` stanza to install entire directories (ocaml/dune#5097, fixes ocaml/dune#5059, @rgrinberg) - Menhir rules are now sandboxed by default (ocaml/dune#6076, @rgrinberg) - Allow rules producing directory targets to create symlinks (ocaml/dune#6077, fixes ocaml/dune#5945, @rgrinberg) - Inline tests are now sandboxed by default (ocaml/dune#6079, @rgrinberg) - Fix build-info version when used with flambda (ocaml/dune#6089, fixes ocaml/dune#6075, @jberdine) - Add an `(include <file>)` term to the `include_dirs` field for adding directories to the include paths sourced from a file. (ocaml/dune#6058, fixes ocaml/dune#3993, @gridbugs) - Support `(extra_objects ...)` field in `(executable ...)` and `(library ...)` stanzas (ocaml/dune#6084, fixes ocaml/dune#4129, @gridbugs) - Fix compilation of Dune under esy on Windows (ocaml/dune#6109, fixes ocaml/dune#6098, @nojb) - Improve error message when parsing several licenses in `(license)` (ocaml/dune#6114, fixes ocaml/dune#6103, @emillon) - odoc rules now about `ODOC_SYNTAX` and will rerun accordingly (ocaml/dune#6010, fixes ocaml/dune#1117, @emillon) - dune install: copy files in an atomic way (ocaml/dune#6150, @emillon) - Add `%{coq:...}` macro for accessing data about the configuration about Coq. For instance `%{coq:version}` (ocaml/dune#6049, @Alizter) - update vendored copy of cmdliner to 1.1.1. This improves the built-in documentation for command groups such as `dune ocaml`. (ocaml/dune#6038, @emillon, ocaml/dune#6169, @shonfeder) - The test suite for Coq now requires Coq >= 8.16 due to changes in the plugin loading mechanism upstream (which now uses findlib). - Starting with Coq build language 0.6, theories can be built without importing Coq's standard library by including `(stdlib no)`. (ocaml/dune#6165 ocaml/dune#6164, fixes ocaml/dune#6163, @ejgallego @Alizter @LasseBlaauwbroek) - on macOS, sign executables produced by artifact substitution (ocaml/dune#6137, fixes ocaml/dune#5650, @emillon) - Added an (aliases ...) field to the (rules ...) stanza which allows the specification of multiple aliases per rule (ocaml/dune#6194, @Alizter)

@rgrinberg

…ne-site, dune-rpc, dune-rpc-lwt, dune-private-libs, dune-glob, dune-configurator, dune-build-info, dune-action-plugin and chrome-trace (3.5.0) CHANGES: - macOS: Handle unknown fsevents without crashing (ocaml/dune#6217, @rgrinberg) - Enable file watching on MacOS SDK < 10.13. (ocaml/dune#6218, @rgrinberg) - Sandbox running cinaps actions starting from cinaps 1.1 (ocaml/dune#6176, @rgrinberg) - Add a `runtime_deps` field in the `cinaps` stanza to specify runtime dependencies for running the cinaps preprocessing action (ocaml/dune#6175, @rgrinberg) - Shadow alias module `Foo__` when building a library `Foo` (ocaml/dune#6126, @rgrinberg) - Extend dune describe to include the root path of the workspace and the relative path to the build directory. (ocaml/dune#6136, @reubenrowe) - Allow dune describe workspace to accept directories as arguments. The provided directories restrict the worskpace description to those directories. (ocaml/dune#6107, fixes ocaml/dune#3893, @esope) - Add a terminal persistence mode that attempts to clear the terminal history. It is enabled by setting terminal persistence to `clear-on-rebuild-and-flush-history` (ocaml/dune#6065, @rgrinberg) - Disallow generating targets in sub direcories in inferred rules. The check to forbid this was accidentally done only for manually specified targets (ocaml/dune#6031, @rgrinberg) - Do not ignore rules marked `(promote (until-clean))` when `--ignore-promoted-rules` (or `-p`) is passed. (ocaml/dune#6010, fixes ocaml/dune#4401, @emillon) - Dune no longer considers .aux files as targets during Coq compilation. This means that .aux files are no longer cached. (ocaml/dune#6024, fixes ocaml/dune#6004, @Alizter) - Cinaps actions are now sandboxed by default (ocaml/dune#6062, @rgrinberg) - Allow rules producing directory targets to be not sandboxed (ocaml/dune#6056, @rgrinberg) - Introduce a `dirs` field in the `install` stanza to install entire directories (ocaml/dune#5097, fixes ocaml/dune#5059, @rgrinberg) - Menhir rules are now sandboxed by default (ocaml/dune#6076, @rgrinberg) - Allow rules producing directory targets to create symlinks (ocaml/dune#6077, fixes ocaml/dune#5945, @rgrinberg) - Inline tests are now sandboxed by default (ocaml/dune#6079, @rgrinberg) - Fix build-info version when used with flambda (ocaml/dune#6089, fixes ocaml/dune#6075, @jberdine) - Add an `(include <file>)` term to the `include_dirs` field for adding directories to the include paths sourced from a file. (ocaml/dune#6058, fixes ocaml/dune#3993, @gridbugs) - Support `(extra_objects ...)` field in `(executable ...)` and `(library ...)` stanzas (ocaml/dune#6084, fixes ocaml/dune#4129, @gridbugs) - Fix compilation of Dune under esy on Windows (ocaml/dune#6109, fixes ocaml/dune#6098, @nojb) - Improve error message when parsing several licenses in `(license)` (ocaml/dune#6114, fixes ocaml/dune#6103, @emillon) - odoc rules now about `ODOC_SYNTAX` and will rerun accordingly (ocaml/dune#6010, fixes ocaml/dune#1117, @emillon) - dune install: copy files in an atomic way (ocaml/dune#6150, @emillon) - Add `%{coq:...}` macro for accessing data about the configuration about Coq. For instance `%{coq:version}` (ocaml/dune#6049, @Alizter) - update vendored copy of cmdliner to 1.1.1. This improves the built-in documentation for command groups such as `dune ocaml`. (ocaml/dune#6038, @emillon, ocaml/dune#6169, @shonfeder) - The test suite for Coq now requires Coq >= 8.16 due to changes in the plugin loading mechanism upstream (which now uses `Findlib`). - Starting with Coq build language 0.6, theories can be built without importing Coq's standard library by including `(stdlib no)`. (ocaml/dune#6165 ocaml/dune#6164, fixes ocaml/dune#6163, @ejgallego @Alizter @LasseBlaauwbroek) - on macOS, sign executables produced by artifact substitution (ocaml/dune#6137, ocaml/dune#6231, fixes ocaml/dune#5650, fixes ocaml/dune#6226, @emillon) - Added an (aliases ...) field to the (rules ...) stanza which allows the specification of multiple aliases per rule (ocaml/dune#6194, @Alizter) - The `(coq.theory ...)` stanza will now ensure that for each declared `(plugin ...)`, the `META` file for it is built before calling `coqdep`. This enables the use of the new `Findlib`-based loading method in Coq 8.16; however as of Coq 8.16.0, Coq itself has some bugs preventing this to work yet. (ocaml/dune#6167 , workarounds ocaml/dune#5767, @ejgallego) - Allow include statement in install stanza (ocaml/dune#6139, fixes ocaml/dune#256, @gridbugs) - Handle CSI n K code in ANSI escape codes from commands. (ocaml/dune#6214, fixes ocaml/dune#5528, @emillon) - Add a new experimental feature `mode_specific_stubs` that allows the specification of different flags and sources for foreign stubs depending on the build mode (ocaml/dune#5649, @voodoos)

esope force-pushed the describe_issue3893 branch from 860e9ce to c220134 Compare August 26, 2022 18:23

esope mentioned this pull request Aug 26, 2022

"dune describe": allow to describe specific libraries and directories #3893

Closed

esope force-pushed the describe_issue3893 branch from c220134 to c00ac3e Compare August 30, 2022 13:03

rgrinberg reviewed Aug 30, 2022

View reviewed changes

esope force-pushed the describe_issue3893 branch 2 times, most recently from 790e4c4 to d0805f2 Compare September 2, 2022 15:32

rgrinberg force-pushed the describe_issue3893 branch from d0805f2 to da1323a Compare September 3, 2022 03:53

rgrinberg added this to the 3.5.0 milestone Sep 3, 2022

rgrinberg merged commit 46c5cbd into ocaml:main Sep 5, 2022

esope deleted the describe_issue3893 branch September 6, 2022 07:27

emillon mentioned this pull request Oct 19, 2022

[new release] xdg, stdune, ordering, ocamlc-loc, fiber, dyn, dune, dune-site, dune-rpc, dune-rpc-lwt, dune-private-libs, dune-glob, dune-configurator, dune-build-info, dune-action-plugin and chrome-trace (3.5.0) ocaml/opam-repository#22317

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

allow `dune describe workspace` to accept directories as arguments #6107

allow `dune describe workspace` to accept directories as arguments #6107

esope commented Aug 26, 2022 •

edited

Loading

rgrinberg commented Aug 29, 2022

esope commented Aug 29, 2022

nojb commented Aug 29, 2022

esope commented Aug 29, 2022

rgrinberg commented Aug 29, 2022

esope commented Aug 30, 2022

esope commented Aug 30, 2022

rgrinberg Aug 30, 2022

esope Aug 31, 2022 •

edited

Loading

esope Sep 2, 2022 •

edited

Loading

rgrinberg Sep 3, 2022

esope Sep 3, 2022

allow dune describe workspace to accept directories as arguments #6107

allow dune describe workspace to accept directories as arguments #6107

Conversation

esope commented Aug 26, 2022 • edited Loading

rgrinberg commented Aug 29, 2022

esope commented Aug 29, 2022

nojb commented Aug 29, 2022

esope commented Aug 29, 2022

rgrinberg commented Aug 29, 2022

esope commented Aug 30, 2022

esope commented Aug 30, 2022

rgrinberg Aug 30, 2022

Choose a reason for hiding this comment

esope Aug 31, 2022 • edited Loading

Choose a reason for hiding this comment

esope Sep 2, 2022 • edited Loading

Choose a reason for hiding this comment

rgrinberg Sep 3, 2022

Choose a reason for hiding this comment

esope Sep 3, 2022

Choose a reason for hiding this comment

allow `dune describe workspace` to accept directories as arguments #6107

allow `dune describe workspace` to accept directories as arguments #6107

esope commented Aug 26, 2022 •

edited

Loading

esope Aug 31, 2022 •

edited

Loading

esope Sep 2, 2022 •

edited

Loading