Re: [PATCH v3] ieee80211: Print human-readable disassoc/deauth reason codes

[Calvin Owens <jcalvinowens@gmail.com>]

On Tuesday 02/11 at 17:48 +0100, Antonio Quartulli wrote:
> On 11/02/14 17:37, Calvin Owens wrote:
> > Create a function to return a descriptive string for each reason code,
> > and print that in addition to the numeric value in the kernel log. These
> > codes are easily found on popular search engines, but one is generally
> > not able to access the internet when dealing with wireless connectivity
> > issues.
> > 
> > Changes in v2: Refactored array of strings into switch statement.
> > Changes in v3: Fix style problem, use simplifying macro for switch
> > statement, eliminate temporary enum variable.
> > 
> > Signed-off-by: Calvin Owens <jcalvinowens@gmail.com>
> > ---
> >  include/net/mac80211.h | 10 +++++++++
> >  net/mac80211/main.c    | 57 ++++++++++++++++++++++++++++++++++++++++++++++++++
> >  net/mac80211/mlme.c    | 12 +++++------
> >  3 files changed, 73 insertions(+), 6 deletions(-)
> > 
> > diff --git a/include/net/mac80211.h b/include/net/mac80211.h
> > index f4ab2fb..d18acfe 100644
> > --- a/include/net/mac80211.h
> > +++ b/include/net/mac80211.h
> > @@ -2971,6 +2971,16 @@ struct ieee80211_ops {
> >   */
> >  struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len,
> >  					const struct ieee80211_ops *ops);
> > +/**
> > + * ieee80211_get_reason_code_string - Get human readable reason code
> > + *
> > + * This function returns a string describing the @reason_code.
> > + *
> > + * @reason_code: Reason code
> 
> Kerneldoc is not properly formatted here.
> The "@argument:" clause should be on the line right after the function
> name (as explained in Documentation/kernel-doc-nano-HOWTO.txt), e.g.:
> 
> /**
>  * function_name - blabla
>  * @arg: I am a good arg description
>  *

I actually just copied the comment format above the functions
surrounding the one I added, several of which also appear to be
incorrectly formatted. I can submit a patch to fix those as well if you
like: is it worth the trouble?

Thanks,
Calvin

> Cheers,
> 
> -- 
> Antonio Quartulli
>