drivers: core: fw_devlink: Fix excess parameter description in docstring

PATCH New Amit Vadhavana 1 participant 1 message Nov 11, 2024 Driver core

Share & tools

Amit Vadhavana

author

2024-11-11 16:53 UTC #0 lore raw

PATCH 1/1 drivers: core: fw_devlink: Fix excess parameter description in docstring

Replace the parameter name 'con' with 'con_handle' in the docstring of __fw_devlink_relax_cycles() to resolve the kernel-doc warning about an excess parameter description.

Address the following warning:
./drivers/base/core.c:1994: warning: Excess function parameter 'con' description in '__fw_devlink_relax_cycles'

Reported-by Stephen Rothwell <[email protected]>

Closes https://lore.kernel.org/all/[email protected]/ open here

Signed-off-by Amit Vadhavana <[email protected]>

---
 drivers/base/core.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

drivers/base/core.c +1 -1

index 78b2c0eacb26..94865c9d8adc 100644
@@ -1971,7 +1971,7 @@ static struct device *fwnode_get_next_parent_dev(const struct fwnode_handle *fwn
 
 /**
  * __fw_devlink_relax_cycles - Relax and mark dependency cycles.
- * @con: Potential consumer device.
+ * @con_handle: Potential consumer device fwnode.
  * @sup_handle: Potential supplier's fwnode.
  *
  * Needs to be called with fwnode_lock and device link lock held.

Signature · 1 line

2.25.1