Skip to content

同じ規則を 1 か所にする (実装と文書の重複をなくす) #653

Open
0 of 9 issues completed

Description

@neguse

問題

同じ規則や事実を複数の場所に書いていて、正を呼ばずに計算し直すか、写している。
片方だけが直されてずれ、bug と、実装と合わない文書になって表に出ている。

  • tcs: IL が意味の一部を持たず、C と VM の backend がそれぞれ推論し直している。通すかどうかの判定が、tcs check と 2 つの backend の 3 か所にある。runtime の処理の多くを、C の出力と tcs VM に別々に書いている。open の tcs の bug の多くは、片方の backend だけに、または両方に同じ形で出る。
  • lub: csproj の入力、entry class、host の引数、gate の手順、test の一覧を何か所でも計算し直すか写していて、既に経路ごとに振る舞いが違う所がある。
  • 文書: 実装の事実を要約して写していて、実装を変えたときに写しが古くなる。エージェント向けの入口が 3 つある。

それぞれの棚卸しは、各段の issue に書いた (master の 3cf29da で確かめた)。

原則

  • 規則と事実ごとに正を 1 か所決め、ほかはそれを呼ぶか、そこを指す。
  • 写すしかないとき (言語の境目をまたぐなど) は、一致を確かめる検査を同じ PR に入れる。
  • 実行経路が 3 つ (tcs VM、tcs2c、.NET) あること、backend が 5 つあることは対象にしない。その中で同じ規則を写している所は対象にする。

段の順

flowchart LR
  p0["0. 待っている PR"] --> p605["1. 置き場所 #605"]
  p0 --> pdoc["1. 文書の正 #649"]
  p605 -. tcs の文書の path .-> pdoc
  p605 --> pil["2. IL #651"]
  p605 --> plex["2. 字句の残り"]
  p605 --> prt["3. runtime #650"]
  pil -. 関数の選び方と書式 .-> prt
  p0 --> plub["4. lub #592 と #652"]
  p647["#647"] --> pgate["4. gate の部品化"]
Loading

0. 待っている PR を片付ける

#593–#603 と #647 は、この後の段で触る file と重なるので、先に merge する。
#601、#602、#603 と、#595、#596、#597、#599、#600 は、処理を 1 か所に寄せる向きの変更である。
#593、#594、#598 は C と VM を別々に直していて、その分は 3. で 1 つに移す。

1. 置き場所と文書の正を決める

2. tcs: 意味の決定を IL に載せ、通すかどうかの判定を 1 か所にする

3. tcs: C の出力と tcs VM に別々にある runtime の処理を 1 つにする

4. lub: 同じ規則を計算し直している所を 1 つにする

5. 後回し

  • box2d と box3d の物理で、key で宣言して寿命を管理する層が 2 本ある (src/physics_box2d.c と src/physics_box3d.c に、同じ名前の静的な関数が 100 以上ある)。box3d には runtime テストが無いので、まとめる前にテストを足す。
  • shader の reflection を作る経路が 2 本ある (src/shader.cpp の Slang の API と、reflection の JSON)。今は食い違いが見つかっていない。

終わりの条件

  • 下に紐づけた issue がすべて閉じている。
  • 新しい重複を作らない約束が AGENTS.md にある。

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions