From ed44272a2efd8202227c1dfac3901edd98ab0b83 Mon Sep 17 00:00:00 2001
From: Takashi Kajinami <tkajinam@redhat.com>
Date: Tue, 27 Oct 2020 09:16:55 +0900
Subject: [PATCH] Fix wrong comments about the required parameters

Some parameters in the barbican::plugins::p11_crypto class and the
barbican::plugins::kmip class are always required when these classes
are loaded.
This patch update the description about these parameters so that it
clearly shows that they are always required.

Change-Id: Ie8f77821e5a09362972aa059ac44b45409eee3fd
---
 manifests/plugins/kmip.pp       | 20 ++++++++++----------
 manifests/plugins/p11_crypto.pp | 23 ++++++-----------------
 2 files changed, 16 insertions(+), 27 deletions(-)

diff --git a/manifests/plugins/kmip.pp b/manifests/plugins/kmip.pp
index 153544e2..c6a611f7 100644
--- a/manifests/plugins/kmip.pp
+++ b/manifests/plugins/kmip.pp
@@ -6,32 +6,32 @@
 #
 # [*kmip_plugin_username*]
 #   (optional) username for KMIP device
-#   Required if kmip_plugin is enabled.
 #   Defaults to undef
 #
 # [*kmip_plugin_password*]
-#   (optional) password for KMIP device
-#   Required if kmip_plugin is enabled.
+#   (optional) password for KMIP device. This parameter is required
+#   when the kmip_plugin_username parameter is set.
 #   Defaults to undef
 #
 # [*kmip_plugin_host*]
-#   (optional) username for KMIP device
-#   Defaults to undef
+#   (required) username for KMIP device
 #
 # [*kmip_plugin_port*]
-#   (optional) port for KMIP device
-#   Defaults to undef
+#   (required) port for KMIP device
 #
 # [*kmip_plugin_keyfile*]
-#   (optional) key file for KMIP device
+#   (optional) key file for KMIP device. This parameter is required when
+#   the kmip_plugin_username parameter is not set.
 #   Defaults to undef
 #
 # [*kmip_plugin_certfile*]
-#   (optional) cert file for KMIP device
+#   (optional) cert file for KMIP device. This parameter is required when
+#   the kmip_plugin_username parameter is not set.
 #   Defaults to undef
 #
 # [*kmip_plugin_ca_certs*]
-#   (optional) ca certs file for KMIP device
+#   (optional) ca certs file for KMIP device. This parameter is required when
+#   the kmip_plugin_username parameter is not set.
 #   Defaults to undef
 #
 # [*global_default*]
diff --git a/manifests/plugins/p11_crypto.pp b/manifests/plugins/p11_crypto.pp
index 052753a4..47bdd1cf 100644
--- a/manifests/plugins/p11_crypto.pp
+++ b/manifests/plugins/p11_crypto.pp
@@ -5,33 +5,22 @@
 # === Parameters
 #
 # [*p11_crypto_plugin_library_path*]
-#   (optional) Path to vendor PKCS11 library
-#   Defaults to $::os_service_default
+#   (required) Path to vendor PKCS11 library
 #
 # [*p11_crypto_plugin_login*]
-#   (optional) Password to login to PKCS11 session
-#   Required if p11_crypto_plugin is enabled.
-#   Defaults to undef
+#   (required) Password to login to PKCS11 session
 #
 # [*p11_crypto_plugin_mkek_label*]
-#   (optional) Label to identify master KEK in the HSM
-#   Required if p11_crypto_plugin is enabled.
-#   Defaults to undef
+#   (required) Label to identify master KEK in the HSM
 #
 # [*p11_crypto_plugin_mkek_length*]
-#   (optional) Length in bytes of master KEK
-#   Required if p11_crypto_plugin is enabled.
-#   Defaults to undef
+#   (required) Length in bytes of master KEK
 #
 # [*p11_crypto_plugin_hmac_label*]
-#   (optional) Label to identify master KEK in the HSM
-#   Required if p11_crypto_plugin is enabled.
-#   Defaults to undef
+#   (required) Label to identify master KEK in the HSM
 #
 # [*p11_crypto_plugin_slot_id*]
-#   (optional) HSM Slot id
-#   Required if p11_crypto_plugin is enabled.
-#   Defaults to undef
+#   (required) HSM Slot id
 #
 # [*p11_crypto_plugin_encryption_mechanism*]
 #   (optional) PKCS#11 Mechanism used for encryption