Skip to contentSkip to conversation

Documentation: dd: Use ReST lists for return values of driver_deferred_probe_check_state()

PATCH New Bagas Sanjaya 1 participant 1 message Apr 16, 2022

Subsystems (3)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 Documentation: dd: Use ReST lists for return values of driver_deferred_probe_check_state()

Sphinx reported build warnings mentioning drivers/base/dd.c:

</path/to/linux>/Documentation/driver-api/infrastructure:35:
./drivers/base/dd.c:280: WARNING: Unexpected indentation. </path/to/linux>/Documentation/driver-api/infrastructure:35:
./drivers/base/dd.c:281: WARNING: Block quote ends without a blank line; unexpected unindent.

The warnings above is due to syntax error in the "Return" section of driver_deferred_probe_check_state() which messed up with desired line breaks.

Fix the issue by using ReST lists syntax.

Fixes c8c43cee29f6ca ("driver core: Fix driver_deferred_probe_check_state() logic")
Cc Greg Kroah-Hartman <[email protected]>
Cc Linus Walleij <[email protected]>
Cc Thierry Reding <[email protected]>
Cc Mark Brown <[email protected]>
Cc Liam Girdwood <[email protected]>
Cc Bjorn Andersson <[email protected]>
Cc Saravana Kannan <[email protected]>
Cc Todd Kjos <[email protected]>
Cc Len Brown <[email protected]>
Cc Pavel Machek <[email protected]>
Cc Ulf Hansson <[email protected]>
Cc Kevin Hilman <[email protected]>
Cc "Rafael J. Wysocki" <[email protected]>
Cc Rob Herring <[email protected]>
Cc John Stultz <[email protected]>
---
 drivers/base/dd.c | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)
drivers/base/dd.c +4 -4
index 3fc3b5940bb..b0b410347ab 100644
@@ -274,10 +274,10 @@ __setup("deferred_probe_timeout=", deferred_probe_timeout_setup);
  * @dev: device to check
  *
  * Return:
- * -ENODEV if initcalls have completed and modules are disabled.
- * -ETIMEDOUT if the deferred probe timeout was set and has expired
- *  and modules are enabled.
- * -EPROBE_DEFER in other cases.
+ * * -ENODEV if initcalls have completed and modules are disabled.
+ * * -ETIMEDOUT if the deferred probe timeout was set and has expired
+ *   and modules are enabled.
+ * * -EPROBE_DEFER in other cases.
  *
  * Drivers or subsystems can opt-in to calling this function instead of directly
  * returning -EPROBE_DEFER.

base-commit: 59250f8a7f3a60a2661b84cbafc1e0eb5d05ec9b

Signature · 1 line
An old man doll... just what I always wanted! - Clara