Skip to content

M0027 patch-outside-workspace

Rule: No committed [patch] or [replace] override takes a path outside the workspace.

Code M0027 (stable, never reused)
Id patch-outside-workspace
Category dependencies
Source spirit_level
Fix by hand

Level per tier

Tier Level Reason
small deny a committed patch into a sibling checkout builds differently on every machine; it lives in an ignored .cargo/config.toml
small-workspace deny a committed patch into a sibling checkout builds differently on every machine; it lives in an ignored .cargo/config.toml
medium deny a committed patch into a sibling checkout builds differently on every machine; it lives in an ignored .cargo/config.toml
big deny a committed patch into a sibling checkout builds differently on every machine; it lives in an ignored .cargo/config.toml
ai off
embedded off
ui off
egui off
units-strict off
units-paranoid off

Why

A [patch] override that takes a path outside the workspace (../widgets) points at a sibling checkout on one machine. Committed, it builds differently, or not at all, on every other machine and in every other worktree, and it hides that the real dependency still lacks the change. [replace], its older form, has the same effect.

Overrides that stay reproducible are fine: a path inside the workspace (one copy of a crate the workspace also builds) and a git fork. How a git override is pinned is the business of git-dependency-pins' policy.

How to fix

To work on a library alongside the project, put the override into the worktree's .cargo/config.toml and keep that file out of git:

# .cargo/config.toml, listed in .gitignore
[patch."https://github.com/acme/widgets"]
widgets = { path = "../widgets" }

Then land the library change in its own repo and cargo update -p widgets. The lint reads [patch] and [replace] in the root Cargo.toml, and in .cargo/config.toml when git tracks that file.

Configure

[lints.patch-outside-workspace]
level = "deny"
reason = "why this project wants it at this level"

Allow one finding in the code with // spirit-level: allow(patch-outside-workspace) <reason> (waivers); the code works there too, as in [lints.M0027].