blockworks-foundation
/
solana
mirror of https://github.com/blockworks-foundation/solana.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Standardize CLI help text

This commit is contained in:
Tyera Eulberg 2018-09-14 16:32:57 -06:00 committed by Tyera Eulberg
parent 8b7edc6d64
commit 27986d7abb
8 changed files with 29 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
src/bin/bench-tps.rs
View File

@ -406,7 +406,7 @@ fn main() {
.long("network")
.value_name("HOST:PORT")
.takes_value(true)
.help("rendezvous with the network at this gossip entry point, defaults to 127.0.0.1:8001"),
.help("Rendezvous with the network at this gossip entry point; defaults to 127.0.0.1:8001"),
)
.arg(
Arg::with_name("identity")
@ -415,7 +415,7 @@ fn main() {
.value_name("PATH")
.takes_value(true)
.required(true)
.help("file containing a client identity (keypair)"),
.help("File containing a client identity (keypair)"),
)
.arg(
Arg::with_name("num-nodes")
@ -423,12 +423,12 @@ fn main() {
.long("num-nodes")
.value_name("NUM")
.takes_value(true)
.help("wait for NUM nodes to converge"),
.help("Wait for NUM nodes to converge"),
)
.arg(
Arg::with_name("reject-extra-nodes")
.long("reject-extra-nodes")
.help("require exactly num-nodes on convergence. Appropriate only for internal networks"),
.help("Require exactly `num-nodes` on convergence. Appropriate only for internal networks"),
)
.arg(
Arg::with_name("threads")
@ -436,31 +436,31 @@ fn main() {
.long("threads")
.value_name("NUM")
.takes_value(true)
.help("number of threads"),
.help("Number of threads"),
)
.arg(
Arg::with_name("duration")
.long("duration")
.value_name("SECS")
.takes_value(true)
.help("run benchmark for SECS seconds then exit, default is forever"),
.help("Seconds to run benchmark, then exit; default is forever"),
)
.arg(
Arg::with_name("converge-only")
.long("converge-only")
.help("exit immediately after converging"),
.help("Exit immediately after converging"),
)
.arg(
Arg::with_name("sustained")
.long("sustained")
.help("use sustained performance mode vs. peak mode. This overlaps the tx generation with transfers."),
.help("Use sustained performance mode vs. peak mode. This overlaps the tx generation with transfers."),
)
.arg(
Arg::with_name("tx_count")
.long("tx_count")
.value_name("NUM")
.takes_value(true)
.help("number of transactions to send per batch")
.help("Number of transactions to send per batch")
)
.get_matches();

8
src/bin/drone.rs
View File

@ -47,7 +47,7 @@ fn main() -> Result<(), Box<error::Error>> {
.value_name("HOST:PORT")
.takes_value(true)
.required(true)
.help("rendezvous with the network at this gossip entry point"),
.help("Rendezvous with the network at this gossip entry point"),
).arg(
Arg::with_name("keypair")
.short("k")
@ -55,17 +55,17 @@ fn main() -> Result<(), Box<error::Error>> {
.value_name("PATH")
.takes_value(true)
.required(true)
.help("File to read the client's keypair from"),
.help("File from which to read the mint's keypair"),
).arg(
Arg::with_name("slice")
.long("slice")
.value_name("SECONDS")
.value_name("SECS")
.takes_value(true)
.help("Time slice over which to limit requests to drone"),
).arg(
Arg::with_name("cap")
.long("cap")
.value_name("NUMBER")
.value_name("NUM")
.takes_value(true)
.help("Request limit for time slice"),
).get_matches();

6
src/bin/fullnode-config.rs
View File

@ -20,7 +20,7 @@ fn main() {
.short("l")
.long("local")
.takes_value(false)
.help("detect network address from local machine configuration"),
.help("Detect network address from local machine configuration"),
).arg(
Arg::with_name("keypair")
.short("k")
@ -33,14 +33,14 @@ fn main() {
.short("p")
.long("public")
.takes_value(false)
.help("detect public network address using public servers"),
.help("Detect public network address using public servers"),
).arg(
Arg::with_name("bind")
.short("b")
.long("bind")
.value_name("PORT")
.takes_value(true)
.help("bind to port or address"),
.help("Bind to port or address"),
).get_matches();
let bind_addr: SocketAddr = {

6
src/bin/fullnode.rs
View File

@ -33,16 +33,16 @@ fn main() -> () {
Arg::with_name("identity")
.short("i")
.long("identity")
.value_name("FILE")
.value_name("PATH")
.takes_value(true)
.help("run with the identity found in FILE"),
.help("Run with the identity found in FILE"),
).arg(
Arg::with_name("network")
.short("n")
.long("network")
.value_name("HOST:PORT")
.takes_value(true)
.help("connect/rendezvous with the network at this gossip entry point"),
.help("Rendezvous with the network at this gossip entry point"),
).arg(
Arg::with_name("ledger")
.short("l")

4
src/bin/genesis.rs
View File

@ -21,7 +21,7 @@ fn main() -> Result<(), Box<error::Error>> {
Arg::with_name("tokens")
.short("t")
.long("tokens")
.value_name("NUMBER")
.value_name("NUM")
.takes_value(true)
.required(true)
.help("Number of tokens with which to initialize mint"),
@ -32,7 +32,7 @@ fn main() -> Result<(), Box<error::Error>> {
.value_name("DIR")
.takes_value(true)
.required(true)
.help("use DIR as persistent ledger location"),
.help("Use directory as persistent ledger location"),
).get_matches();
let tokens = value_t_or_exit!(matches, "tokens", i64);

3
src/bin/keygen.rs
View File

@ -21,8 +21,7 @@ fn main() -> Result<(), Box<error::Error>> {
.long("outfile")
.value_name("PATH")
.takes_value(true)
.required(true)
.help("path to generated file"),
.help("Path to generated file"),
).get_matches();
let rnd = SystemRandom::new();

6
src/bin/ledger-tool.rs
View File

@ -21,7 +21,7 @@ fn main() {
.value_name("DIR")
.takes_value(true)
.required(true)
.help("use DIR for ledger location"),
.help("Use directory for ledger location"),
)
.arg(
Arg::with_name("head")
@ -29,13 +29,13 @@ fn main() {
.long("head")
.value_name("NUM")
.takes_value(true)
.help("at most the first NUM entries in ledger\n (only applies to verify, print, json commands)"),
.help("Limit to at most the first NUM entries in ledger\n (only applies to verify, print, json commands)"),
)
.arg(
Arg::with_name("precheck")
.short("p")
.long("precheck")
.help("use ledger_verify() to check internal ledger consistency before proceeding"),
.help("Use ledger_verify() to check internal ledger consistency before proceeding"),
)
.subcommand(SubCommand::with_name("print").about("Print the ledger"))
.subcommand(SubCommand::with_name("json").about("Print the ledger in JSON format"))

8
src/bin/wallet.rs
View File

@ -79,16 +79,16 @@ fn main() -> Result<(), Box<error::Error>> {
).arg(
Arg::with_name("timeout")
.long("timeout")
.value_name("SECONDS")
.value_name("SECS")
.takes_value(true)
.help("Max SECONDS to wait to get necessary gossip from the network"),
.help("Max seconds to wait to get necessary gossip from the network"),
).subcommand(
SubCommand::with_name("airdrop")
.about("Request a batch of tokens")
.arg(
Arg::with_name("tokens")
.long("tokens")
.value_name("NUMBER")
.value_name("NUM")
.takes_value(true)
.required(true)
.help("The number of tokens to request"),
@ -99,7 +99,7 @@ fn main() -> Result<(), Box<error::Error>> {
.arg(
Arg::with_name("tokens")
.long("tokens")
.value_name("NUMBER")
.value_name("NUM")
.takes_value(true)
.required(true)
.help("The number of tokens to send"),