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: <20170918142109.GH3521@linux.vnet.ibm.com>
Date:   Mon, 18 Sep 2017 07:21:09 -0700
From:   "Paul E. McKenney" <paulmck@...ux.vnet.ibm.com>
To:     Markus Heiser <markus.heiser@...marit.de>
Cc:     Jonathan Corbet <corbet@....net>,
        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)

On Mon, Sep 18, 2017 at 09:30:01AM +0200, Markus Heiser wrote:
> 
> > 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

Thank you for the pointer!  I will try it out.  Except that v4.14-rc1
apparently needs a later version of sphinx...

							Thanx, Paul