itsscb/cargo
1
0
Fork 0
mirror of https://github.com/rust-lang/cargo.git synced 2025-10-01 11:30:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

Tweak unstable docs wording to avoid some confusion.

Browse Source
This commit is contained in:
Eric Huss 2023-10-18 18:14:53 -07:00
parent 4ad8adcf55
commit e7cebdce21
1 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/doc/src/reference/unstable.md
View File

@ -1390,7 +1390,8 @@ This will not affect any hard-coded paths in the source code, such as in strings
The `-Zgc` flag enables garbage-collection within cargo's global cache within the cargo home directory. The `-Zgc` flag enables garbage-collection within cargo's global cache within the cargo home directory.
This includes downloaded dependencies such as compressed `.crate` files, extracted `src` directories, registry index caches, and git dependencies. This includes downloaded dependencies such as compressed `.crate` files, extracted `src` directories, registry index caches, and git dependencies.
When `-Zgc` is present, cargo will track the last time any file was used, and then uses those timestamps to manually or automatically delete files that have not been used for a while. When `-Zgc` is present, cargo will track the last time any index and dependency was used,
and then uses those timestamps to manually or automatically delete cache entries that have not been used for a while.
```sh ```sh
cargo build -Zgc cargo build -Zgc
@ -1400,8 +1401,9 @@ cargo build -Zgc
Automatic deletion happens on commands that are already doing a significant amount of work, Automatic deletion happens on commands that are already doing a significant amount of work,
such as all of the build commands (`cargo build`, `cargo test`, `cargo check`, etc.), and `cargo fetch`. such as all of the build commands (`cargo build`, `cargo test`, `cargo check`, etc.), and `cargo fetch`.
Automatic deletion is only done once per day. The deletion happens just after resolution and packages have been downloaded.
Automatic deletion is disabled if cargo is offline such as with `--offline` or `--frozen` to avoid deleting files that may need to be used if you are offline for a long period of time. Automatic deletion is only done once per day (see `gc.auto.frequency` to configure).
Automatic deletion is disabled if cargo is offline such as with `--offline` or `--frozen` to avoid deleting artifacts that may need to be used if you are offline for a long period of time.
#### Automatic gc configuration #### Automatic gc configuration