Skip to content

Commit f085457

Browse files
committed
edit short and long help strings
Establishes consistent casing and shortens some strings to fit on a single line in 80 column views
1 parent 7ac0397 commit f085457

File tree

1 file changed

+15
-17
lines changed

1 file changed

+15
-17
lines changed

src/main.rs

Lines changed: 15 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -90,10 +90,9 @@ struct Opts {
9090
#[structopt(
9191
long = "regress",
9292
default_value = "error",
93-
help = "Customize what is treated as regression.",
94-
long_help = "Customize what is treated as regression. \
95-
Values include `--regress=error`, `--regress=non-error`, \
96-
`--regress=ice`, and `--regress=success`."
93+
help = "Custom regression definition",
94+
long_help = "Custom regression definition \
95+
[error|non-error|ice|success]"
9796
)]
9897
regress: String,
9998

@@ -105,7 +104,7 @@ struct Opts {
105104
#[structopt(long = "host", help = "Host triple for the compiler", default_value = "unknown")]
106105
host: String,
107106

108-
#[structopt(long = "target", help = "Target platform to install for cross-compilation")]
107+
#[structopt(long = "target", help = "Cross-compilation target platform")]
109108
target: Option<String>,
110109

111110
#[structopt(long = "preserve", help = "Preserve the downloaded artifacts")]
@@ -115,65 +114,64 @@ struct Opts {
115114
preserve_target: bool,
116115

117116
#[structopt(
118-
long = "with-cargo", help = "Download cargo, by default the installed cargo is used"
117+
long = "with-cargo", help = "Download cargo [default: installed cargo]"
119118
)]
120119
with_cargo: bool,
121120

122121
#[structopt(
123-
long = "with-src", help = "Download rust-src, by default this is not downloaded"
122+
long = "with-src", help = "Download rust-src [default: no download]"
124123
)]
125124
with_src: bool,
126125

127126
#[structopt(
128127
long = "test-dir",
129-
help = "Directory to test; this is where you usually run `cargo build`",
128+
help = "Root directory for tests",
130129
default_value = ".",
131130
parse(from_os_str)
132131
)]
133132
test_dir: PathBuf,
134133

135134
#[structopt(
136135
long = "prompt",
137-
help = "Display a prompt in between runs to allow for manually \
138-
inspecting output and retrying."
136+
help = "Manually evaluate for regression with prompts"
139137
)]
140138
prompt: bool,
141139

142140
#[structopt(short = "v", long = "verbose", parse(from_occurrences))]
143141
verbosity: usize,
144142

145143
#[structopt(
146-
help = "Arguments to pass to cargo when running",
144+
help = "Arguments to pass to cargo during tests",
147145
raw(multiple = "true", last = "true"),
148146
parse(from_os_str)
149147
)]
150148
cargo_args: Vec<OsString>,
151149

152150
#[structopt(
153151
long = "start",
154-
help = "the left-bound for the search; this point should *not* have the regression"
152+
help = "Left bound for search (*without* regression)"
155153
)]
156154
start: Option<Bound>,
157155

158156
#[structopt(
159-
long = "end", help = "the right-bound for the search; this point should have the regression"
157+
long = "end", help = "Right bound for search (*with* regression)"
160158
)]
161159
end: Option<Bound>,
162160

163161
#[structopt(
164-
long = "by-commit", help = "without specifying bounds, bisect via commit artifacts"
162+
long = "by-commit", help = "Bisect via commit artifacts"
165163
)]
166164
by_commit: bool,
167165

168-
#[structopt(long = "install", help = "install the given artifact")]
166+
#[structopt(long = "install", help = "Install the given artifact")]
169167
install: Option<Bound>,
170168

171-
#[structopt(long = "force-install", help = "force installation over existing artifacts")]
169+
#[structopt(long = "force-install", help = "Force installation over existing artifacts")]
172170
force_install: bool,
173171

174172
#[structopt(
175173
long = "script",
176-
help = "script to run instead of cargo to test for regression",
174+
help = "Script replacement for `cargo build` command",
177175
parse(from_os_str)
178176
)]
179177
script: Option<PathBuf>,

0 commit comments

Comments
 (0)