regulator: fixed-helper: use the correct function name in comment

Message ID 20230113064421.11986-1-rdunlap@infradead.org
State New
Headers
Series regulator: fixed-helper: use the correct function name in comment |

Commit Message

Randy Dunlap Jan. 13, 2023, 6:44 a.m. UTC
  Use the correct function name and modify the function short description.
This prevents a kernel-doc warning:

drivers/regulator/fixed-helper.c:32: warning: expecting prototype for regulator_register_fixed_name(). Prototype was for regulator_register_always_on() instead

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Liam Girdwood <lgirdwood@gmail.com>
Cc: Mark Brown <broonie@kernel.org>
---
 drivers/regulator/fixed-helper.c |    2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
  

Comments

Mark Brown Jan. 13, 2023, 3:14 p.m. UTC | #1
On Thu, 12 Jan 2023 22:44:21 -0800, Randy Dunlap wrote:
> Use the correct function name and modify the function short description.
> This prevents a kernel-doc warning:
> 
> drivers/regulator/fixed-helper.c:32: warning: expecting prototype for regulator_register_fixed_name(). Prototype was for regulator_register_always_on() instead
> 
> 

Applied to

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

Thanks!

[1/1] regulator: fixed-helper: use the correct function name in comment
      commit: a508a267dda6e67d2eccbc12088a7fecc127ba90

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
  

Patch

diff -- a/drivers/regulator/fixed-helper.c b/drivers/regulator/fixed-helper.c
--- a/drivers/regulator/fixed-helper.c
+++ b/drivers/regulator/fixed-helper.c
@@ -20,7 +20,7 @@  static void regulator_fixed_release(stru
 }
 
 /**
- * regulator_register_fixed_name - register a no-op fixed regulator
+ * regulator_register_always_on - register an always-on regulator with a fixed name
  * @id: platform device id
  * @name: name to be used for the regulator
  * @supplies: consumers for this regulator