From: Kai Huang <kai.huang@intel.com>
To: Bagas Sanjaya <bagasdotme@gmail.com>, linux-doc@vger.kernel.org
Cc: Paolo Bonzini <pbonzini@redhat.com>,
Jonathan Corbet <corbet@lwn.net>,
Thomas Gleixner <tglx@linutronix.de>,
Ingo Molnar <mingo@redhat.com>, Borislav Petkov <bp@alien8.de>,
Dave Hansen <dave.hansen@linux.intel.com>,
"H. Peter Anvin" <hpa@zytor.com>,
Isaku Yamahata <isaku.yamahata@intel.com>,
x86@kernel.org, kvm@vger.kernel.org,
linux-kernel@vger.kernel.org
Subject: Re: [PATCH 11/12] Documentation: x86: Use literal code block for TDX dmesg output
Date: Tue, 12 Jul 2022 16:11:34 +1200 [thread overview]
Message-ID: <b2ac926a9175306b4ae04f73a23c100645d642b6.camel@intel.com> (raw)
In-Reply-To: <20220709042037.21903-12-bagasdotme@gmail.com>
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@gmail.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,
next prev parent reply other threads:[~2022-07-12 4:11 UTC|newest]
Thread overview: 18+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-07-09 4:20 [PATCH 00/12] Documentation: tdx: documentation fixes Bagas Sanjaya
2022-07-09 4:20 ` [PATCH 01/12] Documentation: kvm: Pad bullet lists with blank line Bagas Sanjaya
2022-07-09 4:20 ` [PATCH 02/12] Documentation: kvm: tdx: Use appropriate subbullet marker Bagas Sanjaya
2022-07-09 4:20 ` [PATCH 03/12] Documentation: kvm: tdx: Add footnote markers Bagas Sanjaya
2022-07-09 4:20 ` [PATCH 04/12] Documentation: kvm: tdx: Use bullet list for public kvm trees Bagas Sanjaya
2022-07-09 4:20 ` [PATCH 05/12] Documentation: kvm: tdx: title typofix Bagas Sanjaya
2022-07-09 4:20 ` [PATCH 06/12] Documentation: kvm: tdx-tdp-mmu: Add blank line padding for lists Bagas Sanjaya
2022-07-09 4:20 ` [PATCH 07/12] Documentation: kvm: tdx-tdp-mmu: Use literal code block for EPT violation diagrams Bagas Sanjaya
2022-07-09 4:20 ` [PATCH 08/12] Documentation: kvm: tdx-tdp-mmu: Properly format nested list for EPT state machine Bagas Sanjaya
2022-07-09 4:26 ` Bagas Sanjaya
2022-07-12 19:34 ` Isaku Yamahata
2022-07-09 4:20 ` [PATCH 09/12] Documentation: kvm: tdx-tdp-mmu: Add blank line padding to lists in concurrent sections Bagas Sanjaya
2022-07-09 4:20 ` [PATCH 10/12] Documentation: x86: Enclose TDX initialization code inside code block Bagas Sanjaya
2022-07-12 4:12 ` Kai Huang
2022-07-09 4:20 ` [PATCH 11/12] Documentation: x86: Use literal code block for TDX dmesg output Bagas Sanjaya
2022-07-12 4:11 ` Kai Huang [this message]
2022-07-09 4:20 ` [PATCH 12/12] Documentation: kvm: Add TDX documentation to KVM table of contents Bagas Sanjaya
2022-07-12 19:35 ` [PATCH 00/12] Documentation: tdx: documentation fixes Isaku Yamahata
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=b2ac926a9175306b4ae04f73a23c100645d642b6.camel@intel.com \
--to=kai.huang@intel.com \
--cc=bagasdotme@gmail.com \
--cc=bp@alien8.de \
--cc=corbet@lwn.net \
--cc=dave.hansen@linux.intel.com \
--cc=hpa@zytor.com \
--cc=isaku.yamahata@intel.com \
--cc=kvm@vger.kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mingo@redhat.com \
--cc=pbonzini@redhat.com \
--cc=tglx@linutronix.de \
--cc=x86@kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
all inboxes | Powered by JetHome®