ZacharyZhang-NY
a02b555e66
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).
67 lines
2.5 KiB
Rust
67 lines
2.5 KiB
Rust
//! High-performance git worktree creation using CoW cloning.
|
|
//!
|
|
//! This crate provides fast worktree creation by:
|
|
//! 1. Using `git worktree add --no-checkout` (instant metadata creation)
|
|
//! 2. Parallel CoW file cloning with hash-based sharding
|
|
//! 3. Optional dirty file replication and ignored file copying
|
|
//! 4. BTRFS snapshot support on Linux for O(1) cloning
|
|
//! 5. Worktree sync API for pre-created worktree pools
|
|
//! 6. SQLite metadata tracking (behind `metadata` feature)
|
|
|
|
mod api;
|
|
#[cfg(target_os = "linux")]
|
|
pub mod btrfs;
|
|
mod copy;
|
|
#[cfg(feature = "metadata")]
|
|
pub mod db;
|
|
#[cfg(feature = "metadata")]
|
|
pub mod discovery;
|
|
mod git;
|
|
#[cfg(target_os = "linux")]
|
|
pub(crate) mod mount_info;
|
|
#[cfg(target_os = "linux")]
|
|
mod overlay;
|
|
pub mod sync;
|
|
#[cfg(target_os = "linux")]
|
|
pub(crate) mod util;
|
|
mod worktree;
|
|
|
|
#[cfg(target_os = "linux")]
|
|
pub use api::cleanup_orphaned_btrfs_snapshots;
|
|
#[cfg(target_os = "linux")]
|
|
pub use api::cleanup_orphaned_overlay_snapshots;
|
|
#[cfg(feature = "metadata")]
|
|
pub use api::gc::{GcOptions, GcReport, gc_worktrees, gc_worktrees_with_delegate};
|
|
pub use api::{
|
|
BtrfsDelegate, BtrfsMode, CleanupReport, CopyReport, CreationMode, DelegateSnapshotResult,
|
|
DirtyFilesReport, ENOSPC_OS_MESSAGE, IgnoredFilesMode, OUT_OF_DISK_CONTEXT, RemoveReport,
|
|
WorkingTreeMode, WorktreeBuilder, WorktreeReport, cleanup_worktrees_in,
|
|
cleanup_worktrees_in_with_delegate, remove_worktree, remove_worktree_with_delegate,
|
|
};
|
|
#[cfg(feature = "metadata")]
|
|
pub use db::{
|
|
DbStats, ListFilter, WorktreeDb, WorktreeKind, WorktreeRecord, WorktreeStatus, id_from_path,
|
|
now_epoch_secs, repo_name_from_path, resolve_kigi_home,
|
|
};
|
|
#[cfg(feature = "metadata")]
|
|
pub use discovery::{RebuildReport, discover_worktrees, rebuild_worktree_db};
|
|
pub use git::checkout::{
|
|
rehydrate_worktree_from_ref, snapshot_worktree_to_ref, transfer_snapshot_to_repo,
|
|
};
|
|
pub use sync::{SourceDirtyState, SyncReport, WorktreeSync, collect_source_dirty_state};
|
|
#[cfg(target_os = "linux")]
|
|
pub use worktree::execute::cleanup_snapshot_git_state;
|
|
|
|
/// Count the tracked files in a git repository's index.
|
|
///
|
|
/// Reads the entry count out of the index header via `gix`, so this is an
|
|
/// O(1) read with no directory walk.
|
|
pub fn count_tracked_files(repo_path: &std::path::Path) -> anyhow::Result<usize> {
|
|
let repo = gix::discover(repo_path)
|
|
.map_err(|e| anyhow::anyhow!("failed to discover git repo: {e}"))?;
|
|
let index = repo
|
|
.index_or_load_from_head()
|
|
.map_err(|e| anyhow::anyhow!("failed to load git index: {e}"))?;
|
|
Ok(index.entries().len())
|
|
}
|