linux-kernel - Re: [PATCH] serial: fix htmldocs warnings

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] [day] [month] [year] [list]

Message-Id: <20090922150915.8bcc203d.randy.dunlap@oracle.com>
Date:	Tue, 22 Sep 2009 15:09:15 -0700
From:	Randy Dunlap <randy.dunlap@...cle.com>
To:	Jaswinder Singh Rajput <jaswinder@...nel.org>
Cc:	Greg Kroah-Hartman <gregkh@...e.de>,
	Alan Cox <alan@...rguk.ukuu.org.uk>,
	linux-serial@...r.kernel.org, LKML <linux-kernel@...r.kernel.org>
Subject: Re: [PATCH] serial: fix htmldocs warnings

On Wed, 23 Sep 2009 03:33:58 +0530 Jaswinder Singh Rajput wrote:

> 
>  Warning(/home/jaswinder/linux-2.6//include/linux/serial_core.h:485): No description found for parameter 'uport'
>  Warning(/home/jaswinder/linux-2.6//include/linux/serial_core.h:485): Excess function parameter 'port' description in 'uart_handle_dcd_change'
>  Warning(/home/jaswinder/linux-2.6//include/linux/serial_core.h:511): No description found for parameter 'uport'
>  Warning(/home/jaswinder/linux-2.6//include/linux/serial_core.h:511): Excess function parameter 'port' description in 'uart_handle_cts_change'
>  Warning(/home/jaswinder/linux-2.6//drivers/serial/serial_core.c:2437): No description found for parameter 'uport'
>  Warning(/home/jaswinder/linux-2.6//drivers/serial/serial_core.c:2437): Excess function parameter 'port' description in 'uart_add_one_port'
>  Warning(/home/jaswinder/linux-2.6//drivers/serial/serial_core.c:2509): No description found for parameter 'uport'
>  Warning(/home/jaswinder/linux-2.6//drivers/serial/serial_core.c:2509): Excess function parameter 'port' description in 'uart_remove_one_port'
> 
> Signed-off-by: Jaswinder Singh Rajput <jaswinderrajput@...il.com>

Ack.  I've already sent the same patch.

> ---
>  drivers/serial/serial_core.c |    4 ++--
>  include/linux/serial_core.h  |    4 ++--
>  2 files changed, 4 insertions(+), 4 deletions(-)
> 
> diff --git a/drivers/serial/serial_core.c b/drivers/serial/serial_core.c
> index 2514d00..1689bda 100644
> --- a/drivers/serial/serial_core.c
> +++ b/drivers/serial/serial_core.c
> @@ -2426,7 +2426,7 @@ struct tty_driver *uart_console_device(struct console *co, int *index)
>  /**
>   *	uart_add_one_port - attach a driver-defined port structure
>   *	@drv: pointer to the uart low level driver structure for this port
> - *	@port: uart port structure to use for this port.
> + *	@uport: uart port structure to use for this port.
>   *
>   *	This allows the driver to register its own uart_port structure
>   *	with the core driver.  The main purpose is to allow the low
> @@ -2499,7 +2499,7 @@ int uart_add_one_port(struct uart_driver *drv, struct uart_port *uport)
>  /**
>   *	uart_remove_one_port - detach a driver defined port structure
>   *	@drv: pointer to the uart low level driver structure for this port
> - *	@port: uart port structure for this port
> + *	@uport: uart port structure for this port
>   *
>   *	This unhooks (and hangs up) the specified port structure from the
>   *	core driver.  No further calls will be made to the low-level code
> diff --git a/include/linux/serial_core.h b/include/linux/serial_core.h
> index d58e460..fe661af 100644
> --- a/include/linux/serial_core.h
> +++ b/include/linux/serial_core.h
> @@ -477,7 +477,7 @@ static inline int uart_handle_break(struct uart_port *port)
>  
>  /**
>   *	uart_handle_dcd_change - handle a change of carrier detect state
> - *	@port: uart_port structure for the open port
> + *	@uport: uart_port structure for the open port
>   *	@status: new carrier detect status, nonzero if active
>   */
>  static inline void
> @@ -503,7 +503,7 @@ uart_handle_dcd_change(struct uart_port *uport, unsigned int status)
>  
>  /**
>   *	uart_handle_cts_change - handle a change of clear-to-send state
> - *	@port: uart_port structure for the open port
> + *	@uport: uart_port structure for the open port
>   *	@status: new clear to send status, nonzero if active
>   */
>  static inline void
> -- 
> 1.6.0.6
> 
> 


---
~Randy
--
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/