driver core: Clarify documentation for fwnode_operations.add_links()

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

Signed-off-by: Saravana Kannan <saravanak@google.com>
Reviewed-by: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
Link: https://lore.kernel.org/r/20191113023559.62295-2-saravanak@google.com
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>

diff --git a/include/linux/fwnode.h b/include/linux/fwnode.h
index 766ff9bb58760bd5ce6342567d38435710b0cbed..23df37f85398dea819fc9a6a5e4cb07ed3570910 100644 (file)
--- 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);