From 3d2ba5aaed0c64839e0db4a4dbcf9fe49f7b2738 Mon Sep 17 00:00:00 2001
From: Steffen Eiden <seiden@linux.ibm.com>
Date: Tue, 30 Jan 2024 12:56:08 +0100
Subject: [PATCH] rust/pvsecret: Sync man and help
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

The output of --help and man pages got out of sync.
Apply changes to the help output to fix this.

Acked-by: Marc Hartmayer <mhartmay@linux.ibm.com>
Signed-off-by: Steffen Eiden <seiden@linux.ibm.com>
Signed-off-by: Jan Höppner <hoeppner@linux.ibm.com>
---
 rust/pv/src/cli.rs       | 10 +++++-----
 rust/pvsecret/src/cli.rs |  8 ++++++--
 2 files changed, 11 insertions(+), 7 deletions(-)

diff --git a/rust/pv/src/cli.rs b/rust/pv/src/cli.rs
index daed1c11..3c9a0883 100644
--- a/rust/pv/src/cli.rs
+++ b/rust/pv/src/cli.rs
@@ -30,15 +30,15 @@ pub struct CertificateOptions {
     /// Disable the host-key document verification.
     ///
     /// Does not require the host-key documents to be valid.
-    /// Do not use for a production request unless you verified the host-key document before.
+    /// Do not use for a production request unless you verified the host-key document beforehand.
     #[arg(long)]
     pub no_verify: bool,
 
-    /// Use FILE as a certificate to verify the host-key(s).
+    /// Use FILE as a certificate to verify the host key or keys.
     ///
     /// The certificates are used to establish a chain of trust for the verification
     /// of the host-key documents. Specify this option twice to specify the IBM Z signing key and
-    /// the intermediate CA certificate (signed by the rootCA).
+    /// the intermediate CA certificate (signed by the root CA).
     #[arg(
         short= 'C',
         long = "cert",
@@ -52,7 +52,7 @@ pub struct CertificateOptions {
 
     /// Use FILE as a certificate revocation list.
     ///
-    /// That list is used to check whether a certificate of the chain of
+    /// The list is used to check whether a certificate of the chain of
     /// trust is revoked. Specify this option multiple times to use multiple CRLs.
     #[arg(
         long = "crl",
@@ -70,7 +70,7 @@ pub struct CertificateOptions {
 
     /// Use FILE as the root-CA certificate for the verification.
     ///
-    /// If omitted, the system wide root CAs installed on the system are used.
+    /// If omitted, the system wide-root CAs installed on the system are used.
     /// Use this only if you trust the specified certificate.
     #[arg(long, requires("certs"))]
     pub root_ca: Option<String>,
diff --git a/rust/pvsecret/src/cli.rs b/rust/pvsecret/src/cli.rs
index 5b3e2354..d4d0ecdd 100644
--- a/rust/pvsecret/src/cli.rs
+++ b/rust/pvsecret/src/cli.rs
@@ -117,10 +117,14 @@ pub struct CreateSecretOpt {
 
 #[derive(Subcommand, Debug)]
 pub enum AddSecretType {
+    /// Create a meta secret.
+    ///
     /// Use a meta secret to carry flags to the ultravisor without having to provide an actual
     /// secret value. Meta secrets do not appear in the list of secrets.
     Meta,
 
+    /// Create an association secret.
+    ///
     /// Use an association secret to connect a trusted I/O device to a guest. The `pvapconfig` tool
     /// provides more information about association secrets.
     Association {
@@ -132,7 +136,7 @@ pub enum AddSecretType {
 
         ///Print the hashed name to stdout.
         ///
-        ///The hashed name will not be written to `NAME.yaml`
+        ///The hashed name is not written to `NAME.yaml`
         #[arg(long)]
         stdout: bool,
 
@@ -196,7 +200,7 @@ pub enum Command {
     /// the use case depending on the secret type.
     Create(Box<CreateSecretOpt>),
 
-    /// Repeat an add-secret request (s390x only).
+    /// Perform an add-secret request (s390x only).
     ///
     /// Perform an add-secret request using a previously generated add-secret request. Only
     /// available on s390x.