From 271860a92d4636ee5e0fbbbccdaf02ae6e7ef251 Mon Sep 17 00:00:00 2001 From: Jake Goulding Date: Fri, 13 Oct 2017 19:50:04 -0400 Subject: [PATCH] Clarify that $HOME/.cargo is always checked --- src/doc/book/src/reference/config.md | 20 +++++++++++--------- src/doc/config.md | 19 ++++++++++--------- 2 files changed, 21 insertions(+), 18 deletions(-) diff --git a/src/doc/book/src/reference/config.md b/src/doc/book/src/reference/config.md index 13793cf3495..047853eec06 100644 --- a/src/doc/book/src/reference/config.md +++ b/src/doc/book/src/reference/config.md @@ -6,19 +6,21 @@ manifest, see the [manifest format](reference/manifest.html). ### Hierarchical structure -Cargo allows to have local configuration for a particular project or global -configuration (like git). Cargo also extends this ability to a hierarchical -strategy. If, for example, Cargo were invoked in `/home/foo/bar/baz`, then the + +Cargo allows local configuration for a particular project as well as global +configuration, like git. Cargo extends this to a hierarchical strategy. +If, for example, Cargo were invoked in `/projects/foo/bar/baz`, then the following configuration files would be probed for and unified in this order: -* `/home/foo/bar/baz/.cargo/config` -* `/home/foo/bar/.cargo/config` -* `/home/foo/.cargo/config` -* `/home/.cargo/config` +* `/projects/foo/bar/baz/.cargo/config` +* `/projects/foo/bar/.cargo/config` +* `/projects/foo/.cargo/config` +* `/projects/.cargo/config` * `/.cargo/config` +* `$HOME/.cargo/config` -With this structure you can specify local configuration per-project, and even -possibly check it into version control. You can also specify personal default +With this structure, you can specify configuration per-project, and even +possibly check it into version control. You can also specify personal defaults with a configuration file in your home directory. ### Configuration format diff --git a/src/doc/config.md b/src/doc/config.md index 472d5ca0d3a..46fe401b4f0 100644 --- a/src/doc/config.md +++ b/src/doc/config.md @@ -6,19 +6,20 @@ manifest, see the [manifest format](manifest.html). # Hierarchical structure -Cargo allows to have local configuration for a particular project or global -configuration (like git). Cargo also extends this ability to a hierarchical -strategy. If, for example, Cargo were invoked in `/home/foo/bar/baz`, then the +Cargo allows local configuration for a particular project as well as global +configuration, like git. Cargo extends this to a hierarchical strategy. +If, for example, Cargo were invoked in `/projects/foo/bar/baz`, then the following configuration files would be probed for and unified in this order: -* `/home/foo/bar/baz/.cargo/config` -* `/home/foo/bar/.cargo/config` -* `/home/foo/.cargo/config` -* `/home/.cargo/config` +* `/projects/foo/bar/baz/.cargo/config` +* `/projects/foo/bar/.cargo/config` +* `/projects/foo/.cargo/config` +* `/projects/.cargo/config` * `/.cargo/config` +* `$HOME/.cargo/config` -With this structure you can specify local configuration per-project, and even -possibly check it into version control. You can also specify personal default +With this structure, you can specify configuration per-project, and even +possibly check it into version control. You can also specify personal defaults with a configuration file in your home directory. # Configuration format