[PATCH] tty/n_hdlc: Fix struct n_hdlc kernel-doc warnings

[PATCH] tty/n_hdlc: Fix struct n_hdlc kernel-doc warnings

[Bartlomiej Kubik]

Add missing descriptions for write_work and tty_for_write_work
members in struct n_hdlc.

This fixes the following warnings:
drivers/tty/n_hdlc.c: warning: Function parameter or member
  			       'write_work' not described in 'n_hdlc'
drivers/tty/n_hdlc.c: warning: Function parameter or member
  			       'tty_for_write_work' not described in 'n_hdlc'

Signed-off-by: Bartlomiej Kubik <kubik.bartlomiej@gmail.com>
---
 drivers/tty/n_hdlc.c | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/drivers/tty/n_hdlc.c b/drivers/tty/n_hdlc.c
index 4a4dc58b866a..ac0605ac9d46 100644
--- a/drivers/tty/n_hdlc.c
+++ b/drivers/tty/n_hdlc.c
@@ -127,6 +127,8 @@ struct n_hdlc_buf_list {
  * @rx_buf_list: list of received frame buffers
  * @tx_free_buf_list: list unused transmit frame buffers
  * @rx_free_buf_list: list unused received frame buffers
+ * @write_work: work struct for deferred frame transmission
+ * @tty_for_write_work: pointer to tty instance used by the @write_work
  */
 struct n_hdlc {
 	bool			tbusy;
--
2.39.5

Re: [PATCH] tty/n_hdlc: Fix struct n_hdlc kernel-doc warnings

[Bartłomiej Kubik]

Hi,

I submitted this patch about two weeks ago but haven't received any
feedback yet.
I wanted to check if there are any concerns with the patch or if any
changes are needed.

Please let me know if you need any additional information.

Best regards
Bartłomiej Kubik

On Tue, 2 Dec 2025 at 07:38, Bartlomiej Kubik
<kubik.bartlomiej@gmail.com> wrote:
>
> Add missing descriptions for write_work and tty_for_write_work
> members in struct n_hdlc.
>
> This fixes the following warnings:
> drivers/tty/n_hdlc.c: warning: Function parameter or member
>                                'write_work' not described in 'n_hdlc'
> drivers/tty/n_hdlc.c: warning: Function parameter or member
>                                'tty_for_write_work' not described in 'n_hdlc'
>
> Signed-off-by: Bartlomiej Kubik <kubik.bartlomiej@gmail.com>
> ---
>  drivers/tty/n_hdlc.c | 2 ++
>  1 file changed, 2 insertions(+)
>
> diff --git a/drivers/tty/n_hdlc.c b/drivers/tty/n_hdlc.c
> index 4a4dc58b866a..ac0605ac9d46 100644
> --- a/drivers/tty/n_hdlc.c
> +++ b/drivers/tty/n_hdlc.c
> @@ -127,6 +127,8 @@ struct n_hdlc_buf_list {
>   * @rx_buf_list: list of received frame buffers
>   * @tx_free_buf_list: list unused transmit frame buffers
>   * @rx_free_buf_list: list unused received frame buffers
> + * @write_work: work struct for deferred frame transmission
> + * @tty_for_write_work: pointer to tty instance used by the @write_work
>   */
>  struct n_hdlc {
>         bool                    tbusy;
> --
> 2.39.5
>

Re: [PATCH] tty/n_hdlc: Fix struct n_hdlc kernel-doc warnings

[Greg KH]

On Wed, Dec 17, 2025 at 08:35:56AM +0100, Bartłomiej Kubik wrote:
> Hi,
> 
> I submitted this patch about two weeks ago but haven't received any
> feedback yet.
> I wanted to check if there are any concerns with the patch or if any
> changes are needed.
> 
> Please let me know if you need any additional information.

Please relax, it was the middle of the merge window and just now -rc1 is
out.  Give us a few weeks to catch up, especially for minor things like
documentation issues.

In the meantime, please help out by reviewing other patch submissions to
help make the review load easier on us all and cause your change to move
up the queue.

thanks,

greg k-h