docs(developer): 三处与实现对不上——quickstart 去掉已退役的 src/arch/linux/ld/ · faq .ccr 版本 v6→v9 · corec2 条目加修订注 - #175
Merged
Conversation
…指三轴+组合根)· faq .ccr 版本 v6→v9(指 ccr_io.cr::CCR_VERSION 为准)· corec2 死循环条目加修订注(不再阻塞,corec2==corec3)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
这是什么
docs/developer/里三处与实现对不上的地方。不是风格改动,是事实更正与历史加注。来源 = 文档风格审查批 1 顺带查出的三条(R2),我逐条复核后动手。三处
quickstart.md:55目录表| src/arch/linux/ld/ | ELF 后端(指令编码/链接) |src/arch/ · src/format/ · src/os/,并加注说明src/arch/linux/ld/已退役、组合根在src/targets/x86_64-linux/faq.md:39.ccr内容随 v6 段表推进」src/compiler/ccr_io.cr的CCR_VERSION为准faq.md:34corec2 问答corec2 == corec3IDENTICAL,由src/ci/run.sh的full-bootstrapjob 覆盖)① 的依据:
jj file list -r develop@origin | grep -c '^src/arch/linux/ld/'= 0(该目录在树上已不存在)。② 的依据:
src/compiler/ccr_io.cr:135=CCR_VERSION : int = 9;。③ 为什么是加注不是改写:那段原文已经用了过去时(「它曾有 tokenizer 死循环已知问题」),事实陈述没写错;错的是问题式标题(「为什么我 check 会卡住」)暗示它还在发生。⇒ 按本仓「原文保留 + 加注」惯例处理,不删史。
验核:用刚建的那条判据验我自己的改动
批 1 新入仓的
tools/doc_protected_surface.py(文档非散文面抽取 / 对拍)正好可以量这次改动的波及面:差异逐条全部对得上意图,无多余波及:
- NUM faq.md | 6→+ NUM faq.md | 9(v6→v9)- TROW quickstart.md | <旧行>→+ TROW quickstart.md | <新行>+ INLINE ×8:我新写进注里的引用(CCR_VERSION/corec2/corec2 == corec3/full-bootstrap/src/ci/run.sh/src/compiler/ccr_io.cr/src/arch/linux/ld//src/targets/x86_64-linux/)+ MARKER ×1:新增的修订注整行(该工具把「修订/加注」行也列为受保护面 —— 正合本仓惯例)+ NUM ×若干:新增注里的日期与x86_64里的数字⇒ 这条判据在此判红是预期(改事实面本来就该动受保护面),它的价值是证明改动边界 = 意图边界。
未做
R1):8 档半角 · 3 档全角 · 2 档档内混用。方向须维护者定,本 PR 不碰。