All of lore.kernel.org
 help / color / mirror / Atom feed
From: Mauro Carvalho Chehab <mchehab@s-opensource.com>
To: Jani Nikula <jani.nikula@intel.com>,
	Markus Heiser <markus.heiser@darmarit.de>
Cc: Jonathan Corbet <corbet@lwn.net>,
	Linux Media Mailing List <linux-media@vger.kernel.org>,
	linux-doc@vger.kernel.org
Subject: Functions and data structure cross references with Sphinx
Date: Mon, 1 Aug 2016 08:25:27 -0300	[thread overview]
Message-ID: <20160801082527.0eb7eace@recife.lan> (raw)

There's one remaining major issue I noticed after the conversion of the
media books to Sphinx:

While sphinx complains if a cross-reference (using :ref:) points to an
undefined reference, the same doesn't happen if the reference uses
:c:func: and :c:type:.

In practice, it means that, if we do some typo there, or if we forget to
add the function/struct prototype (or use the wrong domain, like :cpp:),
Sphinx won't generate the proper cross-reference, nor warning the user.

That's specially bad for media, as, while we're using the c domain for
the kAPI and driver-specific books, we need to use the cpp domain on the 
uAPI book - as the c domain doesn't allow multiple declarations for
syscalls, and we have multiple pages for read, write, open, close, 
poll and ioctl.

It would be good to have a way to run Sphinx on some "pedantic"
mode or have something similar to xmlint that would be complaining
about invalid c/cpp domain references.

Thanks,
Mauro

             reply	other threads:[~2016-08-01 11:25 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-08-01 11:25 Mauro Carvalho Chehab [this message]
2016-08-05  7:29 ` Functions and data structure cross references with Sphinx Markus Heiser
2016-08-05 10:47   ` Mauro Carvalho Chehab
2016-08-05 12:22     ` Markus Heiser
2016-08-05 12:43       ` 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=20160801082527.0eb7eace@recife.lan \
    --to=mchehab@s-opensource.com \
    --cc=corbet@lwn.net \
    --cc=jani.nikula@intel.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-media@vger.kernel.org \
    --cc=markus.heiser@darmarit.de \
    /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.