From cd58b5ff1fbf6a693e9dafa4ecbbc89a5bb95f67 Mon Sep 17 00:00:00 2001 From: Thibaut S <33178835+Tbaut@users.noreply.github.com> Date: Tue, 10 Jul 2018 12:17:11 +0200 Subject: [PATCH] Phrasing, precisions and typos in CLI help (#9060) * Update mod.rs * Update mod.rs Rephrase cli subcommand descriptions. * fix comments --- parity/cli/mod.rs | 40 ++++++++++++++++++++-------------------- 1 file changed, 20 insertions(+), 20 deletions(-) diff --git a/parity/cli/mod.rs b/parity/cli/mod.rs index b67c728e5..91e8b3a6b 100644 --- a/parity/cli/mod.rs +++ b/parity/cli/mod.rs @@ -49,16 +49,16 @@ usage! { "Manage accounts", CMD cmd_account_new { - "Create a new acount", + "Create a new account (and its associated key) for the given --chain (default: mainnet)", } CMD cmd_account_list { - "List existing accounts", + "List existing accounts of the given --chain (default: mainnet)", } CMD cmd_account_import { - "Import account", + "Import accounts from JSON UTC keystore files to the specified --chain (default mainnet)", ARG arg_account_import_path : (Option>) = None, "...", @@ -72,7 +72,7 @@ usage! { CMD cmd_wallet_import { - "Import wallet", + "Import wallet into the given --chain (default: mainnet)", ARG arg_wallet_import_path: (Option) = None, "", @@ -82,7 +82,7 @@ usage! { CMD cmd_import { - "Import blockchain", + "Import blockchain data from a file to the given --chain database (default: mainnet)", ARG arg_import_format: (Option) = None, "--format=[FORMAT]", @@ -99,7 +99,7 @@ usage! { CMD cmd_export_blocks { - "Export blocks", + "Export the blockchain blocks from the given --chain database (default: mainnet) into a file. This command requires the chain to be synced with --fat-db on.", ARG arg_export_blocks_format: (Option) = None, "--format=[FORMAT]", @@ -120,7 +120,7 @@ usage! { CMD cmd_export_state { - "Export state", + "Export the blockchain state from the given --chain (default: mainnet) into a file. This command requires the chain to be synced with --fat-db on.", FLAG flag_export_state_no_storage: (bool) = false, "--no-storage", @@ -157,11 +157,11 @@ usage! { "Manage signer", CMD cmd_signer_new_token { - "Generate new token", + "Generate a new signer-authentication token for the given --chain (default: mainnet)", } CMD cmd_signer_list { - "List", + "List the signer-authentication tokens from given --chain (default: mainnet)", } CMD cmd_signer_sign @@ -185,7 +185,7 @@ usage! { CMD cmd_snapshot { - "Make a snapshot of the database", + "Make a snapshot of the database of the given --chain (default: mainnet)", ARG arg_snapshot_at: (String) = "latest", "--at=[BLOCK]", @@ -198,7 +198,7 @@ usage! { CMD cmd_restore { - "Restore database from snapshot", + "Restore the database of the given --chain (default: mainnet) from a snapshot file", ARG arg_restore_file: (Option) = None, "[FILE]", @@ -211,7 +211,7 @@ usage! { CMD cmd_tools_hash { - "Hash a file", + "Hash a file using the Keccak-256 algorithm", ARG arg_tools_hash_file: (Option) = None, "", @@ -224,13 +224,13 @@ usage! { "Manage the database representing the state of the blockchain on this system", CMD cmd_db_kill { - "Clean the database", + "Clean the database of the given --chain (default: mainnet)", } } CMD cmd_export_hardcoded_sync { - "Export the hardcoded sync JSON file from the existing light client database", + "Print the hashed light clients headers of the given --chain (default: mainnet) in a JSON format. To be used as hardcoded headers in a genesis file.", } } { @@ -475,7 +475,7 @@ usage! { ARG arg_jsonrpc_apis: (String) = "web3,eth,pubsub,net,parity,private,parity_pubsub,traces,rpc,shh,shh_pubsub", or |c: &Config| c.rpc.as_ref()?.apis.as_ref().map(|vec| vec.join(",")), "--jsonrpc-apis=[APIS]", - "Specify the APIs available through the HTTP JSON-RPC interface using a comma-delimited list of API names. Possible names are: all, safe, web3, net, eth, pubsub, personal, signer, parity, parity_pubsub, parity_accounts, parity_set, traces, rpc, secretstore, shh, shh_pubsub. You can also disable a specific API by putting '-' in the front, example: all,-personal. safe contains following apis: web3, net, eth, pubsub, parity, parity_pubsub, traces, rpc, shh, shh_pubsub", + "Specify the APIs available through the HTTP JSON-RPC interface using a comma-delimited list of API names. Possible names are: all, safe, web3, net, eth, pubsub, personal, signer, parity, parity_pubsub, parity_accounts, parity_set, traces, rpc, secretstore, shh, shh_pubsub. You can also disable a specific API by putting '-' in the front, example: all,-personal. 'safe' enables the following APIs: web3, net, eth, pubsub, parity, parity_pubsub, traces, rpc, shh, shh_pubsub", ARG arg_jsonrpc_hosts: (String) = "none", or |c: &Config| c.rpc.as_ref()?.hosts.as_ref().map(|vec| vec.join(",")), "--jsonrpc-hosts=[HOSTS]", @@ -483,7 +483,7 @@ usage! { ARG arg_jsonrpc_threads: (usize) = 4usize, or |c: &Config| c.rpc.as_ref()?.processing_threads, "--jsonrpc-threads=[THREADS]", - "Turn on additional processing threads in all HTTP JSON-RPC servers. Setting this to non-zero value allows parallel cpu-heavy queries execution.", + "Turn on additional processing threads in all HTTP JSON-RPC servers. Setting this to non-zero value allows parallel execution of cpu-heavy queries.", ARG arg_jsonrpc_cors: (String) = "none", or |c: &Config| c.rpc.as_ref()?.cors.as_ref().map(|vec| vec.join(",")), "--jsonrpc-cors=[URL]", @@ -512,7 +512,7 @@ usage! { ARG arg_ws_apis: (String) = "web3,eth,pubsub,net,parity,parity_pubsub,private,traces,rpc,shh,shh_pubsub", or |c: &Config| c.websockets.as_ref()?.apis.as_ref().map(|vec| vec.join(",")), "--ws-apis=[APIS]", - "Specify the JSON-RPC APIs available through the WebSockets interface using a comma-delimited list of API names. Possible names are: all, safe, web3, net, eth, pubsub, personal, signer, parity, parity_pubsub, parity_accounts, parity_set, traces, rpc, secretstore, shh, shh_pubsub. You can also disable a specific API by putting '-' in the front, example: all,-personal. safe contains following apis: web3, net, eth, pubsub, parity, parity_pubsub, traces, rpc, shh, shh_pubsub", + "Specify the JSON-RPC APIs available through the WebSockets interface using a comma-delimited list of API names. Possible names are: all, safe, web3, net, eth, pubsub, personal, signer, parity, parity_pubsub, parity_accounts, parity_set, traces, rpc, secretstore, shh, shh_pubsub. You can also disable a specific API by putting '-' in the front, example: all,-personal. 'safe' enables the following APIs: web3, net, eth, pubsub, parity, parity_pubsub, traces, rpc, shh, shh_pubsub", ARG arg_ws_origins: (String) = "parity://*,chrome-extension://*,moz-extension://*", or |c: &Config| c.websockets.as_ref()?.origins.as_ref().map(|vec| vec.join(",")), "--ws-origins=[URL]", @@ -524,7 +524,7 @@ usage! { ARG arg_ws_max_connections: (usize) = 100usize, or |c: &Config| c.websockets.as_ref()?.max_connections, "--ws-max-connections=[CONN]", - "Maximal number of allowed concurrent WebSockets JSON-RPC connections.", + "Maximum number of allowed concurrent WebSockets JSON-RPC connections.", ["API and Console Options – IPC"] FLAG flag_no_ipc: (bool) = false, or |c: &Config| c.ipc.as_ref()?.disable.clone(), @@ -537,7 +537,7 @@ usage! { ARG arg_ipc_apis: (String) = "web3,eth,pubsub,net,parity,parity_pubsub,parity_accounts,private,traces,rpc,shh,shh_pubsub", or |c: &Config| c.ipc.as_ref()?.apis.as_ref().map(|vec| vec.join(",")), "--ipc-apis=[APIS]", - "Specify custom API set available via JSON-RPC over IPC using a comma-delimited list of API names. Possible names are: all, safe, web3, net, eth, pubsub, personal, signer, parity, parity_pubsub, parity_accounts, parity_set, traces, rpc, secretstore, shh, shh_pubsub. You can also disable a specific API by putting '-' in the front, example: all,-personal. safe contains: web3, net, eth, pubsub, parity, parity_pubsub, traces, rpc, shh, shh_pubsub", + "Specify custom API set available via JSON-RPC over IPC using a comma-delimited list of API names. Possible names are: all, safe, web3, net, eth, pubsub, personal, signer, parity, parity_pubsub, parity_accounts, parity_set, traces, rpc, secretstore, shh, shh_pubsub. You can also disable a specific API by putting '-' in the front, example: all,-personal. 'safe' enables the following APIs: web3, net, eth, pubsub, parity, parity_pubsub, traces, rpc, shh, shh_pubsub", ["API and Console Options – Dapps"] FLAG flag_no_dapps: (bool) = false, or |c: &Config| c.dapps.as_ref()?.disable.clone(), @@ -657,7 +657,7 @@ usage! { FLAG flag_tx_queue_no_unfamiliar_locals: (bool) = false, or |c: &Config| c.mining.as_ref()?.tx_queue_no_unfamiliar_locals.clone(), "--tx-queue-no-unfamiliar-locals", - "Transactions received via local means (HTTP JSON-RPC, WebSockets JSON-RPC, etc) will be treated as external if the sending account is unknown.", + "Local transactions sent through JSON-RPC (HTTP, WebSockets, etc) will be treated as 'external' if the sending account is unknown.", FLAG flag_refuse_service_transactions: (bool) = false, or |c: &Config| c.mining.as_ref()?.refuse_service_transactions.clone(), "--refuse-service-transactions",