driver core: Silence device links sphinx warning

Silence this warning emitted by sphinx:
include/linux/device.h:938: warning: No description found for parameter 'links'

While at it, fix typos in comments of device links code.

Cc: Rafael J. Wysocki <rafael@kernel.org>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: Silvio Fricke <silvio.fricke@gmail.com>
Signed-off-by: Lukas Wunner <lukas@wunner.de>
Reviewed-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>

diff --git a/drivers/base/core.c b/drivers/base/core.c
index b8b2f61054763f3128b448f6e7e25110b109c3c6..020ea7f0552073c62c91e55d62e0c0151917251e 100644 (file)
--- a/drivers/base/core.c
+++ b/drivers/base/core.c
@@ -172,7 +172,7 @@ static int device_reorder_to_tail(struct device *dev, void *not_used)
  *
  * The supplier device is required to be registered when this function is called
  * and NULL will be returned if that is not the case.  The consumer device need
- * not be registerd, however.
+ * not be registered, however.
  */
 struct device_link *device_link_add(struct device *consumer,
                                    struct device *supplier, u32 flags)
@@ -225,7 +225,7 @@ struct device_link *device_link_add(struct device *consumer,
        INIT_LIST_HEAD(&link->c_node);
        link->flags = flags;
 
-       /* Deterine the initial link state. */
+       /* Determine the initial link state. */
        if (flags & DL_FLAG_STATELESS) {
                link->status = DL_STATE_NONE;
        } else {

diff --git a/include/linux/device.h b/include/linux/device.h
index 4cd8e52033b047e7a614aa4eac3b5a520449cc5d..67bbbee8fe02b0207a998fd374e850bbca4b1c85 100644 (file)
--- a/include/linux/device.h
+++ b/include/linux/device.h
@@ -817,6 +817,7 @@ struct dev_links_info {
  *             on.  This shrinks the "Board Support Packages" (BSPs) and
  *             minimizes board-specific #ifdefs in drivers.
  * @driver_data: Private pointer for driver specific info.
+ * @links:     Links to suppliers and consumers of this device.
  * @power:     For device power management.
  *             See Documentation/power/devices.txt for details.
  * @pm_domain: Provide callbacks that are executed during system suspend,