[docs]: Clarify vendored sources as read-only and way to modify #13512
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? @weihanglo rustbot has assigned @weihanglo. Use r? to explicitly pick a reviewer |
rustbot
added
A-documenting-cargo-itself
weihanglo
reviewed
Mar 1, 2024
LuuuXXX
force-pushed
the
issue-5805
branch
2 times, most recently
from
db44ffe to
14190ed
Compare
weihanglo
approved these changes
Mar 1, 2024
src/doc/man/cargo-vendor.md
Outdated
| @@ -21,6 +21,12 @@ stdout after `cargo vendor` completes the vendoring process. | |||
| You will need to add or redirect it to your Cargo configuration file, | |||
| which is usually `.cargo/config.toml` locally for the current package. | |||
|
|
|||
| Cargo treats vendored sources as read-only as it does to registry and git sources. | |||
There was a problem hiding this comment.
Just notice there are some trailing spaces. Not sure if it is intentionally done but they do render to a linebreak here. Otherwise looks good to me.
Suggested change
| Cargo treats vendored sources as read-only as it does to registry and git sources. | |
| Cargo treats vendored sources as read-only as it does to registry and git sources. |
There was a problem hiding this comment.
More thanks, modified
|
@bors r+ Thanks for the polish! |
bors
added
S-waiting-on-bors
|
☀️ Test successful - checks-actions |
This was referenced Mar 1, 2024
bors
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Mar 2, 2024
Update cargo 12 commits in 8964c8ccff6e420e2a38b8696d178d69fab84d9d..f772ec0224d3755ce52ac5128a80319fb2eb45d0 2024-02-27 19:22:46 +0000 to 2024-03-01 22:57:35 +0000 - feat(toml): Warn on unset Edition (rust-lang/cargo#13505) - fix(msrv): Report all incompatible packages, not just a random one (rust-lang/cargo#13514) - refactor: abstract `std::fs` away from on-disk index cache (rust-lang/cargo#13515) - chore(deps): update compatible (rust-lang/cargo#13507) - chore(deps): update rust crate rusqlite to 0.31.0 (rust-lang/cargo#13510) - [docs]: Clarify vendored sources as read-only and way to modify (rust-lang/cargo#13512) - chore(deps): update rust crate supports-hyperlinks to v3 (rust-lang/cargo#13511) - refactor: Clarify more Config -> Context (rust-lang/cargo#13506) - test: Make `edition` explicit in packages (rust-lang/cargo#13504) - Add all unit's children recursively for `doc.extern-map` option (rust-lang/cargo#13481) - fix(rustc): Always pass --edition to rustc (rust-lang/cargo#13499) - Silently ignore `cargo::rustc-check-cfg` to avoid MSRV annoyance when stabilizing `-Zcheck-cfg` (rust-lang/cargo#13438) r? ghost
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?
To document that vendored sources are not intended to be modified, and
[patch]or apathdependency is the correct way to modify a vendored crate.#5805 (comment)