auto merge of #9234 : steveklabnik/rust/rustpkg_manpage, r=cmr

Closes #9221.

"rustpkg test" isn't implemented yet, so it shouldn't be in the manpage. Referring interested parties to the manual is probably
the right thing for now; eventually, these documents should merge.

/cc @catamorphism
This commit is contained in:
bors 2013-09-17 03:30:48 -07:00
commit 2a706aab1c
1 changed files with 4 additions and 17 deletions

View File

@ -11,6 +11,8 @@ This tool is a package manager for applications written in the Rust language,
available at <\fBhttps://www.rust-lang.org\fR>. It provides commands to build,
install and test Rust programs.
\fBrustpkg\fR is still a work in progress. See \fBdoc/rustpkg.md\fR in the Rust source distribution for future plans.
.SH COMMANDS
.TP
@ -25,10 +27,6 @@ Remove all generated files from the \fIbuild\fR directory in the target's worksp
Builds the specified target, and all its dependencies, and then installs the
build products into the \fIlib\fR and \fIbin\fR directories of their respective
workspaces.
.TP
\fBtest\fR
Builds the module called \fItest.rs\fR in the specified workspace, and then runs
the resulting executable in test mode.
.SS "BUILD COMMAND"
@ -58,20 +56,9 @@ of the first entry in RUST_PATH.
Examples:
$ rustpkg install git://github.com/mozilla/servo.git#1.2
$ rustpkg install github.com/mozilla/servo.git#1.2
$ rustpkg install rust-glfw
.SS "TEST COMMAND"
rustpkg test \fI[pkgname]\fR
The test command is a shortcut for the command line:
$ rustc --test <filename> -o <filestem>test~ && ./<filestem>test~
Note the suffix on the output filename (the word "test" followed by a tilde),
which should ensure the file does not clash with a user-generated files.
.SH "ENVIRONMENT"
.TP
@ -186,7 +173,7 @@ rust, rustc, rustdoc, rusti
See <\fBhttps://github.com/mozilla/rust/issues\fR> for issues.
.SH "AUTHOR"
See \fBAUTHORS.txt\fR in the rust source distribution. Graydon Hoare
See \fBAUTHORS.txt\fR in the Rust source distribution. Graydon Hoare
<\fIgraydon@mozilla.com\fR> is the project leader.
.SH "COPYRIGHT"