From 449c1762ebe562d901c23089f91db3b898c751de Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Pascal=20Eng=C3=A9libert?= <tuxmain@zettascript.org>
Date: Wed, 13 Nov 2024 13:45:44 +0100
Subject: [PATCH] distance-oracle: fix docs and cli help
---
distance-oracle/src/main.rs | 2 ++
docs/user/distance.md | 2 +-
node/src/cli.rs | 2 +-
3 files changed, 4 insertions(+), 2 deletions(-)
diff --git a/distance-oracle/src/main.rs b/distance-oracle/src/main.rs
index 5da3aea14..405abda20 100644
--- a/distance-oracle/src/main.rs
+++ b/distance-oracle/src/main.rs
@@ -20,8 +20,10 @@ use clap::Parser;
struct Cli {
#[clap(short = 'd', long, default_value = "/tmp/duniter/chains/gdev/distance")]
evaluation_result_dir: String,
+ /// Number of seconds between two evaluations (oneshot if absent)
#[clap(short = 'i', long, default_value = "None")]
interval: Option<u64>,
+ /// Node used for fetching state
#[clap(short = 'u', long, default_value = "ws://127.0.0.1:9944")]
rpc_url: String,
/// Log level (off, error, warn, info, debug, trace)
diff --git a/docs/user/distance.md b/docs/user/distance.md
index 2df0d6feb..015ab0824 100644
--- a/docs/user/distance.md
+++ b/docs/user/distance.md
@@ -8,7 +8,7 @@ Distance evaluation is operated on a voluntary basis by individual smiths. Since
Any smith member authoring blocks can run a distance evaluation oracle. It is better to have a machine more powerful than the reference machine.
-Create a service from this commandline, run by the same user as Duniter, on the same system:
+Create a service from this command line, run by the same user as Duniter, on the same system:
/absolute/path/to/duniter distance-oracle --interval <duration>
diff --git a/node/src/cli.rs b/node/src/cli.rs
index 12580c991..196e29d0f 100644
--- a/node/src/cli.rs
+++ b/node/src/cli.rs
@@ -137,7 +137,7 @@ pub struct DistanceOracle {
/// Number of seconds between two evaluations (oneshot if absent)
#[clap(short = 'i', long)]
pub interval: Option<u64>,
- /// Local forging node
+ /// Node used for fetching state
#[clap(short = 'u', long, default_value = "ws://127.0.0.1:9944")]
pub rpc_url: String,
}
--
GitLab