Skip to content

Commit

Permalink
docs: avoid suggesting star dependencies.
Browse files Browse the repository at this point in the history
A `*` version constraint makes it hard/impossible to release a breaking
change (e.g. clap 2.0) without causing people's code to break.  `cargo
update` with a `*` dependency will happily move from (say) 1.4 to 2.0,
even though semver says these may be a breaking change. Using a more
precise dependency constraint gives the crate author more flexibility in
making breaking changes, and makes users of the crate happier if/when
they do happen.

rust-lang/rfcs#1241 contains a bit more
discussion about this.
  • Loading branch information
huonw committed Oct 1, 2015
1 parent 32c9482 commit d33228f
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -365,7 +365,7 @@ fn main() {

If you were to compile any of the above programs and run them with the flag `--help` or `-h` (or `help` subcommand, since we defined `test` as a subcommand) the following would be output

**NOTE**: The YAML option requires adding a special `features` flag when compiling `clap` because it is not compiled by default since it takes additional dependencies that some people may not need. Simply change your `clap = "*"` to `clap = {version = "*", features = ["yaml"]}` in your `Cargo.toml` to use the YAML version.
**NOTE**: The YAML option requires adding a special `features` flag when compiling `clap` because it is not compiled by default since it takes additional dependencies that some people may not need. Simply change your `clap = "1"` to `clap = {version = "1", features = ["yaml"]}` in your `Cargo.toml` to use the YAML version.

```sh
$ myapp --help
Expand Down Expand Up @@ -413,7 +413,7 @@ To test out `clap`'s default auto-generated help/version follow these steps:
*
```toml
[dependencies]
clap = "*"
clap = "1"
```

* Add the following to your `src/main.rs`
Expand All @@ -436,7 +436,7 @@ For full usage, add `clap` as a dependency in your `Cargo.toml` file to use from

```toml
[dependencies]
clap = "*"
clap = "1"
```
Or track the latest on the master branch at github:

Expand All @@ -457,15 +457,15 @@ If you'd like to keep your dependency list to **only** `clap`, you can disable a

```toml
[dependencies.clap]
version = "*"
version = "1"
default-features = false
```

You can also selectively enable only the features you'd like to include, by adding:

```toml
[dependencies.clap]
version = "*"
version = "1"
default-features = false
# Cherry-pick the features you'd like to use
Expand Down

0 comments on commit d33228f

Please sign in to comment.