nordic-dev.net/rust
nordic-dev.net/rust
2
0
Fork 0
mirror of https://github.com/rust-lang/rust.git synced 2024-11-22 14:55:26 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update rustpkg man page.

Browse Source 
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.
This commit is contained in:
Steve Klabnik 2013-09-16 13:51:02 -07:00
parent 0ec4d34b3f
commit e1507f3120
1 changed files with 4 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
man/rustpkg.1
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, available at <\fBhttps://www.rust-lang.org\fR>. It provides commands to build,
install and test Rust programs. 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 .SH COMMANDS
.TP .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 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 build products into the \fIlib\fR and \fIbin\fR directories of their respective
workspaces. 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" .SS "BUILD COMMAND"
@ -58,20 +56,9 @@ of the first entry in RUST_PATH.
Examples: Examples:
$ rustpkg install git://github.com/mozilla/servo.git#1.2 $ rustpkg install github.com/mozilla/servo.git#1.2
$ rustpkg install rust-glfw $ 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" .SH "ENVIRONMENT"
.TP .TP
@ -186,7 +173,7 @@ rust, rustc, rustdoc, rusti
See <\fBhttps://github.com/mozilla/rust/issues\fR> for issues. See <\fBhttps://github.com/mozilla/rust/issues\fR> for issues.
.SH "AUTHOR" .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. <\fIgraydon@mozilla.com\fR> is the project leader.
.SH "COPYRIGHT" .SH "COPYRIGHT"