docs: improve comments in SBD examples

linux-system-roles · Sep 26, 2024 · 3ba798e · 3ba798e
1 parent 0f68410
commit 3ba798e
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -1651,9 +1651,10 @@ in /var/lib/pcsd with the file name FILENAME.crt and FILENAME.key, respectively.
 - hosts: node1 node2
   vars:
     my_sbd_devices:
-      # This variable is not used by the role.
-      # It's purpose is to define SBD devices once so they don't need
+      # This variable is not used by the role directly.
+      # Its purpose is to define SBD devices once so they don't need
       # to be repeated several times in the role variables.
+      # Instead, variables directly used by the role refer to this variable.
       - /dev/disk/by-id/000001
       - /dev/disk/by-id/000002
       - /dev/disk/by-id/000003

diff --git a/examples/sbd.yml b/examples/sbd.yml
@@ -4,9 +4,10 @@
   hosts: node1 node2
   vars:
     my_sbd_devices:
-      # This variable is not used by the role.
-      # It's purpose is to define SBD devices once so they don't need
+      # This variable is not used by the role directly.
+      # Its purpose is to define SBD devices once so they don't need
       # to be repeated several times in the role variables.
+      # Instead, variables directly used by the role refer to this variable.
       - /dev/disk/by-id/000001
       - /dev/disk/by-id/000002
       - /dev/disk/by-id/000003