From: Jani Nikula <jani.nikula@linux.intel.com>
To: Daniel Vetter <daniel@ffwll.ch>, Robert Bragg <robert@sixbynine.org>
Cc: Daniel Vetter <daniel.vetter@ffwll.ch>, intel-gfx@lists.freedesktop.org
Subject: Re: [PATCH] drm/i915/perf: More documentation hooked to i915.rst
Date: Thu, 01 Dec 2016 14:12:33 +0200 [thread overview]
Message-ID: <87wpfjx2z2.fsf@intel.com> (raw)
In-Reply-To: <20161130194127.gjmbwht2apmwcecm@phenom.ffwll.local>
On Wed, 30 Nov 2016, Daniel Vetter <daniel@ffwll.ch> wrote:
> On Tue, Nov 29, 2016 at 05:00:55PM +0000, Robert Bragg wrote:
>> +.. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
>> + :functions: i915_perf_init
>> +.. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
>> + :functions: i915_perf_fini
>> +.. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
>> + :functions: i915_perf_register
>> +.. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
>> + :functions: i915_perf_unregister
>> +.. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
>> + :functions: i915_perf_open_ioctl
>> +.. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
>> + :functions: i915_perf_release
>
> One potential issue with listing everything explicitly is that if someone
> ever (and this is bound to happen) adds a new function, they'll forget to
> add it. Hence we just pull them all in, and if you want to refernce some
> specifically, do that in the overview sections.
One real issue with listing everything separately is that kernel-doc
parses the source file once per every kernel-doc directive.
Also, doesn't Sphinx complain about not having a blank line to end the
indented block after the directive? It might not, but I thought it
might.
BR,
Jani.
--
Jani Nikula, Intel Open Source Technology Center
_______________________________________________
Intel-gfx mailing list
Intel-gfx@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/intel-gfx
next prev parent reply other threads:[~2016-12-01 12:12 UTC|newest]
Thread overview: 15+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-11-29 17:00 [PATCH] drm/i915/perf: More documentation hooked to i915.rst Robert Bragg
2016-11-29 20:45 ` ✗ Fi.CI.BAT: warning for " Patchwork
2016-11-29 20:52 ` Saarinen, Jani
2016-11-30 16:30 ` [PATCH] " Matthew Auld
2016-11-30 19:41 ` Daniel Vetter
2016-12-01 12:12 ` Jani Nikula [this message]
2016-12-02 15:17 ` Robert Bragg
2016-12-02 15:05 ` Robert Bragg
-- strict thread matches above, loose matches on Subject: below --
2016-12-05 11:20 Robert Bragg
2016-12-05 12:16 ` Matthew Auld
2016-12-07 21:40 ` Robert Bragg
2016-12-08 15:53 ` Daniel Vetter
2016-12-09 12:41 ` Robert Bragg
2016-12-12 7:34 ` Daniel Vetter
2016-12-12 10:00 ` Jani Nikula
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=87wpfjx2z2.fsf@intel.com \
--to=jani.nikula@linux.intel.com \
--cc=daniel.vetter@ffwll.ch \
--cc=daniel@ffwll.ch \
--cc=intel-gfx@lists.freedesktop.org \
--cc=robert@sixbynine.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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.