Home

cargo refquiem finds comments, doc comments, string literals and Markdown that still name Rust declarations or Cargo entries removed from Git history.

Install

Install Rust and Cargo and Git. The crate requires Rust 1.88 or later. Install the source used by this wiki with a C toolchain available.

cargo +stable install --git https://github.com/LucaCappelletti94/cargo-refquiem.git --branch main --locked refquiem
cargo refquiem --version

Start with a finding

Find your first stale reference creates a small crate, renames a function and repairs the documentation that still names it.

In an existing Rust workspace, scan from its directory.

cargo refquiem

The default scan reads the history reachable from HEAD and compares its declarations with the working tree. Findings produce exit status 1. See Configuration to restrict the range, choose a member or change exclusions.

Interpret the result

Reports describes locations, suggested replacements, unused suppressions and skipped dependency warnings. How matching works explains why context and live names affect a match.

Suggestions need review against the intended API. An unresolved dependency warning means part of the historical API could not be checked, even when the report has no findings.

Integrate

• GitHub Action covers pull request reviews, annotations and fork-safe posting.
• Library shows how to scan a workspace from Rust.
• History and cache explains revision comparisons, source resolution and cached parsing.

The repository contains the source and action.