about summary refs log tree commit diff
path: root/doc/rustpkg.md
diff options
context:
space:
mode:
authorJack Moffitt <jack@metajack.im>2013-12-12 15:14:52 -0700
committerJack Moffitt <jack@metajack.im>2013-12-12 15:22:23 -0700
commitda9a02a189eca6040af3becaf05743fa4e5d6911 (patch)
treeffd4c0942fb4d6212f6cad75bff256c41f57638b /doc/rustpkg.md
parent1b12dca7f97a51c6cbb4f47ea6e095d841a97c1a (diff)
downloadrust-da9a02a189eca6040af3becaf05743fa4e5d6911.tar.gz
rust-da9a02a189eca6040af3becaf05743fa4e5d6911.zip
Update documentation for new `pkgid` attribute.
Diffstat (limited to 'doc/rustpkg.md')
-rw-r--r--doc/rustpkg.md7
1 files changed, 4 insertions, 3 deletions
diff --git a/doc/rustpkg.md b/doc/rustpkg.md
index 1b1f91828cb..ff413ec1f1b 100644
--- a/doc/rustpkg.md
+++ b/doc/rustpkg.md
@@ -89,6 +89,10 @@ as well as `foo/src/bar/extras/baz/lib.rs`,
 then both `bar` and `bar/extras/baz` are valid package identifiers
 in the workspace `foo`.
 
+Because rustpkg uses generic source file names as the main inputs, you will
+need to specify the package identifier in them using the `pkgid` attribute
+on the crate.
+
 ## Source files
 
 rustpkg searches for four different fixed filenames in order to determine the crates to build:
@@ -108,9 +112,6 @@ When building a package that is not under version control,
 or that has no tags, `rustpkg` assumes the intended version is 0.1.
 
 > **Note:** A future version of rustpkg will support semantic versions.
-> Also, a future version will add the option to specify a version with a metadata
-> attribute like `#[link(vers = "3.1415")]` inside the crate module,
-> though this attribute will never be mandatory.
 
 # Dependencies