diff mbox series

docs: update documentation of reboot param

Message ID 20241016124202.801139-1-marmarek@invisiblethingslab.com (mailing list archive)
State Superseded
Headers show
Series docs: update documentation of reboot param | expand

Commit Message

Marek Marczykowski-Górecki Oct. 16, 2024, 12:41 p.m. UTC
Reflect changed default mode, and fix formatting of `efi` value.

Fixes: d81dd3130351 ("x86/shutdown: change default reboot method preference")
Signed-off-by: Marek Marczykowski-Górecki <marmarek@invisiblethingslab.com>
---
 docs/misc/xen-command-line.pandoc | 5 ++---
 1 file changed, 2 insertions(+), 3 deletions(-)

Comments

Jan Beulich Oct. 16, 2024, 1:06 p.m. UTC | #1
On 16.10.2024 14:41, Marek Marczykowski-Górecki wrote:
> Reflect changed default mode, and fix formatting of `efi` value.
> 
> Fixes: d81dd3130351 ("x86/shutdown: change default reboot method preference")
> Signed-off-by: Marek Marczykowski-Górecki <marmarek@invisiblethingslab.com>

Acked-by: Jan Beulich <jbeulich@suse.com>
with ...

> --- a/docs/misc/xen-command-line.pandoc
> +++ b/docs/misc/xen-command-line.pandoc
> @@ -2153,14 +2153,13 @@ Specify the host reboot method.
>  
>  `kbd` instructs Xen to reboot the host via the keyboard controller.
>  
> -`acpi` instructs Xen to reboot the host using RESET_REG in the ACPI FADT.
> +`acpi` instructs Xen to reboot the host using RESET_REG in the ACPI FADT (this is default mode if available).

... this line suitably wrapped (can likely be done while committing).

Jan
Jan Beulich Oct. 16, 2024, 1:08 p.m. UTC | #2
On 16.10.2024 14:41, Marek Marczykowski-Górecki wrote:
> --- a/docs/misc/xen-command-line.pandoc
> +++ b/docs/misc/xen-command-line.pandoc
> @@ -2153,14 +2153,13 @@ Specify the host reboot method.
>  
>  `kbd` instructs Xen to reboot the host via the keyboard controller.
>  
> -`acpi` instructs Xen to reboot the host using RESET_REG in the ACPI FADT.
> +`acpi` instructs Xen to reboot the host using RESET_REG in the ACPI FADT (this is default mode if available).
>  
>  `pci` instructs Xen to reboot the host using PCI reset register (port CF9).
>  
>  `Power` instructs Xen to power-cycle the host using PCI reset register (port CF9).
>  
> -'efi' instructs Xen to reboot using the EFI reboot call (in EFI mode by
> - default it will use that method first).
> +`efi` instructs Xen to reboot using the EFI reboot call.
>  
>  `xen` instructs Xen to reboot using Xen's SCHEDOP hypercall (this is the default
>  when running nested Xen)

Hmm, out of context there is the pretty bogus

> Default: `0`

I wonder if we shouldn't adjust that as well while at it, to perhaps say
"system dependent" or some such.

Jan
diff mbox series

Patch

diff --git a/docs/misc/xen-command-line.pandoc b/docs/misc/xen-command-line.pandoc
index 5ce63044ade8..0e36608f13e6 100644
--- a/docs/misc/xen-command-line.pandoc
+++ b/docs/misc/xen-command-line.pandoc
@@ -2153,14 +2153,13 @@  Specify the host reboot method.
 
 `kbd` instructs Xen to reboot the host via the keyboard controller.
 
-`acpi` instructs Xen to reboot the host using RESET_REG in the ACPI FADT.
+`acpi` instructs Xen to reboot the host using RESET_REG in the ACPI FADT (this is default mode if available).
 
 `pci` instructs Xen to reboot the host using PCI reset register (port CF9).
 
 `Power` instructs Xen to power-cycle the host using PCI reset register (port CF9).
 
-'efi' instructs Xen to reboot using the EFI reboot call (in EFI mode by
- default it will use that method first).
+`efi` instructs Xen to reboot using the EFI reboot call.
 
 `xen` instructs Xen to reboot using Xen's SCHEDOP hypercall (this is the default
 when running nested Xen)