automated: linux: update docs for pkcs11 test

This patch changes formatting for test description to markdown. This allows it to be rendered in the readthedocs.org properly. Signed-off-by: Milosz Wasilewski <[email protected]>
Linaro · Feb 6, 2024 · 0a0c385 · 0a0c385
1 parent 22f8af6
commit 0a0c385
Showing 1 changed file with 15 additions and 12 deletions.
diff --git a/automated/linux/pkcs11/pkcs11.yaml b/automated/linux/pkcs11/pkcs11.yaml
@@ -1,21 +1,24 @@
 metadata:
     format: Lava-Test Test Definition 1.0
     name: pkcs11-tests
-    description: "Basic test suite for pkcs11 operations.
-    The main motivation behind the tests is checking the interaction
-    with SE05x TPM devices. Tests can also be used with softhsm if
-    TPM is not available
+    description: |
+        Basic test suite for pkcs11 operations.
+        The main motivation behind the tests is checking the interaction
+        with SE05x TPM devices. Tests can also be used with softhsm if
+        TPM is not available
 
-    Example use with TPM:
-        ./pkcs11.sh -p 'pkcs11-tool --module /usr/lib/libckteec.so.0.1'
+        Example use with TPM:
 
-    Example use with softhsm:
-        ./pkcs11.sh -p 'pkcs11-tool --module /usr/lib/softhsm/libsofthsm2.so' -t false
+            ./pkcs11.sh -p 'pkcs11-tool --module /usr/lib/libckteec.so.0.1'
+
+        Example use with softhsm:
+
+            ./pkcs11.sh -p 'pkcs11-tool --module /usr/lib/softhsm/libsofthsm2.so' -t false
+
+        ssscli tool comes from NXP and is not packaged for any distribution
+        at the moment. It needs to be preinstalled in the OS in order to use
+        SE05x TPM for this test.
 
-    ssscli tool comes from NXP and is not packaged for any distribution
-    at the moment. It needs to be preinstalled in the OS in order to use
-    SE05x TPM for this test.
-    "
     maintainer:
         - [email protected]
     os: