doc: clarify config-relative paths for `--config <path>` #11079

weihanglo · 2022-09-13T09:07:26Z

What does this PR try to resolve?

Resolves #10991.

Instead of changing the behaviour (it might break things), we document the current one as @sunshowers suggesting.

How should we test and review this PR?

Check changes in

src/doc/src/reference/config.md and
src/doc/man/includes/section-options-common.md.

cargo help build
# Proofread the manpage change.
mdbook serve
# open http://[::1]:3000/reference/config.html#config-relative-paths
# and proofread the config-relative paths section

rust-highfive · 2022-09-13T09:07:32Z

r? @epage

(rust-highfive has picked a reviewer for you, use r? to override)

src/doc/src/reference/config.md

epage · 2022-09-13T11:52:17Z

src/doc/src/reference/config.md

+* For environment variables it is relative to the current working directory.
+* For config files, that is relative to the parent directory of the directory where the value was defined.


Should we also explicitly call out --config key=value?

I'm not seeing the change for this

I thought you were suggesting something like this, no?

https://github.com/rust-lang/cargo/pull/11079/files#diff-0917d2867ed0f7116151e8c28138a91760a17f3fca809cc72523053c2762f3afR248-R250

I feel like I'm missing something.

I see config.md covering

Environment variables

Implicit config files

Explicit config files via --config <path>

I'm not seeing --config key=value being discussed for where paths would be relative to.

Got it. Thank you for catching this! Fixed with 758ee5d.

Current implementation as a reference.

cargo/src/cargo/util/config/value.rs

Lines 66 to 75 in c187114

/// Root directory where this is defined.

///

/// If from a file, it is the directory above `.cargo/config`.

/// CLI and env are the current working directory.

pub fn root<'a>(&'a self, config: &'a Config) -> &'a Path {

match self {

Definition::Path(p) => p.parent().unwrap().parent().unwrap(),

Definition::Environment(_) | Definition::Cli => config.cwd(),

}

}

src/doc/src/reference/config.md

weihanglo · 2022-09-13T13:16:23Z

All issues are resolved. Does it look better?

epage · 2022-09-13T16:20:06Z

@bors r+

bors · 2022-09-13T16:20:08Z

📌 Commit 758ee5d has been approved by epage

It is now in the queue for this repository.

bors · 2022-09-13T16:20:15Z

⌛ Testing commit 758ee5d with merge fedd172...

bors · 2022-09-13T17:07:58Z

☀️ Test successful - checks-actions
Approved by: epage
Pushing fedd172 to master...

10 commits in 646e9a0b9ea8354cc409d05f10e8dc752c5de78e..082503982ea0fb7a8fd72210427d43a2e2128a63 2022-09-02 14:29:28 +0000 to 2022-09-13 17:49:38 +0000 - Take priority into account within the pending queue (rust-lang/cargo#11032) - fix(add): Clarify which version the features are added for (rust-lang/cargo#11075) - doc: clarify config-relative paths for `--config <path>` (rust-lang/cargo#11079) - Do not add home bin path to PATH if it's already there (rust-lang/cargo#11023) - Don't use `for` loop on an `Option` (rust-lang/cargo#11081) - Remove dead code (rust-lang/cargo#11080) - Change progress indicator for sparse registries (rust-lang/cargo#11068) - chore(ci): Ensure intradoc links are valid (rust-lang/cargo#11055) - Cache index files based on contents hash (rust-lang/cargo#11044) - fix: specifies the max length for crate name (rust-lang/cargo#11051)

Update cargo 10 commits in 646e9a0b9ea8354cc409d05f10e8dc752c5de78e..082503982ea0fb7a8fd72210427d43a2e2128a63 2022-09-02 14:29:28 +0000 to 2022-09-13 17:49:38 +0000 - Take priority into account within the pending queue (rust-lang/cargo#11032) - fix(add): Clarify which version the features are added for (rust-lang/cargo#11075) - doc: clarify config-relative paths for `--config <path>` (rust-lang/cargo#11079) - Do not add home bin path to PATH if it's already there (rust-lang/cargo#11023) - Don't use `for` loop on an `Option` (rust-lang/cargo#11081) - Remove dead code (rust-lang/cargo#11080) - Change progress indicator for sparse registries (rust-lang/cargo#11068) - chore(ci): Ensure intradoc links are valid (rust-lang/cargo#11055) - Cache index files based on contents hash (rust-lang/cargo#11044) - fix: specifies the max length for crate name (rust-lang/cargo#11051)

rust-highfive assigned epage Sep 13, 2022

rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Sep 13, 2022

weihanglo added the A-documenting-cargo-itself Area: Cargo's documentation label Sep 13, 2022

Expand details for --config cli arg

65332bc

weihanglo force-pushed the issue-10991 branch from 264fb9c to 0161499 Compare September 13, 2022 09:26

epage reviewed Sep 13, 2022

View reviewed changes

weihanglo force-pushed the issue-10991 branch from 0161499 to e3a2735 Compare September 13, 2022 13:12

Clarify config-relative paths for --config <path>

164a859

weihanglo force-pushed the issue-10991 branch from e3a2735 to 164a859 Compare September 13, 2022 13:14

weihanglo requested a review from epage September 13, 2022 13:16

Call out rule of relative path of --config KEY=VALUE

758ee5d

weihanglo force-pushed the issue-10991 branch from 9f1baf0 to 758ee5d Compare September 13, 2022 15:50

epage approved these changes Sep 13, 2022

View reviewed changes

bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Sep 13, 2022

bors merged commit fedd172 into rust-lang:master Sep 13, 2022

weihanglo deleted the issue-10991 branch September 13, 2022 17:09

weihanglo mentioned this pull request Sep 13, 2022

Update cargo rust-lang/rust#101776

Merged

ehuss added this to the 1.65.0 milestone Sep 21, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

doc: clarify config-relative paths for `--config <path>` #11079

doc: clarify config-relative paths for `--config <path>` #11079

weihanglo commented Sep 13, 2022 •

edited

Loading

rust-highfive commented Sep 13, 2022

epage Sep 13, 2022

epage Sep 13, 2022

weihanglo Sep 13, 2022

epage Sep 13, 2022

weihanglo Sep 13, 2022

weihanglo Sep 13, 2022

weihanglo commented Sep 13, 2022

epage commented Sep 13, 2022

bors commented Sep 13, 2022

bors commented Sep 13, 2022

bors commented Sep 13, 2022

		* For environment variables it is relative to the current working directory.
		* For config files, that is relative to the parent directory of the directory where the value was defined.

	/// Root directory where this is defined.
	///
	/// If from a file, it is the directory above `.cargo/config`.
	/// CLI and env are the current working directory.
	pub fn root<'a>(&'a self, config: &'a Config) -> &'a Path {
	match self {
	Definition::Path(p) => p.parent().unwrap().parent().unwrap(),
	Definition::Environment(_) \| Definition::Cli => config.cwd(),
	}
	}

doc: clarify config-relative paths for --config <path> #11079

doc: clarify config-relative paths for --config <path> #11079

Conversation

weihanglo commented Sep 13, 2022 • edited Loading

What does this PR try to resolve?

How should we test and review this PR?

rust-highfive commented Sep 13, 2022

epage Sep 13, 2022

Choose a reason for hiding this comment

epage Sep 13, 2022

Choose a reason for hiding this comment

weihanglo Sep 13, 2022

Choose a reason for hiding this comment

epage Sep 13, 2022

Choose a reason for hiding this comment

weihanglo Sep 13, 2022

Choose a reason for hiding this comment

weihanglo Sep 13, 2022

Choose a reason for hiding this comment

weihanglo commented Sep 13, 2022

epage commented Sep 13, 2022

bors commented Sep 13, 2022

bors commented Sep 13, 2022

bors commented Sep 13, 2022

doc: clarify config-relative paths for `--config <path>` #11079

doc: clarify config-relative paths for `--config <path>` #11079

weihanglo commented Sep 13, 2022 •

edited

Loading