[PATCH] drm/doc: Switch to sphinx/rst fixed-width quoting

[Jani Nikula]

On Wed, 01 Jun 2016, Daniel Vetter <daniel.vetter at ffwll.ch> wrote:
> On Wed, Jun 1, 2016 at 11:46 AM, Jani Nikula
> <jani.nikula at linux.intel.com> wrote:
>> On Wed, 01 Jun 2016, Daniel Vetter <daniel.vetter at 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



BR,
Jani.



-- 
Jani Nikula, Intel Open Source Technology Center