Re: [PATCH 2/2] driver core: Silence device links sphinx warning
From: "Rafael J. Wysocki" <rafael@kernel.org>
Date: 2016-12-05 22:21:21
Also in:
linux-iommu, linux-samsung-soc
On Sun, Dec 4, 2016 at 1:10 PM, Lukas Wunner [off-list ref] wrote:
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: Greg Kroah-Hartman <gregkh@linuxfoundation.org> Cc: Jonathan Corbet <corbet@lwn.net> Cc: Silvio Fricke <redacted> Signed-off-by: Lukas Wunner <lukas@wunner.de>
Acked-by: Rafael J. Wysocki <redacted> and thanks for fixing these! [Adds note to self to spellcheck patches next time.]
quoted hunk
--- drivers/base/core.c | 4 ++-- include/linux/device.h | 1 + 2 files changed, 3 insertions(+), 2 deletions(-)diff --git a/drivers/base/core.c b/drivers/base/core.c index d0c9df5..8c25e68 100644 --- 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 3896af4..87edfdf 100644 --- a/include/linux/device.h +++ b/include/linux/device.h@@ -813,6 +813,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/admin-guide/devices.rst for details. * @pm_domain: Provide callbacks that are executed during system suspend, --2.10.2