linux-kernel - Re: [PATCH 32/35] staging: lustre: mount: fix lmd_parse() to handle commas in expr

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Date:   Fri, 18 Nov 2016 18:14:26 +0100
From:   Greg Kroah-Hartman <gregkh@...uxfoundation.org>
To:     James Simmons <jsimmons@...radead.org>
Cc:     devel@...verdev.osuosl.org,
        Andreas Dilger <andreas.dilger@...el.com>,
        Linux Kernel Mailing List <linux-kernel@...r.kernel.org>,
        Jian Yu <jian.yu@...el.com>,
        Oleg Drokin <oleg.drokin@...el.com>,
        Lustre Development List <lustre-devel@...ts.lustre.org>
Subject: Re: [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