rust/pv: Fix some comments

The library is used by multiple PV related tools, not only for managing
the guest secret store.
Reviewed-by: Steffen Eiden <seiden@linux.ibm.com>
Signed-off-by: Marc Hartmayer <mhartmay@linux.ibm.com>
Signed-off-by: Steffen Eiden <seiden@linux.ibm.com>

rust/pv/src/lib.rs

@@ -11,7 +11,7 @@
     unused_qualifications
 )]
 #![doc = include_str!("../README.md")]
-//! # Manage guest secret store
+//! # Library for Protected Virtualization (PV) related tools
 //!
 //! This crate provides functionalities for creating add-secret requests. Also provides support for
 //! sending those requests, list all stored secrets, and lock the secret store.

rust/pv/src/uvsecret/user_data.rs

@@ -141,7 +141,7 @@ impl UserData {
         Ok(Self::Signed(SignedUserData { sign_key, data }))
     }
 
-    /// Signs data in buf, writes signature to buf+user_data_offset+sign_offset if applicable.
+    /// Signs data in buf, writes signature to `buf+user_data_offset+sign_offset` if applicable.
     ///
     /// Uses [`MessageDigest::sha512`] as digest. Does not modify the abritary user data buffer.
     ///

rust/pv/src/verify.rs

@@ -23,7 +23,7 @@ use crate::Result;
 mod helper;
 mod test;
 
-/// A HkdVerifier verifies that a host-key document(HKD) can be trusted.
+/// A `HkdVerifier` verifies that a host-key document(HKD) can be trusted.
 ///
 /// If the verification fails the HKD should not be used to create requests.
 pub trait HkdVerifier {
@@ -62,7 +62,7 @@ impl HkdVerifier for CertVerifier {
     /// This function verifies a host-key
     /// document. To do so multiple steps are required:
     ///
-    /// 1. issuer(host_key) == subject(ibm_z_sign_key)
+    /// 1. `issuer(host_key`) == `subject(ibm_z_sign_key`)
     /// 2. Signature verification
     /// 3. @hkd must not be expired
     /// 4. @hkd must not be revoked

rust/pv/src/verify/helper.rs

@@ -119,7 +119,7 @@ pub fn store_setup<P: AsRef<Path>, Q: AsRef<Path>, R: AsRef<Path>>(
 }
 
 /// Verify that the given IBM signing keys can be trusted
-/// -> check the chain: IBMsignKey<-InterCA(s)<-RootCA
+/// -> check the chain: `IBMsignKey`<-InterCA(s)<-`RootCA`
 pub fn verify_chain(
     store: &X509StoreRef,
     untrusted_certs: &Stack<X509>,