Skip to content

Commit

Permalink
docs: add possible values to pgk-fmt argument (rust-lang#383)
Browse files Browse the repository at this point in the history
  • Loading branch information
azzamsa committed Sep 15, 2022
1 parent 0e68c0f commit 559c3b8
Showing 1 changed file with 32 additions and 1 deletion.
33 changes: 32 additions & 1 deletion crates/bin/src/args.rs
Expand Up @@ -75,7 +75,38 @@ pub struct Args {
pub bin_dir: Option<String>,

/// Override Cargo.toml package manifest pkg-fmt.
#[clap(help_heading = "Overrides", long)]
///
/// The availiable package formats are:
///
/// - tar: download format is TAR (uncompressed)
///
/// - tbz2: Download format is TAR + Bzip2
///
/// - tgz: Download format is TGZ (TAR + GZip)
///
/// - txz: Download format is TAR + XZ
///
/// - tzstd: Download format is TAR + Zstd
///
/// - zip: Download format is Zip
///
/// - bin: Download format is raw / binary
#[clap(
help_heading = "Overrides",
long,
value_name = "PKG_FMT",
possible_values = [
PossibleValue::new("tar").help(
"Download format is TAR (uncompressed)."
),
PossibleValue::new("tbz2").help("Download format is TAR + Bzip2."),
PossibleValue::new("tgz").help("Download format is TGZ (TAR + GZip)."),
PossibleValue::new("txz").help("Download format is TAR + XZ."),
PossibleValue::new("tzstd").help("Download format is TAR + Zstd."),
PossibleValue::new("zip").help("Download format is Zip."),
PossibleValue::new("bin").help("Download format is raw / binary."),
]
)]
pub pkg_fmt: Option<PkgFmt>,

/// Override Cargo.toml package manifest pkg-url.
Expand Down

0 comments on commit 559c3b8

Please sign in to comment.