All of lore.kernel.org
 help / color / mirror / Atom feed
From: Jonathan Corbet <corbet@lwn.net>
To: Amol Grover <frextrite@gmail.com>
Cc: "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>,
	Joel Fernandes <joel@joelfernandes.org>,
	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: Wed, 4 Dec 2019 07:48:33 -0700	[thread overview]
Message-ID: <20191204074833.44bcc079@lwn.net> (raw)
In-Reply-To: <20191204082412.GA6959@workstation-kernel-dev>

On Wed, 4 Dec 2019 13:54:12 +0530
Amol Grover <frextrite@gmail.com> wrote:

> The cross-reference of the functions should be done automatically by sphinx
> while generating HTML, right? But when compiled none of the functions were
> cross-referenced hence "``" was added around the methods (and other symbols)
> to distinguish them from normal text.

If there's nothing to cross-reference to (i.e. no kerneldoc comments)
then the reference obviously won't be generated.  I would still ask that
you leave out the literal markers; they will block linking to any docs
added in the future, and they clutter up the text - the plain-text reading
experience is important too.

Thanks,

jon

WARNING: multiple messages have this Message-ID (diff)
From: Jonathan Corbet <corbet@lwn.net>
To: Amol Grover <frextrite@gmail.com>
Cc: "Paul E . McKenney" <paulmck@kernel.org>,
	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>,
	Joel Fernandes <joel@joelfernandes.org>,
	linux-kernel-mentees@lists.linuxfoundation.org
Subject: Re: [Linux-kernel-mentees] [PATCH] doc: listRCU: Add some more listRCU patterns in the kernel
Date: Wed, 4 Dec 2019 07:48:33 -0700	[thread overview]
Message-ID: <20191204074833.44bcc079@lwn.net> (raw)
In-Reply-To: <20191204082412.GA6959@workstation-kernel-dev>

On Wed, 4 Dec 2019 13:54:12 +0530
Amol Grover <frextrite@gmail.com> wrote:

> The cross-reference of the functions should be done automatically by sphinx
> while generating HTML, right? But when compiled none of the functions were
> cross-referenced hence "``" was added around the methods (and other symbols)
> to distinguish them from normal text.

If there's nothing to cross-reference to (i.e. no kerneldoc comments)
then the reference obviously won't be generated.  I would still ask that
you leave out the literal markers; they will block linking to any docs
added in the future, and they clutter up the text - the plain-text reading
experience is important too.

Thanks,

jon
_______________________________________________
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-04 14:48 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 [this message]
2019-12-04 14:48       ` 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
2019-12-05 15:14               ` [Linux-kernel-mentees] " 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=20191204074833.44bcc079@lwn.net \
    --to=corbet@lwn.net \
    --cc=frextrite@gmail.com \
    --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.