* [PATCH] regulator: core: fix documentation error in regulator_allow_bypass
@ 2013-03-01 0:44 Nishanth Menon
2013-03-01 6:09 ` Mark Brown
0 siblings, 1 reply; 2+ messages in thread
From: Nishanth Menon @ 2013-03-01 0:44 UTC (permalink / raw)
To: Mark Brown; +Cc: Nishanth Menon, Liam Girdwood, linux-kernel
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>
---
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(-)
diff --git a/drivers/regulator/core.c b/drivers/regulator/core.c
index da9782b..154bc8f 100644
--- a/drivers/regulator/core.c
+++ b/drivers/regulator/core.c
@@ -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
--
1.7.9.5
^ permalink raw reply related [flat|nested] 2+ messages in thread
* Re: [PATCH] regulator: core: fix documentation error in regulator_allow_bypass
2013-03-01 0:44 [PATCH] regulator: core: fix documentation error in regulator_allow_bypass Nishanth Menon
@ 2013-03-01 6:09 ` Mark Brown
0 siblings, 0 replies; 2+ messages in thread
From: Mark Brown @ 2013-03-01 6:09 UTC (permalink / raw)
To: Nishanth Menon; +Cc: Liam Girdwood, linux-kernel
[-- Attachment #1: Type: text/plain, Size: 260 bytes --]
On Thu, Feb 28, 2013 at 06:44:54PM -0600, Nishanth Menon wrote:
> commit f59c8f9f (regulator: core: Support bypass mode)
> has a short documentation error around the regulator_allow_bypass
> parameter 'enable' which is documented as 'allow'.
Applied, thanks.
[-- Attachment #2: Digital signature --]
[-- Type: application/pgp-signature, Size: 836 bytes --]
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2013-03-01 6:10 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2013-03-01 0:44 [PATCH] regulator: core: fix documentation error in regulator_allow_bypass Nishanth Menon
2013-03-01 6:09 ` Mark Brown
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox