From: Mike Rapoport <rppt@linux.vnet.ibm.com>
To: Matthew Wilcox <willy@infradead.org>
Cc: Jonathan Corbet <corbet@lwn.net>,
Jani Nikula <jani.nikula@intel.com>,
linux-doc <linux-doc@vger.kernel.org>
Subject: Re: [PATCH v3 1/2] Documentation/sphinx: allow "functions" with no parameters
Date: Sat, 30 Jun 2018 17:59:27 +0300 [thread overview]
Message-ID: <20180630145927.GA18999@rapoport-lnx> (raw)
In-Reply-To: <20180630112156.GK7646@bombadil.infradead.org>
On Sat, Jun 30, 2018 at 04:21:56AM -0700, Matthew Wilcox wrote:
> On Sat, Jun 30, 2018 at 12:05:10AM +0300, Mike Rapoport wrote:
> > @@ -488,14 +488,19 @@ doc: *title*
> > .. kernel-doc:: drivers/gpu/drm/i915/intel_audio.c
> > :doc: High Definition Audio over HDMI and Display Port
> >
> > -functions: *function* *[...]*
> > +functions: *[ function ...]*
> > Include documentation for each *function* in *source*.
> > + If no *function* if specified, the documentaion for all functions
>
> "is specified". "documentation".
>
> > - Example::
> > + Examples::
> >
> > .. kernel-doc:: lib/bitmap.c
> > :functions: bitmap_parselist bitmap_parselist_user
> >
> > + .. kernel-doc:: lib/idr.c
> > + :functions:
>
> Is this the right syntax? Should we rather have:
>
> .. kernel-doc:: lib/idr.c
> :functions: *
IMHO :functions: with no parameters is simpler.
--
Sincerely yours,
Mike.
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at http://vger.kernel.org/majordomo-info.html
next prev parent reply other threads:[~2018-06-30 14:59 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-06-29 21:05 [PATCH v3 0/2] Documentation/sphinx: add kind of "nodocs" directive Mike Rapoport
2018-06-29 21:05 ` [PATCH v3 1/2] Documentation/sphinx: allow "functions" with no parameters Mike Rapoport
2018-06-30 11:21 ` Matthew Wilcox
2018-06-30 14:59 ` Mike Rapoport [this message]
2018-06-30 15:33 ` Jonathan Corbet
2018-06-29 21:05 ` [PATCH v3 2/2] docs/idr: use empty "functions" directive Mike Rapoport
2018-06-29 21:07 ` [PATCH v3 0/2] Documentation/sphinx: add kind of "nodocs" directive Jonathan Corbet
2018-06-30 13:56 ` Jonathan Corbet
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=20180630145927.GA18999@rapoport-lnx \
--to=rppt@linux.vnet.ibm.com \
--cc=corbet@lwn.net \
--cc=jani.nikula@intel.com \
--cc=linux-doc@vger.kernel.org \
--cc=willy@infradead.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