tidy up help strings

Author: willcl-ark

src/rust-cli/debug.rs

@@ -8,8 +8,11 @@ use crate::rpc_call::make_rpc_call;
 
 #[derive(Subcommand, Debug)]
 pub enum DebugCommand {
-    /// Generate the docker-compose file for a given <graph_file> and return it.
-    GenerateCompose { graph_file_path: PathBuf },
+    /// Generate the docker-compose file for a given graph_file
+    GenerateCompose {
+        /// Path to graph file to generate from
+        graph_file_path: PathBuf,
+    },
 }
 
 pub async fn handle_debug_command(

src/rust-cli/graph.rs

@@ -16,18 +16,23 @@ use xmltree::{Element, EmitterConfig, XMLNode};
 
 #[derive(Subcommand, Debug)]
 pub enum GraphCommand {
-    /// Create a cycle graph with <number> nodes, and include 7 extra random outbounds per node.
-    /// Returns XML file as string with or without --outfile option
+    /// Create a cycle graph with 7 extra random outbounds per node.
     Create {
+        /// Number of nodes in the graph
         number: usize,
+        /// Write graph to a this file path
         #[arg(short, long)]
         outfile: Option<PathBuf>,
+        /// Bitcoin Core version to set on nodes
         #[arg(short, long)]
         version: Option<String>,
+        /// config values to add to bitcoin.conf
         #[arg(short, long)]
         bitcoin_conf: Option<PathBuf>,
     },
+    /// (broken) Validate a *.graphml file against the graph schema
     Validate {
+        /// Path to graph file
         graph: PathBuf,
     },
 }

src/rust-cli/image.rs

@@ -5,21 +5,28 @@ use std::process::{Command, Stdio};
 
 #[derive(Subcommand, Debug)]
 pub enum ImageCommand {
-    /// Build bitcoind and bitcoin-cli from <repo>/<branch> as <registry>:<tag>.
+    /// Build a bitcoind/bitcoin-cli docker image.
     /// Optionally deploy to remote registry using --action=push, otherwise image is loaded to local registry.
     Build {
+        /// Github repo e.g. bitcoin/bitcoin
         #[arg(long)]
         repo: String,
+        /// Branch e.g. v27.0
         #[arg(long)]
         branch: String,
+        /// docker registry e.g. user/repo
         #[arg(long)]
         registry: String,
+        /// docker image tag(s) to apply e.g. 27.0-warnet
         #[arg(long)]
         tag: String,
+        /// Custom Bitcoin Core build args to use
         #[arg(long)]
         build_args: Option<String>,
+        /// Arches to build for (multiple arches only supported with action=push)
         #[arg(long)]
         arches: Option<String>,
+        /// Load (to local) or push (to remote) registry
         #[arg(long)]
         action: Option<String>,
     },

src/rust-cli/main.rs

@@ -34,38 +34,55 @@ enum Commands {
         #[command(subcommand)]
         command: Option<DebugCommand>,
     },
-    /// Fetch the Bitcoin Core debug log from <node> in [network]
-    DebugLog { node: u64 },
+    /// Fetch the Bitcoin Core debug log from a node
+    DebugLog {
+        /// Node index (integer)
+        node: u64,
+    },
     /// Graph commands
     Graph {
         #[command(subcommand)]
         command: Option<GraphCommand>,
     },
-    /// Grep combined logs via fluentd using regex <pattern>
-    GrepLogs { pattern: String },
+    /// Grep combined logs using regex
+    GrepLogs {
+        /// Pattern to search for (as regex)
+        pattern: String,
+    },
     /// Build a warnet-ready bitcoind docker image from a github branch
     Image {
         #[command(subcommand)]
         command: Option<ImageCommand>,
     },
-    /// Call lncli <method> [params] on <node> in [network]
+    /// Call "lncli ..." on a node
     LnCli {
+        /// Node index (integer)
         node: u64,
+        /// lncli method
         method: String,
+        /// Optional arguments to method
         params: Option<Vec<String>>,
     },
-    /// Fetch messages sent between <node_a> and <node_b> in [network]
-    Messages { node_a: u64, node_b: u64 },
+    /// Fetch bitcoin P2P messages sent between two nodes
+    Messages {
+        /// First node
+        node_a: u64,
+        /// Second node
+        node_b: u64,
+    },
     /// Network commands
     Network {
         #[command(subcommand)]
         command: Option<NetworkCommand>,
     },
-    /// Call bitcoin-cli <method> [params] on <node> in [network]
+    /// Call "bitcoin-cli ..." on a node
     Rpc {
+        /// Node index (integer)
         node: u64,
+        /// bitcoin-cli method
         #[arg(allow_hyphen_values = true)]
         method: String,
+        /// Optional arguments to method
         params: Option<Vec<String>>,
     },
     /// Scenario commands

src/rust-cli/network.rs

@@ -10,9 +10,11 @@ use crate::rpc_call::make_rpc_call;
 
 #[derive(Subcommand, Debug)]
 pub enum NetworkCommand {
-    /// Start a network from a <graph_file>
+    /// Start a network from a graph_file
     Start {
+        /// Path to graph file
         graph_file: PathBuf,
+        /// Force overwite config dir if already exists
         #[arg(long, short)]
         force: bool,
     },

src/rust-cli/scenarios.rs

@@ -10,20 +10,27 @@ use std::path::PathBuf;
 pub enum ScenarioCommand {
     /// List available scenarios in the Warnet Test Framework
     Available {},
-    /// Run a scenario from remote repository with <name>
+    /// Run a scenario file from remote repository (on warnet server)
     Run {
+        /// Scenario name
         scenario: String,
+        /// Arguments to scenario
         additional_args: Vec<String>,
     },
-    /// Run a local scenario <file> by sending it to the server
+    /// Run a local scenario file by sending it to the server
     RunFile {
+        /// Path to scenario file
         scenario_path: PathBuf,
+        /// Arguments to scenario
         additional_args: Vec<String>,
     },
     /// List active scenarios
     Active {},
-    /// Stop a scenario with <PID>
-    Stop { pid: u64 },
+    /// Stop a scenario
+    Stop {
+        /// PID of scenario to stop
+        pid: u64,
+    },
 }
 async fn handle_available(params: ObjectParams) -> anyhow::Result<()> {
     let data = make_rpc_call("scenarios_available", params)