linux-kernel - Re: [PATCH 11/12] Documentation: x86: Use literal code block for TDX dmesg output

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: <b2ac926a9175306b4ae04f73a23c100645d642b6.camel@intel.com>
Date:   Tue, 12 Jul 2022 16:11:34 +1200
From:   Kai Huang <kai.huang@...el.com>
To:     Bagas Sanjaya <bagasdotme@...il.com>, linux-doc@...r.kernel.org
Cc:     Paolo Bonzini <pbonzini@...hat.com>,
        Jonathan Corbet <corbet@....net>,
        Thomas Gleixner <tglx@...utronix.de>,
        Ingo Molnar <mingo@...hat.com>, Borislav Petkov <bp@...en8.de>,
        Dave Hansen <dave.hansen@...ux.intel.com>,
        "H. Peter Anvin" <hpa@...or.com>,
        Isaku Yamahata <isaku.yamahata@...el.com>, x86@...nel.org,
        kvm@...r.kernel.org, linux-kernel@...r.kernel.org
Subject: Re: [PATCH 11/12] Documentation: x86: Use literal code block for
 TDX dmesg output

On Sat, 2022-07-09 at 11:20 +0700, Bagas Sanjaya wrote:
> The dmesg output blocks are using line blocks, which is incorrect, since
> this will render the blocks as normal paragraph with preserved line
> breaks instead of code blocks.
> 
> Use literal code blocks instead for the output.

Thank you very much!

Obviously I am not familiar with .rst.   I'll fix.

> 
> Fixes: f05f595045dfc7 ("Documentation/x86: Add documentation for TDX host support")
> Signed-off-by: Bagas Sanjaya <bagasdotme@...il.com>
> ---
>  Documentation/x86/tdx.rst | 30 +++++++++++++++---------------
>  1 file changed, 15 insertions(+), 15 deletions(-)
> 
> diff --git a/Documentation/x86/tdx.rst b/Documentation/x86/tdx.rst
> index 4430912a2e4f05..f5bd22b89159ec 100644
> --- a/Documentation/x86/tdx.rst
> +++ b/Documentation/x86/tdx.rst
> @@ -41,11 +41,11 @@ TDX boot-time detection
>  -----------------------
>  
>  Kernel detects TDX and the TDX private KeyIDs during kernel boot.  User
> -can see below dmesg if TDX is enabled by BIOS:
> +can see below dmesg if TDX is enabled by BIOS::
>  
> -|  [..] tdx: SEAMRR enabled.
> -|  [..] tdx: TDX private KeyID range: [16, 64).
> -|  [..] tdx: TDX enabled by BIOS.
> +   [..] tdx: SEAMRR enabled.
> +   [..] tdx: TDX private KeyID range: [16, 64).
> +   [..] tdx: TDX enabled by BIOS.
>  
>  TDX module detection and initialization
>  ---------------------------------------
> @@ -79,20 +79,20 @@ caller.
>  User can consult dmesg to see the presence of the TDX module, and whether
>  it has been initialized.
>  
> -If the TDX module is not loaded, dmesg shows below:
> +If the TDX module is not loaded, dmesg shows below::
>  
> -|  [..] tdx: TDX module is not loaded.
> +   [..] tdx: TDX module is not loaded.
>  
>  If the TDX module is initialized successfully, dmesg shows something
> -like below:
> +like below::
>  
> -|  [..] tdx: TDX module: vendor_id 0x8086, major_version 1, minor_version 0, build_date 20211209, build_num 160
> -|  [..] tdx: 65667 pages allocated for PAMT.
> -|  [..] tdx: TDX module initialized.
> +   [..] tdx: TDX module: vendor_id 0x8086, major_version 1, minor_version 0, build_date 20211209, build_num 160
> +   [..] tdx: 65667 pages allocated for PAMT.
> +   [..] tdx: TDX module initialized.
>  
> -If the TDX module failed to initialize, dmesg shows below:
> +If the TDX module failed to initialize, dmesg shows below::
>  
> -|  [..] tdx: Failed to initialize TDX module.  Shut it down.
> +   [..] tdx: Failed to initialize TDX module.  Shut it down.
>  
>  TDX Interaction to Other Kernel Components
>  ------------------------------------------
> @@ -143,10 +143,10 @@ There are basically two memory hot-add cases that need to be prevented:
>  ACPI memory hot-add and driver managed memory hot-add.  The kernel
>  rejectes the driver managed memory hot-add too when TDX is enabled by
>  BIOS.  For instance, dmesg shows below error when using kmem driver to
> -add a legacy PMEM as system RAM:
> +add a legacy PMEM as system RAM::
>  
> -|  [..] tdx: Unable to add memory [0x580000000, 0x600000000) on TDX enabled platform.
> -|  [..] kmem dax0.0: mapping0: 0x580000000-0x5ffffffff memory add failed
> +   [..] tdx: Unable to add memory [0x580000000, 0x600000000) on TDX enabled platform.
> +   [..] kmem dax0.0: mapping0: 0x580000000-0x5ffffffff memory add failed
>  
>  However, adding new memory to ZONE_DEVICE should not be prevented as
>  those pages are not managed by the page allocator.  Therefore,