diff --git a/CHANGELOG.md b/CHANGELOG.md index aed701a19c6..5600fecf843 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -21,6 +21,8 @@ _gated behind `unstable-v4`_ ## [Unreleased] - ReleaseDate +## [3.1.17] - 2022-05-06 + ### Fixes - Allow value names for `arg!` macro to have dashes when quoted, like longs @@ -3331,7 +3333,8 @@ Minimum version of Rust is now v1.13.0 (Stable) * **arg** allow lifetimes other than 'static in arguments ([9e8c1fb9](https://github.com/clap-rs/clap/commit/9e8c1fb9406f8448873ca58bab07fe905f1551e5)) -[Unreleased]: https://github.com/clap-rs/clap/compare/v3.1.16...HEAD +[Unreleased]: https://github.com/clap-rs/clap/compare/v3.1.17...HEAD +[3.1.17]: https://github.com/clap-rs/clap/compare/v3.1.16...v3.1.17 [3.1.16]: https://github.com/clap-rs/clap/compare/v3.1.15...v3.1.16 [3.1.15]: https://github.com/clap-rs/clap/compare/v3.1.14...v3.1.15 [3.1.14]: https://github.com/clap-rs/clap/compare/v3.1.13...v3.1.14 diff --git a/Cargo.toml b/Cargo.toml index 6aec249f0e8..f9e9d56c64a 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -9,7 +9,7 @@ members = [ [package] name = "clap" -version = "3.1.16" +version = "3.1.17" description = "A simple to use, efficient, and full-featured Command Line Argument Parser" repository = "https://github.com/clap-rs/clap" documentation = "https://docs.rs/clap/" diff --git a/README.md b/README.md index e5f56953662..26b8739b066 100644 --- a/README.md +++ b/README.md @@ -5,8 +5,8 @@ [![Crates.io](https://img.shields.io/crates/v/clap?style=flat-square)](https://crates.io/crates/clap) [![Crates.io](https://img.shields.io/crates/d/clap?style=flat-square)](https://crates.io/crates/clap) -[![License](https://img.shields.io/badge/license-Apache%202.0-blue?style=flat-square)](https://github.com/clap-rs/clap/blob/v3.1.16/LICENSE-APACHE) -[![License](https://img.shields.io/badge/license-MIT-blue?style=flat-square)](https://github.com/clap-rs/clap/blob/v3.1.16/LICENSE-MIT) +[![License](https://img.shields.io/badge/license-Apache%202.0-blue?style=flat-square)](https://github.com/clap-rs/clap/blob/v3.1.17/LICENSE-APACHE) +[![License](https://img.shields.io/badge/license-MIT-blue?style=flat-square)](https://github.com/clap-rs/clap/blob/v3.1.17/LICENSE-MIT) [![Build Status](https://img.shields.io/github/workflow/status/clap-rs/clap/CI/staging?style=flat-square)](https://github.com/clap-rs/clap/actions/workflows/ci.yml?query=branch%3Astaging) [![Coverage Status](https://img.shields.io/coveralls/github/clap-rs/clap/master?style=flat-square)](https://coveralls.io/github/clap-rs/clap?branch=master) [![Contributors](https://img.shields.io/github/contributors/clap-rs/clap?style=flat-square)](https://github.com/clap-rs/clap/graphs/contributors) @@ -14,15 +14,15 @@ Dual-licensed under [Apache 2.0](LICENSE-APACHE) or [MIT](LICENSE-MIT). 1. [About](#about) -2. Tutorial: [Builder API](https://github.com/clap-rs/clap/blob/v3.1.16/examples/tutorial_builder/README.md), [Derive API](https://github.com/clap-rs/clap/blob/v3.1.16/examples/tutorial_derive/README.md) -3. [Examples](https://github.com/clap-rs/clap/blob/v3.1.16/examples/README.md) +2. Tutorial: [Builder API](https://github.com/clap-rs/clap/blob/v3.1.17/examples/tutorial_builder/README.md), [Derive API](https://github.com/clap-rs/clap/blob/v3.1.17/examples/tutorial_derive/README.md) +3. [Examples](https://github.com/clap-rs/clap/blob/v3.1.17/examples/README.md) 4. [API Reference](https://docs.rs/clap) - - [Derive Reference](https://github.com/clap-rs/clap/blob/v3.1.16/examples/derive_ref/README.md) + - [Derive Reference](https://github.com/clap-rs/clap/blob/v3.1.17/examples/derive_ref/README.md) - [Feature Flags](#feature-flags) -5. [CHANGELOG](https://github.com/clap-rs/clap/blob/v3.1.16/CHANGELOG.md) -6. [FAQ](https://github.com/clap-rs/clap/blob/v3.1.16/docs/FAQ.md) +5. [CHANGELOG](https://github.com/clap-rs/clap/blob/v3.1.17/CHANGELOG.md) +6. [FAQ](https://github.com/clap-rs/clap/blob/v3.1.17/docs/FAQ.md) 7. [Questions & Discussions](https://github.com/clap-rs/clap/discussions) -8. [Contributing](https://github.com/clap-rs/clap/blob/v3.1.16/CONTRIBUTING.md) +8. [Contributing](https://github.com/clap-rs/clap/blob/v3.1.17/CONTRIBUTING.md) 8. [Sponsors](#sponsors) ## About @@ -32,8 +32,8 @@ Create your command-line parser, with all of the bells and whistles, declarative ### Example This uses our -[Derive API](https://github.com/clap-rs/clap/blob/v3.1.16/examples/tutorial_derive/README.md) -which provides access to the [Builder API](https://github.com/clap-rs/clap/blob/v3.1.16/examples/tutorial_builder/README.md) as attributes on a `struct`: +[Derive API](https://github.com/clap-rs/clap/blob/v3.1.17/examples/tutorial_derive/README.md) +which provides access to the [Builder API](https://github.com/clap-rs/clap/blob/v3.1.17/examples/tutorial_builder/README.md) as attributes on a `struct`: ```rust,no_run @@ -63,7 +63,7 @@ fn main() { Add this to `Cargo.toml`: ```toml [dependencies] -clap = { version = "3.1.16", features = ["derive"] } +clap = { version = "3.1.17", features = ["derive"] } ``` ```bash $ demo --help @@ -103,12 +103,12 @@ CLI parsers optimized for other use cases. ### Selecting an API -Why use the declarative [Derive API](https://github.com/clap-rs/clap/blob/v3.1.16/examples/tutorial_derive/README.md): +Why use the declarative [Derive API](https://github.com/clap-rs/clap/blob/v3.1.17/examples/tutorial_derive/README.md): - Easier to read, write, and modify - Easier to keep the argument declaration and reading of argument in sync - Easier to reuse, e.g. [clap-verbosity-flag](https://crates.io/crates/clap-verbosity-flag) -Why use the procedural [Builder API](https://github.com/clap-rs/clap/blob/v3.1.16/examples/tutorial_builder/README.md): +Why use the procedural [Builder API](https://github.com/clap-rs/clap/blob/v3.1.17/examples/tutorial_builder/README.md): - Faster compile times if you aren't already using other procedural macros - More flexible, e.g. you can look up how many times an argument showed up, what its values were, and what were the indexes of those values. The Derive diff --git a/src/derive.rs b/src/derive.rs index 0cb88fcdd9b..c2ab829dff4 100644 --- a/src/derive.rs +++ b/src/derive.rs @@ -20,7 +20,7 @@ use std::ffi::OsString; /// See also [`Subcommand`] and [`Args`]. /// /// See the -/// [derive reference](https://github.com/clap-rs/clap/blob/v3.1.16/examples/derive_ref/README.md) +/// [derive reference](https://github.com/clap-rs/clap/blob/v3.1.17/examples/derive_ref/README.md) /// for attributes and best practices. /// /// **NOTE:** Deriving requires the `derive` feature flag @@ -306,7 +306,7 @@ pub trait FromArgMatches: Sized { /// - `Variant(ChildArgs)`: No attribute is used with enum variants that impl `Args`. /// /// See the -/// [derive reference](https://github.com/clap-rs/clap/blob/v3.1.16/examples/derive_ref/README.md) +/// [derive reference](https://github.com/clap-rs/clap/blob/v3.1.17/examples/derive_ref/README.md) /// for attributes and best practices. /// /// **NOTE:** Deriving requires the `derive` feature flag @@ -350,7 +350,7 @@ pub trait Args: FromArgMatches + Sized { /// `Subcommand`. /// /// See the -/// [derive reference](https://github.com/clap-rs/clap/blob/v3.1.16/examples/derive_ref/README.md) +/// [derive reference](https://github.com/clap-rs/clap/blob/v3.1.17/examples/derive_ref/README.md) /// for attributes and best practices. /// /// **NOTE:** Deriving requires the `derive` feature flag @@ -394,7 +394,7 @@ pub trait Subcommand: FromArgMatches + Sized { /// - Allowing using the `#[clap(default_value_t)]` attribute without implementing `Display`. /// /// See the -/// [derive reference](https://github.com/clap-rs/clap/blob/v3.1.16/examples/derive_ref/README.md) +/// [derive reference](https://github.com/clap-rs/clap/blob/v3.1.17/examples/derive_ref/README.md) /// for attributes and best practices. /// /// **NOTE:** Deriving requires the `derive` feature flag