Improve CARGO_ENCODED_RUSTFLAGS and CARGO_ENCODED_RUSTDOCFLAGS variables docs #10633
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
r? @ehuss (rust-highfive has picked a reviewer for you, use r? to override) |
rust-highfive
added
the
S-waiting-on-review
…les docs Signed-off-by: hi-rustin <rustin.liu@gmail.com>
hi-rustin
force-pushed
the
rustin-patch-docs-variables
branch
from
ba01351
to
26a499b
Compare
epage
reviewed
May 5, 2022
Comment on lines
36
to
+42
| invocations that Cargo performs. In contrast with [`cargo rustdoc`], this is | ||
| useful for passing a flag to *all* `rustdoc` instances. See | ||
| [`build.rustdocflags`] for some more ways to set flags. This string is | ||
| split by whitespace; for a more robust encoding of multiple arguments, | ||
| set `CARGO_ENCODED_RUSTDOCFLAGS` instead with arguments separated by | ||
| `0x1f` (ASCII Unit Separator). | ||
| split by whitespace; for a more robust encoding of multiple arguments, | ||
| see `CARGO_ENCODED_RUSTDOCFLAGS`. | ||
| * `CARGO_ENCODED_RUSTDOCFLAGS` - A list of custom flags separated by `0x1f` | ||
| (ASCII Unit Separator) to pass to all `rustdoc` invocations that Cargo performs. |
There was a problem hiding this comment.
I'm mixed on the fact that the old variables have some context not documented in the new variables but this is enough of an improvement I don't think its worth blocking this for the discussion and any updates.
|
Thanks! @bors r+ |
|
📌 Commit 26a499b has been approved by |
bors
added
S-waiting-on-bors
|
☀️ Test successful - checks-actions |
RalfJung
reviewed
May 11, 2022
| @@ -363,18 +363,19 @@ Can be overridden with the `--target-dir` CLI option. | |||
| ##### `build.rustflags` | |||
| * Type: string or array of strings | |||
| * Default: none | |||
| * Environment: `CARGO_BUILD_RUSTFLAGS` or `RUSTFLAGS` | |||
| * Environment: `CARGO_BUILD_RUSTFLAGS` or `CARGO_ENCODED_RUSTFLAGS` or `RUSTFLAGS` | |||
|
|
|||
| Extra command-line flags to pass to `rustc`. The value may be a array of | |||
| strings or a space-separated string. | |||
|
|
|||
| There are three mutually exclusive sources of extra flags. They are checked in | |||
There was a problem hiding this comment.
three mutually exclusive sources
This should probably say "four" now?
There was a problem hiding this comment.
Good catch! Thanks!
#10657
Merged
bors
added a commit
that referenced
this pull request
May 11, 2022
Fix typo See: #10633 (comment) r? `@epage`
bors
added a commit
to rust-lang-ci/rust
that referenced
this pull request
May 12, 2022
Update cargo 20 commits in a44758ac805600edbb6ba51e7e6fb81a6077c0cd..3f052d8eed98c6a24f8b332fb2e6e6249d12d8c1 2022-05-04 02:29:34 +0000 to 2022-05-12 15:19:04 +0000 - pre-stabilization documentation for workspace inheritance (rust-lang/cargo#10659) - test: Make curr_dir work in/out of workspace (rust-lang/cargo#10658) - Fix no_cross_doctests race condition. (rust-lang/cargo#10660) - Fix typo (rust-lang/cargo#10657) - feat(install): Support `foo@version` like cargo-add (rust-lang/cargo#10650) - fix typos found by the `typos-cli` crate (rust-lang/cargo#10649) - feat(yank): Support foo@version like cargo-add (rust-lang/cargo#10597) - add `cargo-features` to unstable docs for workspace inheritance (rust-lang/cargo#10648) - Use the traits added to the Rust 2021 Edition prelude (rust-lang/cargo#10646) - Pass `--target` to `rustdoc` for `cargo test` if specified with host target. (rust-lang/cargo#10594) - Fix use of .. in dep-info-basedir (rust-lang/cargo#10281) - fix some typos (rust-lang/cargo#10639) - Move snapshot tests into testsuite (rust-lang/cargo#10638) - Improve support of condition compilation checking (rust-lang/cargo#10566) - When documenting private items in a binary, ignore warnings about links to private items (rust-lang/cargo#10142) - Extend pkgid syntax with ``@`` support (rust-lang/cargo#10582) - move one `snapshot/add` test into `testsuite/cargo_add/` (rust-lang/cargo#10631) - Add caveat for covering features (rust-lang/cargo#10605) - Improve CARGO_ENCODED_RUSTFLAGS and CARGO_ENCODED_RUSTDOCFLAGS variables docs (rust-lang/cargo#10633) - reorganize `snapshot` tests to better work in contexts that sort by extension (rust-lang/cargo#10629)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR try to resolve?
close #10555
It has been improved according to the three requirements in the issue.