From: Daniel Vetter <daniel@ffwll.ch>
To: Jani Nikula <jani.nikula@linux.intel.com>
Cc: Daniel Vetter <daniel.vetter@ffwll.ch>,
DRI Development <dri-devel@lists.freedesktop.org>,
Daniel Vetter <daniel.vetter@intel.com>
Subject: Re: [PATCH] drm/doc: Switch to sphinx/rst fixed-width quoting
Date: Wed, 1 Jun 2016 16:44:15 +0200 [thread overview]
Message-ID: <20160601144415.GY7231@phenom.ffwll.local> (raw)
In-Reply-To: <8760tt9g4d.fsf@intel.com>
On Wed, Jun 01, 2016 at 04:46:10PM +0300, Jani Nikula wrote:
> On Wed, 01 Jun 2016, Daniel Vetter <daniel.vetter@ffwll.ch> wrote:
> > On Wed, Jun 1, 2016 at 11:46 AM, Jani Nikula
> > <jani.nikula@linux.intel.com> wrote:
> >> On Wed, 01 Jun 2016, Daniel Vetter <daniel.vetter@ffwll.ch> wrote:
> >>> There's still something very fishy going on with some of these, e.g.
> >>> the drm_modeset_lock Example: and the "Standard GTF Parameters:" Line
> >>> somehow get treated as heading when just appending a :: at the end of
> >>> those lines. But it seems to work everywhere else. Maybe the
> >>> kernel-doc heading generation logic is still a bit wonky?
> >>
> >> Try adding a blank line between the line with trailing :: and the actual
> >> preformatted text. Seems to do the right thing for me.
> >>
> >> http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#literal-blocks
> >>
> >> "Blank lines are required before and after a literal block, but these
> >> blank lines are not included as part of the literal block."
> >
> > That's not what I've meant. The following sometimes (but not always,
> > only in the 2 places I've mentioned) becomes a kernel-doc directive
>
> What do you mean by "kernel-doc directive" exactly?
>
> > and not a block quote:
> >
> > * Standard GTF Parameters::
> > *
> > * stuff I wanted to have block quoted.
> >
> > But if I switch the :: to be on a line of it's own (like in the patch)
> > it's totally fine.
>
> Odd. It does seem to work for me. What does this print near there?
>
> $ scripts/kernel-doc -rst -function drm_gtf_mode drivers/gpu/drm/drm_modes.c
Tried again, it works now. Probably fixed through some rebasing and me
being on an older version of your toolchain. I'll send out v3.
-Daniel
--
Daniel Vetter
Software Engineer, Intel Corporation
http://blog.ffwll.ch
_______________________________________________
dri-devel mailing list
dri-devel@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/dri-devel
next prev parent reply other threads:[~2016-06-01 14:44 UTC|newest]
Thread overview: 20+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-05-31 21:11 [PATCH 1/6] drm/doc: Update kerneldoc for drm_crtc.h Daniel Vetter
2016-05-31 21:11 ` [PATCH 2/6] drm/atomic-helper: Fixup kerneldoc for drm_atomic_helper_legacy_gamma_set Daniel Vetter
2016-05-31 21:11 ` [PATCH 3/6] drm/doc: Improve kernel-doc for drm_fb_cma_helper.c Daniel Vetter
2016-06-02 14:31 ` Liviu Dudau
2016-06-02 22:15 ` Laurent Pinchart
2016-05-31 21:11 ` [PATCH 4/6] drm/gpu.tmpl: Don't forget to rename the include directives, too Daniel Vetter
2016-06-02 13:52 ` Jani Nikula
2016-06-02 14:28 ` Daniel Vetter
2016-05-31 21:11 ` [PATCH 5/6] drm/doc: Drop kerneldoc for static functions in drm_irq.c Daniel Vetter
2016-05-31 21:11 ` [PATCH 6/6] drm/doc: Switch to sphinx/rst fixed-width quoting Daniel Vetter
2016-06-01 8:46 ` [PATCH] " Daniel Vetter
2016-06-01 9:46 ` Jani Nikula
2016-06-01 13:33 ` Daniel Vetter
2016-06-01 13:46 ` Jani Nikula
2016-06-01 14:44 ` Daniel Vetter [this message]
2016-06-02 14:29 ` Daniel Vetter
2016-06-02 13:50 ` [PATCH 1/6] drm/doc: Update kerneldoc for drm_crtc.h Jani Nikula
2016-06-02 14:28 ` Liviu Dudau
[not found] <890e1aabffc12303f8c110aa5686ad51b01eed6b>
2016-06-01 14:44 ` [PATCH] drm/doc: Switch to sphinx/rst fixed-width quoting Daniel Vetter
2016-06-06 7:10 ` 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=20160601144415.GY7231@phenom.ffwll.local \
--to=daniel@ffwll.ch \
--cc=daniel.vetter@ffwll.ch \
--cc=daniel.vetter@intel.com \
--cc=dri-devel@lists.freedesktop.org \
--cc=jani.nikula@linux.intel.com \
/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