Re: [PATCH] ACPI: PRM: Fix missing guid_t declaration in linux/prmt.h

[Yazen Ghannam]

On Thu, Jan 09, 2025 at 12:43:09PM +0100, Robert Richter wrote:
> Yazen,
> 
> On 08.01.25 10:10:37, Yazen Ghannam wrote:
> > On Tue, Jan 07, 2025 at 05:19:22PM +0100, Robert Richter wrote:
> > > Seen the following build error:
> > > 
> > >  ./include/linux/prmt.h:5:27: error: unknown type name ‘guid_t’
> > >      5 | int acpi_call_prm_handler(guid_t handler_guid, void *param_buffer);
> > >        |                           ^~~~~~
> > > 
> > > The include file uses guid_t but it is not declared. Include
> > > linux/uuid.h to fix this.
> > > 
> > > Cc: Yazen Ghannam <Yazen.Ghannam@xxxxxxx>
> > > Cc: John Allen <john.allen@xxxxxxx>
> > > Cc: Borislav Petkov (AMD) <bp@xxxxxxxxx>
> > > Signed-off-by: Robert Richter <rrichter@xxxxxxx>

Reviewed-by: Yazen Ghannam <yazen.ghannam@xxxxxxx>

> > > ---
> > >  include/linux/prmt.h | 2 ++
> > >  1 file changed, 2 insertions(+)
> > > 
> > > diff --git a/include/linux/prmt.h b/include/linux/prmt.h
> > > index 9c094294403f..c53ab287e932 100644
> > > --- a/include/linux/prmt.h
> > > +++ b/include/linux/prmt.h
> > > @@ -1,5 +1,7 @@
> > >  /* SPDX-License-Identifier: GPL-2.0-only */
> > >  
> > > +#include <linux/uuid.h>
> > > +
> > >  #ifdef CONFIG_ACPI_PRMT
> > >  void init_prmt(void);
> > >  int acpi_call_prm_handler(guid_t handler_guid, void *param_buffer);
> > > -- 
> > 
> > Hi Robert,
> > 
> > This looks correct. But can you please share how you've encountered the
> > issue?
> 
> sure, I have used it here:
> 
>  https://lore.kernel.org/all/20250107141015.3367194-26-rrichter@xxxxxxx/
> 
> I just included linux/prmt.h to get the declaration of
> acpi_call_prm_handler() without anything else. I assume other users of
> linux/prmt.h indirectly include linux/uuid.h with some other include
> file.
> 

Thanks Robert. This reminded me of a rule, but it took me a bit to find
it again.

Documentation/process/submit-checklist.rst -> "Review your code" #1

I wonder: is there a script, coccinelle test, or something that will
catch this in case we forget?

Thanks,
Yazen