docs(comments): rewrite comments across all crates to the guidelines

Sweep every first-party crate source (1956 .rs files) to the project comment
guidelines: delete redundant restatements, decorative banners, change
narration, and end-of-line comments; keep and tighten the crucial ones
(invariants, bug rationale, SAFETY blocks, ported-source attribution).

No functional code changed. Every edit is proven comment-only against the
prior tree by a comment-stripping lexer (string/char/raw-string aware) plus a
separate doctest-fence check. Where removing a comment made rustfmt or clippy
want to re-lay-out adjacent code, the minimal triggering comment is restored so
code tokens stay byte-identical.

Gates green: cargo fmt --all --check (0 diffs), cargo check and cargo clippy
--workspace --all-targets (0 warnings).

Adds scripts/check_codegen_comment_guidelines.py — the enforcement gate for
these guidelines (flags banners, end-of-line comments, change narration, and
commented-out code).
This commit is contained in:
ZacharyZhang-NY committed 2026-07-23 16:55:39 -04:00
1 parent ff0fb56c67
commit a02b555e66
1458 files changed
+10729 -21750

No files matched your search

@@ -30,10 +30,10 @@ pub struct OverlayInfo {
pub overlay_root: PathBuf,
}
/// Detect if `path` is on a FUSE+overlayfs stack with btrfs upper.
/// Detect whether `path` is on a FUSE+overlayfs stack with a btrfs upper.
///
/// Returns `Ok(Some(OverlayInfo))` if all conditions are met, `Ok(None)` otherwise.
/// Handles `EIO`/`ENOTCONN` from a crashed FUSE daemon gracefully by returning `Ok(None)`.
/// A crashed FUSE daemon (`EIO`/`ENOTCONN`) is not an error here: it yields
/// `Ok(None)` like any other unsuitable mount.
pub fn detect_fuse_overlay(path: &Path) -> Result<Option<OverlayInfo>> {
let entries = match mount_info::parse_mountinfo() {
Ok(entries) => entries,
@@ -46,12 +46,12 @@ pub fn detect_fuse_overlay(path: &Path) -> Result<Option<OverlayInfo>> {
detect_fuse_overlay_from_entries(path, &entries)
}
/// Testable version that takes pre-parsed entries.
/// Split out from `detect_fuse_overlay` so tests can drive it with synthetic
/// mountinfo instead of the host's real mount table.
pub(crate) fn detect_fuse_overlay_from_entries(
path: &Path,
entries: &[mount_info::MountEntry],
) -> Result<Option<OverlayInfo>> {
// Step 1: Find overlay mount containing this path.
let overlay = match mount_info::find_overlay_mount(entries, path) {
Some(info) => info,
None => {
@@ -60,7 +60,6 @@ pub(crate) fn detect_fuse_overlay_from_entries(
}
};
// Step 2: Verify the lower layer is a FUSE mount.
if !mount_info::is_fuse_mount(entries, &overlay.lower_dir) {
tracing::debug!(
lower = %overlay.lower_dir.display(),
@@ -69,12 +68,12 @@ pub(crate) fn detect_fuse_overlay_from_entries(
return Ok(None);
}
// Step 3: Verify the upper layer is on btrfs.
let upper_on_btrfs = match crate::btrfs::is_btrfs(&overlay.upper_dir) {
Ok(true) => true,
Ok(false) => false,
Err(e) => {
// EIO / ENOTCONN from crashed FUSE — treat as "not available"
// EIO/ENOTCONN from a crashed FUSE daemon lands here; treat any
// probe failure as "not btrfs" rather than failing detection.
tracing::debug!(
upper = %overlay.upper_dir.display(),
error = %e,
@@ -92,7 +91,6 @@ pub(crate) fn detect_fuse_overlay_from_entries(
return Ok(None);
}
// Derive overlay_root — parent of upper_dir (sibling of upper/ and work/).
let overlay_root = overlay
.upper_dir
.parent()
@@ -151,7 +149,6 @@ mod tests {
#[test]
fn test_detect_overlay_without_fuse_lower() {
// Overlay where lower is ext4, not FUSE — should return None.
let mountinfo = "\
22 1 8:1 / / rw - ext4 /dev/sda1 rw
30 22 8:2 / /lower rw - ext4 /dev/sda2 rw
@@ -176,15 +173,11 @@ mod tests {
#[test]
fn test_overlay_info_fields() {
// We can't run the btrfs check in unit tests (no btrfs fs), but we
// can verify the parsing portion works by calling the internal function
// and checking that step 3 (btrfs) is the failing point.
// The sample upper path does not exist on the test host, so the btrfs
// probe fails and detection stops short of `Some`. This only covers
// the mountinfo parsing path; the result is deliberately unasserted.
let entries = parse_mountinfo_from(FUSE_OVERLAY_MOUNTINFO);
// This will return None because the sample upper path doesn't exist,
// so is_btrfs will fail — but that's expected in a unit test.
let result = detect_fuse_overlay_from_entries(Path::new("/workspace/repo"), &entries);
assert!(result.is_ok());
// On a system without the actual btrfs mount, this returns None.
// On a host with a live FUSE+overlay stack it would return Some.
}
}
@@ -513,7 +513,7 @@ pub fn cleanup_orphaned_overlay_snapshots() -> crate::api::CleanupReport {
report
}
// ── Internal helpers ─────────────────────────────────────────────────────
// Internal helpers
/// Mount overlayfs using `libc::mount()` syscall.
fn mount_overlay(lower: &Path, upper: &Path, work: &Path, target: &Path) -> Result<()> {