Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a note about rustflags compatibility. #9524

Merged
merged 2 commits into from
Jun 1, 2021
Merged

Add a note about rustflags compatibility. #9524

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2d08c73
Add a note about rustflags compatibility.
ehuss May 30, 2021
4d3772b
Add a note about passing in rustflags that conflict with Cargo.
ehuss May 30, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions src/doc/src/reference/config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -349,6 +349,16 @@ Without `--target`, the flags will be passed to all compiler invocations
you have args that you do not want to pass to build scripts or proc macros and
are building for the host, pass `--target` with the host triple.

It is not recommended to pass in flags that Cargo itself usually manages. For
example, the flags driven by [profiles] are best handled by setting the
appropriate profile setting.

> **Caution**: Due to the low-level nature of passing flags directly to the
> compiler, this may cause a conflict with future versions of Cargo which may
> issue the same or similar flags on its own which may interfere with the
> flags you specify. This is an area where Cargo may not always be backwards
> compatible.

##### `build.rustdocflags`
* Type: string or array of strings
* Default: none
Expand Down