x86/reboot: Document how to override DMI platform quirks
authorPaul Gortmaker <paul.gortmaker@windriver.com>
Sun, 30 May 2021 16:24:46 +0000 (12:24 -0400)
committerThomas Gleixner <tglx@linutronix.de>
Thu, 12 Aug 2021 10:06:58 +0000 (12:06 +0200)
commit12febc181886f0658ce3413f554203c255d338dd
tree25329a77073a4e859eb05d45f3ad967c0cb69a2a
parent162a5284faf41b2441b8f686f9ac4771c7a8f669
x86/reboot: Document how to override DMI platform quirks

commit 5955633e91bf ("x86/reboot: Skip DMI checks if reboot set by user")
made it so that it's not required to recompile the kernel in order to
bypass broken reboot quirks compiled into an image:

 * This variable is used privately to keep track of whether or not
 * reboot_type is still set to its default value (i.e., reboot= hasn't
 * been set on the command line).  This is needed so that we can
 * suppress DMI scanning for reboot quirks.  Without it, it's
 * impossible to override a faulty reboot quirk without recompiling.

However, at the time it was not eally documented outside the source code,
and so this information isn't really available to the average user out
there.

The change is a little white lie and invented "reboot=default" since it is
easy to remember, and documents well.  The truth is that any random string
that is *not* a currently accepted string will work.

Since that doesn't document well for non-coders, and since it's unknown
what the future additions might be, lay claim on "default" since that is
exactly what it achieves.

Signed-off-by: Paul Gortmaker <paul.gortmaker@windriver.com>
Signed-off-by: Thomas Gleixner <tglx@linutronix.de>
Link: https://lore.kernel.org/r/20210530162447.996461-3-paul.gortmaker@windriver.com
Documentation/admin-guide/kernel-parameters.txt
Documentation/x86/x86_64/boot-options.rst