-
Notifications
You must be signed in to change notification settings - Fork 12.9k
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.
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
Rustpkg docs and tests #5948
Rustpkg docs and tests #5948
Conversation
I only read the docs but I like them. :) |
rustpkg searches for packages using the `RUST_PATH` environment variable, | ||
which is a colon-separated list (semicolon-separated on Windows) of directories. | ||
|
||
Each directory in this list is a *package source* for rustpkg. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd use "workspace" rather than "package source" here; too confusable with the src/ subdir and/or the place you downloaded the package from.
This is looking good. Thanks. |
@catamorphism It strikes me that rustpkg.md discusses conventions for bench, test, lib and bin but says nothing about documentation. I know API docs are likely to be extracted using rustdoc, but many projects may (I'm an optimist!) include tutorial-style introductions and the like, or at least a README and LICENSE/COPYING file. Presumably it would make sense to install these. I agree with @graydon that 'workspace' makes more sense than 'package source' (which to me suggests the upstream git repo, which you'd expect wouldn't contain a 'build' dir). |
+1 to teaching rustpkg about docs |
I will incorporate these comments and then push a new commit to this branch. |
So as to preserve comments, I'll actually just open a new pull request. |
Fix ICE in `repeat_once` changelog: Fix ICE in [`repeat_once`] Fixes rust-lang#5944
r? @graydon - This pull request continues to sketch out the test cases, this time hopefully with the right directory structure; and adds a sketch of a manual for rustpkg.