Hacktoberfest 2026：メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

Derive the .cmi / .cmt / .ast magic numbers instead of bumping them in every PR

オープン
  • 何か問題がありますか？
#8,947 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
35/100
issue の種類
機能追加
明瞭さ
明確に書かれている
活発さ
活発
技術スタック
ocaml
領域
compilers

調査の方向性

Start with compiler/ext/config.ml and inspect how the .cmi, .cmt, and .ast magic numbers are defined, then trace the serialized interfaces and release tooling described in the proposal. The work spans digest generation, release recording and counter updates, and possibly dev build suffixes and prefix changes. Done means release counters change only when serialized layouts change, outside tools can distinguish compatible releases, and the changelog notes the prefix change.

索引モデルが issue の本文から書いたものです。

説明

Problem

compiler/ext/config.ml holds hand-numbered magic numbers for .cmi (Caml1999I036), .cmt (Caml1999T043) and marshaled .ast files (ResImpl01315 / ResIntf01315). Every PR that changes a serialized type bumps them, so parallel PRs constantly conflict on the same lines. That's the same problem we had with CHANGELOG.md before fragments. There have been about 20 bumps since August.

The per-PR precision buys nothing:

  • Rebuilds after a compiler change are driven by bsc_hash, which both build systems store, not by the magic numbers.
  • Outside tools only ever see released versions, so intermediate bumps between two releases are invisible to them.
  • A bump forgotten in a PR fails silently: mixing files across a layout change crashes in Marshal instead of giving a clean error.

The Caml1999 prefix is a separate problem. OCaml 5.5 uses Caml1999I037 / Caml1999T037, so our I036 is most likely a real OCaml release's .cmi number, and the next bump would collide with OCaml 5.5. An OCaml tool would then accept a ReScript .cmi and misread it, instead of rejecting it.

What outside tools need

Tools that read .cmi/.cmt files may rely on the magic number. They need:

  • A stable number for each release.
  • A change between releases only when the format may have changed, so they can tell that two releases share a format.
  • Ordering, for "built by a newer compiler" checks (cmi_format.ml already uses it for its older/newer error).

Proposal

Bump the counters at release time, not in PRs:

  1. A dune rule computes a digest of the interfaces whose values are serialized. For .cmi that is types, path, ident, parsetree, …; for .cmt add typedtree; for .ast it is parsetree. Prefer whole directories or dune's cmi digests over a hand-picked file list, which would go stale like manual bumps do.
  2. A checked-in file records the counter and digest from the last release. PRs never touch it.
  3. The release script, or a CI check on release PRs, compares the current digest with the recorded one. If they differ, it bumps the counter and records the new digest. Comment-only edits cause harmless extra bumps.
  4. Optional: dev builds append the digest (e.g. …037+3fa9c1d2), so mixing two dev builds that share a counter but differ in layout gives a clean error instead of a crash. Releases ship the bare counter.
  5. Switch to our own prefixes (e.g. ResCmi… / ResCmt…, like the .ast numbers already did), so OCaml tools reject our files. Note this in the changelog because outside tools will see it.

Not in scope: .cmj has no magic number yet, only a digest of its own content (js_cmj_format.ml has a TODO). It could get a counter under the same scheme. The frozen Parsetree0 PPX numbers (Caml1999M022 / N022) must never change and stay as they are.

Alternatives considered

  • The compiler version as the magic number. Stable per release and never touched by PRs. However, it changes on every release even when the format didn't, it has no meaningful ordering across prereleases, and dev builds sharing a version can't detect a layout mismatch.
  • A pure content digest. Exact and never conflicts, but outside tools can't see that two releases share a format, and there's no ordering.
主要言語
OCaml
スター
7.5k
フォーク
483
平均マージ
21時間 8分
マージ済み PR（30日）
183

環境構築

Codespaces で開く

このプロジェクトの開発コンテナを、あなたの GitHub アカウントでブラウザ上に起動します。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

rescript-lang/rescript のほかの issue

rescript-lang/rescript の issue をすべて見る

似ている issue

Compilers の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。