Techwizz/kernel-fxtec-pro1x
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

regulator: core: fix documentation error in regulator_allow_bypass

Browse source 
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'

Cc: Liam Girdwood <lgirdwood@gmail.com>
Cc: Mark Brown <broonie@opensource.wolfsonmicro.com>
Cc: linux-kernel@vger.kernel.org
Signed-off-by: Nishanth Menon <nm@ti.com>
Signed-off-by: Mark Brown <broonie@opensource.wolfsonmicro.com>
This commit is contained in:
Nishanth Menon 2013-02-28 18:44:54 -06:00 committed by Mark Brown
parent 5838b032fd
commit 9345dfb849
1 changed files with 1 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
drivers/regulator/core.c
View file

@ -2830,7 +2830,7 @@ EXPORT_SYMBOL_GPL(regulator_get_bypass_regmap);
* regulator_allow_bypass - allow the regulator to go into bypass mode * regulator_allow_bypass - allow the regulator to go into bypass mode
* *
* @regulator: Regulator to configure * @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 * Allow the regulator to go into bypass mode if all other consumers
* for the regulator also enable bypass mode and the machine * for the regulator also enable bypass mode and the machine