[tip: x86/urgent] x86/Documentation: Indent 'note::' directive for protocol version number note

From: tip-bot2 for Bagas Sanjaya
Date: Mon Nov 06 2023 - 06:58:25 EST


The following commit has been merged into the x86/urgent branch of tip:

Commit-ID: 18216762bcf618c52b85719d3563243f80e4a2d4
Gitweb: https://git.kernel.org/tip/18216762bcf618c52b85719d3563243f80e4a2d4
Author: Bagas Sanjaya <bagasdotme@xxxxxxxxx>
AuthorDate: Mon, 06 Nov 2023 17:12:04 +07:00
Committer: Ingo Molnar <mingo@xxxxxxxxxx>
CommitterDate: Mon, 06 Nov 2023 12:53:57 +01:00

x86/Documentation: Indent 'note::' directive for protocol version number note

The protocol version number note is between the protocol version table and
the memory layout section. As such, Sphinx renders the note directive not
only on the actual note, but until the end of doc.

Indent the directive so that only the actual protocol version number
note is rendered as such.

Fixes: 2c33c27fd603 ("x86/boot: Introduce kernel_info")
Signed-off-by: Bagas Sanjaya <bagasdotme@xxxxxxxxx>
Signed-off-by: Ingo Molnar <mingo@xxxxxxxxxx>
Cc: Jonathan Corbet <corbet@xxxxxxx>
Link: https://lore.kernel.org/r/20231106101206.76487-2-bagasdotme@xxxxxxxxx
Signed-off-by: Ingo Molnar <mingo@xxxxxxxxxx>
---
Documentation/arch/x86/boot.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/arch/x86/boot.rst b/Documentation/arch/x86/boot.rst
index f5d2f24..22cc7a0 100644
--- a/Documentation/arch/x86/boot.rst
+++ b/Documentation/arch/x86/boot.rst
@@ -77,7 +77,7 @@ Protocol 2.14 BURNT BY INCORRECT COMMIT
Protocol 2.15 (Kernel 5.5) Added the kernel_info and kernel_info.setup_type_max.
============= ============================================================

-.. note::
+ .. note::
The protocol version number should be changed only if the setup header
is changed. There is no need to update the version number if boot_params
or kernel_info are changed. Additionally, it is recommended to use