Re: ReST questions

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On Sun, 22 Oct 2017, Randy Dunlap <rdunlap@xxxxxxxxxxxxx> wrote:
> (2) It wants to preface each "function" in the "art" with ":c:func:" and put
> back-quote marks around each function name, like `finish()`.  That makes the ASCII art
> unreadable.
>
> I have tried :: by itself and .. code-block:: none
> without success.
>
> Is there a way to prevent this :c:func: enhancing?

That's a hard one, I'm afraid. We do the substitutions in kernel-doc the
perl script, at a level where we don't want to parse reStructuredText to
figure out where the substitutions are fine and where they're
not. Worse, we don't even have any way to escape them.

The right fix would be to remove the substitutions from kernel-doc the
perl script altogether, and apply them after all the reStructuredText
parsing is done, where we have access to the doctree structures
[1]. Then we could be smarter about where we change them to
cross-references. We wouldn't be doing simple regexp conversions, we'd
be wrapping pieces of text in doctree reference nodes. I think it should
even be possible to complain about references to non-existing targets.

SMOP.


BR,
Jani.


[1] http://docutils.sourceforge.net/docs/ref/doctree.html


-- 
Jani Nikula, Intel Open Source Technology Center
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html



[Index of Archives]     [Kernel Newbies]     [Security]     [Netfilter]     [Bugtraq]     [Linux FS]     [Yosemite Forum]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Samba]     [Video 4 Linux]     [Device Mapper]     [Linux Resources]

  Powered by Linux