Skip to content

Commit cb501a1

Browse files
authored
Document cargo limitation w/ workspaces & configs
This behavior is described in this bug: #2930 I think we should document limitations of the tool which exist at present if they do not bind our hands in the future. If this bug is fixed, this note should be removed.
1 parent 18f2598 commit cb501a1

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

src/doc/src/reference/config.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,16 @@ home directory is the lowest priority. Arrays will be joined together.
3535
> and is the preferred form. If both files exist, Cargo will use the file
3636
> without the extension.
3737
38+
39+
> **Note:** At present, when being invoked from a workspace, Cargo does not read
40+
> config files from crates within the workspace. i.e. if a workspace has two
41+
> crates in it, named `/projects/foo/bar/baz/mylib` and
42+
> `/projects/foo/bar/baz/mybin`, and there are Cargo configs at
43+
> `/projects/foo/bar/baz/mylib/.cargo/config.toml`
44+
> and `/projects/foo/bar/baz/mybin/.cargo/config.toml`, Cargo does not read
45+
> those configuration files if it is invoked from the workspace root
46+
> (`/projects/foo/bar/baz/`).
47+
3848
### Configuration format
3949

4050
Configuration files are written in the [TOML format][toml] (like the

0 commit comments

Comments
 (0)