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

Jump to bottom

Update docs language regarding repository vs package root #4367

Closed
behnam opened this issue Aug 5, 2017 · 2 comments · Fixed by #4375
Closed

Update docs language regarding repository vs package root #4367

behnam opened this issue Aug 5, 2017 · 2 comments · Fixed by #4375
Labels
A-documenting-cargo-itself Area: Cargo's documentation

Comments

@behnam
Copy link
Contributor

behnam commented Aug 5, 2017

From http://doc.crates.io/manifest.html:

# This points to a file in the repository (relative to this `Cargo.toml`). The
# contents of this file are stored and indexed in the registry.
readme = "..."

The problem is that these kinds of links cannot point to outside of package root, since anything outside of package root won't be able to be packaged in the first place.

With workspaces and not all Cargo manifest files being on the (git) repository top-level anymore, usage of word repository here is now confusing and should be avoided in package-level documentation.

The notion of package root (vs. repository) is also important important in explaining workspace.members and workspace.exclude, as I've noted here: #4268 (comment)
@behnam
Copy link
Contributor Author

behnam commented Aug 5, 2017

/cc @alexcrichton
label: A-documenting-cargo-itself

@behnam
Copy link
Contributor Author

behnam commented Aug 5, 2017

And a misuse of repository to refer to the crates index:

The publish field can be used to prevent a package from being published to a repository by mistake.

@alexcrichton alexcrichton added the A-documenting-cargo-itself Area: Cargo's documentation label Aug 7, 2017
@behnam behnam mentioned this issue Aug 7, 2017
Merged
bors added a commit that referenced this issue Aug 7, 2017
@bors
Auto merge of #4375 - behnam:root-vs-repo, r=alexcrichton
35bda50 
[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>
@bors bors closed this as completed in #4375 Aug 8, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
A-documenting-cargo-itself Area: Cargo's documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

[docs] Update language regarding repository vs package root behnam/rust-cargo
2 participants
@behnam @alexcrichton