Commit 9345dfb8 authored Feb 28, 2013 by Nishanth Menon Committed by Mark Brown Mar 01, 2013

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'

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>

parent 5838b032

drivers/regulator/core.c

+1 −1

Original line number	Diff line number	Diff line
		@@ -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

Admin message