Skip to content

Commit

Permalink
rustpkg: Update manual
Browse files Browse the repository at this point in the history
  • Loading branch information
catamorphism authored and thestinger committed Jun 28, 2013
1 parent b854d6e commit d805859
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions doc/rustpkg.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,12 +95,22 @@ When building a package that is in a `git` repository,
When building a package that is not under version control,
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

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
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

## build
Expand Down

0 comments on commit d805859

Please sign in to comment.