From: Ian Jackson <ijackson@chiark.greenend.org.uk>
Date: Tue, 10 Jan 2023 01:50:27 +0000 (+0000)
Subject: Config inspection: docs (wip)
X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ian/git?a=commitdiff_plain;h=f8a76d54eabf0a980db7bf27f58a7ed45a9d3587;p=hippotat.git

Config inspection: docs (wip)

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>
---

diff --git a/client/client.rs b/client/client.rs
index 52b7ec3..627a799 100644
--- a/client/client.rs
+++ b/client/client.rs
@@ -19,7 +19,11 @@ pub struct Opts {
   #[clap(flatten)]
   config: config::Opts,
 
-  /// Print a config item, do not actually run
+  /// Print config item(s), do not actually run
+  ///
+  /// Argument is (comma-separated) list of config keys;
+  /// values will be printed space-separated.
+  /// The key `pretty` dumps the whole config in a pretty debug format.
   ///
   /// One line is output for each association.
   /// Additional pseudo-config-keys are recognised:
diff --git a/server/server.rs b/server/server.rs
index 0f240fb..97aa326 100644
--- a/server/server.rs
+++ b/server/server.rs
@@ -35,7 +35,11 @@ pub struct Opts {
   #[clap(long)]
   pidfile: Option<String>,
 
-  /// Print a config item, do not actually run
+  /// Print config item(s), do not actually run
+  ///
+  /// Argument is (comma-separated) list of config keys;
+  /// values will be printed space-separated.
+  /// The key `pretty` dumps the whole config in a pretty debug format.
   #[clap(long)]
   print_config: Option<String>,
 }