ocaml / ocaml/dune

Minor improvements for Build_info and install

Open
#2,565 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

cli enhancement
Dominant language
OCaml
Stars
1.9k
Forks
500
Avg merge
15h 21m
Merged PRs (30d)
277

Description

I noticed a few things about Build_info and related use of dune install that could be improved.

  • The https://dune.readthedocs.io/en/latest/dune-libs.html#build-info section led me to add dune.build-info to the libraries entry in my executable stanza, but from reading the dune tests it turned out that dune-build-info is needed instead.

  • The example code in that section doesn't compile since Build_info.V1.version now takes a unit arg.

  • The Installing ... messages do not seem to respect e.g. --display=quiet.

  • It would be nice to warn if setting --prefix=_build/install/... since doing so silently produces empty exes.

  • dune install --help claims to support --watch but seems to ignore it.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the Build_info section in the Dune documentation and the Dune tests referenced in the issue. Reproduce the remaining cases with --display=quiet, --prefix=_build/install/..., and --watch, then trace the install command handling. Done means the documented dependency and example are correct and each reported install behavior is addressed or clearly scoped.

Written by the indexing model from the issue text.

Assessment

Tech stack
ocaml
Domain
build-system, documentation
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.