Skip to contentSkip to conversation

power: supply: core: repair kernel-doc for power_supply_vbat2ri()

PATCH In review Lukas Bulwahn 2 participants 2 messages Oct 31, 2022

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 power: supply: core: repair kernel-doc for power_supply_vbat2ri()

The function power_supply_vbat2ri() does not have a parameter called table, despite it being mentioned in the kernel-doc comment. The table is actually obtained from the info parameter, the battery information container. Hence, ./scripts/kernel-doc -none drivers/power/supply/power_supply_core.c warns about this excess function parameter.

Adjust the kernel-doc comment for power_supply_vbat2ri() for make W=1 happiness.

---
 drivers/power/supply/power_supply_core.c | 1 -
 1 file changed, 1 deletion(-)
drivers/power/supply/power_supply_core.c +0 -1
index 4b5fb172fa99..9035e349bf53 100644
@@ -870,7 +870,6 @@ EXPORT_SYMBOL_GPL(power_supply_temp2resist_simple);
  * power_supply_vbat2ri() - find the battery internal resistance
  * from the battery voltage
  * @info: The battery information container
- * @table: Pointer to battery resistance temperature table
  * @vbat_uv: The battery voltage in microvolt
  * @charging: If we are charging (true) or not (false)
  *
Signature · 1 line
2.17.1
#1 lore raw

Hi,

Quoted 11 lines · Lukas Bulwahn

The function power_supply_vbat2ri() does not have a parameter called table, despite it being mentioned in the kernel-doc comment. The table is actually obtained from the info parameter, the battery information container. Hence, ./scripts/kernel-doc -none drivers/power/supply/power_supply_core.c warns about this excess function parameter.

Adjust the kernel-doc comment for power_supply_vbat2ri() for make W=1 happiness.

---

Thanks, queued.

-- Sebastian

Quoted 18 lines
 drivers/power/supply/power_supply_core.c | 1 -
 1 file changed, 1 deletion(-)
drivers/power/supply/power_supply_core.c +0 -1
index 4b5fb172fa99..9035e349bf53 100644
@@ -870,7 +870,6 @@ EXPORT_SYMBOL_GPL(power_supply_temp2resist_simple);
  * power_supply_vbat2ri() - find the battery internal resistance
  * from the battery voltage
  * @info: The battery information container
- * @table: Pointer to battery resistance temperature table
  * @vbat_uv: The battery voltage in microvolt
  * @charging: If we are charging (true) or not (false)
  *
Signature · 1 line
2.17.1