]> git.ipfire.org Git - thirdparty/linux.git/commitdiff
Documentation: ABI: sysfs-class-reboot-mode-reboot_modes: fix doc warnings
authorRandy Dunlap <rdunlap@infradead.org>
Sun, 26 Apr 2026 23:27:05 +0000 (16:27 -0700)
committerSebastian Reichel <sebastian.reichel@collabora.com>
Fri, 12 Jun 2026 22:01:26 +0000 (00:01 +0200)
Repair the docs build warnings in this file by unindenting the description,
adding blank lines, and using `` to quote *arg.

WARNING: Documentation/ABI/testing/sysfs-class-reboot-mode-reboot_modes:36: abi_sys_class_reboot_mode_driver_reboot_modes doesn't have a description
Documentation/ABI/testing/sysfs-class-reboot-mode-reboot_modes:1: ERROR: Unexpected indentation. [docutils]
Documentation/ABI/testing/sysfs-class-reboot-mode-reboot_modes:1: ERROR: Unexpected indentation. [docutils]
Documentation/ABI/testing/sysfs-class-reboot-mode-reboot_modes:1: WARNING: Inline emphasis start-string without end-string. [docutils]
Documentation/ABI/testing/sysfs-class-reboot-mode-reboot_modes:1: ERROR: Unexpected indentation. [docutils]

Fixes: d3da03025e6d ("Documentation: ABI: Add sysfs-class-reboot-mode-reboot_modes")
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Reviewed-by: Bartosz Golaszewski <bartosz.golaszewski@oss.qualcomm.com>
Link: https://patch.msgid.link/20260426232705.422938-1-rdunlap@infradead.org
Signed-off-by: Sebastian Reichel <sebastian.reichel@collabora.com>
Documentation/ABI/testing/sysfs-class-reboot-mode-reboot_modes

index a16c54ab841bb4687d3844ac5dd4abf6b37326e1..4306966b7fcc33f2dfd4c48828950a09e1077a1f 100644 (file)
@@ -2,33 +2,36 @@ What:         /sys/class/reboot-mode/<driver>/reboot_modes
 Date:          March 2026(TBD)
 KernelVersion: TBD
 Contact:       linux-pm@vger.kernel.org
-               Description:
+Description:
                This interface exposes the reboot-mode arguments
                registered with the reboot-mode framework. It is
                a read-only interface and provides a space
                separated list of reboot-mode arguments supported
                on the current platform.
                Example:
+
                 recovery fastboot bootloader
 
                The exact sysfs path may vary depending on the
                name of the driver that registers the arguments.
-               Example:
+               Example::
+
                 /sys/class/reboot-mode/nvmem-reboot-mode/reboot_modes
                 /sys/class/reboot-mode/syscon-reboot-mode/reboot_modes
                 /sys/class/reboot-mode/qcom-pon/reboot_modes
 
                The supported arguments can be used by userspace to
                invoke device reset using the standard reboot() system
-               call interface, with the "argument" as string to "*arg"
-               parameter along with LINUX_REBOOT_CMD_RESTART2.
+               call interface, with the "argument" as string to ``*arg``
+               parameter along with ``LINUX_REBOOT_CMD_RESTART2``.
 
                A driver can expose the supported arguments by
                registering them with the reboot-mode framework
                using the property names that follow the
                mode-<argument> format.
                Example:
-                mode-bootloader, mode-recovery.
+
+                mode-bootloader, mode-recovery
 
                This attribute is useful for scripts or initramfs
                logic that need to programmatically determine