ocaml / ocaml/dune

output relative paths in error output to improve reproducibility

Open
#4,832 11 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

In RWO, we have expect tests that fail, but result in host-paths being leaked into the expect tests. For example

$ dune runtest
       patdiff (internal) (exit 1)
  (cd _build/default && /home/yminsky/Documents/code/rwo/_build/install/default/bin/patdiff -keep-whitespace -location-style omake -ascii test.ml test.ml.corrected)

could be

$ dune runtest
       patdiff (internal) (exit 1)
  (cd _build/default && ../install/default/bin/patdiff -keep-whitespace -location-style omake -ascii test.ml test.ml.corrected)

in order to have the same output irrespective of what host its run on. See https://github.com/realworldocaml/book/issues/3448 for more.

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 dune runtest output and the patdiff command shown in the issue, then inspect the RWO expect tests and the related realworldocaml/book issue #3448. Done means host-specific absolute paths are replaced by reproducible relative paths without changing the intended command behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
ocaml
Domain
build-system
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.