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

Fix error/warnings for config file #10923

Merged
merged 1 commit into from
Sep 25, 2024
Merged

Fix error/warnings for config file #10923

merged 1 commit into from
Sep 25, 2024

Conversation

H-ANSEN
Copy link
Contributor

@H-ANSEN H-ANSEN commented Sep 15, 2024

The following pull request seeks to resolve the issue listed below!

Expected Behavior

The configuration file for dune makes use of the same version numbering scheme as dune-project files (lang dune <ver>). When attempting to use dune with a configuration file that has a mismatch between a stanza and it's supported dune version an error indicating this mismatch in the configuration file should be displayed:

File "dune/config", line 2, characters 0-15:
2 | (cache enabled)
Error: 'cache' is only available since version 2.0 of the dune language.
Please update your dune config file to have (lang dune 2.0).

Actual Behavior

The actual recommends changing the version in the dune-project file as opposed to the users config file:

File "dune/config" line 2, characters 0-15:
2 | (cache enabled)
Error: 'cache' is only available since version 2.0 of the dune language.
Please update your dune-project file to have (lang dune 2.0).

Reproduction

printf "(lang dune 1.0)\n(cache enabled)" > dune-config
dune init proj test --config-file=dune-config

@rgrinberg
Copy link
Member

@Leonidas-from-XIV could you review this one?

Leonidas-from-XIV
Leonidas-from-XIV requested changes Sep 23, 2024
View reviewed changes
Copy link
Collaborator

@Leonidas-from-XIV Leonidas-from-XIV left a comment

Choose a reason for hiding this comment

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

Thanks for the contribution, I appreciate the extensive tests. The code is fine, see my comments on what would be worth improving to get it merged.

doc/changes/10923.md Outdated Show resolved Hide resolved
src/dune_sexp/syntax.ml Outdated Show resolved Hide resolved
src/dune_sexp/syntax.mli Outdated Show resolved Hide resolved
src/dune_sexp/syntax.mli Outdated Show resolved Hide resolved
test/blackbox-tests/test-cases/config/config-version.t Show resolved Hide resolved
test/blackbox-tests/test-cases/config/config-version.t Outdated Show resolved Hide resolved
test/blackbox-tests/test-cases/config/config-version.t Outdated Show resolved Hide resolved
Leonidas-from-XIV
Leonidas-from-XIV requested changes Sep 25, 2024
View reviewed changes
Copy link
Collaborator

@Leonidas-from-XIV Leonidas-from-XIV left a comment

Choose a reason for hiding this comment

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

Thanks for the revisions, the tests look pretty good now. I have one clarification and one small thing to make the tests safer, after that I think it's good to go!

src/dune_sexp/syntax.ml Outdated Show resolved Hide resolved
test/blackbox-tests/test-cases/config/config-version.t Show resolved Hide resolved
Leonidas-from-XIV
Leonidas-from-XIV approved these changes Sep 25, 2024
View reviewed changes
Copy link
Collaborator

@Leonidas-from-XIV Leonidas-from-XIV left a comment

Choose a reason for hiding this comment

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

Looks good, thanks!

@H-ANSEN @Leonidas-from-XIV
Fix error messages when referring to the dune config
308d03e 
Signed-off-by: teague hansen <[email protected]>
Signed-off-by: Marek Kubica <[email protected]>
@Leonidas-from-XIV Leonidas-from-XIV merged commit 17071ec into ocaml:main Sep 25, 2024
27 checks passed
Sylvain78 pushed a commit to Sylvain78/dune that referenced this pull request Sep 25, 2024
@H-ANSEN @Sylvain78
Fix error messages when referring to the dune config (ocaml#10923)
c33fb1f 
Signed-off-by: teague hansen <[email protected]>
Signed-off-by: Marek Kubica <[email protected]>
Signed-off-by: Sylvain78 <[email protected]>
anmonteiro pushed a commit to anmonteiro/dune that referenced this pull request Nov 17, 2024
@H-ANSEN @anmonteiro
Fix error messages when referring to the dune config (ocaml#10923)
ffa70cf 
Signed-off-by: teague hansen <[email protected]>
Signed-off-by: Marek Kubica <[email protected]>
maiste added a commit to maiste/opam-repository that referenced this pull request Nov 25, 2024
@maiste
[new release] dune (15 packages) (3.17.0~alpha0)
f1d49be 
CHANGES:

### Fixed

- Show the context name for errors happening in non-default contexts.
  (ocaml/dune#10414, fixes ocaml/dune#10378, @jchavarri)

- Correctly declare dependencies of indexes so that they are rebuilt when
  needed. (ocaml/dune#10623, @voodoos)

- Don't depend on coq-stdlib being installed when expanding variables
  of the `coq.version` family (ocaml/dune#10631, fixes ocaml/dune#10629, @gares)

- Error out if no files are found when using `copy_files`. (ocaml/dune#10649, @jchavarri)

- Re_export dune-section private library in the dune-site library stanza,
  in order to avoid failure when generating and building sites modules
  with implicit_transitive_deps = false. (ocaml/dune#10650, fixes ocaml/dune#9661, @MA0100)

- Expect test fixes: support multiple modes and fix dependencies when there is
  a custom runner (ocaml/dune#10671, @vouillon)

- In a `(library)` stanza with `(extra_objects)` and `(foreign_stubs)`, avoid
  double linking the extra object files in the final executable.
  (ocaml/dune#10783, fixes ocaml/dune#10785, @nojb)

- Map `(re_export)` library dependencies to the `exports` field in `META` files,
  and vice-versa. This field was proposed in to
  https://discuss.ocaml.org/t/proposal-a-new-exports-field-in-findlib-meta-files/13947.
  The field is included in Dune-generated `META` files only when the Dune lang
  version is >= 3.17.
  (ocaml/dune#10831, fixes ocaml/dune#10830, @nojb)

- Fix staged pps preprocessors on Windows (which were not working at all
  previously) (ocaml/dune#10869, fixes ocaml/dune#10867, @nojb)

- Fix `dune describe` when an executable is disabled with `enabled_if`.
  (ocaml/dune#10881, fixes ocaml/dune#10779, @moyodiallo)

- Fix an issue where C stubs would be rebuilt whenever the stderr of Dune was
  redirected. (ocaml/dune#10883, fixes ocaml/dune#10882, @nojb)

- Format long lists in s-expressions to fill the line instead of formatting
  them in a vertical way (ocaml/dune#10892, fixes ocaml/dune#10860, @nojb)

- Fix the URL opened by the command `dune ocaml doc`. (ocaml/dune#10897, @gridbugs)

- Fix the file referred to in the error/warning message displayed due to the
  dune configuration version not supporting a particular configuration
  stanza in use. (ocaml/dune#10923, @H-ANSEN)

- Fix `enabled_if` when it uses `env` variable. (ocaml/dune#10936, fixes ocaml/dune#10905, @moyodiallo)

- Fix exec -w for relative paths with --root argument (ocaml/dune#10982, @gridbugs)

- Do not ignore the `(locks ..)` field in the `test` and `tests` stanza
  (ocaml/dune#11081, @rgrinberg)

- Tolerate files without extension when generating merlin rules.
  (ocaml/dune#11128, @anmonteiro)

### Added

- Make Merlin/OCaml-LSP aware of "hidden" dependencies used by
  `(implicit_transitive_deps false)` via the `-H` compiler flag. (ocaml/dune#10535, @voodoos)

- Add support for the -H flag (introduced in OCaml compiler 5.2) in dune
  (requires lang versions 3.17). This adaptation gives
  the correct semantics for `(implicit_transitive_deps false)`.
  (ocaml/dune#10644, fixes ocaml/dune#9333, ocsigen/tyxml#274, ocaml/dune#2733, ocaml/dune#4963, @MA0100)

- Add support for specifying Gitlab organization repositories in `source`
  stanzas (ocaml/dune#10766, fixes ocaml/dune#6723, @H-ANSEN)

- New option to control jsoo sourcemap generation in env and executable stanza
  (ocaml/dune#10777, fixes ocaml/dune#10673, @hhugo)

- One can now control jsoo compilation_mode inside an executable stanza
  (ocaml/dune#10777, fixes ocaml/dune#10673, @hhugo)

- Add support for specifying default values of the `authors`, `maintainers`, and
  `license` stanzas of the `dune-project` file via the dune config file. Default
  values are set using the `(project_defaults)` stanza (ocaml/dune#10835, @H-ANSEN)

- Add names to source tree events in performance traces (ocaml/dune#10884, @jchavarri)

- Add `codeberg` as an option for defining project sources in dune-project
  files. For example, `(source (codeberg user/repo))`. (ocaml/dune#10904, @nlordell)

- `dune runtest` can now run individual tests with `dune runtest mytest.t`
  (ocaml/dune#11041, @Alizter).

- Wasm_of_ocaml support (ocaml/dune#11093, @vouillon)

- Add a `coqdep_flags` field to the `coq` field of the `env` stanza, and to the `coq.theory` stanza, allowing to configure `coqdep` flags.
  (ocaml/dune#11094, @rlepigre)

### Changed

- Remove all remnants of the experimental `patch-back-source-tree`. (ocaml/dune#10771,
  @rgrinberg)

- Change the preset value for author and maintainer fields in the
  `dune-project` file to encourage including emails. (ocaml/dune#10848, @punchagan)

- Tweak the preset value for tags in the `dune-project` file to hint at topics
  not having a special meaning. (ocaml/dune#10849, @punchagan)

- Change some colors to improve readability in light-mode terminals
  (ocaml/dune#10890, @gridbugs)

- Forward the linkall flag to jsoo in whole program compilation as well (ocaml/dune#10935, @hhugo)

- Configurator uses `pkgconf` as pkg-config implementation when available
  and forwards it the `target` of `ocamlc -config`. (ocaml/dune#10937, @pirbo)

- Enable Dune cache by default. Add a new Dune cache setting
  `enabled-except-user-rules`, which enables the Dune cache, but excludes
  user-written rules from it. This is a conservative choice that can avoid
  breaking rules whose dependencies are not correctly specified. This is the
  current default. (ocaml/dune#10944, ocaml/dune#10710, @nojb, @ElectreAAS)

- Do not add `dune` dependency in `dune-project` when creating projects with
  `dune init proj`. The Dune dependency is implicitely added when generating
  opam files (ocaml/dune#11129, @Leonidas-from-XIV)
@maiste maiste mentioned this pull request Nov 25, 2024
Draft
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Leonidas-from-XIV Leonidas-from-XIV Leonidas-from-XIV approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

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