[PATCH] docs: trusted-encrypted: fix htmldocs build error

[PATCH] docs: trusted-encrypted: fix htmldocs build error

[Gopi Krishna Menon]

Running "make htmldocs" generates the following build error and
warning in trusted-encrypted.rst:

Documentation/security/keys/trusted-encrypted.rst:18: ERROR: Unexpected indentation.
Documentation/security/keys/trusted-encrypted.rst:19: WARNING: Block quote ends without a blank line; unexpected unindent.

Add a blank line before bullet list and fix the indentation of text to
fix the build error and resolve the warning.

Signed-off-by: Gopi Krishna Menon <krishnagopi487@gmail.com>
---

Tested by running "make htmldocs" before and after the change,
ensuring that output renders correctly in browsers.

 Documentation/security/keys/trusted-encrypted.rst | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/Documentation/security/keys/trusted-encrypted.rst b/Documentation/security/keys/trusted-encrypted.rst
index 2bcaaa7d119b..eae6a36b1c9a 100644
--- a/Documentation/security/keys/trusted-encrypted.rst
+++ b/Documentation/security/keys/trusted-encrypted.rst
@@ -14,10 +14,11 @@ Trusted Keys as Protected key
 =============================
 It is the secure way of keeping the keys in the kernel key-ring as Trusted-Key,
 such that:
+
 - Key-blob, an encrypted key-data, created to be stored, loaded and seen by
-            userspace.
+  userspace.
 - Key-data, the plain-key text in the system memory, to be used by
-            kernel space only.
+  kernel space only.
 
 Though key-data is not accessible to the user-space in plain-text, but it is in
 plain-text in system memory, when used in kernel space. Even though kernel-space
-- 
2.43.0

Re: [PATCH] docs: trusted-encrypted: fix htmldocs build error

[Randy Dunlap]

Adding patch signers.

Fixes: 95c46f40aac4 ("docs: trusted-encrypted: trusted-keys as protected keys")

although that might not matter if this patch is only in a -next tree.


On 10/17/25 11:11 AM, Gopi Krishna Menon wrote:
> Running "make htmldocs" generates the following build error and
> warning in trusted-encrypted.rst:
> 
> Documentation/security/keys/trusted-encrypted.rst:18: ERROR: Unexpected indentation.
> Documentation/security/keys/trusted-encrypted.rst:19: WARNING: Block quote ends without a blank line; unexpected unindent.
> 
> Add a blank line before bullet list and fix the indentation of text to
> fix the build error and resolve the warning.
> 
> Signed-off-by: Gopi Krishna Menon <krishnagopi487@gmail.com>

Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
Tested-by: Randy Dunlap <rdunlap@infradead.org>

> ---
> 
> Tested by running "make htmldocs" before and after the change,
> ensuring that output renders correctly in browsers.
> 
>  Documentation/security/keys/trusted-encrypted.rst | 5 +++--
>  1 file changed, 3 insertions(+), 2 deletions(-)
> 
> diff --git a/Documentation/security/keys/trusted-encrypted.rst b/Documentation/security/keys/trusted-encrypted.rst
> index 2bcaaa7d119b..eae6a36b1c9a 100644
> --- a/Documentation/security/keys/trusted-encrypted.rst
> +++ b/Documentation/security/keys/trusted-encrypted.rst
> @@ -14,10 +14,11 @@ Trusted Keys as Protected key
>  =============================
>  It is the secure way of keeping the keys in the kernel key-ring as Trusted-Key,
>  such that:
> +
>  - Key-blob, an encrypted key-data, created to be stored, loaded and seen by
> -            userspace.
> +  userspace.
>  - Key-data, the plain-key text in the system memory, to be used by
> -            kernel space only.
> +  kernel space only.
>  
>  Though key-data is not accessible to the user-space in plain-text, but it is in
>  plain-text in system memory, when used in kernel space. Even though kernel-space

-- 
~Randy

Re: [PATCH] docs: trusted-encrypted: fix htmldocs build error

[Jarkko Sakkinen]

On Fri, Oct 17, 2025 at 12:27:43PM -0700, Randy Dunlap wrote:
> Adding patch signers.
> 
> Fixes: 95c46f40aac4 ("docs: trusted-encrypted: trusted-keys as protected keys")
> 
> although that might not matter if this patch is only in a -next tree.
> 
> 
> On 10/17/25 11:11 AM, Gopi Krishna Menon wrote:
> > Running "make htmldocs" generates the following build error and
> > warning in trusted-encrypted.rst:
> > 
> > Documentation/security/keys/trusted-encrypted.rst:18: ERROR: Unexpected indentation.
> > Documentation/security/keys/trusted-encrypted.rst:19: WARNING: Block quote ends without a blank line; unexpected unindent.
> > 
> > Add a blank line before bullet list and fix the indentation of text to
> > fix the build error and resolve the warning.
> > 
> > Signed-off-by: Gopi Krishna Menon <krishnagopi487@gmail.com>
> 
> Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
> Tested-by: Randy Dunlap <rdunlap@infradead.org>

Reviewed-by: Jarkko Sakkinen <jarkko@kernel.org>

BR, Jarkko