[PATCH] pinctrl: provide documentation pointer

[PATCH] pinctrl: provide documentation pointer

[Linus Walleij]

The PIN_CONFIG_OUTPUT parameter is really tricky to understand
and needs an explicit pointer to the documentation.

Cc: Tomasz Figa <t.figa@samsung.com>
Cc: Kyungmin Park <kyungmin.park@samsung.com>
Signed-off-by: Linus Walleij <linus.walleij@linaro.org>
---
 include/linux/pinctrl/pinconf-generic.h | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/include/linux/pinctrl/pinconf-generic.h b/include/linux/pinctrl/pinconf-generic.h
index fb90ef5eb038..4b1432548e9e 100644
--- a/include/linux/pinctrl/pinconf-generic.h
+++ b/include/linux/pinctrl/pinconf-generic.h
@@ -83,7 +83,9 @@
  *	passed in the argument on a custom form, else just use argument 1
  *	to indicate low power mode, argument 0 turns low power mode off.
  * @PIN_CONFIG_OUTPUT: this will configure the pin in output, use argument
- *	1 to indicate high level, argument 0 to indicate low level.
+ *	1 to indicate high level, argument 0 to indicate low level. (Please
+ *	Documentation/pinctrl.txt, section "GPIO mode pitfalls" for a
+ *	discussion around this parameter.)
  * @PIN_CONFIG_END: this is the last enumerator for pin configurations, if
  *	you need to pass in custom configurations to the pin controller, use
  *	PIN_CONFIG_END+1 as the base offset.
-- 
1.8.3.1

Re: [PATCH] pinctrl: provide documentation pointer

[Stephen Warren]

On 11/25/2013 07:45 AM, Linus Walleij wrote:
> The PIN_CONFIG_OUTPUT parameter is really tricky to understand
> and needs an explicit pointer to the documentation.

> diff --git a/include/linux/pinctrl/pinconf-generic.h b/include/linux/pinctrl/pinconf-generic.h

>   * @PIN_CONFIG_OUTPUT: this will configure the pin in output, use argument

Well, while you're touching that...
s/in/as an/   s/, use/. Use/

> - *	1 to indicate high level, argument 0 to indicate low level.
> + *	1 to indicate high level, argument 0 to indicate low level. (Please
> + *	Documentation/pinctrl.txt, section "GPIO mode pitfalls" for a

Add "see" to the start of that line.

> + *	discussion around this parameter.)

(no need to resend to fix that, from my side at least)