lkml.org 
[lkml]   [2016]   [Nov]   [18]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
Patch in this message
/
Date
From
SubjectRe: [PATCH 32/35] staging: lustre: mount: fix lmd_parse() to handle commas in expr_list
On Fri, Nov 18, 2016 at 04:54:03PM +0000, James Simmons wrote:
>
> > > --- a/drivers/staging/lustre/lustre/obdclass/obd_mount.c
> > > +++ b/drivers/staging/lustre/lustre/obdclass/obd_mount.c
> > > @@ -871,6 +871,87 @@ static int lmd_parse_mgs(struct lustre_mount_data *lmd, char **ptr)
> > > return 0;
> > > }
> > >
> > > +/**
> > > + * Find the first comma delimiter from the specified \a buf and make \a *endh
> > > + * point to the string starting with the comma. The commas in expression list
> > > + * [...] will be skipped.
> > > + *
> > > + * \param[in] buf a comma-separated string
> > > + * \param[in] endh a pointer to a pointer that will point to the string
> > > + * starting with the comma
> >
> > Please drop this mess of \param, it's not needed and is not kernel-doc
> > format.
>
> Is it just the [in] mess that needs to be removed or does the doc style
> need to migrate to another format. Looking online doesn't reveal much and'
> I saw something about @arg format as well. I see both in tree. What is the
> right one to use and do clear docs on this format exist somewhere.

@arg is the correct one, see the file
Documentation/kernel-documentation.rst in the section, "How to format
kernel-doc comments" for how to do this properly.

thanks,

greg k-h

\
 
 \ /
  Last update: 2016-11-18 18:14    [W:0.048 / U:0.684 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site