[PATCH v2] tty: serial: uartlite: Fix kernel doc warning

[PATCH v2] tty: serial: uartlite: Fix kernel doc warning

[Shubhrajyoti Datta]

Fix the below warning
drivers/tty/serial/uartlite.c:79: warning: Function parameter or member 'reg_ops' not described in 'uartlite_data'
drivers/tty/serial/uartlite.c:79: warning: Function parameter or member 'clk' not described in 'uartlite_data'
drivers/tty/serial/uartlite.c:79: warning: Function parameter or member 'baud' not described in 'uartlite_data'
drivers/tty/serial/uartlite.c:79: warning: Function parameter or member 'cflags' not described in 'uartlite_data'

Reported-by: kernel test robot <yujie.liu@intel.com>
Closes: https://lore.kernel.org/r/202311061059.NUeUar9b-lkp@intel.com/
Fixes: ea017f5853e9 ("tty: serial: uartlite: Prevent changing fixed parameters")
Signed-off-by: Shubhrajyoti Datta <shubhrajyoti.datta@amd.com>

---

Changes in v2:
Update doc for uartlite_data

 drivers/tty/serial/uartlite.c | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/drivers/tty/serial/uartlite.c b/drivers/tty/serial/uartlite.c
index 404c14acafa5..e586d7aeac98 100644
--- a/drivers/tty/serial/uartlite.c
+++ b/drivers/tty/serial/uartlite.c
@@ -62,11 +62,11 @@ static struct uart_port *console_port;
 #endif
 
 /**
- * struct uartlite_data: Driver private data
- * reg_ops: Functions to read/write registers
- * clk: Our parent clock, if present
- * baud: The baud rate configured when this device was synthesized
- * cflags: The cflags for parity and data bits
+ * struct uartlite_data - Driver private data
+ * @reg_ops: Functions to read/write registers
+ * @clk: Our parent clock, if present
+ * @baud: The baud rate configured when this device was synthesized
+ * @cflags: The cflags for parity and data bits
  */
 struct uartlite_data {
 	const struct uartlite_reg_ops *reg_ops;
-- 
2.17.1

Re: [PATCH v2] tty: serial: uartlite: Fix kernel doc warning

[Jiri Slaby]

On 20. 11. 23, 10:09, Shubhrajyoti Datta wrote:
> Fix the below warning
> drivers/tty/serial/uartlite.c:79: warning: Function parameter or member 'reg_ops' not described in 'uartlite_data'
> drivers/tty/serial/uartlite.c:79: warning: Function parameter or member 'clk' not described in 'uartlite_data'
> drivers/tty/serial/uartlite.c:79: warning: Function parameter or member 'baud' not described in 'uartlite_data'
> drivers/tty/serial/uartlite.c:79: warning: Function parameter or member 'cflags' not described in 'uartlite_data'
> 
> Reported-by: kernel test robot <yujie.liu@intel.com>
> Closes: https://lore.kernel.org/r/202311061059.NUeUar9b-lkp@intel.com/
> Fixes: ea017f5853e9 ("tty: serial: uartlite: Prevent changing fixed parameters")
> Signed-off-by: Shubhrajyoti Datta <shubhrajyoti.datta@amd.com>
> 
> ---
> 
> Changes in v2:
> Update doc for uartlite_data

Despite I don't understand this comment, I see you fixed what I asked 
for, so:

Reviewed-by: Jiri Slaby <jirislaby@kernel.org>

thanks,
-- 
js
suse labs

Re: [PATCH v2] tty: serial: uartlite: Fix kernel doc warning

[Sean Anderson]

On 11/20/23 04:09, Shubhrajyoti Datta wrote:
> Fix the below warning
> drivers/tty/serial/uartlite.c:79: warning: Function parameter or member 'reg_ops' not described in 'uartlite_data'
> drivers/tty/serial/uartlite.c:79: warning: Function parameter or member 'clk' not described in 'uartlite_data'
> drivers/tty/serial/uartlite.c:79: warning: Function parameter or member 'baud' not described in 'uartlite_data'
> drivers/tty/serial/uartlite.c:79: warning: Function parameter or member 'cflags' not described in 'uartlite_data'
> 
> Reported-by: kernel test robot <yujie.liu@intel.com>
> Closes: https://cas5-0-urlprotect.trendmicro.com:443/wis/clicktime/v1/query?url=https%3a%2f%2flore.kernel.org%2fr%2f202311061059.NUeUar9b%2dlkp%40intel.com%2f&umid=ca5e675b-75fa-4a6d-95a0-b7630f896afe&auth=d807158c60b7d2502abde8a2fc01f40662980862-7a9c276d4643e915ccea59b2b954eb8784b19bd4
> Fixes: ea017f5853e9 ("tty: serial: uartlite: Prevent changing fixed parameters")
> Signed-off-by: Shubhrajyoti Datta <shubhrajyoti.datta@amd.com>
> 
> ---
> 
> Changes in v2:
> Update doc for uartlite_data
> 
>  drivers/tty/serial/uartlite.c | 10 +++++-----
>  1 file changed, 5 insertions(+), 5 deletions(-)
> 
> diff --git a/drivers/tty/serial/uartlite.c b/drivers/tty/serial/uartlite.c
> index 404c14acafa5..e586d7aeac98 100644
> --- a/drivers/tty/serial/uartlite.c
> +++ b/drivers/tty/serial/uartlite.c
> @@ -62,11 +62,11 @@ static struct uart_port *console_port;
>  #endif
>  
>  /**
> - * struct uartlite_data: Driver private data
> - * reg_ops: Functions to read/write registers
> - * clk: Our parent clock, if present
> - * baud: The baud rate configured when this device was synthesized
> - * cflags: The cflags for parity and data bits
> + * struct uartlite_data - Driver private data
> + * @reg_ops: Functions to read/write registers
> + * @clk: Our parent clock, if present
> + * @baud: The baud rate configured when this device was synthesized
> + * @cflags: The cflags for parity and data bits
>   */
>  struct uartlite_data {
>  	const struct uartlite_reg_ops *reg_ops;

FYI: this is a duplicate of https://lore.kernel.org/all/20231106152428.3641883-1-sean.anderson@seco.com/