Skip to content

Commit 73a925a

Browse files
authored
docs: Improve comments (#15197)
This salvages the few comments of #[15196](#15196)
2 parents 3b784a4 + 280bc1f commit 73a925a

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

src/cargo/ops/fix.rs

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,27 +4,27 @@
44
//! diagnostics with suggested fixes that can be applied to the files on the
55
//! filesystem, and validate that those changes didn't break anything.
66
//!
7-
//! Cargo begins by launching a `LockServer` thread in the background to
7+
//! Cargo begins by launching a [`LockServer`] thread in the background to
88
//! listen for network connections to coordinate locking when multiple targets
99
//! are built simultaneously. It ensures each package has only one fix running
1010
//! at once.
1111
//!
12-
//! The `RustfixDiagnosticServer` is launched in a background thread (in
12+
//! The [`RustfixDiagnosticServer`] is launched in a background thread (in
1313
//! `JobQueue`) to listen for network connections to coordinate displaying
1414
//! messages to the user on the console (so that multiple processes don't try
1515
//! to print at the same time).
1616
//!
1717
//! Cargo begins a normal `cargo check` operation with itself set as a proxy
18-
//! for rustc by setting `primary_unit_rustc` in the build config. When
18+
//! for rustc by setting `BuildConfig::primary_unit_rustc` in the build config. When
1919
//! cargo launches rustc to check a crate, it is actually launching itself.
20-
//! The `FIX_ENV_INTERNAL` environment variable is set so that cargo knows it is in
21-
//! fix-proxy-mode.
20+
//! The `FIX_ENV_INTERNAL` environment variable is set to the value of the [`LockServer`]'s
21+
//! address so that cargo knows it is in fix-proxy-mode.
2222
//!
2323
//! Each proxied cargo-as-rustc detects it is in fix-proxy-mode (via `FIX_ENV_INTERNAL`
2424
//! environment variable in `main`) and does the following:
2525
//!
26-
//! - Acquire a lock from the `LockServer` from the master cargo process.
27-
//! - Launches the real rustc (`rustfix_and_fix`), looking at the JSON output
26+
//! - Acquire a lock from the [`LockServer`] from the master cargo process.
27+
//! - Launches the real rustc ([`rustfix_and_fix`]), looking at the JSON output
2828
//! for suggested fixes.
2929
//! - Uses the `rustfix` crate to apply the suggestions to the files on the
3030
//! file system.

0 commit comments

Comments
 (0)