Skip to content

Commit

Permalink
Merge #3016
Browse files Browse the repository at this point in the history
3016: Revert "Automatically read license field from Cargo.toml" r=pksunkara a=epage



Co-authored-by: Ed Page <[email protected]>
  • Loading branch information
bors[bot] and epage authored Nov 12, 2021
2 parents 3092751 + 7a59dc3 commit 98c1a75
Show file tree
Hide file tree
Showing 9 changed files with 0 additions and 62 deletions.
1 change: 0 additions & 1 deletion examples/01a_quick_example.rs
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,6 @@ fn main() {
.version("1.0")
.author("Kevin K. <[email protected]>")
.about("Does awesome things")
.license("MIT OR Apache-2.0")
.arg("-c, --config=[FILE] 'Sets a custom config file'")
.arg("<output> 'Sets an optional output file'")
.arg("-d..., --debug... 'Turn debugging information on'")
Expand Down
1 change: 0 additions & 1 deletion examples/01b_quick_example.rs
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,6 @@ fn main() {
.version("1.0")
.author("Kevin K. <[email protected]>")
.about("Does awesome things")
.license("MIT OR Apache-2.0")
.arg(
Arg::new("config")
.short('c')
Expand Down
1 change: 0 additions & 1 deletion examples/02_apps.rs
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ fn main() {
.version("1.0")
.author("Kevin K. <[email protected]>")
.about("Does awesome things")
.license("MIT OR Apache-2.0")
.get_matches();

// This example doesn't do much, but it *does* give automatic -h, --help, -V, and --version functionality ;)
Expand Down
1 change: 0 additions & 1 deletion examples/04_using_matches.rs
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@ fn main() {
// argument.
let matches = App::new("MyApp")
.about("Parses an input file to do awesome things")
.license("MIT OR Apache-2.0")
.version("1.0")
.author("Kevin K. <[email protected]>")
.arg(
Expand Down
1 change: 0 additions & 1 deletion examples/08_subcommands.rs
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@ fn main() {
App::new("add") // The name we call argument with
.about("Adds files to myapp") // The message displayed in "myapp -h"
// or "myapp help"
.license("MIT OR Apache-2.0")
.version("0.1") // Subcommands can have independent version
.author("Kevin K.") // And authors
.arg(
Expand Down
1 change: 0 additions & 1 deletion examples/20_subcommands.rs
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,6 @@ fn main() {
.subcommand(
App::new("clone")
.about("clones repos")
.license("MIT OR Apache-2.0")
.arg(Arg::new("repo").about("The repo to clone").required(true)),
)
.subcommand(
Expand Down
1 change: 0 additions & 1 deletion examples/21_aliases.rs
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ fn main() {
App::new("ls")
.aliases(&["list", "dir"])
.about("Adds files to myapp")
.license("MIT OR Apache-2.0")
.version("0.1")
.author("Kevin K.")
.arg(
Expand Down
22 changes: 0 additions & 22 deletions src/build/app/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,6 @@ pub struct App<'help> {
pub(crate) author: Option<&'help str>,
pub(crate) version: Option<&'help str>,
pub(crate) long_version: Option<&'help str>,
pub(crate) license: Option<&'help str>,
pub(crate) about: Option<&'help str>,
pub(crate) long_about: Option<&'help str>,
pub(crate) before_help: Option<&'help str>,
Expand Down Expand Up @@ -747,27 +746,6 @@ impl<'help> App<'help> {
self
}

/// Sets a string of the license to be displayed when displaying help information.
///
/// **Pro-tip:** Use `clap`s convenience macro [`crate_license!`] to automatically set your
/// application's license to the same thing as your crate at compile time. See the
/// [`examples/`] directory for more information
///
/// # Examples
///
/// ```no_run
/// # use clap::{App, Arg};
/// App::new("myprog")
/// .license("MIT OR Apache-2.0")
/// # ;
/// ```
/// [`crate_license!`]: ./macro.crate_license!.html
/// [`examples/`]: https://github.com/clap-rs/clap/tree/master/examples
pub fn license<S: Into<&'help str>>(mut self, license: S) -> Self {
self.license = Some(license.into());
self
}

/// Overrides the `clap` generated usage string.
///
/// This will be displayed to the user when errors are found in argument parsing.
Expand Down
33 changes: 0 additions & 33 deletions src/macros.rs
Original file line number Diff line number Diff line change
Expand Up @@ -32,37 +32,6 @@ macro_rules! load_yaml {
};
}

/// Allows you to pull the licence from your Cargo.toml at compile time. If the `license` field is
/// empty, then the `licence-field` is read. If both fields are empty, then an empty string is
/// returned.
///
/// # Examples
///
/// ```no_run
/// # #[macro_use]
/// # extern crate clap;
/// # use clap::App;
/// # fn main() {
/// let m = App::new("app")
/// .license(crate_license!())
/// .get_matches();
/// # }
/// ```
#[cfg(feature = "cargo")]
#[macro_export]
macro_rules! crate_license {
() => {{
let mut license = env!("CARGO_PKG_LICENSE");
if license.is_empty() {
license = env!("CARGO_PKG_LICENSE_FILE");
}
if license.is_empty() {
license = "";
}
license
}};
}

/// Allows you to pull the version from your Cargo.toml at compile time as
/// `MAJOR.MINOR.PATCH_PKGVERSION_PRE`
///
Expand Down Expand Up @@ -197,14 +166,12 @@ macro_rules! app_from_crate {
.version($crate::crate_version!())
.author($crate::crate_authors!())
.about($crate::crate_description!())
.license($crate::crate_license!())
};
($sep:expr) => {
$crate::App::new($crate::crate_name!())
.version($crate::crate_version!())
.author($crate::crate_authors!($sep))
.about($crate::crate_description!())
.license($crate::crate_license!())
};
}

Expand Down

0 comments on commit 98c1a75

Please sign in to comment.