Skip to content

Commit 2d4e130

Browse files
committed
Provide a custom usage string for --help
The generated output is not very readable. We can do better by providing a custom string. This makes the binary smaller too.
1 parent af796a9 commit 2d4e130

File tree

2 files changed

+8
-1
lines changed

2 files changed

+8
-1
lines changed

Cargo.toml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,12 @@ exclude = ["tests/07a-mount-point-excl", "tests/10-example"]
1414

1515
[dependencies]
1616
anyhow = "1.0.12"
17-
clap = { version = "4.5", default-features = false, features = ["std", "cargo", "help" , "usage", "error-context"] }
17+
clap = { version = "4.5", default-features = false, features = ["std", "cargo", "help" , "error-context"] }
1818
liboverdrop = "0.1.0"
1919
rust-ini = ">=0.15, <0.18"
2020
log = { version = "0.4", features = ["std"] }
2121
fasteval = { version = "0.2", default-features = false }
22+
indoc = "2.0.5"
2223

2324
[dev-dependencies]
2425
tempfile = "3"

src/main.rs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ mod kernlog;
66
mod setup;
77

88
use anyhow::Result;
9+
use indoc::indoc;
910
use log::{info, LevelFilter};
1011
use std::borrow::Cow;
1112
use std::env;
@@ -24,6 +25,11 @@ enum Opts {
2425
#[rustfmt::skip]
2526
fn command() -> clap::Command {
2627
clap::command!()
28+
.override_usage(indoc! {"
29+
zram-generator --setup-device <device>
30+
zram-generator --reset-device <device>
31+
zram-generator dir1 [dir2 dir3]
32+
"})
2733
.arg(
2834
clap::arg!(--"setup-device" <device> "Set up a single device")
2935
.conflicts_with("reset-device")

0 commit comments

Comments
 (0)