pezkuwichain/pezkuwi-subxt
1
0
Fork 0
mirror of https://github.com/pezkuwichain/pezkuwi-subxt.git synced 2026-04-27 03:27:58 +00:00
Code Issues Packages Projects Releases Wiki Activity

Minor fixes to CLI arg docs (#5339)

Browse Source 
* minor fixes to CLI arg docs

* Update client/cli/src/params/shared_params.rs

Co-authored-by: Bastian Köcher <bkchr@users.noreply.github.com>
This commit is contained in:
joe petrowski
2020-03-21 08:52:57 +01:00
committed by GitHub
parent 71aef91099
commit 40f57f8ffa
6 changed files with 25 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files
substrate/client/cli/src/commands/mod.rs
+4 -4
View File
@@ -50,7 +50,7 @@ const DEFAULT_NETWORK_CONFIG_PATH : &'static str = "network";
/// `Run` are exported as main executable parameters.
#[derive(Debug, Clone, StructOpt)]
pub enum Subcommand {
/// Build a spec.json file, outputing to stdout.
/// Build a spec.json file, outputs to stdout.
BuildSpec(build_spec_cmd::BuildSpecCmd),
/// Export blocks to a file.
@@ -70,7 +70,7 @@ pub enum Subcommand {
}
impl Subcommand {
/// Get the shared parameters of a `CoreParams` command
/// Get the shared parameters of a `CoreParams` command.
pub fn get_shared_params(&self) -> &SharedParams {
use Subcommand::*;
@@ -84,7 +84,7 @@ impl Subcommand {
}
}
/// Run any `CoreParams` command
/// Run any `CoreParams` command.
pub fn run<B, BC, BB>(
self,
config: Configuration,
@@ -107,7 +107,7 @@ impl Subcommand {
}
}
/// Update and prepare a `Configuration` with command line parameters
/// Update and prepare a `Configuration` with command line parameters.
pub fn update_config<F>(
&self,
mut config: &mut Configuration,
substrate/client/cli/src/commands/runcmd.rs
+10 -10
View File
@@ -82,7 +82,7 @@ pub struct RunCmd {
)]
pub sentry: bool,
/// Disable GRANDPA voter when running in validator mode, otherwise disables the GRANDPA observer.
/// Disable GRANDPA voter when running in validator mode, otherwise disable the GRANDPA observer.
#[structopt(long = "no-grandpa")]
pub no_grandpa: bool,
@@ -92,7 +92,7 @@ pub struct RunCmd {
/// Listen to all RPC interfaces.
///
/// Default is local. Note: not all RPC methods are safe to be exposed publicly. Use a RPC proxy
/// Default is local. Note: not all RPC methods are safe to be exposed publicly. Use an RPC proxy
/// server to filter out dangerous methods. More details: https://github.com/paritytech/substrate/wiki/Public-RPC.
/// Use `--unsafe-rpc-external` to suppress the warning if you understand the risks.
#[structopt(long = "rpc-external")]
@@ -106,7 +106,7 @@ pub struct RunCmd {
/// Listen to all Websocket interfaces.
///
/// Default is local. Note: not all RPC methods are safe to be exposed publicly. Use a RPC proxy
/// Default is local. Note: not all RPC methods are safe to be exposed publicly. Use an RPC proxy
/// server to filter out dangerous methods. More details: https://github.com/paritytech/substrate/wiki/Public-RPC.
/// Use `--unsafe-ws-external` to suppress the warning if you understand the risks.
#[structopt(long = "ws-external")]
@@ -169,7 +169,7 @@ pub struct RunCmd {
/// The URL of the telemetry server to connect to.
///
/// This flag can be passed multiple times as a mean to specify multiple
/// This flag can be passed multiple times as a means to specify multiple
/// telemetry endpoints. Verbosity levels range from 0-9, with 0 denoting
/// the least verbosity. If no verbosity level is specified the default is
/// 0.
@@ -275,7 +275,7 @@ pub struct RunCmd {
}
impl RunCmd {
/// Get the `Sr25519Keyring` matching one of the flag
/// Get the `Sr25519Keyring` matching one of the flag.
pub fn get_keyring(&self) -> Option<sp_keyring::Sr25519Keyring> {
use sp_keyring::Sr25519Keyring::*;
@@ -290,7 +290,7 @@ impl RunCmd {
else { None }
}
/// Update and prepare a `Configuration` with command line parameters of `RunCmd` and `VersionInfo`
/// Update and prepare a `Configuration` with command line parameters of `RunCmd` and `VersionInfo`.
pub fn update_config<F>(
&self,
mut config: &mut Configuration,
@@ -444,7 +444,7 @@ impl RunCmd {
Ok(())
}
/// Run the command that runs the node
/// Run the command that runs the node.
pub fn run<FNL, FNF, SL, SF>(
self,
config: Configuration,
@@ -489,7 +489,7 @@ impl RunCmd {
}
}
/// Check whether a node name is considered as valid
/// Check whether a node name is considered as valid.
pub fn is_node_name_valid(_name: &str) -> Result<(), &str> {
let name = _name.to_string();
if name.chars().count() >= NODE_NAME_MAX_LENGTH {
@@ -586,7 +586,7 @@ fn parse_telemetry_endpoints(s: &str) -> Result<(String, u8), Box<dyn std::error
/// handling of `structopt`.
#[derive(Clone, Debug)]
pub enum Cors {
/// All hosts allowed
/// All hosts allowed.
All,
/// Only hosts on the list are allowed.
List(Vec<String>),
@@ -601,7 +601,7 @@ impl From<Cors> for Option<Vec<String>> {
}
}
/// Parse cors origins
/// Parse cors origins.
fn parse_cors(s: &str) -> Result<Cors, Box<dyn std::error::Error>> {
let mut is_all = false;
let mut origins = Vec::new();