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

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <7928c851-649d-47f4-a747-3314c0d45706@infradead.org>
Date: Fri, 17 Oct 2025 12:27:43 -0700
From: Randy Dunlap <rdunlap@...radead.org>
To: Gopi Krishna Menon <krishnagopi487@...il.com>, zohar@...ux.ibm.com,
 James.Bottomley@...senPartnership.com, jarkko@...nel.org, corbet@....net,
 Meenakshi Aggarwal <meenakshi.aggarwal@....com>,
 Pankaj Gupta <pankaj.gupta@....com>, Herbert Xu <herbert@...dor.apana.org.au>
Cc: linux-integrity@...r.kernel.org, keyrings@...r.kernel.org,
 linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org,
 skhan@...uxfoundation.org, david.hunter.linux@...il.com,
 linux-kernel-mentees@...ts.linux.dev, khalid@...nel.org
Subject: Re: [PATCH] docs: trusted-encrypted: fix htmldocs build error

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@...il.com>

Reviewed-by: Randy Dunlap <rdunlap@...radead.org>
Tested-by: Randy Dunlap <rdunlap@...radead.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