regulator: Fix regulator_get_{optional,exclusive}() documentation

regulator_get_optional() doesn't hold an exclusive reference to
the regulator. Fix the documentation and reword the exclusive
documentation to fix the grammatical error "this reference is
held".

Signed-off-by: Stephen Boyd <sboyd@codeaurora.org>
Signed-off-by: Mark Brown <broonie@linaro.org>
This commit is contained in:
Stephen Boyd 2014-05-28 12:41:28 -07:00 committed by Mark Brown
parent 366986274c
commit 69c3f7239e
1 changed files with 4 additions and 7 deletions

View File

@ -1430,9 +1430,9 @@ EXPORT_SYMBOL_GPL(regulator_get);
* *
* Returns a struct regulator corresponding to the regulator producer, * Returns a struct regulator corresponding to the regulator producer,
* or IS_ERR() condition containing errno. Other consumers will be * or IS_ERR() condition containing errno. Other consumers will be
* unable to obtain this reference is held and the use count for the * unable to obtain this regulator while this reference is held and the
* regulator will be initialised to reflect the current state of the * use count for the regulator will be initialised to reflect the current
* regulator. * state of the regulator.
* *
* This is intended for use by consumers which cannot tolerate shared * This is intended for use by consumers which cannot tolerate shared
* use of the regulator such as those which need to force the * use of the regulator such as those which need to force the
@ -1456,10 +1456,7 @@ EXPORT_SYMBOL_GPL(regulator_get_exclusive);
* @id: Supply name or regulator ID. * @id: Supply name or regulator ID.
* *
* Returns a struct regulator corresponding to the regulator producer, * Returns a struct regulator corresponding to the regulator producer,
* or IS_ERR() condition containing errno. Other consumers will be * or IS_ERR() condition containing errno.
* unable to obtain this reference is held and the use count for the
* regulator will be initialised to reflect the current state of the
* regulator.
* *
* This is intended for use by consumers for devices which can have * This is intended for use by consumers for devices which can have
* some supplies unconnected in normal use, such as some MMC devices. * some supplies unconnected in normal use, such as some MMC devices.