aboutsummaryrefslogtreecommitdiff
path: root/vendor/clap/src/_features.rs
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/clap/src/_features.rs')
-rw-r--r--vendor/clap/src/_features.rs28
1 files changed, 28 insertions, 0 deletions
diff --git a/vendor/clap/src/_features.rs b/vendor/clap/src/_features.rs
new file mode 100644
index 0000000..b47ee25
--- /dev/null
+++ b/vendor/clap/src/_features.rs
@@ -0,0 +1,28 @@
+//! ## Documentation: Feature Flags
+//!
+//! Available [compile-time feature flags](https://doc.rust-lang.org/cargo/reference/features.html#dependency-features)
+//!
+//! #### Default Features
+//!
+//! * **std**: _Not Currently Used._ Placeholder for supporting `no_std` environments in a backwards compatible manner.
+//! * **color**: Turns on colored error messages.
+//! * **help**: Auto-generate help output
+//! * **usage**: Auto-generate usage
+//! * **error-context**: Include contextual information for errors (which arg failed, etc)
+//! * **suggestions**: Turns on the `Did you mean '--myoption'?` feature for when users make typos.
+//!
+//! #### Optional features
+//!
+//! * **deprecated**: Guided experience to prepare for next breaking release (at different stages of development, this may become default)
+//! * **derive**: Enables the custom derive (i.e. `#[derive(Parser)]`). Without this you must use one of the other methods of creating a `clap` CLI listed above.
+//! * **cargo**: Turns on macros that read values from [`CARGO_*` environment variables](https://doc.rust-lang.org/cargo/reference/environment-variables.html#environment-variables-cargo-sets-for-crates).
+//! * **env**: Turns on the usage of environment variables during parsing.
+//! * **unicode**: Turns on support for unicode characters (including emoji) in arguments and help messages.
+//! * **wrap_help**: Turns on the help text wrapping feature, based on the terminal size.
+//! * **string**: Allow runtime generated strings (e.g. with [`Str`][crate::builder::Str]).
+//!
+//! #### Experimental features
+//!
+//! **Warning:** These may contain breaking changes between minor releases.
+//!
+//! * **unstable-v5**: Preview features which will be stable on the v5.0 release