public inbox for linux-kernel@vger.kernel.org
 help / color / mirror / Atom feed
From: "Paul E. McKenney" <paulmck@linux.vnet.ibm.com>
To: Markus Heiser <markus.heiser@darmarit.de>
Cc: Jonathan Corbet <corbet@lwn.net>,
	Randy Dunlap <rdunlap@infradead.org>,
	LKML <linux-kernel@vger.kernel.org>,
	Linux Doc Mailing List <linux-doc@vger.kernel.org>
Subject: Re: rcu kernel-doc issues (4.14-rc1)
Date: Mon, 18 Sep 2017 07:21:09 -0700	[thread overview]
Message-ID: <20170918142109.GH3521@linux.vnet.ibm.com> (raw)
In-Reply-To: <5651996D-F075-48A5-BC3A-9FE0537824A6@darmarit.de>

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@linux.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

  reply	other threads:[~2017-09-18 14:21 UTC|newest]

Thread overview: 20+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-09-17  1:26 rcu kernel-doc issues (4.14-rc1) Randy Dunlap
2017-09-17  4:41 ` Paul E. McKenney
2017-09-17 17:47   ` Paul E. McKenney
2017-09-17 17:57     ` Randy Dunlap
2017-09-17 19:49       ` Paul E. McKenney
2017-09-18  2:40         ` Paul E. McKenney
2017-09-18  7:30           ` Markus Heiser
2017-09-18 14:21             ` Paul E. McKenney [this message]
2017-10-16 19:58         ` Randy Dunlap
2017-10-16 20:07           ` Paul E. McKenney
2017-10-16 20:18             ` Randy Dunlap
2017-10-16 20:26               ` Paul E. McKenney
2017-10-16 21:46                 ` Randy Dunlap
2017-10-16 23:35                   ` Paul E. McKenney
2017-10-18 16:03                 ` Jonathan Corbet
2017-10-18 16:27                   ` Paul E. McKenney
2017-10-18 16:36                     ` Jonathan Corbet
2017-10-20 16:42                       ` Paul E. McKenney
2017-10-20 16:53                         ` Randy Dunlap
2017-09-18  6:43 ` Markus Heiser

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20170918142109.GH3521@linux.vnet.ibm.com \
    --to=paulmck@linux.vnet.ibm.com \
    --cc=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=markus.heiser@darmarit.de \
    --cc=rdunlap@infradead.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox