[docs] Update language regarding repository vs package root #4375
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
In the current documentation, there are many places with language that assumes a *repository* (as in VCS) is the same as *package root* (the directory where `Cargo.toml` sits). With the new workspace features, this is far from true now, and the inaccurate language makes it difficault for newbies or developers without much familiarity with the cargo internals with authoring their manifest files. This diff tries to use the right terms for places any of these concepts is referred to: * Package root, * Workspace root, * VCS repository, and * Package repository/index, like crates.io.
|
r? @matklad (rust_highfive has picked a reviewer for you, use r? to override) |
|
@bors: r+ Thanks! |
|
📌 Commit e774367 has been approved by |
bors
added a commit
that referenced
this pull request
Aug 7, 2017
[docs] Update language regarding repository vs package root In the current documentation, there are many places with language that assumes a *repository* (as in VCS) is the same as *package root* (the directory where `Cargo.toml` sits). With the new workspace features, this is far from true now, and the inaccurate language makes it difficault for newbies or developers without much familiarity with the cargo internals with authoring their manifest files. This diff tries to use the right terms for places any of these concepts is referred to: * Package root, * Workspace root, * VCS repository, and * Package repository/index, like crates.io. Fixes <#4367>
|
☀️ Test successful - status-appveyor, status-travis |
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.
In the current documentation, there are many places with language that
assumes a repository (as in VCS) is the same as package root (the
directory where
Cargo.tomlsits).With the new workspace features, this is far from true now, and the
inaccurate language makes it difficault for newbies or developers
without much familiarity with the cargo internals with authoring their
manifest files.
This diff tries to use the right terms for places any of these concepts
is referred to:
Fixes #4367