From: Mark Brown <broonie@opensource.wolfsonmicro.com>
Date: Tue, 24 Jan 2012 11:17:26 +0000 (+0000)
Subject: regulator: Fix documentation for of_node parameter of regulator_register()
X-Git-Tag: firefly_0821_release~3680^2~3642
X-Git-Url: http://demsky.eecs.uci.edu/git/?a=commitdiff_plain;h=4a7cbb56fdbd92a47f57ca8b25bf5db35f0d6518;p=firefly-linux-kernel-4.4.55.git

regulator: Fix documentation for of_node parameter of regulator_register()

Commit 5bc75a886353 ("kernel-doc: fix new warning in regulator core")
added documentation for of_node to address a warning but the
documentation didn't explain what the parameter is for so would be
likely to be unhelpful for users.  Clarify that.

Signed-off-by: Mark Brown <broonie@opensource.wolfsonmicro.com>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
---

diff --git a/drivers/regulator/core.c b/drivers/regulator/core.c
index b1fa25d6583a..e9a83f84adaf 100644
--- a/drivers/regulator/core.c
+++ b/drivers/regulator/core.c
@@ -2731,7 +2731,8 @@ static void rdev_init_debugfs(struct regulator_dev *rdev)
  * @dev: struct device for the regulator
  * @init_data: platform provided init data, passed through by driver
  * @driver_data: private regulator data
- * @of_node: target open firmware device structure (may be NULL)
+ * @of_node: OpenFirmware node to parse for device tree bindings (may be
+ *           NULL).
  *
  * Called by regulator drivers to register a regulator.
  * Returns 0 on success.