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

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-Id: <5651996D-F075-48A5-BC3A-9FE0537824A6@darmarit.de>
Date:   Mon, 18 Sep 2017 09:30:01 +0200
From:   Markus Heiser <markus.heiser@...marit.de>
To:     "Paul E. McKenney" <paulmck@...ux.vnet.ibm.com>,
        Jonathan Corbet <corbet@....net>
Cc:     Randy Dunlap <rdunlap@...radead.org>,
        LKML <linux-kernel@...r.kernel.org>,
        Linux Doc Mailing List <linux-doc@...r.kernel.org>
Subject: Re: rcu kernel-doc issues (4.14-rc1)


> Am 18.09.2017 um 04:40 schrieb Paul E. McKenney <paulmck@...ux.vnet.ibm.com>:
[...]
> 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@vger.kernel.org/msg14409.html

-- Markus --