driver:base:core: Adding a "Return:" line in comment for device_link_add()

[PATCH v1] driver:base:core: Adding a "Return:" line in comment for device_link_add()

Yuesong Li posted 1 patch 1 year, 5 months ago

Download mbox

drivers/base/core.c | 3 +++
1 file changed, 3 insertions(+)

Expand all Fold all

[PATCH v1] driver:base:core: Adding a "Return:" line in comment for device_link_add()

Posted by Yuesong Li 1 year, 5 months ago

The original document doesn't explain the return value directly which
leads to confusing in error checking.

You can find the reason here:
Link: https://lore.kernel.org/all/1d4c39e109bcf288d5900670e024a315.sboyd@kernel.org/

Signed-off-by: Yuesong Li <liyuesong@vivo.com>
---
 drivers/base/core.c | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/drivers/base/core.c b/drivers/base/core.c
index 6d3897492285..97d5005b2210 100644
--- a/drivers/base/core.c
+++ b/drivers/base/core.c
@@ -682,6 +682,9 @@ postcore_initcall(devlink_class_init);
  * @supplier: Supplier end of the link.
  * @flags: Link flags.
  *
+ * Return: On success, a device_link struct will be returned.
+ *         On error or invalid flag settings, NULL will be returned.
+ *
  * The caller is responsible for the proper synchronization of the link creation
  * with runtime PM.  First, setting the DL_FLAG_PM_RUNTIME flag will cause the
  * runtime PM framework to take the link into account.  Second, if the
-- 
2.34.1