All of lore.kernel.org
 help / color / mirror / Atom feed
From: Amol Grover <frextrite@gmail.com>
To: Joel Fernandes <joel@joelfernandes.org>
Cc: Jonathan Corbet <corbet@lwn.net>,
	"Paul E . McKenney" <paulmck@kernel.org>,
	Josh Triplett <josh@joshtriplett.org>,
	Steven Rostedt <rostedt@goodmis.org>,
	Mathieu Desnoyers <mathieu.desnoyers@efficios.com>,
	Lai Jiangshan <jiangshanlai@gmail.com>,
	rcu@vger.kernel.org, linux-doc@vger.kernel.org,
	linux-kernel@vger.kernel.org,
	linux-kernel-mentees@lists.linuxfoundation.org,
	Shuah Khan <skhan@linuxfoundation.org>,
	Madhuparna Bhowmik <madhuparnabhowmik04@gmail.com>
Subject: Re: [PATCH] doc: listRCU: Add some more listRCU patterns in the kernel
Date: Thu, 5 Dec 2019 20:44:18 +0530	[thread overview]
Message-ID: <20191205151418.GA3424@workstation-kernel-dev> (raw)
In-Reply-To: <20191204163552.GE17404@google.com>

On Wed, Dec 04, 2019 at 11:35:52AM -0500, Joel Fernandes wrote:
> On Wed, Dec 04, 2019 at 08:47:29AM -0700, Jonathan Corbet wrote:
> > On Wed, 4 Dec 2019 10:39:58 -0500
> > Joel Fernandes <joel@joelfernandes.org> wrote:
> > 
> > > Actually I had asked Amol privately to add the backticks. It appeared
> > > super weird in my browser when some function calls were rendered
> > > monospace while others weren't. Not all functions were successfully
> > > cross referenced for me. May be it is my kernel version?
> > 
> > If you have an example of a failure to cross-reference a function that
> > has kerneldoc comments *that are included in the toctree*, I'd like to see
> > it; that's a bug.
> > 
> > Changing the font on functions without anything to cross-reference to is
> > easy enough and should probably be done; I'll look into it when I get a
> > chance.
> 
> I tried on a different machine (my work machine) and the cross-referencing is
> working fine. So I am not sure if this could be something related to Sphinx
> version or I had used an older kernel tree before. This kernel tree is
> Linus's master.
> 

This is great! I'll remove the "``" from function text and send in the
updated version. However, should I leave in the "``CONSTANTS``" and
"``variables``"? They dont' have any kernel docs to be cross-referenced
with and also make them distinguishable from the normal text.

Thanks
Amol

> thanks,
> 
>  - Joel
> 

WARNING: multiple messages have this Message-ID (diff)
From: Amol Grover <frextrite@gmail.com>
To: Joel Fernandes <joel@joelfernandes.org>
Cc: "Paul E . McKenney" <paulmck@kernel.org>,
	Jonathan Corbet <corbet@lwn.net>,
	linux-doc@vger.kernel.org, Lai Jiangshan <jiangshanlai@gmail.com>,
	Josh Triplett <josh@joshtriplett.org>,
	Steven Rostedt <rostedt@goodmis.org>,
	linux-kernel@vger.kernel.org, rcu@vger.kernel.org,
	Mathieu Desnoyers <mathieu.desnoyers@efficios.com>,
	linux-kernel-mentees@lists.linuxfoundation.org
Subject: Re: [Linux-kernel-mentees] [PATCH] doc: listRCU: Add some more listRCU patterns in the kernel
Date: Thu, 5 Dec 2019 20:44:18 +0530	[thread overview]
Message-ID: <20191205151418.GA3424@workstation-kernel-dev> (raw)
In-Reply-To: <20191204163552.GE17404@google.com>

On Wed, Dec 04, 2019 at 11:35:52AM -0500, Joel Fernandes wrote:
> On Wed, Dec 04, 2019 at 08:47:29AM -0700, Jonathan Corbet wrote:
> > On Wed, 4 Dec 2019 10:39:58 -0500
> > Joel Fernandes <joel@joelfernandes.org> wrote:
> > 
> > > Actually I had asked Amol privately to add the backticks. It appeared
> > > super weird in my browser when some function calls were rendered
> > > monospace while others weren't. Not all functions were successfully
> > > cross referenced for me. May be it is my kernel version?
> > 
> > If you have an example of a failure to cross-reference a function that
> > has kerneldoc comments *that are included in the toctree*, I'd like to see
> > it; that's a bug.
> > 
> > Changing the font on functions without anything to cross-reference to is
> > easy enough and should probably be done; I'll look into it when I get a
> > chance.
> 
> I tried on a different machine (my work machine) and the cross-referencing is
> working fine. So I am not sure if this could be something related to Sphinx
> version or I had used an older kernel tree before. This kernel tree is
> Linus's master.
> 

This is great! I'll remove the "``" from function text and send in the
updated version. However, should I leave in the "``CONSTANTS``" and
"``variables``"? They dont' have any kernel docs to be cross-referenced
with and also make them distinguishable from the normal text.

Thanks
Amol

> thanks,
> 
>  - Joel
> 
_______________________________________________
Linux-kernel-mentees mailing list
Linux-kernel-mentees@lists.linuxfoundation.org
https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees

  reply	other threads:[~2019-12-05 15:14 UTC|newest]

Thread overview: 24+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-12-03  6:39 [PATCH] doc: listRCU: Add some more listRCU patterns in the kernel Amol Grover
2019-12-03  6:39 ` [Linux-kernel-mentees] " Amol Grover
2019-12-03 13:41 ` Jonathan Corbet
2019-12-03 13:41   ` [Linux-kernel-mentees] " Jonathan Corbet
2019-12-04  8:24   ` Amol Grover
2019-12-04  8:24     ` [Linux-kernel-mentees] " Amol Grover
2019-12-04 14:48     ` Jonathan Corbet
2019-12-04 14:48       ` [Linux-kernel-mentees] " Jonathan Corbet
2019-12-04 15:39       ` Joel Fernandes
2019-12-04 15:39         ` [Linux-kernel-mentees] " Joel Fernandes
2019-12-04 15:47         ` Jonathan Corbet
2019-12-04 15:47           ` [Linux-kernel-mentees] " Jonathan Corbet
2019-12-04 16:35           ` Joel Fernandes
2019-12-04 16:35             ` [Linux-kernel-mentees] " Joel Fernandes
2019-12-05 15:14             ` Amol Grover [this message]
2019-12-05 15:14               ` Amol Grover
2019-12-06  1:08               ` Joel Fernandes
2019-12-06  1:08                 ` [Linux-kernel-mentees] " Joel Fernandes
2019-12-06  8:07 ` [PATCH v2] " Amol Grover
2019-12-06  8:07   ` [Linux-kernel-mentees] " Amol Grover
2019-12-19 16:29   ` Jonathan Corbet
2019-12-19 16:29     ` [Linux-kernel-mentees] " Jonathan Corbet
2019-12-19 16:56     ` Paul E. McKenney
2019-12-19 16:56       ` [Linux-kernel-mentees] " Paul E. McKenney

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=20191205151418.GA3424@workstation-kernel-dev \
    --to=frextrite@gmail.com \
    --cc=corbet@lwn.net \
    --cc=jiangshanlai@gmail.com \
    --cc=joel@joelfernandes.org \
    --cc=josh@joshtriplett.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel-mentees@lists.linuxfoundation.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=madhuparnabhowmik04@gmail.com \
    --cc=mathieu.desnoyers@efficios.com \
    --cc=paulmck@kernel.org \
    --cc=rcu@vger.kernel.org \
    --cc=rostedt@goodmis.org \
    --cc=skhan@linuxfoundation.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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.