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

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

[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.

Signed-off-by: Lukas Bulwahn <lukas.bulwahn@gmail.com>
---
 drivers/power/supply/power_supply_core.c | 1 -
 1 file changed, 1 deletion(-)

diff --git a/drivers/power/supply/power_supply_core.c b/drivers/power/supply/power_supply_core.c
index 4b5fb172fa99..9035e349bf53 100644
--- a/drivers/power/supply/power_supply_core.c
+++ b/drivers/power/supply/power_supply_core.c
@@ -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)
  *
-- 
2.17.1

Re: [PATCH] power: supply: core: repair kernel-doc for power_supply_vbat2ri()

[Sebastian Reichel]

[-- Attachment #1: Type: text/plain, Size: 1379 bytes --]

Hi,

On Mon, Oct 31, 2022 at 04:18:08PM +0100, Lukas Bulwahn wrote:
> 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.
> 
> Signed-off-by: Lukas Bulwahn <lukas.bulwahn@gmail.com>
> ---

Thanks, queued.

-- Sebastian

>  drivers/power/supply/power_supply_core.c | 1 -
>  1 file changed, 1 deletion(-)
> 
> diff --git a/drivers/power/supply/power_supply_core.c b/drivers/power/supply/power_supply_core.c
> index 4b5fb172fa99..9035e349bf53 100644
> --- a/drivers/power/supply/power_supply_core.c
> +++ b/drivers/power/supply/power_supply_core.c
> @@ -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)
>   *
> -- 
> 2.17.1
> 

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]