Re: [PATCH] platform/x86: dell-wmi: Add a comment explaining the 0xb2 magic number

[Darren Hart <dvhart@infradead.org>]

On Sat, May 27, 2017 at 12:51:36PM +0200, Pali Rohár wrote:
> On Saturday 27 May 2017 07:15:28 Darren Hart wrote:
> > From: Andy Lutomirski <luto@kernel.org>
> > 
> > The hotkey table is 0xb2, add a comment for clarity.
> > 
> > Suggested-by: Darren Hart <dvhart@infradead.org>
> > Signed-off-by: Andy Lutomirski <luto@kernel.org>
> > Cc: Matthew Garrett <mjg59@srcf.ucam.org>
> > Cc: "Pali Rohár" <pali.rohar@gmail.com>
> > Cc: Andy Shevchenko <andy@infradead.org>
> > Signed-off-by: Darren Hart (VMware) <dvhart@infradead.org>
> > ---
> >  drivers/platform/x86/dell-wmi.c | 1 +
> >  1 file changed, 1 insertion(+)
> > 
> > diff --git a/drivers/platform/x86/dell-wmi.c
> > b/drivers/platform/x86/dell-wmi.c index 8a64c79..24467b1 100644
> > --- a/drivers/platform/x86/dell-wmi.c
> > +++ b/drivers/platform/x86/dell-wmi.c
> > @@ -449,6 +449,7 @@ static void __init handle_dmi_entry(const struct
> > dmi_header *dm, if (results->err || results->keymap)
> >  		return;		/* We already found the hotkey table. */
> > 
> > +	/* The Dell hotkey table is type 0xB2.  Scan until we find it. */
> >  	if (dm->type != 0xb2)
> >  		return;
> 
> Good. Reviewed-by: Pali Rohár <pali.rohar@gmail.com>
> 
> (Maybe in future we should add a #define name for such magic constants)

Thanks for the review.

A define is most useful, in my opinion, when the magic number is required
multiple times, as it avoids human error and avoids maintenance issues when
updated, etc. I'm not necessarily opposed, but I didn't think it was necessary
in this case.

-- 
Darren Hart
VMware Open Source Technology Center