Skip to content

Commit d805859

Browse files
catamorphismthestinger
authored andcommitted
rustpkg: Update manual
1 parent b854d6e commit d805859

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

doc/rustpkg.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,12 +95,22 @@ When building a package that is in a `git` repository,
9595
When building a package that is not under version control,
9696
or that has no tags, `rustpkg` assumes the intended version is 0.1.
9797

98+
# Dependencies
99+
100+
rustpkg infers dependencies from `extern mod` directives.
101+
Thus, there should be no need to pass a `-L` flag to rustpkg to tell it where to find a library.
102+
(In the future, it will also be possible to write an `extern mod` directive referring to a remote package.)
103+
98104
# Custom build scripts
99105

100106
A file called `pkg.rs` at the root level in a workspace is called a *package script*.
101107
If a package script exists, rustpkg executes it to build the package
102108
rather than inferring crates as described previously.
103109

110+
Inside `pkg.rs`, it's possible to call back into rustpkg to finish up the build.
111+
`rustpkg::api` contains functions to build, install, or clean libraries and executables
112+
in the way rustpkg normally would without custom build logic.
113+
104114
# Command reference
105115

106116
## build

0 commit comments

Comments
 (0)