Auto merge of #9948 - weihanglo:issue-9940, r=ehuss

Doc about InstallTracker files and `install.root` resolves #9940
rust-lang · Sep 26, 2021 · 6b6b0b4 · 6b6b0b4
2 parents 39ed55e + d54b10f
commit 6b6b0b4
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 2 deletions.
diff --git a/src/doc/src/guide/cargo-home.md b/src/doc/src/guide/cargo-home.md
@@ -18,8 +18,8 @@ The Cargo home consists of following components:
 * `credentials.toml`
  	Private login credentials from [`cargo login`] in order to log in to a [registry][def-registry].
 
-* `.crates.toml`
-	This hidden file contains [package][def-package] information of crates installed via [`cargo install`]. Do NOT edit by hand!
+* `.crates.toml`, `.crates2.json`
+	These hidden files contain [package][def-package] information of crates installed via [`cargo install`]. Do NOT edit by hand!
 
 ## Directories:
 

diff --git a/src/doc/src/reference/config.md b/src/doc/src/reference/config.md
@@ -612,6 +612,9 @@ The `[install]` table defines defaults for the [`cargo install`] command.
 Sets the path to the root directory for installing executables for [`cargo
 install`]. Executables go into a `bin` directory underneath the root.
 
+To track information of installed executables, some extra files, such as
+`.crates.toml` and `.crates2.json`, are also created under this root.
+
 The default if not specified is Cargo's home directory (default `.cargo` in
 your home directory).