Files
endorphin-aster-vm/docs/README.md
T
codex-bot 51cd64e688
Verify databases and deploy Aster VM / verify-and-deploy (push) Successful in 7m49s
ci: publish actual Endor example outputs as artifacts
2026-10-19 15:16:28 +08:00

5.1 KiB
Raw Blame History

文档索引

这里保存与源码一起版本管理的全局说明。当前页面负责找入口;局部文件职责由对应代码目录 README 维护。阅读次序:系统架构 → 运行时主题 → 对应源码目录。运行部署则从 operations 进入。

按问题查找

想知道什么 权威说明 代码入口
各个 crate 如何分层,哪些能力已实现 架构 crates
解释型为何生成字节码,资源修订与平台升级如何区分 执行与版本模型(设计方向) frontend、core;最小源码执行已接入,平台资源版本管理未实现
EndorObject、对象头、句柄、默认操作 对象模型 objects/src
Number、String、Dict、Cell、Function、异常数据 基本对象 objects/src
字符串、文件、流与 endor URI 如何进入 lexer Endor 阅读器 reader.rs、source.rs
源码如何分词、PEG 规则、AST 和诊断 源码前端 lexer.peg、grammar.peg、frontend、CLI
AST 根/声明/语句、ASDL 生成、遍历、位置与 JSON/编辑器接口 AST 模型 Endor.asdl、AST 实现、editor
名称/作用域分析、源码到字节码和 VM、可执行示例 编译链路 compiler、CLI
操作码、代码验证、局部槽、函数定义与调用协议 字节码 VM instruction.rs/code.rs 在 objects/src,frame.rs/eval.rs 在 core/src
基础信息保存在哪里、旧库如何迁移 宿主文件信息 host
UTF-8 在日本地区是否适用,其他编码怎样进入 VM 文本编码 core、host
数据库连接给谁用,是否自动建表或保存基础信息 数据库特殊类 storage
VM、对象与执行帧何时创建/释放,循环如何回收 生命周期 heap.rs 在 objects/src,eval.rs 在 core/src
LC_CTYPE、UTF-8、显式数据库配置和执行限额 配置 core、storage、server
CLI/HTTP 怎么运行,数据库在哪里使用 运行 cli、server
Docker、PostgreSQL、ces-control、回退与数据目录 部署 scripts、工作流
检查覆盖什么,CI 中哪里查看 Endor 实际输出与 artifact 验证 示例清单、报告脚本、core/tests、storage/tests
改代码后文档写在哪里、怎样避免失效 维护规则 各目录 README 与本索引

多层目录

目录 负责的内容
architecture 系统边界、依赖方向、解释执行与平台资源版本方向
runtime 源码前端、对象、基本载荷、字节码和生命周期
operations 运行、配置、部署和验证
contributing 开发定位方法与随代码更新文档的规则

旧 outputs 的设计正文已融合到 runtime,重复入口和 outputs 目录已移除;CPython 研究与早期报告保存在本地忽略的 work/research,不纳入 Git。原 docs 平铺文档已迁入这些主题。过时启动模型、旧测试通过数量和机器资源快照已移除;历史内容需要时查 Git 历史,不混入当前行为说明。

仓库内查询

在仓库根目录使用静态文本检索:

rg -n 'LC_CTYPE|UTF-8|DATABASE_URL' docs crates --glob '*.md'
rg -n 'EndorFrame|ReturnValue|collect_cycles' crates/core/src crates/objects/src
rg --files -g README.md -g '!work/**' -g '!outputs/**' -g '!target/**'

没有额外的文档服务器或搜索依赖。新增主题时更新此表;新增受版本管理的目录时增加 README,并从父目录 README 链接过去。