[PR #30] [MERGED] docs: fix stale overlaybd paths in architecture guide #129

New issue

Closed

opened 2026-10-29 14:20:01 +00:00 by bsakaguchi · 0 comments

bsakaguchi commented

2026-10-29 14:20:01 +00:00

Owner

📋 Pull Request Information

Original PR: https://github.com/kvcache-ai/AgentENV/pull/30
Author: @jiaoqsh
Created: 7/28/2026
Status: ✅ Merged
Merged: 7/28/2026
Merged by: @huajq

Base: main ← Head: docs/fix-architecture-overlaybd-references

📝 Commits (1)

fb99fb7 docs: fix stale overlaybd paths in architecture guide

📊 Changes

1 file changed (+16 additions, -10 deletions)

View changed files

📝 docs/src/internals/architecture.md (+16 -10)

📄 Description

What

docs/src/internals/architecture.md still describes the pre-reorganization overlaybd
source layout. Two of its references no longer exist in the tree:

index_file.rs — LSMT stacking now lives under lsmt/file/ (readonly.rs,
readwrite.rs, stack.rs)
snapshot_runtime() — no such function exists; the accompanying reflink-based
description is stale as well

Changes

Key files list in the overlaybd section: corrected to the current paths —
image/image_file.rs, lsmt/file/, lsmt/format.rs, lsmt/index.rs,
compression/zfile.rs, image/snapshot.rs.
Snapshot paragraph: replaced with the current behavior —
ImageFile::create_snapshot_and_restack() seals the live upper via
LSMTFile::close_seal_and_reopen() so it becomes the newest lower layer and reopens a
fresh writable upper in place, while image/snapshot.rs::export_upper_as_snapshot_layer()
retains the explicit upper-export path used by packaging and export flows. This matches
what CLAUDE.md already documents.
Directory Structure block: the overlaybd subtree now reflects the actual image/,
lsmt/, compression/ and backend/ layout.

The ublk/, ublk-daemon/, util/ and uffd-core/ entries in the same document were
checked against the tree and are accurate, so they are left unchanged.

Documentation only — no code changes.

🤖 Generated with Claude Code

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/kvcache-ai/AgentENV/pull/30 **Author:** [@jiaoqsh](https://github.com/jiaoqsh) **Created:** 7/28/2026 **Status:** ✅ Merged **Merged:** 7/28/2026 **Merged by:** [@huajq](https://github.com/huajq) **Base:** `main` ← **Head:** `docs/fix-architecture-overlaybd-references` --- ### 📝 Commits (1) - [`fb99fb7`](https://github.com/kvcache-ai/AgentENV/commit/fb99fb71a49b282964709e84d8ddc69cf6f417b4) docs: fix stale overlaybd paths in architecture guide ### 📊 Changes **1 file changed** (+16 additions, -10 deletions) <details> <summary>View changed files</summary> 📝 `docs/src/internals/architecture.md` (+16 -10) </details> ### 📄 Description ## What `docs/src/internals/architecture.md` still describes the pre-reorganization overlaybd source layout. Two of its references no longer exist in the tree: - `index_file.rs` — LSMT stacking now lives under `lsmt/file/` (`readonly.rs`, `readwrite.rs`, `stack.rs`) - `snapshot_runtime()` — no such function exists; the accompanying reflink-based description is stale as well ## Changes - **Key files** list in the overlaybd section: corrected to the current paths — `image/image_file.rs`, `lsmt/file/`, `lsmt/format.rs`, `lsmt/index.rs`, `compression/zfile.rs`, `image/snapshot.rs`. - **Snapshot** paragraph: replaced with the current behavior — `ImageFile::create_snapshot_and_restack()` seals the live upper via `LSMTFile::close_seal_and_reopen()` so it becomes the newest lower layer and reopens a fresh writable upper in place, while `image/snapshot.rs::export_upper_as_snapshot_layer()` retains the explicit upper-export path used by packaging and export flows. This matches what `CLAUDE.md` already documents. - **Directory Structure** block: the overlaybd subtree now reflects the actual `image/`, `lsmt/`, `compression/` and `backend/` layout. The `ublk/`, `ublk-daemon/`, `util/` and `uffd-core/` entries in the same document were checked against the tree and are accurate, so they are left unchanged. Documentation only — no code changes. 🤖 Generated with [Claude Code](https://claude.com/claude-code) --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

bsakaguchi

2026-10-29 14:20:01 +00:00