diff options
| author | Bagas Sanjaya <bagasdotme@gmail.com> | 2023-11-06 17:12:04 +0700 |
|---|---|---|
| committer | Ingo Molnar <mingo@kernel.org> | 2023-11-06 12:53:57 +0100 |
| commit | 18216762bcf618c52b85719d3563243f80e4a2d4 (patch) | |
| tree | dcae07c2a1c0c0a06671f748e096652ba4710cab /Documentation | |
| parent | c692800cb2ef7a4f4940c68d765cd4649aff3e46 (diff) | |
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@gmail.com>
Signed-off-by: Ingo Molnar <mingo@kernel.org>
Cc: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20231106101206.76487-2-bagasdotme@gmail.com
Signed-off-by: Ingo Molnar <mingo@kernel.org>
Diffstat (limited to 'Documentation')
| -rw-r--r-- | Documentation/arch/x86/boot.rst | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/Documentation/arch/x86/boot.rst b/Documentation/arch/x86/boot.rst index f5d2f2414de8..22cc7a040dae 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 |