diff --git a/src/doc/src/reference/config.md b/src/doc/src/reference/config.md index af11bb80b71..a6fc0b0f1ff 100644 --- a/src/doc/src/reference/config.md +++ b/src/doc/src/reference/config.md @@ -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