[PATCH v1] driver core: Clarify documentation for fwnode_operations.add_links()

[PATCH v1] driver core: Clarify documentation for fwnode_operations.add_links()

[Saravana Kannan]

The wording was a bit ambiguous. So update it to make it clear.

Signed-off-by: Saravana Kannan <saravanak@google.com>
---
 include/linux/fwnode.h | 15 ++++++++-------
 1 file changed, 8 insertions(+), 7 deletions(-)

diff --git a/include/linux/fwnode.h b/include/linux/fwnode.h
index 766ff9bb5876..23df37f85398 100644
--- a/include/linux/fwnode.h
+++ b/include/linux/fwnode.h
@@ -94,15 +94,16 @@ struct fwnode_reference_args {
  *		available suppliers.
  *
  *		Return 0 if device links have been successfully created to all
- *		the suppliers this device needs to create device links to or if
- *		the supplier information is not known.
+ *		the known suppliers of this device or if the supplier
+ *		information is not known.
  *
- *		Return -ENODEV if and only if the suppliers needed for probing
- *		the device are not yet available to create device links to.
+ *		Return -ENODEV if the suppliers needed for probing this device
+ *		have not been registered yet (because device links can only be
+ *		created to devices registered with the driver core).
  *
- *		Return -EAGAIN if there are suppliers that need to be linked to
- *		that are not yet available but none of those suppliers are
- *		necessary for probing this device.
+ *		Return -EAGAIN if some of the suppliers of this device have not
+ *		been registered yet, but none of those suppliers are necessary
+ *		for probing the device.
  */
 struct fwnode_operations {
 	struct fwnode_handle *(*get)(struct fwnode_handle *fwnode);
-- 
2.24.0.rc1.363.gb1bccd3e3d-goog

Re: [PATCH v1] driver core: Clarify documentation for fwnode_operations.add_links()

[Rafael J. Wysocki]

On Wed, Nov 13, 2019 at 3:36 AM Saravana Kannan <saravanak@google.com> wrote:
>
> The wording was a bit ambiguous. So update it to make it clear.
>
> Signed-off-by: Saravana Kannan <saravanak@google.com>

Looks better with this change IMO:

Reviewed-by: Rafael J. Wysocki <rafael.j.wysocki@intel.com>

> ---
>  include/linux/fwnode.h | 15 ++++++++-------
>  1 file changed, 8 insertions(+), 7 deletions(-)
>
> diff --git a/include/linux/fwnode.h b/include/linux/fwnode.h
> index 766ff9bb5876..23df37f85398 100644
> --- a/include/linux/fwnode.h
> +++ b/include/linux/fwnode.h
> @@ -94,15 +94,16 @@ struct fwnode_reference_args {
>   *             available suppliers.
>   *
>   *             Return 0 if device links have been successfully created to all
> - *             the suppliers this device needs to create device links to or if
> - *             the supplier information is not known.
> + *             the known suppliers of this device or if the supplier
> + *             information is not known.
>   *
> - *             Return -ENODEV if and only if the suppliers needed for probing
> - *             the device are not yet available to create device links to.
> + *             Return -ENODEV if the suppliers needed for probing this device
> + *             have not been registered yet (because device links can only be
> + *             created to devices registered with the driver core).
>   *
> - *             Return -EAGAIN if there are suppliers that need to be linked to
> - *             that are not yet available but none of those suppliers are
> - *             necessary for probing this device.
> + *             Return -EAGAIN if some of the suppliers of this device have not
> + *             been registered yet, but none of those suppliers are necessary
> + *             for probing the device.
>   */
>  struct fwnode_operations {
>         struct fwnode_handle *(*get)(struct fwnode_handle *fwnode);
> --
> 2.24.0.rc1.363.gb1bccd3e3d-goog
>