Fix wrong type of rustc-flags in documentation #13957

iawia002 · 2024-05-23T09:06:01Z

When I tried to add some custom configuration according to the documentation in https://doc.rust-lang.org/cargo/reference/config.html#configuration-format, I encountered the following error:

error: expected a string, but found a array for `rustc-flags` in /xxx/.cargo/config.toml

I believe the type of rustc-flags should be a string:

cargo/src/doc/src/reference/config.md

Lines 1243 to 1253 in 95b921b

 #### `target.<triple>.<links>` 

 The links sub-table provides a way to [override a build script]. When 

 specified, the build script for the given `links` library will not be 

 run, and the given values will be used instead. 

 ```toml 

 [target.x86_64-unknown-linux-gnu.foo] 

 rustc-link-lib = ["foo"] 

 rustc-link-search = ["/path/to/foo"] 

 rustc-flags = "-L /some/path"

rustbot · 2024-05-23T09:06:06Z

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @weihanglo (or someone else) some time within the next two weeks.

Please see the contribution instructions for more information. Namely, in order to ensure the minimum review times lag, PR authors and assigned reviewers should ensure that the review label (S-waiting-on-review and S-waiting-on-author) stays updated, invoking these commands when appropriate:

@rustbot author: the review is finished, PR author should check the comments and take action accordingly
@rustbot review: the author is ready for a review, this PR will be queued again in the reviewer's queue

weihanglo · 2024-05-23T12:42:35Z

src/doc/src/reference/config.md

@@ -170,7 +170,7 @@ rustflags = ["…", "…"] # custom flags for `rustc`
 [target.<triple>.<links>] # `links` build script override
 rustc-link-lib = ["foo"]
 rustc-link-search = ["/path/to/foo"]
-rustc-flags = ["-L", "/some/path"]


Yeah. Looks like it only accepts strings. Good catch and thanks!

cargo/src/cargo/util/context/target.rs

Lines 159 to 165 in 5da2858

"rustc-flags" => {

let flags = value.string(key)?;

let whence = format!("target config `{}.{}` (in {})", target_key, key, flags.1);

let (paths, links) = BuildOutput::parse_rustc_flags(flags.0, &whence)?;

output.library_paths.extend(paths);

output.library_links.extend(links);

}

weihanglo · 2024-05-23T12:44:32Z

@bors r+

Thanks for the contribution!

bors · 2024-05-23T12:44:35Z

📌 Commit 63e8461 has been approved by weihanglo

It is now in the queue for this repository.

bors · 2024-05-23T12:45:53Z

⌛ Testing commit 63e8461 with merge 3830c0c...

bors · 2024-05-23T13:16:04Z

☀️ Test successful - checks-actions
Approved by: weihanglo
Pushing 3830c0c to master...

Update cargo 7 commits in 84dc5dc11a9007a08f27170454da6097265e510e..a8d72c675ee52dd57f0d8f2bae6655913c15b2fb 2024-05-20 18:57:08 +0000 to 2024-05-24 03:34:17 +0000 - Improve error description when deserializing partial field struct (rust-lang/cargo#13956) - fix: remove symlink dir on Windows (rust-lang/cargo#13910) - Fix wrong type of rustc-flags in documentation (rust-lang/cargo#13957) - Add more high level traces (rust-lang/cargo#13951) - upgrade gix from 0.62 to 0.63 (rust-lang/cargo#13948) - Use `i32` rather than `usize` as "default integer" in library template (rust-lang/cargo#13939) - fetch specific commits even if the github fast path fails (rust-lang/cargo#13946) r? ghost

Fix wrong type of rustc-flags in documentation

63e8461

rustbot assigned weihanglo May 23, 2024

rustbot added A-documenting-cargo-itself Area: Cargo's documentation S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels May 23, 2024

weihanglo approved these changes May 23, 2024

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 May 23, 2024

bors merged commit 3830c0c into rust-lang:master May 23, 2024
21 checks passed

iawia002 deleted the docs branch May 24, 2024 00:34

weihanglo mentioned this pull request May 24, 2024

Update cargo rust-lang/rust#125524

Merged

rustbot added this to the 1.80.0 milestone May 25, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix wrong type of rustc-flags in documentation #13957

Fix wrong type of rustc-flags in documentation #13957

iawia002 commented May 23, 2024

rustbot commented May 23, 2024

weihanglo May 23, 2024

weihanglo commented May 23, 2024

bors commented May 23, 2024

bors commented May 23, 2024

bors commented May 23, 2024

	#### `target.<triple>.<links>`

	The links sub-table provides a way to [override a build script]. When
	specified, the build script for the given `links` library will not be
	run, and the given values will be used instead.

	```toml
	[target.x86_64-unknown-linux-gnu.foo]
	rustc-link-lib = ["foo"]
	rustc-link-search = ["/path/to/foo"]
	rustc-flags = "-L /some/path"

	"rustc-flags" => {
	let flags = value.string(key)?;
	let whence = format!("target config `{}.{}` (in {})", target_key, key, flags.1);
	let (paths, links) = BuildOutput::parse_rustc_flags(flags.0, &whence)?;
	output.library_paths.extend(paths);
	output.library_links.extend(links);
	}

Fix wrong type of rustc-flags in documentation #13957

Fix wrong type of rustc-flags in documentation #13957

Conversation

iawia002 commented May 23, 2024

rustbot commented May 23, 2024

weihanglo May 23, 2024

Choose a reason for hiding this comment

weihanglo commented May 23, 2024

bors commented May 23, 2024

bors commented May 23, 2024

bors commented May 23, 2024