Re: rcu kernel-doc issues (4.14-rc1)

From: Markus Heiser
Date: Mon Sep 18 2017 - 03:30:20 EST



> Am 18.09.2017 um 04:40 schrieb Paul E. McKenney <paulmck@xxxxxxxxxxxxxxxxxx>:
[...]
> And after some playing around, I did get rid of the error messages.
> The code-block output looks a bit strange though, hints? I preceded
> the code block with "::", again at Akira's suggestion. It looks fine
> except for the :c:func: and backquotes on the first and last lines.
>
> Thanx, Paul
>
> ------------------------------------------------------------------------
>
> :c:func:`rcu_read_lock()`;
> p = rcu_dereference(gp);
> long_lived = is_long_lived(p);
> if (long_lived) {
> if (!atomic_inc_not_zero(p->refcnt))
> long_lived = false;
> else
> p = rcu_pointer_handoff(p);
> }
> :c:func:`rcu_read_unlock()`;

FYI:

such replacements in code-blocks are comming from the "Highlights
and cross-references" see:

https://www.kernel.org/doc/html/latest/doc-guide/kernel-doc.html#highlights-and-cross-references

and this is still a bug in the kernel-doc parser:

https://www.mail-archive.com/linux-doc@xxxxxxxxxxxxxxx/msg14409.html

-- Markus --