Skip to content

Commit

Permalink
x86/Documentation: Indent 'note::' directive for protocol version num…
Browse files Browse the repository at this point in the history
…ber 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: 2c33c27 ("x86/boot: Introduce kernel_info")
Signed-off-by: Bagas Sanjaya <[email protected]>
Signed-off-by: Ingo Molnar <[email protected]>
Cc: Jonathan Corbet <[email protected]>
Link: https://lore.kernel.org/r/[email protected]
Signed-off-by: Ingo Molnar <[email protected]>
  • Loading branch information
bagasme authored and Ingo Molnar committed Nov 6, 2023
1 parent c692800 commit 1821676
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion Documentation/arch/x86/boot.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 1821676

Please sign in to comment.