linux-kernel - Re: [PATCH v3 3/3] Input: gpio_keys - convert struct descriptions to kernel-doc

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <20140426044134.GA27425@core.coreip.homeip.net>
Date:	Fri, 25 Apr 2014 21:41:34 -0700
From:	Dmitry Torokhov <dmitry.torokhov@...il.com>
To:	Andy Shevchenko <andriy.shevchenko@...ux.intel.com>
Cc:	Linus Walleij <linus.walleij@...aro.org>,
	linux-input@...r.kernel.org, linux-kernel@...r.kernel.org
Subject: Re: [PATCH v3 3/3] Input: gpio_keys - convert struct descriptions to
 kernel-doc

On Fri, Apr 25, 2014 at 07:22:17PM +0300, Andy Shevchenko wrote:
> This patch converts descriptions of the structures defined in linux/gpio_keys.h
> to follow kernel-doc format.
> 
> There is no functional change.
> 
> Signed-off-by: Andy Shevchenko <andriy.shevchenko@...ux.intel.com>
> Acked-by: Linus Walleij <linus.walleij@...aro.org>

Applied, thank you.

> ---
>  include/linux/gpio_keys.h | 45 +++++++++++++++++++++++++++++++++------------
>  1 file changed, 33 insertions(+), 12 deletions(-)
> 
> diff --git a/include/linux/gpio_keys.h b/include/linux/gpio_keys.h
> index a7e977f..997134a 100644
> --- a/include/linux/gpio_keys.h
> +++ b/include/linux/gpio_keys.h
> @@ -3,29 +3,50 @@
>  
>  struct device;
>  
> +/**
> + * struct gpio_keys_button - configuration parameters
> + * @code:		input event code (KEY_*, SW_*)
> + * @gpio:		%-1 if this key does not support gpio
> + * @active_low:
> + * @desc:
> + * @type:		input event type (%EV_KEY, %EV_SW, %EV_ABS)
> + * @wakeup:		configure the button as a wake-up source
> + * @debounce_interval:	debounce ticks interval in msecs
> + * @can_disable:
> + * @value:		axis value for %EV_ABS
> + * @irq:		Irq number in case of interrupt keys
> + */
>  struct gpio_keys_button {
> -	/* Configuration parameters */
> -	unsigned int code;	/* input event code (KEY_*, SW_*) */
> -	int gpio;		/* -1 if this key does not support gpio */
> +	unsigned int code;
> +	int gpio;
>  	int active_low;
>  	const char *desc;
> -	unsigned int type;	/* input event type (EV_KEY, EV_SW, EV_ABS) */
> -	int wakeup;		/* configure the button as a wake-up source */
> -	int debounce_interval;	/* debounce ticks interval in msecs */
> +	unsigned int type;
> +	int wakeup;
> +	int debounce_interval;
>  	bool can_disable;
> -	int value;		/* axis value for EV_ABS */
> -	unsigned int irq;	/* Irq number in case of interrupt keys */
> +	int value;
> +	unsigned int irq;
>  };
>  
> +/**
> + * struct gpio_keys_platform_data - platform data for gpio_keys driver
> + * @buttons:
> + * @nbuttons:
> + * @poll_interval:	polling interval in msecs - for polling driver only
> + * @rep:		enable input subsystem auto repeat
> + * @enable:
> + * @disable:
> + * @name:		input device name
> + */
>  struct gpio_keys_platform_data {
>  	struct gpio_keys_button *buttons;
>  	int nbuttons;
> -	unsigned int poll_interval;	/* polling interval in msecs -
> -					   for polling driver only */
> -	unsigned int rep:1;		/* enable input subsystem auto repeat */
> +	unsigned int poll_interval;
> +	unsigned int rep:1;
>  	int (*enable)(struct device *dev);
>  	void (*disable)(struct device *dev);
> -	const char *name;		/* input device name */
> +	const char *name;
>  };
>  
>  #endif
> -- 
> 1.9.2
> 

-- 
Dmitry
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@...r.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/