bjoernager/rust
bjoernager/rust
1
Fork 0
Code Activity

rustpkg: Update manual

Browse source
This commit is contained in:
Tim Chevalier 2013-06-27 12:13:55 -07:00 • committed by Daniel Micay
parent b854d6ea1c
commit d805859ff5
1 changed files with 10 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

10
doc/rustpkg.md
View file

@ -95,12 +95,22 @@ When building a package that is in a `git` repository,
When building a package that is not under version control, When building a package that is not under version control,
or that has no tags, `rustpkg` assumes the intended version is 0.1. or that has no tags, `rustpkg` assumes the intended version is 0.1.
# Dependencies
rustpkg infers dependencies from `extern mod` directives.
Thus, there should be no need to pass a `-L` flag to rustpkg to tell it where to find a library.
(In the future, it will also be possible to write an `extern mod` directive referring to a remote package.)
# Custom build scripts # Custom build scripts
A file called `pkg.rs` at the root level in a workspace is called a *package script*. A file called `pkg.rs` at the root level in a workspace is called a *package script*.
If a package script exists, rustpkg executes it to build the package If a package script exists, rustpkg executes it to build the package
rather than inferring crates as described previously. rather than inferring crates as described previously.
Inside `pkg.rs`, it's possible to call back into rustpkg to finish up the build.
`rustpkg::api` contains functions to build, install, or clean libraries and executables
in the way rustpkg normally would without custom build logic.
# Command reference # Command reference
## build ## build