Cycles with %{read:...} can be better documented

Open Beginner friendly
#15,080 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
68/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Quiet
Tech stack
ocaml
Domain
build-system, documentation

Research direction

Start with the documentation for %{read:<path>} and compare its explanation of moving paths with the linked cram test, test/blackbox-tests/test-cases/enabled_if/eif-library-cycle.t. Clarify when a read creates a cycle, including files in the same or parent directory, and update the documentation so the directory guidance is unambiguous.

Written by the indexing model from the issue text.

Description

docs

Expected Behavior

Using %{read:<path>} doesn't cause cycles. At the very least, the documentation for avoiding these cycles can use some clarification on what we mean by "move <path> to a different directory".

Actual Behavior

Currently, we have cycles when the file being read is in the same folder or the parent folder of the library in whose stanza we have the read pform. This behavior is captured in this cram test, for instance. #14946 was an issue reported by a user running into this.

Dominant language
OCaml
Stars
1.9k
Forks
500
Avg merge
14h 32m
Merged PRs (30d)
270

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.

More from ocaml/dune

All issues in ocaml/dune

Similar issues

More Build System issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.