[PATCH -next] regulator: pf9453: Improve documentation for pf9453_regulator_set_ramp_delay_regmap

[PATCH -next] regulator: pf9453: Improve documentation for pf9453_regulator_set_ramp_delay_regmap

[Yang Li]

The function pf9453_regulator_set_ramp_delay_regmap lacked detailed
parameter descriptions and return value explanations in its documentation.
This patch improves the documentation by adding specific details about
the parameters, their usage, and the return values, enhancing clarity for
developers.

Reported-by: Abaci Robot <abaci@linux.alibaba.com>
Closes: https://bugzilla.openanolis.cn/show_bug.cgi?id=20168
Signed-off-by: Yang Li <yang.lee@linux.alibaba.com>
---
 drivers/regulator/pf9453-regulator.c | 1 +
 1 file changed, 1 insertion(+)

diff --git a/drivers/regulator/pf9453-regulator.c b/drivers/regulator/pf9453-regulator.c
index ed6bf0f6c4fe..2ae457b3611f 100644
--- a/drivers/regulator/pf9453-regulator.c
+++ b/drivers/regulator/pf9453-regulator.c
@@ -412,6 +412,7 @@ static int find_closest_bigger(unsigned int target, const unsigned int *table,
  * pf9453_regulator_set_ramp_delay_regmap
  *
  * @rdev: regulator to operate on
+ * @ramp_delay: desired ramp delay value in microseconds
  *
  * Regulators that use regmap for their register I/O can set the ramp_reg
  * and ramp_mask fields in their descriptor and then use this as their
-- 
2.32.0.3.g01195cf9f

Re: [PATCH -next] regulator: pf9453: Improve documentation for pf9453_regulator_set_ramp_delay_regmap

[Mark Brown]

On Mon, 07 Apr 2025 14:45:32 +0800, Yang Li wrote:
> The function pf9453_regulator_set_ramp_delay_regmap lacked detailed
> parameter descriptions and return value explanations in its documentation.
> This patch improves the documentation by adding specific details about
> the parameters, their usage, and the return values, enhancing clarity for
> developers.
> 
> 
> [...]

Applied to

   https://git.kernel.org/pub/scm/linux/kernel/git/broonie/regulator.git for-next

Thanks!

[1/1] regulator: pf9453: Improve documentation for pf9453_regulator_set_ramp_delay_regmap
      commit: b3d9e96c96b0076a11aa1001d55b3dc189b8cd1c

All being well this means that it will be integrated into the linux-next
tree (usually sometime in the next 24 hours) and sent to Linus during
the next merge window (or sooner if it is a bug fix), however if
problems are discovered then the patch may be dropped or reverted.

You may get further e-mails resulting from automated or manual testing
and review of the tree, please engage with people reporting problems and
send followup patches addressing any issues that are reported if needed.

If any updates are required or you are submitting further changes they
should be sent as incremental updates against current git, existing
patches will not be replaced.

Please add any relevant lists and maintainers to the CCs when replying
to this mail.

Thanks,
Mark