platform: Document platform_add_devices() return value

Message ID 20221220085116.19837-1-umang.jain@ideasonboard.com
State New
Headers
Series platform: Document platform_add_devices() return value |

Commit Message

Umang Jain Dec. 20, 2022, 8:51 a.m. UTC
  platform_add_devices() returns 0 on success and negative
errno on failure. Document it.

Signed-off-by: Umang Jain <umang.jain@ideasonboard.com>
---
 drivers/base/platform.c | 2 ++
 1 file changed, 2 insertions(+)
  

Patch

diff --git a/drivers/base/platform.c b/drivers/base/platform.c
index 968f3d71eeab..9759dddc5531 100644
--- a/drivers/base/platform.c
+++ b/drivers/base/platform.c
@@ -499,6 +499,8 @@  EXPORT_SYMBOL_GPL(platform_get_irq_byname_optional);
  * platform_add_devices - add a numbers of platform devices
  * @devs: array of platform devices to add
  * @num: number of platform devices in array
+ *
+ * Return: 0 on success, negative error number on failure.
  */
 int platform_add_devices(struct platform_device **devs, int num)
 {