regulator: core: fix documentation error in regulator_allow_bypass
PATCH 1/1 regulator: core: fix documentation error in regulator_allow_bypass
commit f59c8f9f (regulator: core: Support bypass mode) has a short documentation error around the regulator_allow_bypass parameter 'enable' which is documented as 'allow'.
This generates kernel-doc warning as follows:./scripts/kernel-doc drivers/regulator/core.c >/dev/null Warning(drivers/regulator/core.c:2841): No description found for parameter 'enable' Warning(drivers/regulator/core.c:2841): Excess function parameter 'allow' description in 'regulator_allow_bypass'
---
the above error is based off:
master de1a226 Merge tag 'writeback-fixes' of git://git.kernel.org/pub/scm/linux/kernel/git/wfg/linux
from: git://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux-2.6.git
defconfig used: omap2plus_defconfig
drivers/regulator/core.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/regulator/core.c +1 -1
@@ -2830,7 +2830,7 @@ EXPORT_SYMBOL_GPL(regulator_get_bypass_regmap);* regulator_allow_bypass - allow the regulator to go into bypass mode * * @regulator: Regulator to configure -* @allow: enable or disable bypass mode +* @enable: enable or disable bypass mode * * Allow the regulator to go into bypass mode if all other consumers * for the regulator also enable bypass mode and the machine
Signature · 1 line
1.7.9.5
Mark Brown
AppliedQuoted 3 lines · Nishanth Menon
commit
f59c8f9f(regulator: core: Support bypass mode) has a short documentation error around theregulator_allow_bypassparameter 'enable' which is documented as 'allow'.
Applied, thanks.