ocaml / ocaml/dune

Decouple qualified/unqualified from including subdirectories

Open
#3,314 4 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

As discussed in today's meeting:

Right now, the qualified/unqualified choice is for all languages and this is a problem. This problem was revealed for Coq, since Coq uses the qualified semantic and OCaml only supports the unqualified one. And even if OCaml supported both, we might want different settings for Coq and OCaml when extracting OCaml code from Coq.

In the end, we agreed that for most language the choice is made once and for all by the language itself. It is only for OCaml where the user can make this choice. So in the end we decided to de-couple both settings. include_subdirs will now have two state: true and false, and in the true case we can additionally specify whether OCaml sources are qualified or not. For instance:

(include_subdirs true (ocaml unqualified))

We should add the new syntax and deprecated the old one. In version 3 of the language, we'll forbid the old syntax.

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 at the existing include_subdirs syntax and the qualified/unqualified configuration handling described in the issue. Trace how both settings are parsed and validated for OCaml and other languages. Done means the new nested syntax is accepted, the old syntax is deprecated, and version 3 rejects the old syntax.

Written by the indexing model from the issue text.

Assessment

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