All of lore.kernel.org
 help / color / mirror / Atom feed
From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
To: Jonathan Corbet <corbet@lwn.net>
Cc: Linux Doc Mailing List <linux-doc@vger.kernel.org>,
	linux-kernel@vger.kernel.org
Subject: Re: [PATCH v2 1/5] docs: cdomain.py: add support for two new Sphinx 3.1+ tags
Date: Fri, 25 Sep 2020 06:37:15 +0200	[thread overview]
Message-ID: <20200925063715.047cc585@coco.lan> (raw)
In-Reply-To: <20200924102439.18f95779@lwn.net>

Em Thu, 24 Sep 2020 10:24:39 -0600
Jonathan Corbet <corbet@lwn.net> escreveu:

> On Thu, 24 Sep 2020 18:21:45 +0200
> Mauro Carvalho Chehab <mchehab+huawei@kernel.org> wrote:
> 
> > As part of changing the documentation subsystem to properly
> > build with Sphinx 3.1+, add support for two tags:
> > 
> > 	- :c:expr:`foo`
> > 	- .. c:namespace::"  
> 
> So is there a reason we need :c:expr: ?  What does it add for us?

Good point. This came from a suggestion from the Sphinx issue.

The :c:expr: actually helped to identify two wrong declarations at the
DVB uAPI docs[1] but in practice it doesn't do much, except
by using a different font like placing "struct" in italics.

I was expecting it to also create cross-references to the structs
mentioned there, but, at least on my tests, it didn't work like that.

Anyway, I guess we can just get rid of it.

I'll send a v3 series without that.

Thanks,
Mauro

  reply	other threads:[~2020-09-25  4:37 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-09-24 16:21 [PATCH v2 0/5] docs: cdomain.py: add support for two new Sphinx 3.1+ tags Mauro Carvalho Chehab
2020-09-24 16:21 ` [PATCH v2 1/5] " Mauro Carvalho Chehab
2020-09-24 16:24   ` Jonathan Corbet
2020-09-25  4:37     ` Mauro Carvalho Chehab [this message]
2020-09-24 16:21 ` [PATCH v2 2/5] media: docs: make CEC documents compatible with Sphinx 3.1+ Mauro Carvalho Chehab
2020-09-24 16:25   ` Jonathan Corbet
2020-09-24 16:47     ` Mauro Carvalho Chehab
2020-09-24 16:21 ` [PATCH v2 3/5] media: docs: make V4L documents more " Mauro Carvalho Chehab
2020-09-24 16:21 ` [PATCH v2 4/5] media: docs: make DVB " Mauro Carvalho Chehab
2020-09-24 16:21 ` [PATCH v2 5/5] media: docs: make MC " Mauro Carvalho Chehab

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=20200925063715.047cc585@coco.lan \
    --to=mchehab+huawei@kernel.org \
    --cc=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.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.