itsscb/cargo
1
0
Fork 0
mirror of https://github.com/rust-lang/cargo.git synced 2025-10-01 11:30:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

Squash:

Browse Source 
* Explain how `version` works for `git` dependencies
* Link to multiple-locations, since this is already explained there
* more extensive rewrite
This commit is contained in:
Kyle J Strand 2023-06-14 11:14:34 -07:00 committed by Kyle J Strand
parent 2a6f7f6efe
commit 01e1ff0484
1 changed files with 32 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
src/doc/src/reference/specifying-dependencies.md
View File

@ -53,12 +53,14 @@ and `x > 0`.
It is possible to further tweak the logic for selecting compatible versions It is possible to further tweak the logic for selecting compatible versions
using special operators, though it shouldn't be necessary most of the time. using special operators, though it shouldn't be necessary most of the time.
### Caret requirements ### Version requirement syntax
#### Caret requirements
**Caret requirements** are an alternative syntax for the default strategy, **Caret requirements** are an alternative syntax for the default strategy,
`^1.2.3` is exactly equivalent to `1.2.3`. `^1.2.3` is exactly equivalent to `1.2.3`.
### Tilde requirements #### Tilde requirements
**Tilde requirements** specify a minimal version with some ability to update. **Tilde requirements** specify a minimal version with some ability to update.
If you specify a major, minor, and patch version or only a major and minor If you specify a major, minor, and patch version or only a major and minor
@ -73,7 +75,7 @@ version, then minor- and patch-level changes are allowed.
~1 := >=1.0.0, <2.0.0 ~1 := >=1.0.0, <2.0.0
``` ```
### Wildcard requirements #### Wildcard requirements
**Wildcard requirements** allow for any version where the wildcard is **Wildcard requirements** allow for any version where the wildcard is
positioned. positioned.
@ -88,7 +90,7 @@ positioned.
> **Note**: [crates.io] does not allow bare `*` versions. > **Note**: [crates.io] does not allow bare `*` versions.
### Comparison requirements #### Comparison requirements
**Comparison requirements** allow manually specifying a version range or an **Comparison requirements** allow manually specifying a version range or an
exact version to depend on. exact version to depend on.
@ -102,7 +104,7 @@ Here are some examples of comparison requirements:
= 1.2.3 = 1.2.3
``` ```
### Multiple requirements #### Multiple version requirements
As shown in the examples above, multiple version requirements can be As shown in the examples above, multiple version requirements can be
separated with a comma, e.g., `>= 1.2, < 1.5`. separated with a comma, e.g., `>= 1.2, < 1.5`.
@ -157,7 +159,7 @@ some-crate = { version = "1.0", registry = "my-registry" }
``` ```
> **Note**: [crates.io] does not allow packages to be published with > **Note**: [crates.io] does not allow packages to be published with
> dependencies on other registries. > dependencies on code published outside of [crates.io].
[registries documentation]: registries.md [registries documentation]: registries.md
@ -195,6 +197,15 @@ varies by where the repo is hosted; GitHub in particular exposes a reference to
the most recent commit of every pull request as shown, but other git hosts often the most recent commit of every pull request as shown, but other git hosts often
provide something equivalent, possibly under a different naming scheme. provide something equivalent, possibly under a different naming scheme.
> **Note**: Neither the `git` key nor the `path` key changes the meaning of the
> `version` key: the `version` key always implies that the package is available
> in a registry. `version`, `git`, and `path` keys are considered [separate
> locations](#multiple-locations) for resolving the dependency.
>
> When the dependency is retrieved from `git`, the `version` key will _not_
> affect which commit is used, but the version information in the dependency's
> `Cargo.toml` file will still be validated against the `version` requirement.
Once a `git` dependency has been added, Cargo will lock that dependency to the Once a `git` dependency has been added, Cargo will lock that dependency to the
latest commit at the time. New commits will not be pulled down automatically latest commit at the time. New commits will not be pulled down automatically
once the lock is in place. However, they can be pulled down manually with once the lock is in place. However, they can be pulled down manually with
@ -202,9 +213,11 @@ once the lock is in place. However, they can be pulled down manually with
See [Git Authentication] for help with git authentication for private repos. See [Git Authentication] for help with git authentication for private repos.
> **Note**: [crates.io] does not allow packages to be published with `git` > **Note**: [crates.io] does not allow packages to be published with
> dependencies (`git` [dev-dependencies] are ignored). See the [Multiple > dependencies on code published outside of [crates.io] itself
> locations](#multiple-locations) section for a fallback alternative. > ([dev-dependencies] are ignored). See the [Multiple
> locations](#multiple-locations) section for a fallback alternative for `git`
> and `path` dependencies.
[Git Authentication]: ../appendix/git-authentication.md [Git Authentication]: ../appendix/git-authentication.md
@ -245,9 +258,16 @@ and specify its version in the dependencies line as well:
hello_utils = { path = "hello_utils", version = "0.1.0" } hello_utils = { path = "hello_utils", version = "0.1.0" }
``` ```
> **Note**: [crates.io] does not allow packages to be published with `path` > **Note**: Neither the `git` key nor the `path` key changes the meaning of the
> dependencies (`path` [dev-dependencies] are ignored). See the [Multiple > `version` key: the `version` key always implies that the package is available
> locations](#multiple-locations) section for a fallback alternative. > in a registry. `version`, `git`, and `path` keys are considered [separate
> locations](#multiple-locations) for resolving the dependency.
> **Note**: [crates.io] does not allow packages to be published with
> dependencies on code published outside of [crates.io] itself
> ([dev-dependencies] are ignored). See the [Multiple
> locations](#multiple-locations) section for a fallback alternative for `git`
> and `path` dependencies.
### Multiple locations ### Multiple locations