Linux Kernel Mentees list
 help / color / mirror / Atom feed
From: corbet at lwn.net (Jonathan Corbet)
Subject: [Linux-kernel-mentees] [PATCH v3 5/6] Documentation: RCU: Add links to rcu.rst
Date: Tue, 25 Jun 2019 15:40:10 -0600	[thread overview]
Message-ID: <20190625154010.557448ff@lwn.net> (raw)
In-Reply-To: <20190625211740.GQ26519@linux.ibm.com>

On Tue, 25 Jun 2019 14:17:40 -0700
"Paul E. McKenney" <paulmck at linux.ibm.com> wrote:

> > Certainly "up_rcu" seems like a better name.  I do believe, though, that
> > you can also use the title directly:
> > 
> >   See `RCU on Uniprocessor Systems`_ for more information  
> 
> That does look prettier, though we might want to do something more
> directly mapped for people directly reading the .rst files.

Yeah, the alternative there is to just say "Documentation/RCU/UP.rst".
It's vaporware at the moment, but the plan is to recognize such strings
and link them up automatically in the build process.  It's easy enough to
do, I just have to get around to it.  In anticipation of that, just
putting in the file name is probably the right thing to do.

Thanks,

jon

WARNING: multiple messages have this Message-ID (diff)
From: corbet@lwn.net (Jonathan Corbet)
Subject: [Linux-kernel-mentees] [PATCH v3 5/6] Documentation: RCU: Add links to rcu.rst
Date: Tue, 25 Jun 2019 15:40:10 -0600	[thread overview]
Message-ID: <20190625154010.557448ff@lwn.net> (raw)
Message-ID: <20190625214010.N1-zHOCGXlVufjVtNCjzACzBAvzyNX7vPivLn37UCZA@z> (raw)
In-Reply-To: <20190625211740.GQ26519@linux.ibm.com>

On Tue, 25 Jun 2019 14:17:40 -0700
"Paul E. McKenney" <paulmck at linux.ibm.com> wrote:

> > Certainly "up_rcu" seems like a better name.  I do believe, though, that
> > you can also use the title directly:
> > 
> >   See `RCU on Uniprocessor Systems`_ for more information  
> 
> That does look prettier, though we might want to do something more
> directly mapped for people directly reading the .rst files.

Yeah, the alternative there is to just say "Documentation/RCU/UP.rst".
It's vaporware at the moment, but the plan is to recognize such strings
and link them up automatically in the build process.  It's easy enough to
do, I just have to get around to it.  In anticipation of that, just
putting in the file name is probably the right thing to do.

Thanks,

jon

  parent reply	other threads:[~2019-06-25 21:40 UTC|newest]

Thread overview: 94+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-06-22  7:02 [Linux-kernel-mentees] [PATCH 2/3] Documentation: RCU: Convert RCU linked list to ReST c0d1n61at3
2019-06-22  7:02 ` Jiunn Chang
2019-06-22 15:00 ` corbet
2019-06-22 15:00   ` Jonathan Corbet
2019-06-23  8:14   ` [Linux-kernel-mentees] [PATCH v2 0/7] Documentation: RCU: Convert to c0d1n61at3
2019-06-23  8:14     ` Jiunn Chang
2019-06-23 23:39     ` joel
2019-06-23 23:39       ` Joel Fernandes
2019-06-24  0:39     ` corbet
2019-06-24  0:39       ` Jonathan Corbet
2019-06-25  6:26     ` [Linux-kernel-mentees] [PATCH v3 0/6] Documentation: RCU: Convert to reST c0d1n61at3
2019-06-25  6:26       ` Jiunn Chang
2019-06-26 19:12       ` [Linux-kernel-mentees] [PATCH v4 0/5] " c0d1n61at3
2019-06-26 19:12         ` Jiunn Chang
2019-06-26 20:07         ` [Linux-kernel-mentees] [PATCH v5 " c0d1n61at3
2019-06-26 20:07           ` Jiunn Chang
2019-06-26 20:07         ` [Linux-kernel-mentees] [PATCH v5 1/5] Documentation: RCU: Convert RCU basic concepts " c0d1n61at3
2019-06-26 20:07           ` Jiunn Chang
2019-06-27 14:34           ` corbet
2019-06-27 14:34             ` Jonathan Corbet
2019-06-27 15:13             ` rostedt
2019-06-27 15:13               ` Steven Rostedt
2019-06-27 16:48               ` skhan
2019-06-27 16:48                 ` Shuah Khan
2019-06-27 16:26             ` paulmck
2019-06-27 16:26               ` Paul E. McKenney
2019-06-27 16:47             ` c0d1n61at3
2019-06-27 16:47               ` Jiunn Chang
2019-06-26 20:07         ` [Linux-kernel-mentees] [PATCH v5 2/5] Documentation: RCU: Convert RCU linked list " c0d1n61at3
2019-06-26 20:07           ` Jiunn Chang
2019-06-26 20:07         ` [Linux-kernel-mentees] [PATCH v5 3/5] Documentation: RCU: Convert RCU UP systems " c0d1n61at3
2019-06-26 20:07           ` Jiunn Chang
2019-06-26 20:07         ` [Linux-kernel-mentees] [PATCH v5 4/5] Documentation: RCU: Rename txt files to rst c0d1n61at3
2019-06-26 20:07           ` Jiunn Chang
2019-06-26 20:07         ` [Linux-kernel-mentees] [PATCH v5 5/5] Documentation: RCU: Add TOC tree hooks c0d1n61at3
2019-06-26 20:07           ` Jiunn Chang
2019-06-26 19:12       ` [Linux-kernel-mentees] [PATCH v4 1/5] Documentation: RCU: Convert RCU basic concepts to reST c0d1n61at3
2019-06-26 19:12         ` Jiunn Chang
2019-06-26 19:12       ` [Linux-kernel-mentees] [PATCH v4 2/5] Documentation: RCU: Convert RCU linked list " c0d1n61at3
2019-06-26 19:12         ` Jiunn Chang
2019-06-26 19:12       ` [Linux-kernel-mentees] [PATCH v4 3/5] Documentation: RCU: Convert RCU UP systems " c0d1n61at3
2019-06-26 19:12         ` Jiunn Chang
2019-06-26 19:12       ` [Linux-kernel-mentees] [PATCH v4 4/5] Documentation: RCU: Rename txt files to rst c0d1n61at3
2019-06-26 19:12         ` Jiunn Chang
2019-06-26 19:12       ` [Linux-kernel-mentees] [PATCH v4 5/5] Documentation: RCU: Add TOC tree hooks c0d1n61at3
2019-06-26 19:12         ` Jiunn Chang
2019-06-25  6:26     ` [Linux-kernel-mentees] [PATCH v3 1/6] Documentation: RCU: Convert RCU basic concepts to reST c0d1n61at3
2019-06-25  6:26       ` Jiunn Chang
2019-06-25  6:26     ` [Linux-kernel-mentees] [PATCH v3 2/6] Documentation: RCU: Convert RCU linked list " c0d1n61at3
2019-06-25  6:26       ` Jiunn Chang
2019-06-25  6:26     ` [Linux-kernel-mentees] [PATCH v3 3/6] Documentation: RCU: Convert RCU UP systems " c0d1n61at3
2019-06-25  6:26       ` Jiunn Chang
2019-06-25 16:03       ` paulmck
2019-06-25 16:03         ` Paul E. McKenney
2019-06-25  6:26     ` [Linux-kernel-mentees] [PATCH v3 4/6] Documentation: RCU: Rename txt files to rst c0d1n61at3
2019-06-25  6:26       ` Jiunn Chang
2019-06-25  6:26     ` [Linux-kernel-mentees] [PATCH v3 5/6] Documentation: RCU: Add links to rcu.rst c0d1n61at3
2019-06-25  6:26       ` Jiunn Chang
2019-06-25 15:56       ` paulmck
2019-06-25 15:56         ` Paul E. McKenney
2019-06-25 21:01         ` corbet
2019-06-25 21:01           ` Jonathan Corbet
2019-06-25 21:17           ` paulmck
2019-06-25 21:17             ` Paul E. McKenney
2019-06-25 21:40             ` corbet [this message]
2019-06-25 21:40               ` Jonathan Corbet
2019-06-25 21:45               ` paulmck
2019-06-25 21:45                 ` Paul E. McKenney
2019-06-25  6:26     ` [Linux-kernel-mentees] [PATCH v3 6/6] Documentation: RCU: Add TOC tree hooks c0d1n61at3
2019-06-25  6:26       ` Jiunn Chang
2019-06-23  8:14   ` [Linux-kernel-mentees] [PATCH v2 1/7] Documentation: RCU: Convert RCU basic concepts to ReST c0d1n61at3
2019-06-23  8:14     ` Jiunn Chang
2019-06-23 23:34     ` joel
2019-06-23 23:34       ` Joel Fernandes
2019-06-23  8:14   ` [Linux-kernel-mentees] [PATCH v2 2/7] Documentation: RCU: Rename " c0d1n61at3
2019-06-23  8:14     ` Jiunn Chang
2019-06-23  8:14   ` [Linux-kernel-mentees] [PATCH v2 3/7] Documentation: RCU: Convert RCU linked list " c0d1n61at3
2019-06-23  8:14     ` Jiunn Chang
2019-06-23 23:31     ` joel
2019-06-23 23:31       ` Joel Fernandes
2019-06-24  0:43     ` corbet
2019-06-24  0:43       ` Jonathan Corbet
2019-06-23  8:14   ` [Linux-kernel-mentees] [PATCH v2 4/7] Documentation: RCU: Rename " c0d1n61at3
2019-06-23  8:14     ` Jiunn Chang
2019-06-23  8:14   ` [Linux-kernel-mentees] [PATCH v2 5/7] Documentation: RCU: Convert RCU UP systems " c0d1n61at3
2019-06-23  8:14     ` Jiunn Chang
2019-06-23 23:27     ` joel
2019-06-23 23:27       ` Joel Fernandes
2019-06-24  0:45     ` corbet
2019-06-24  0:45       ` Jonathan Corbet
2019-06-23  8:14   ` [Linux-kernel-mentees] [PATCH v2 6/7] Documentation: RCU: Rename " c0d1n61at3
2019-06-23  8:14     ` Jiunn Chang
2019-06-23  8:14   ` [Linux-kernel-mentees] [PATCH v2 7/7] Documentation: RCU: Add links to rcu.rst c0d1n61at3
2019-06-23  8:14     ` Jiunn Chang

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=20190625154010.557448ff@lwn.net \
    --to=linux-kernel-mentees@lists.linux-foundation.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