From: Mauro Carvalho Chehab <mchehab@s-opensource.com>
To: Linux Media Mailing List <linux-media@vger.kernel.org>
Cc: Mauro Carvalho Chehab <mchehab@s-opensource.com>,
Mauro Carvalho Chehab <mchehab@infradead.org>,
Markus Heiser <markus.heiser@darmarit.de>,
Jonathan Corbet <corbet@lwn.net>,
linux-doc@vger.kernel.org,
Jani Nikula <jani.nikula@linux.intel.com>,
Mauro Carvalho Chehab <mchehab@kernel.org>,
Markus Heiser <markus.heiser@darmarIT.de>
Subject: [PATCH 18/47] [media] docs-rst: use C domain for enum references on uapi
Date: Thu, 8 Sep 2016 09:03:40 -0300 [thread overview]
Message-ID: <1f49c93a0c50c9a293aee22e9212ff64bed590d1.1473334905.git.mchehab@s-opensource.com> (raw)
In-Reply-To: <cover.1473334905.git.mchehab@s-opensource.com>
In-Reply-To: <cover.1473334905.git.mchehab@s-opensource.com>
Change the parse-headers.pl and the corresponding files to use
the C domain for enum references.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
Documentation/media/uapi/v4l/hist-v4l2.rst | 2 +-
Documentation/media/uapi/v4l/subdev-formats.rst | 2 +-
Documentation/media/uapi/v4l/v4l2.rst | 2 +-
Documentation/media/uapi/v4l/vidioc-dqevent.rst | 2 +-
Documentation/media/uapi/v4l/vidioc-g-priority.rst | 2 +-
Documentation/media/uapi/v4l/vidioc-queryctrl.rst | 14 +++++++-------
Documentation/media/uapi/v4l/vidioc-subdev-g-fmt.rst | 10 +++++-----
include/media/v4l2-dev.h | 12 ++++++------
8 files changed, 23 insertions(+), 23 deletions(-)
diff --git a/Documentation/media/uapi/v4l/hist-v4l2.rst b/Documentation/media/uapi/v4l/hist-v4l2.rst
index a84895968349..bd45431ed00e 100644
--- a/Documentation/media/uapi/v4l/hist-v4l2.rst
+++ b/Documentation/media/uapi/v4l/hist-v4l2.rst
@@ -1361,7 +1361,7 @@ V4L2 in Linux 3.19
:ref:`v4l2_quantization <v4l2-quantization>` fields to struct
:c:type:`v4l2_pix_format`, struct
:c:type:`v4l2_pix_format_mplane` and
- struct :ref:`v4l2_mbus_framefmt <v4l2-mbus-framefmt>`.
+ struct :c:type:`v4l2_mbus_framefmt`.
V4L2 in Linux 4.4
diff --git a/Documentation/media/uapi/v4l/subdev-formats.rst b/Documentation/media/uapi/v4l/subdev-formats.rst
index 52013b55ea80..f0d7754f1906 100644
--- a/Documentation/media/uapi/v4l/subdev-formats.rst
+++ b/Documentation/media/uapi/v4l/subdev-formats.rst
@@ -7,7 +7,7 @@ Media Bus Formats
.. tabularcolumns:: |p{4.4cm}|p{4.4cm}|p{8.7cm}|
-.. _v4l2-mbus-framefmt:
+.. c:type:: v4l2_mbus_framefmt
.. flat-table:: struct v4l2_mbus_framefmt
:header-rows: 0
diff --git a/Documentation/media/uapi/v4l/v4l2.rst b/Documentation/media/uapi/v4l/v4l2.rst
index 785d4cdd2f85..e020c57f98d4 100644
--- a/Documentation/media/uapi/v4l/v4l2.rst
+++ b/Documentation/media/uapi/v4l/v4l2.rst
@@ -116,7 +116,7 @@ Rewrote Colorspace chapter, added new enum
:ref:`v4l2_quantization <v4l2-quantization>` fields to struct
:c:type:`v4l2_pix_format`, struct
:c:type:`v4l2_pix_format_mplane` and struct
-:ref:`v4l2_mbus_framefmt <v4l2-mbus-framefmt>`.
+:c:type:`v4l2_mbus_framefmt`.
:revision: 3.17 / 2014-08-04 (*lp, hv*)
diff --git a/Documentation/media/uapi/v4l/vidioc-dqevent.rst b/Documentation/media/uapi/v4l/vidioc-dqevent.rst
index cf0e98f5112f..3038f349049c 100644
--- a/Documentation/media/uapi/v4l/vidioc-dqevent.rst
+++ b/Documentation/media/uapi/v4l/vidioc-dqevent.rst
@@ -356,7 +356,7 @@ call.
-
- The type of the control. See enum
- :ref:`v4l2_ctrl_type <v4l2-ctrl-type>`.
+ :c:type:`v4l2_ctrl_type`.
- .. row 3
diff --git a/Documentation/media/uapi/v4l/vidioc-g-priority.rst b/Documentation/media/uapi/v4l/vidioc-g-priority.rst
index d6a07c076837..cbd2a3cbb18e 100644
--- a/Documentation/media/uapi/v4l/vidioc-g-priority.rst
+++ b/Documentation/media/uapi/v4l/vidioc-g-priority.rst
@@ -44,7 +44,7 @@ an enum v4l2_priority variable and call :ref:`VIDIOC_S_PRIORITY <VIDIOC_G_PRIORI
with a pointer to this variable.
-.. _v4l2-priority:
+.. c:type:: v4l2_priority
.. tabularcolumns:: |p{6.6cm}|p{2.2cm}|p{8.7cm}|
diff --git a/Documentation/media/uapi/v4l/vidioc-queryctrl.rst b/Documentation/media/uapi/v4l/vidioc-queryctrl.rst
index ef32e28e57c7..1a798be69e10 100644
--- a/Documentation/media/uapi/v4l/vidioc-queryctrl.rst
+++ b/Documentation/media/uapi/v4l/vidioc-queryctrl.rst
@@ -142,7 +142,7 @@ See also the examples in :ref:`control`.
- ``minimum``
- Minimum value, inclusive. This field gives a lower bound for the
- control. See enum :ref:`v4l2_ctrl_type <v4l2-ctrl-type>` how
+ control. See enum :c:type:`v4l2_ctrl_type` how
the minimum value is to be used for each possible control type.
Note that this a signed 32-bit value.
@@ -153,7 +153,7 @@ See also the examples in :ref:`control`.
- ``maximum``
- Maximum value, inclusive. This field gives an upper bound for the
- control. See enum :ref:`v4l2_ctrl_type <v4l2-ctrl-type>` how
+ control. See enum :c:type:`v4l2_ctrl_type` how
the maximum value is to be used for each possible control type.
Note that this a signed 32-bit value.
@@ -164,7 +164,7 @@ See also the examples in :ref:`control`.
- ``step``
- This field gives a step size for the control. See enum
- :ref:`v4l2_ctrl_type <v4l2-ctrl-type>` how the step value is
+ :c:type:`v4l2_ctrl_type` how the step value is
to be used for each possible control type. Note that this an
unsigned 32-bit value.
@@ -269,7 +269,7 @@ See also the examples in :ref:`control`.
- ``minimum``
- Minimum value, inclusive. This field gives a lower bound for the
- control. See enum :ref:`v4l2_ctrl_type <v4l2-ctrl-type>` how
+ control. See enum :c:type:`v4l2_ctrl_type` how
the minimum value is to be used for each possible control type.
Note that this a signed 64-bit value.
@@ -280,7 +280,7 @@ See also the examples in :ref:`control`.
- ``maximum``
- Maximum value, inclusive. This field gives an upper bound for the
- control. See enum :ref:`v4l2_ctrl_type <v4l2-ctrl-type>` how
+ control. See enum :c:type:`v4l2_ctrl_type` how
the maximum value is to be used for each possible control type.
Note that this a signed 64-bit value.
@@ -291,7 +291,7 @@ See also the examples in :ref:`control`.
- ``step``
- This field gives a step size for the control. See enum
- :ref:`v4l2_ctrl_type <v4l2-ctrl-type>` how the step value is
+ :c:type:`v4l2_ctrl_type` how the step value is
to be used for each possible control type. Note that this an
unsigned 64-bit value.
@@ -456,7 +456,7 @@ See also the examples in :ref:`control`.
.. tabularcolumns:: |p{5.8cm}|p{1.4cm}|p{1.0cm}|p{1.4cm}|p{6.9cm}|
-.. _v4l2-ctrl-type:
+.. c:type:: v4l2_ctrl_type
.. cssclass:: longtable
diff --git a/Documentation/media/uapi/v4l/vidioc-subdev-g-fmt.rst b/Documentation/media/uapi/v4l/vidioc-subdev-g-fmt.rst
index 2df1342ac6ea..90d876faa5b9 100644
--- a/Documentation/media/uapi/v4l/vidioc-subdev-g-fmt.rst
+++ b/Documentation/media/uapi/v4l/vidioc-subdev-g-fmt.rst
@@ -38,7 +38,7 @@ These ioctls are used to negotiate the frame format at specific subdev
pads in the image pipeline.
To retrieve the current format applications set the ``pad`` field of a
-struct :ref:`v4l2_subdev_format <v4l2-subdev-format>` to the desired
+struct :c:type:`v4l2_subdev_format` to the desired
pad number as reported by the media API and the ``which`` field to
``V4L2_SUBDEV_FORMAT_ACTIVE``. When they call the
``VIDIOC_SUBDEV_G_FMT`` ioctl with a pointer to this structure the
@@ -49,7 +49,7 @@ To change the current format applications set both the ``pad`` and
the ``VIDIOC_SUBDEV_S_FMT`` ioctl with a pointer to this structure the
driver verifies the requested format, adjusts it based on the hardware
capabilities and configures the device. Upon return the struct
-:ref:`v4l2_subdev_format <v4l2-subdev-format>` contains the current
+:c:type:`v4l2_subdev_format` contains the current
format as would be returned by a ``VIDIOC_SUBDEV_G_FMT`` call.
Applications can query the device capabilities by setting the ``which``
@@ -78,7 +78,7 @@ should be as close as possible to the original request.
.. tabularcolumns:: |p{4.4cm}|p{4.4cm}|p{8.7cm}|
-.. _v4l2-subdev-format:
+.. c:type:: v4l2_subdev_format
.. flat-table:: struct v4l2_subdev_format
:header-rows: 0
@@ -105,7 +105,7 @@ should be as close as possible to the original request.
- .. row 3
- - struct :ref:`v4l2_mbus_framefmt <v4l2-mbus-framefmt>`
+ - struct :c:type:`v4l2_mbus_framefmt`
- ``format``
@@ -164,7 +164,7 @@ EBUSY
fix the problem first. Only returned by ``VIDIOC_SUBDEV_S_FMT``
EINVAL
- The struct :ref:`v4l2_subdev_format <v4l2-subdev-format>`
+ The struct :c:type:`v4l2_subdev_format`
``pad`` references a non-existing pad, or the ``which`` field
references a non-existing format.
diff --git a/include/media/v4l2-dev.h b/include/media/v4l2-dev.h
index 5272aeec0cec..477e90d89a04 100644
--- a/include/media/v4l2-dev.h
+++ b/include/media/v4l2-dev.h
@@ -56,7 +56,7 @@ struct v4l2_ctrl_handler;
*
* .. note::
* The size of @prios array matches the number of priority types defined
- * by :ref:`enum v4l2_priority <v4l2-priority>`.
+ * by enum &v4l2_priority.
*/
struct v4l2_prio_state {
atomic_t prios[4];
@@ -73,8 +73,8 @@ void v4l2_prio_init(struct v4l2_prio_state *global);
* v4l2_prio_change - changes the v4l2 file handler priority
*
* @global: pointer to the &struct v4l2_prio_state of the device node.
- * @local: pointer to the desired priority, as defined by :ref:`enum v4l2_priority <v4l2-priority>`
- * @new: Priority type requested, as defined by :ref:`enum v4l2_priority <v4l2-priority>`.
+ * @local: pointer to the desired priority, as defined by enum &v4l2_priority
+ * @new: Priority type requested, as defined by enum &v4l2_priority.
*
* .. note::
* This function should be used only by the V4L2 core.
@@ -86,7 +86,7 @@ int v4l2_prio_change(struct v4l2_prio_state *global, enum v4l2_priority *local,
* v4l2_prio_open - Implements the priority logic for a file handler open
*
* @global: pointer to the &struct v4l2_prio_state of the device node.
- * @local: pointer to the desired priority, as defined by :ref:`enum v4l2_priority <v4l2-priority>`
+ * @local: pointer to the desired priority, as defined by enum &v4l2_priority
*
* .. note::
* This function should be used only by the V4L2 core.
@@ -97,7 +97,7 @@ void v4l2_prio_open(struct v4l2_prio_state *global, enum v4l2_priority *local);
* v4l2_prio_close - Implements the priority logic for a file handler close
*
* @global: pointer to the &struct v4l2_prio_state of the device node.
- * @local: priority to be released, as defined by :ref:`enum v4l2_priority <v4l2-priority>`
+ * @local: priority to be released, as defined by enum &v4l2_priority
*
* .. note::
* This function should be used only by the V4L2 core.
@@ -118,7 +118,7 @@ enum v4l2_priority v4l2_prio_max(struct v4l2_prio_state *global);
* v4l2_prio_close - Implements the priority logic for a file handler close
*
* @global: pointer to the &struct v4l2_prio_state of the device node.
- * @local: desired priority, as defined by :ref:`enum v4l2_priority <v4l2-priority>` local
+ * @local: desired priority, as defined by enum &v4l2_priority local
*
* .. note::
* This function should be used only by the V4L2 core.
--
2.7.4
next prev parent reply other threads:[~2016-09-08 12:04 UTC|newest]
Thread overview: 51+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-09-08 12:03 [PATCH 00/47] Fix most of Sphinx warnings in nitpick mode Mauro Carvalho Chehab
2016-09-08 12:03 ` [PATCH 01/47] kernel-doc: ignore arguments on macro definitions Mauro Carvalho Chehab
2016-09-08 12:03 ` [PATCH 02/47] docs-rst: parse-headers.pl: make debug a command line option Mauro Carvalho Chehab
2016-09-08 12:03 ` [PATCH 03/47] docs-rst: parse-headers.pl: use the C domain for cross-references Mauro Carvalho Chehab
2016-09-08 14:47 ` Markus Heiser
2016-09-08 12:03 ` [PATCH 04/47] [media] conf_nitpick.py: add external vars to ignore list Mauro Carvalho Chehab
2016-09-08 12:03 ` [PATCH 05/47] [media] dvb_ringbuffer.h: Document all functions Mauro Carvalho Chehab
2016-09-08 12:03 ` [PATCH 06/47] [media] dtv-core.rst: move DTV ringbuffer notes to kAPI doc Mauro Carvalho Chehab
2016-09-08 12:03 ` [PATCH 07/47] [media] dvb_ringbuffer.h: document the define macros Mauro Carvalho Chehab
2016-09-08 12:03 ` [PATCH 08/47] [media] demux.h: Fix a few documentation issues Mauro Carvalho Chehab
2016-09-08 12:03 ` [PATCH 09/47] [media] mc-core.rst: Fix cross-references to the source Mauro Carvalho Chehab
2016-09-08 12:03 ` [PATCH 10/47] [media] demux.h: fix a documentation warning Mauro Carvalho Chehab
2016-09-08 12:03 ` [PATCH 11/47] [media] docs-rst: improve the kAPI documentation for the mediactl Mauro Carvalho Chehab
2016-09-08 12:03 ` [PATCH 12/47] [media] conf_nitpick.py: ignore external functions used on mediactl Mauro Carvalho Chehab
2016-09-08 12:03 ` [PATCH 13/47] [media] rc-map.h: document structs/enums on it Mauro Carvalho Chehab
2016-09-08 12:03 ` [PATCH 14/47] [media] v4l2-ctrls: document some extra data structures Mauro Carvalho Chehab
2016-09-08 12:03 ` [PATCH 15/47] [media] docs-rst: convert uAPI structs to C domain Mauro Carvalho Chehab
2016-09-08 12:03 ` [PATCH 16/47] [media] diff-v4l.rst: Fix V4L version 1 references Mauro Carvalho Chehab
2016-09-08 12:03 ` [PATCH 17/47] [media] v4l2-ctrls.h: fix doc reference for prepare_ext_ctrls() Mauro Carvalho Chehab
2016-09-08 12:03 ` Mauro Carvalho Chehab [this message]
2016-09-08 12:03 ` [PATCH 19/47] [media] v4l2-ctrls.h: Fix some c:type references Mauro Carvalho Chehab
2016-09-08 12:03 ` [PATCH 20/47] [media] cec-ioc-dqevent.rst: fix some undefined references Mauro Carvalho Chehab
2016-09-08 12:03 ` [PATCH 21/47] [media] v4l2-ioctl.h: document the remaining functions Mauro Carvalho Chehab
2016-09-08 12:03 ` [PATCH 22/47] [media] v4l2-dev.rst: fix a broken c domain reference Mauro Carvalho Chehab
2016-09-08 12:25 ` Laurent Pinchart
2016-09-08 12:03 ` [PATCH 23/47] [media] v4l2-device.h: fix some doc tags Mauro Carvalho Chehab
2016-09-08 12:03 ` [PATCH 24/47] [media] v4l2-dv-timings.h: let kernel-doc parte the typedef argument Mauro Carvalho Chehab
2016-09-08 12:03 ` [PATCH 25/47] [media] v4l2-subdev.rst: get rid of legacy functions Mauro Carvalho Chehab
2016-09-08 12:03 ` [PATCH 26/47] [media] v4l2-subdev.h: fix a doc nitpick warning Mauro Carvalho Chehab
2016-09-08 12:03 ` [PATCH 27/47] [media] docs-rst exceptions: use C domain references for DVB headers Mauro Carvalho Chehab
2016-09-08 12:03 ` [PATCH 28/47] [media] ca-get-cap.rst: add a table for struct ca_caps Mauro Carvalho Chehab
2016-09-08 12:03 ` [PATCH 29/47] [media] ca-get-descr-info.rst: add doc for for struct ca_descr_info Mauro Carvalho Chehab
2016-09-08 12:03 ` [PATCH 30/47] [media] ca-get-msg.rst: add a boilerplate for struct ca_msg Mauro Carvalho Chehab
2016-09-08 12:03 ` [PATCH 31/47] [media] ca-get-slot-info.rst: document struct ca_slot_info Mauro Carvalho Chehab
2016-09-08 12:03 ` [PATCH 32/47] [media] ca-set-pid.rst: document struct ca_pid Mauro Carvalho Chehab
2016-09-08 12:03 ` [PATCH 33/47] [media] docs-rst: fix the remaining broken links for DVB CA API Mauro Carvalho Chehab
2016-09-08 12:03 ` [PATCH 34/47] [media] fix broken references on dvb/video*rst Mauro Carvalho Chehab
2016-09-08 12:03 ` [PATCH 35/47] [media] docs-rst: fix dmx bad cross-references Mauro Carvalho Chehab
2016-09-08 12:03 ` [PATCH 36/47] [media] docs-rst: fix cec " Mauro Carvalho Chehab
2016-09-08 12:03 ` [PATCH 37/47] [media] docs-rst: simplify c:type: cross references Mauro Carvalho Chehab
2016-09-08 12:04 ` [PATCH 38/47] [media] docs-rst: fix some broken struct references Mauro Carvalho Chehab
2016-09-08 12:04 ` [PATCH 39/47] [media] fix clock_gettime cross-references Mauro Carvalho Chehab
2016-09-08 12:04 ` [PATCH 40/47] [media] libv4l-introdution.rst: fix function definitions Mauro Carvalho Chehab
2016-09-08 12:04 ` [PATCH 41/47] [media] libv4l-introduction.rst: improve crossr-references Mauro Carvalho Chehab
2016-09-08 12:04 ` [PATCH 42/47] [media] hist-v4l2.rst: don't do refs to old structures Mauro Carvalho Chehab
2016-09-08 12:04 ` [PATCH 43/47] [media] docs-rst: fix cross-references for videodev2.h Mauro Carvalho Chehab
2016-09-08 12:04 ` [PATCH 44/47] [media] dev-sliced-vbi.rst: fix reference for v4l2_mpeg_vbi_ITV0 Mauro Carvalho Chehab
2016-09-08 12:04 ` [PATCH 45/47] [media] media-ioc-g-topology.rst: fix a c domain reference Mauro Carvalho Chehab
2016-09-08 12:04 ` [PATCH 46/47] [media] docs-rst: fix two wrong :name: tags Mauro Carvalho Chehab
2016-09-08 12:04 ` [PATCH 47/47] [media] rc-map.h: fix a Sphinx warning Mauro Carvalho Chehab
2016-09-08 12:14 ` [PATCH 00/47] Fix most of Sphinx warnings in nitpick mode Jonathan Corbet
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=1f49c93a0c50c9a293aee22e9212ff64bed590d1.1473334905.git.mchehab@s-opensource.com \
--to=mchehab@s-opensource.com \
--cc=corbet@lwn.net \
--cc=jani.nikula@linux.intel.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-media@vger.kernel.org \
--cc=markus.heiser@darmarit.de \
--cc=mchehab@infradead.org \
--cc=mchehab@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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).