Received-SPF: pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) client-ip=209.132.180.67;
Date:   Thu, 5 Dec 2019 20:08:06 -0500
From:   Joel Fernandes <joel@joelfernandes.org>
To:     Amol Grover <frextrite@gmail.com>
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
Message-ID: <20191206010806.GA142442@google.com>
References: <20191203063941.6981-1-frextrite@gmail.com>
 <20191203064132.38d75348@lwn.net>
 <20191204082412.GA6959@workstation-kernel-dev>
 <20191204074833.44bcc079@lwn.net>
 <20191204153958.GA17404@google.com>
 <20191204084729.184480f3@lwn.net>
 <20191204163552.GE17404@google.com>
 <20191205151418.GA3424@workstation-kernel-dev>
MIME-Version: 1.0
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
In-Reply-To: <20191205151418.GA3424@workstation-kernel-dev>
User-Agent: Mutt/1.10.1 (2018-07-13)
Sender: linux-kernel-owner@vger.kernel.org
Precedence: bulk

On Thu, Dec 05, 2019 at 08:44:18PM +0530, Amol Grover wrote:
> 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.

I think you should.

thanks,

 - Joel