Re: [PATCH] device_cgroup: fix the comment format for recently added functions

Aristeu Rozanski
2014-05-02T15:49:59Z

Hi Tejun,
On Fri, May 02, 2014 at 11:30:28AM -0400, Tejun Heo wrote:
> On Thu, Apr 24, 2014 at 03:33:21PM -0400, Aristeu Rozanski wrote:
> > @@ -306,17 +306,17 @@ static int devcgroup_seq_show(struct seq_file *m, void *v)
> > }
> >
> > /**
> > - * match_exception - iterates the exception list trying to match a rule
> > - * based on type, major, minor and access type. It is
> > - * considered a match if an exception is found that
> > - * will contain the entire range of provided parameters.
> > + * match_exception - iterates the exception list trying to find a complete match
> > * @exceptions: list of exceptions
> > * @type: device type (DEV_BLOCK or DEV_CHAR)
> > * @major: device file major number, ~0 to match all
> > * @minor: device file minor number, ~0 to match all
> > * @access: permission mask (ACC_READ, ACC_WRITE, ACC_MKNOD)
> > *
> > - * returns: true in case it matches an exception completely
> > + * It is considered a complete match if an exception is found that will
> > + * contain the entire range of provided parameters.
> > + *
> > + * Return: true in case it matches an exception completely
>
> Can you just merge "Return: " section into the paragraph? Just go
> "Returns true blah blah".

That goes against Documentation/kernel-doc-nano-HOWTO.txt.

--
Aristeu