config/doc/ignition.yaml: correction in description

Docs rephrase in luks.cex.enabled description. coreos/butane#536 (comment)
madhu-pillai · Aug 30, 2024 · 0d91393 · 0d91393
1 parent 3b3a27b
commit 0d91393
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 2 deletions.
diff --git a/config/doc/ignition.yaml b/config/doc/ignition.yaml
@@ -384,7 +384,7 @@ root:
               desc: describes the IBM Crypto Express (CEX) card configuration for the luks device.
               children:
                 - name: enabled 
-                  desc: whether or not to use a CEX secure key to encrypt the luks device.
+                  desc: whether or not to enable cex compatibility for luks. If omitted, defaults to false. 
     - name: systemd
       desc: describes the desired state of the systemd units.
       children:

diff --git a/docs/configuration-v3_5_experimental.md b/docs/configuration-v3_5_experimental.md
@@ -155,7 +155,7 @@ The Ignition configuration is a JSON document conforming to the following specif
         * **config** (string): the clevis configuration JSON.
         * **_needsNetwork_** (boolean): whether or not the device requires networking.
     * **_cex_** (object): describes the IBM Crypto Express (CEX) card configuration for the luks device.
-      * **_enabled_** (boolean): whether or not to use a CEX secure key to encrypt the luks device.
+      * **_enabled_** (boolean): whether or not to enable cex compatibility for luks. If omitted, defaults to false.
 * **_systemd_** (object): describes the desired state of the systemd units.
   * **_units_** (list of objects): the list of systemd units. Every unit must have a unique `name`.
     * **name** (string): the name of the unit. This must be suffixed with a valid unit type (e.g. "thing.service").

diff --git a/docs/release-notes.md b/docs/release-notes.md
@@ -16,6 +16,7 @@ nav_order: 9
 ### Changes
 
 - The Dracut module now installs partx
+- Sentence correction in document `luks.cex.enabled.desc` 
 
 ### Bug fixes