public inbox for cgroups@vger.kernel.org
 help / color / mirror / Atom feed
From: Aristeu Rozanski <aris-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org>
To: Tejun Heo <tj-DgEjT+Ai2ygdnm+yROfE0A@public.gmane.org>
Cc: cgroups-u79uwXL29TY76Z2rM5mHXA@public.gmane.org,
	Serge Hallyn
	<serge.hallyn-Z7WLFzj8eWMS+FvcfC7Uqw@public.gmane.org>,
	Li Zefan <lizefan-hv44wF8Li93QT0dZR+AlfA@public.gmane.org>
Subject: Re: [PATCH] device_cgroup: fix the comment format for recently added functions
Date: Fri, 2 May 2014 11:49:59 -0400	[thread overview]
Message-ID: <20140502154959.GH29214@redhat.com> (raw)
In-Reply-To: <20140502153028.GG10204-Gd/HAXX7CRxy/B6EtB590w@public.gmane.org>

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

  parent reply	other threads:[~2014-05-02 15:49 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2014-04-24 19:33 [PATCH] device_cgroup: fix the comment format for recently added functions Aristeu Rozanski
     [not found] ` <20140424193321.GS29214-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org>
2014-04-28 20:31   ` Serge Hallyn
2014-05-02 15:30   ` Tejun Heo
     [not found]     ` <20140502153028.GG10204-Gd/HAXX7CRxy/B6EtB590w@public.gmane.org>
2014-05-02 15:49       ` Aristeu Rozanski [this message]
     [not found]         ` <20140502154959.GH29214-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org>
2014-05-04 19:19           ` Tejun Heo
2014-05-04 19:21   ` Tejun Heo

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20140502154959.GH29214@redhat.com \
    --to=aris-h+wxahxf7alqt0dzr+alfa@public.gmane.org \
    --cc=cgroups-u79uwXL29TY76Z2rM5mHXA@public.gmane.org \
    --cc=lizefan-hv44wF8Li93QT0dZR+AlfA@public.gmane.org \
    --cc=serge.hallyn-Z7WLFzj8eWMS+FvcfC7Uqw@public.gmane.org \
    --cc=tj-DgEjT+Ai2ygdnm+yROfE0A@public.gmane.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox