[PATCH] efi: stmm: fix kernel-doc "bad line" warnings

[PATCH] efi: stmm: fix kernel-doc "bad line" warnings

[Randy Dunlap]

Add a beginning " *" to each line to avoid kernel-doc warnings:

Warning: drivers/firmware/efi/stmm/mm_communication.h:34 bad line: 
Warning: drivers/firmware/efi/stmm/mm_communication.h:113 bad line: 
Warning: drivers/firmware/efi/stmm/mm_communication.h:130 bad line: 

Fixes: c44b6be62e8d ("efi: Add tee-based EFI variable driver")
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
Cc: Ard Biesheuvel <ardb@kernel.org>
Cc: linux-efi@vger.kernel.org
Cc: linux-arm-kernel@lists.infradead.org
Cc: Maxime Coquelin <mcoquelin.stm32@gmail.com>
Cc: Alexandre Torgue <alexandre.torgue@foss.st.com>
---
 drivers/firmware/efi/stmm/mm_communication.h |    6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

--- linux-next-20251107.orig/drivers/firmware/efi/stmm/mm_communication.h
+++ linux-next-20251107/drivers/firmware/efi/stmm/mm_communication.h
@@ -32,7 +32,7 @@
 
 /**
  * struct efi_mm_communicate_header - Header used for SMM variable communication
-
+ *
  * @header_guid:  header use for disambiguation of content
  * @message_len:  length of the message. Does not include the size of the
  *                header
@@ -111,7 +111,7 @@ struct efi_mm_communicate_header {
 
 /**
  * struct smm_variable_communicate_header - Used for SMM variable communication
-
+ *
  * @function:     function to call in Smm.
  * @ret_status:   return status
  * @data:         payload
@@ -128,7 +128,7 @@ struct smm_variable_communicate_header {
 /**
  * struct smm_variable_access - Used to communicate with StMM by
  *                              SetVariable and GetVariable.
-
+ *
  * @guid:         vendor GUID
  * @data_size:    size of EFI variable data
  * @name_size:    size of EFI name

Re: [PATCH] efi: stmm: fix kernel-doc "bad line" warnings

[Ilias Apalodimas]

Hi Randy

On Tue, 11 Nov 2025 at 08:02, Randy Dunlap <rdunlap@infradead.org> wrote:
>
> Add a beginning " *" to each line to avoid kernel-doc warnings:
>
> Warning: drivers/firmware/efi/stmm/mm_communication.h:34 bad line:
> Warning: drivers/firmware/efi/stmm/mm_communication.h:113 bad line:
> Warning: drivers/firmware/efi/stmm/mm_communication.h:130 bad line:
>
> Fixes: c44b6be62e8d ("efi: Add tee-based EFI variable driver")
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>

Is the fixes tag necessary here?
Acked-by: Ilias Apalodimas <ilias.apalodimas@linaro.org>

Thanks
/Ilias
> ---
> Cc: Ard Biesheuvel <ardb@kernel.org>
> Cc: linux-efi@vger.kernel.org
> Cc: linux-arm-kernel@lists.infradead.org
> Cc: Maxime Coquelin <mcoquelin.stm32@gmail.com>
> Cc: Alexandre Torgue <alexandre.torgue@foss.st.com>
> ---
>  drivers/firmware/efi/stmm/mm_communication.h |    6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
>
> --- linux-next-20251107.orig/drivers/firmware/efi/stmm/mm_communication.h
> +++ linux-next-20251107/drivers/firmware/efi/stmm/mm_communication.h
> @@ -32,7 +32,7 @@
>
>  /**
>   * struct efi_mm_communicate_header - Header used for SMM variable communication
> -
> + *
>   * @header_guid:  header use for disambiguation of content
>   * @message_len:  length of the message. Does not include the size of the
>   *                header
> @@ -111,7 +111,7 @@ struct efi_mm_communicate_header {
>
>  /**
>   * struct smm_variable_communicate_header - Used for SMM variable communication
> -
> + *
>   * @function:     function to call in Smm.
>   * @ret_status:   return status
>   * @data:         payload
> @@ -128,7 +128,7 @@ struct smm_variable_communicate_header {
>  /**
>   * struct smm_variable_access - Used to communicate with StMM by
>   *                              SetVariable and GetVariable.
> -
> + *
>   * @guid:         vendor GUID
>   * @data_size:    size of EFI variable data
>   * @name_size:    size of EFI name
>

Re: [PATCH] efi: stmm: fix kernel-doc "bad line" warnings

[Ard Biesheuvel]

On Tue, 11 Nov 2025 at 09:50, Ilias Apalodimas
<ilias.apalodimas@linaro.org> wrote:
>
> Hi Randy
>
> On Tue, 11 Nov 2025 at 08:02, Randy Dunlap <rdunlap@infradead.org> wrote:
> >
> > Add a beginning " *" to each line to avoid kernel-doc warnings:
> >
> > Warning: drivers/firmware/efi/stmm/mm_communication.h:34 bad line:
> > Warning: drivers/firmware/efi/stmm/mm_communication.h:113 bad line:
> > Warning: drivers/firmware/efi/stmm/mm_communication.h:130 bad line:
> >
> > Fixes: c44b6be62e8d ("efi: Add tee-based EFI variable driver")
> > Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
>
> Acked-by: Ilias Apalodimas <ilias.apalodimas@linaro.org>
>

Thanks! Queued up now.

> Is the fixes tag necessary here?

I'll keep it as it doesn't do any harm, and it makes the stable tree
doc build a bit less noisy I guess.