diff options
| author | Tim Chevalier <chevalier@alum.wellesley.edu> | 2013-07-26 20:06:30 -0700 |
|---|---|---|
| committer | Tim Chevalier <chevalier@alum.wellesley.edu> | 2013-07-26 20:06:41 -0700 |
| commit | 7079ec6e2ed0d9de58d5a87b8ac7f6c31a65a4cd (patch) | |
| tree | 6225cc7dac1b5872eeda74b1636a32bb0d98a1df | |
| parent | c8780511b924705fbb567398e5201d9b492a2f32 (diff) | |
| download | rust-7079ec6e2ed0d9de58d5a87b8ac7f6c31a65a4cd.tar.gz rust-7079ec6e2ed0d9de58d5a87b8ac7f6c31a65a4cd.zip | |
docs: Talk about tags that aren't versions in the "Package identifiers" section
| -rw-r--r-- | doc/rustpkg.md | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/rustpkg.md b/doc/rustpkg.md index 506fc2ad15a..46ab7afab43 100644 --- a/doc/rustpkg.md +++ b/doc/rustpkg.md @@ -76,6 +76,14 @@ A package ID can also specify a version, like: `github.com/mozilla/rust#0.3`. In this case, `rustpkg` will check that the repository `github.com/mozilla/rust` has a tag named `0.3`, and report an error otherwise. +A package ID can also specify a particular revision of a repository, like: +`github.com/mozilla/rust#release-0.7`. +When the refspec (portion of the package ID after the `#`) can't be parsed as a decimal number, +rustpkg passes the refspec along to the version control system without interpreting it. +rustpkg also interprets any dependencies on such a package ID literally +(as opposed to versions, where a newer version satisfies a dependency on an older version). +Thus, `github.com/mozilla/rust#5c4cd30f80` is also a valid package ID, +since git can deduce that 5c4cd30f80 refers to a revision of the desired repository. ## Source files |