[PATCH] regulator: Suggest use of datasheet supply or pin names for consumers

[PATCH] regulator: Suggest use of datasheet supply or pin names for consumers

[Mark Brown]

Update the documentation to suggest the use of datasheet names for
the supplies requested by regulator consumers. Doing this makes it
easier to tie the design for a given platform up with the requirements
of the driver for a consumer.

Signed-off-by: Mark Brown <broonie@opensource.wolfsonmicro.com>
---
 drivers/regulator/core.c |    9 ++++++---
 1 files changed, 6 insertions(+), 3 deletions(-)

diff --git a/drivers/regulator/core.c b/drivers/regulator/core.c
index b85e4a9..d55a25a 100644
--- a/drivers/regulator/core.c
+++ b/drivers/regulator/core.c
@@ -925,9 +925,12 @@ overflow_err:
  * @id: Supply name or regulator ID.
  *
  * Returns a struct regulator corresponding to the regulator producer,
- * or IS_ERR() condition containing errno.  Use of supply names
- * configured via regulator_set_device_supply() is strongly
- * encouraged.
+ * or IS_ERR() condition containing errno.
+ *
+ * Use of supply names configured via regulator_set_device_supply() is
+ * strongly encouraged.  It is recommended that the supply name used
+ * should match the name used for the supply and/or the relevant
+ * device pins in the datasheet.
  */
 struct regulator *regulator_get(struct device *dev, const char *id)
 {
-- 
1.5.6.5

Re: [PATCH] regulator: Suggest use of datasheet supply or pin names for consumers

[Liam Girdwood]

On Wed, 2009-02-11 at 15:32 +0000, Mark Brown wrote:
> Update the documentation to suggest the use of datasheet names for
> the supplies requested by regulator consumers. Doing this makes it
> easier to tie the design for a given platform up with the requirements
> of the driver for a consumer.
> 
> Signed-off-by: Mark Brown <broonie@opensource.wolfsonmicro.com>
> ---
>  drivers/regulator/core.c |    9 ++++++---
>  1 files changed, 6 insertions(+), 3 deletions(-)
> 

Applied.

Thanks

Liam