public inbox for linux-kernel@vger.kernel.org
 help / color / mirror / Atom feed
From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
To: Linux Media Mailing List <linux-media@vger.kernel.org>
Cc: linuxarm@huawei.com, mauro.chehab@huawei.com,
	Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
	Antti Palosaari <crope@iki.fi>, Bingbu Cao <bingbu.cao@intel.com>,
	Hans Verkuil <hverkuil-cisco@xs4all.nl>,
	Mauro Carvalho Chehab <mchehab@kernel.org>,
	Randy Dunlap <rdunlap@infradead.org>,
	Sakari Ailus <sakari.ailus@linux.intel.com>,
	Tianshu Qiu <tian.shu.qiu@intel.com>,
	linux-kernel@vger.kernel.org
Subject: [PATCH 0/9] Address several issues when building media docs with Sphinx 3.x
Date: Wed, 30 Sep 2020 08:35:53 +0200	[thread overview]
Message-ID: <cover.1601447236.git.mchehab+huawei@kernel.org> (raw)

The C domain parser was re-written on Sphinx 3.x.

It is now a lot more pedantic than on past versions, and has
specific macros for addressing C namespaces and documenting
data types, like c:struct, c:enum, c:macro, etc.

I'm currently working on addressing the issues upstream,  as
some changes at the documentation build system are needed
(mainly kernel-doc and cdomain.py).

Yet, there are several simple issues at the media documentation 
that can easily be fixed without requiring any changes at the
documentation build system.

While Sphinx < 3.x doesn't print any warnings, I suspect that
most issues addressed here will provide either duplicated
cross-references and/or produce wrong output.

This series address those.

As there's no change at the documentation content
(just format tags were changed), my plan is to apply this series
either later today or tomorrow. 

Mauro Carvalho Chehab (9):
  media: camera-sensor.rst: fix a doc build warning
  media: glossary.rst: use the right case for glossary entries
  media: docs: ipu3.rst: rely at automarkup extension
  media: dvb-frontends: remove a clone of a kernel-doc markup at
    zd1301_demod.h
  media: v4l2-subdev.rst: get rid of a duplicatd kernel-doc markup
  media: cec-core.rst: fix warnings with Sphinx 3.0+
  media: v4l2-subdev.h: fix a kernel-doc markup
  media: hist-v4l2.rst: remove struct duplication
  media: hist-v4l2.rst: remove :c:`type` from structs and enums

 Documentation/admin-guide/media/ipu3.rst      |  38 +--
 .../driver-api/media/camera-sensor.rst        |   2 +-
 Documentation/driver-api/media/cec-core.rst   |  62 ++---
 .../driver-api/media/v4l2-subdev.rst          |   2 -
 .../userspace-api/media/glossary.rst          |  20 +-
 .../userspace-api/media/v4l/hist-v4l2.rst     | 239 ++++++++----------
 drivers/media/dvb-frontends/zd1301_demod.h    |   6 -
 include/media/v4l2-subdev.h                   |   2 +-
 8 files changed, 162 insertions(+), 209 deletions(-)

-- 
2.26.2



             reply	other threads:[~2020-09-30  6:36 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-09-30  6:35 Mauro Carvalho Chehab [this message]
2020-09-30  6:35 ` [PATCH 1/9] media: camera-sensor.rst: fix a doc build warning Mauro Carvalho Chehab
2020-09-30  6:35 ` [PATCH 2/9] media: glossary.rst: use the right case for glossary entries Mauro Carvalho Chehab
2020-09-30  6:35 ` [PATCH 3/9] media: docs: ipu3.rst: rely at automarkup extension Mauro Carvalho Chehab
2020-09-30  9:19   ` Sakari Ailus
2020-09-30  6:35 ` [PATCH 4/9] media: dvb-frontends: remove a clone of a kernel-doc markup at zd1301_demod.h Mauro Carvalho Chehab
2020-09-30  6:35 ` [PATCH 5/9] media: v4l2-subdev.rst: get rid of a duplicatd kernel-doc markup Mauro Carvalho Chehab
2020-09-30  6:35 ` [PATCH 6/9] media: cec-core.rst: fix warnings with Sphinx 3.0+ Mauro Carvalho Chehab
2020-09-30  6:36 ` [PATCH 7/9] media: v4l2-subdev.h: fix a kernel-doc markup Mauro Carvalho Chehab
2020-09-30  6:36 ` [PATCH 8/9] media: hist-v4l2.rst: remove struct duplication Mauro Carvalho Chehab
2020-09-30  6:36 ` [PATCH 9/9] media: hist-v4l2.rst: remove :c:`type` from structs and enums 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=cover.1601447236.git.mchehab+huawei@kernel.org \
    --to=mchehab+huawei@kernel.org \
    --cc=bingbu.cao@intel.com \
    --cc=crope@iki.fi \
    --cc=hverkuil-cisco@xs4all.nl \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-media@vger.kernel.org \
    --cc=linuxarm@huawei.com \
    --cc=mauro.chehab@huawei.com \
    --cc=mchehab@kernel.org \
    --cc=rdunlap@infradead.org \
    --cc=sakari.ailus@linux.intel.com \
    --cc=tian.shu.qiu@intel.com \
    /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