* [PATCH 01/51] Documentation: linuxt_tv: update the documentation year
2016-07-04 11:46 [PATCH 00/51] First part of documentation fixups Mauro Carvalho Chehab
@ 2016-07-04 11:46 ` Mauro Carvalho Chehab
2016-07-04 11:46 ` [PATCH 02/51] Documentation: some fixups at linux_tv/index.rst Mauro Carvalho Chehab
` (49 subsequent siblings)
50 siblings, 0 replies; 52+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-04 11:46 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, Jonathan Corbet,
Markus Heiser, linux-doc
The RST version was produced in 2016. So, update it where
it was still pointing to the wrong year.
While here, added the missing (copyright) symbols.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
Documentation/linux_tv/conf.py | 2 +-
Documentation/linux_tv/index.rst | 4 +++-
Documentation/linux_tv/media/dvb/dvbapi.rst | 6 ++++--
3 files changed, 8 insertions(+), 4 deletions(-)
diff --git a/Documentation/linux_tv/conf.py b/Documentation/linux_tv/conf.py
index 8013c921256b..ea5f6ef25d6b 100644
--- a/Documentation/linux_tv/conf.py
+++ b/Documentation/linux_tv/conf.py
@@ -25,7 +25,7 @@ kernel_doc_mode = "kernel-doc"
# ------------------------------------------------------------------------------
project = u'LINUX MEDIA INFRASTRUCTURE API'
-copyright = u'2009-2015 : LinuxTV Developers'
+copyright = u'2009-2016 : LinuxTV Developers'
author = u'The LinuxTV Developers'
# The version info for the project you're documenting, acts as replacement for
diff --git a/Documentation/linux_tv/index.rst b/Documentation/linux_tv/index.rst
index 42b3d4520942..e6df371243d8 100644
--- a/Documentation/linux_tv/index.rst
+++ b/Documentation/linux_tv/index.rst
@@ -1,10 +1,12 @@
.. -*- coding: utf-8; mode: rst -*-
+.. include:: <isonum.txt>
+
##############################
LINUX MEDIA INFRASTRUCTURE API
##############################
-**Copyright** 2009-2015 : LinuxTV Developers
+**Copyright** |copy| 2009-2016 : LinuxTV Developers
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.1 or
diff --git a/Documentation/linux_tv/media/dvb/dvbapi.rst b/Documentation/linux_tv/media/dvb/dvbapi.rst
index 5e513ac86052..daeeb4d64917 100644
--- a/Documentation/linux_tv/media/dvb/dvbapi.rst
+++ b/Documentation/linux_tv/media/dvb/dvbapi.rst
@@ -1,5 +1,7 @@
.. -*- coding: utf-8; mode: rst -*-
+.. include:: <isonum.txt>
+
.. _dvbapi:
#############
@@ -41,9 +43,9 @@ Revision and Copyright
:address: m.chehab@samsung.com
:contrib: Ported document to Docbook XML.
-**Copyright** 2002, 2003 : Convergence GmbH
+**Copyright** |copy| 2002, 2003 : Convergence GmbH
-**Copyright** 2009-2015 : Mauro Carvalho Chehab
+**Copyright** |copy| 2009-2016 : Mauro Carvalho Chehab
:revision: 2.1.0 / 2015-05-29 (*mcc*)
--
2.7.4
^ permalink raw reply related [flat|nested] 52+ messages in thread* [PATCH 02/51] Documentation: some fixups at linux_tv/index.rst
2016-07-04 11:46 [PATCH 00/51] First part of documentation fixups Mauro Carvalho Chehab
2016-07-04 11:46 ` [PATCH 01/51] Documentation: linuxt_tv: update the documentation year Mauro Carvalho Chehab
@ 2016-07-04 11:46 ` Mauro Carvalho Chehab
2016-07-04 11:46 ` [PATCH 03/51] Documentation: v4l2.rst: Fix authors and revisions lists Mauro Carvalho Chehab
` (48 subsequent siblings)
50 siblings, 0 replies; 52+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-04 11:46 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, Jonathan Corbet,
Markus Heiser, linux-doc
Fix some issues from the conversion and improve the documentation
a little bit, by adding two relevent keywords (SDR and DTMB).
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
Documentation/linux_tv/index.rst | 21 +++++++--------------
1 file changed, 7 insertions(+), 14 deletions(-)
diff --git a/Documentation/linux_tv/index.rst b/Documentation/linux_tv/index.rst
index e6df371243d8..b0389cbfb1aa 100644
--- a/Documentation/linux_tv/index.rst
+++ b/Documentation/linux_tv/index.rst
@@ -12,7 +12,7 @@ Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.1 or
any later version published by the Free Software Foundation. A copy of
the license is included in the chapter entitled "GNU Free Documentation
-License"
+License".
============
@@ -21,8 +21,8 @@ Introduction
This document covers the Linux Kernel to Userspace API's used by video
and radio streaming devices, including video cameras, analog and digital
-TV receiver cards, AM/FM receiver cards, streaming capture and output
-devices, codec devices and remote controllers.
+TV receiver cards, AM/FM receiver cards, Software Defined Radio (SDR),
+streaming capture and output devices, codec devices and remote controllers.
A typical media device hardware is shown at
:ref:`typical_media_device`.
@@ -36,21 +36,17 @@ A typical media device hardware is shown at
Typical Media Device
- Typical Media Device Block Diagram
-
-
-
The media infrastructure API was designed to control such devices. It is
divided into four parts.
-The first part covers radio, video capture and output, cameras, analog
-TV devices and codecs.
+The first part covers radio, video capture and output,
+cameras, analog TV devices and codecs.
The second part covers the API used for digital TV and Internet
reception via one of the several digital tv standards. While it is
called as DVB API, in fact it covers several different video standards
-including DVB-T/T2, DVB-S/S2, DVB-C, ATSC, ISDB-T, ISDB-S,etc. The
-complete list of supported standards can be found at
+including DVB-T/T2, DVB-S/S2, DVB-C, ATSC, ISDB-T, ISDB-S, DTMB, etc.
+The complete list of supported standards can be found at
:ref:`fe-delivery-system-t`.
The third part covers the Remote Controller API.
@@ -97,6 +93,3 @@ etc, please mail to:
=========
* :ref:`genindex`
-
-.. todolist::
-
--
2.7.4
^ permalink raw reply related [flat|nested] 52+ messages in thread* [PATCH 03/51] Documentation: v4l2.rst: Fix authors and revisions lists
2016-07-04 11:46 [PATCH 00/51] First part of documentation fixups Mauro Carvalho Chehab
2016-07-04 11:46 ` [PATCH 01/51] Documentation: linuxt_tv: update the documentation year Mauro Carvalho Chehab
2016-07-04 11:46 ` [PATCH 02/51] Documentation: some fixups at linux_tv/index.rst Mauro Carvalho Chehab
@ 2016-07-04 11:46 ` Mauro Carvalho Chehab
2016-07-04 11:46 ` [PATCH 04/51] Documentation: querycap.rst: fix troubles on some references Mauro Carvalho Chehab
` (47 subsequent siblings)
50 siblings, 0 replies; 52+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-04 11:46 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, Jonathan Corbet,
Markus Heiser, linux-doc
The conversion of the authors and revision history lists
didn't end too well.
Manually fix them.
The revision history still needs some care in the future.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
Documentation/linux_tv/media/v4l/v4l2.rst | 70 +++++++++++++++++--------------
1 file changed, 39 insertions(+), 31 deletions(-)
diff --git a/Documentation/linux_tv/media/v4l/v4l2.rst b/Documentation/linux_tv/media/v4l/v4l2.rst
index cf636b665d95..1ddbd67ec466 100644
--- a/Documentation/linux_tv/media/v4l/v4l2.rst
+++ b/Documentation/linux_tv/media/v4l/v4l2.rst
@@ -1,12 +1,13 @@
.. -*- coding: utf-8; mode: rst -*-
+.. include:: <isonum.txt>
.. _v4l2spec:
#####################################
Video for Linux Two API Specification
#####################################
-**Revision 4.4**
+**Revision 4.5**
.. toctree::
:maxdepth: 1
@@ -30,49 +31,56 @@ Video for Linux Two API Specification
Revision and Copyright
**********************
+Authors, in alphabetical order:
-:author: Schimek Michael (*H*)
-:address: mschimek@gmx.at
+- Ailus, Sakari <sakari.ailus@iki.fi>
-:author: Dirks Bill
-:contrib: Original author of the V4L2 API and documentation.
+ - Subdev selections API.
-:author: Verkuil Hans
-:address: hverkuil@xs4all.nl
-:contrib: Designed and documented the VIDIOC_LOG_STATUS ioctl, the extended control ioctls, major parts of the sliced VBI API, the MPEG encoder and decoder APIs and the DV Timings API.
+- Carvalho Chehab, Mauro <m.chehab@kernel.org>
-:author: Rubli Martin
-:contrib: Designed and documented the VIDIOC_ENUM_FRAMESIZES and VIDIOC_ENUM_FRAMEINTERVALS ioctls.
+ - Documented libv4l, designed and added v4l2grab example, Remote Controller chapter.
-:author: Walls Andy
-:address: awalls@md.metrocast.net
-:contrib: Documented the fielded V4L2_MPEG_STREAM_VBI_FMT_IVTV MPEG stream embedded, sliced VBI data format in this specification.
+- Dirks, Bill
-:author: Carvalho Chehab Mauro
-:address: m.chehab@samsung.com
-:contrib: Documented libv4l, designed and added v4l2grab example, Remote Controller chapter.
+ - Original author of the V4L2 API and documentation.
-:author: Karicheri Muralidharan
-:address: m-karicheri2@ti.com
-:contrib: Documented the Digital Video timings API.
+- H Schimek, Michael <mschimek@gmx.at>
-:author: Osciak Pawel
-:address: pawel AT osciak.com
-:contrib: Designed and documented the multi-planar API.
+ - Original author of the V4L2 API and documentation.
-:author: Ailus Sakari
-:address: sakari.ailus@iki.fi
-:contrib: Subdev selections API.
+- Karicheri, Muralidharan <m-karicheri2@ti.com>
-:author: Palosaari Antti
-:address: crope@iki.fi
-:contrib: SDR API.
+ - Documented the Digital Video timings API.
-**Copyright** 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015 : Bill Dirks, Michael H. Schimek, Hans Verkuil, Martin Rubli, Andy Walls, Muralidharan Karicheri, Mauro Carvalho Chehab, Pawel Osciak
+- Osciak, Pawel <pawel@osciak.com>
+
+ - Designed and documented the multi-planar API.
+
+- Palosaari, Antti <crope@iki.fi>
+
+ - SDR API.
+
+- Rubli, Martin
+
+ - Designed and documented the VIDIOC_ENUM_FRAMESIZES and VIDIOC_ENUM_FRAMEINTERVALS ioctls.
+
+- Walls, Andy <awalls@md.metrocast.net>
+
+ - Documented the fielded V4L2_MPEG_STREAM_VBI_FMT_IVTV MPEG stream embedded, sliced VBI data format in this specification.
+
+- Verkuil, Hans <hverkuil@xs4all.nl>
+
+ - Designed and documented the VIDIOC_LOG_STATUS ioctl, the extended control ioctls, major parts of the sliced VBI API, the MPEG encoder and decoder APIs and the DV Timings API.
+
+**Copyright** |copy| 1999-2016: Bill Dirks, Michael H. Schimek, Hans Verkuil, Martin Rubli, Andy Walls, Muralidharan Karicheri, Mauro Carvalho Chehab, Pawel Osciak, Sakari Ailus & Antti Palosaari.
Except when explicitly stated as GPL, programming examples within this
part can be used and distributed without restrictions.
+****************
+Revision History
+****************
:revision: 4.5 / 2015-10-29 (*rr*)
@@ -254,7 +262,7 @@ packed pixel formats.
Added the Video Output Overlay interface, new MPEG controls,
V4L2_FIELD_INTERLACED_TB and V4L2_FIELD_INTERLACED_BT,
-VIDIOC_DBG_G/S_REGISTER, VIDIOC_(TRY_)ENCODER_CMD,
+VIDIOC_DBG_G/S_REGISTER, VIDIOC\_(TRY\_)ENCODER_CMD,
VIDIOC_G_CHIP_IDENT, VIDIOC_G_ENC_INDEX, new pixel formats.
Clarifications in the cropping chapter, about RGB pixel formats, the
mmap(), poll(), select(), read() and write() functions. Typographical
@@ -311,7 +319,7 @@ for frame format enumeration of digital devices.
:revision: 0.13 / 2006-04-07 (*mhs*)
-Corrected the description of struct v4l2_window clips. New V4L2_STD_
+Corrected the description of struct v4l2_window clips. New V4L2_STD\_
and V4L2_TUNER_MODE_LANG1_LANG2 defines.
--
2.7.4
^ permalink raw reply related [flat|nested] 52+ messages in thread* [PATCH 04/51] Documentation: querycap.rst: fix troubles on some references
2016-07-04 11:46 [PATCH 00/51] First part of documentation fixups Mauro Carvalho Chehab
` (2 preceding siblings ...)
2016-07-04 11:46 ` [PATCH 03/51] Documentation: v4l2.rst: Fix authors and revisions lists Mauro Carvalho Chehab
@ 2016-07-04 11:46 ` Mauro Carvalho Chehab
2016-07-04 11:46 ` [PATCH 05/51] Documentation: linux_tv/index.rst: add xrefs for document divisions Mauro Carvalho Chehab
` (46 subsequent siblings)
50 siblings, 0 replies; 52+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-04 11:46 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, Jonathan Corbet,
Markus Heiser, linux-doc
This is not due to the format change, but there are some
wrong references on this file. Fix them.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
Documentation/linux_tv/media/v4l/querycap.rst | 10 +++++-----
1 file changed, 5 insertions(+), 5 deletions(-)
diff --git a/Documentation/linux_tv/media/v4l/querycap.rst b/Documentation/linux_tv/media/v4l/querycap.rst
index 2568820a3954..ce0c0e3f9b53 100644
--- a/Documentation/linux_tv/media/v4l/querycap.rst
+++ b/Documentation/linux_tv/media/v4l/querycap.rst
@@ -16,9 +16,9 @@ check if the kernel device is compatible with this specification, and to
query the :ref:`functions <devices>` and :ref:`I/O methods <io>`
supported by the device.
-Starting with kernel version 3.1, VIDIOC-QUERYCAP will return the V4L2
-API version used by the driver, with generally matches the Kernel
-version. There's no need of using
+Starting with kernel version 3.1, :ref:`VIDIOC_QUERYCAP <vidioc-querycap>`
+will return the V4L2 API version used by the driver, with generally
+matches the Kernel version. There's no need of using
:ref:`VIDIOC_QUERYCAP <vidioc-querycap>` to check if a specific ioctl
is supported, the V4L2 core now returns ENOTTY if a driver doesn't
provide support for an ioctl.
@@ -30,8 +30,8 @@ abstraction is a major objective of this API, the
:ref:`VIDIOC_QUERYCAP <vidioc-querycap>` ioctl also allows driver
specific applications to reliably identify the driver.
-All V4L2 drivers must support ``VIDIOC_QUERYCAP``. Applications should
-always call this ioctl after opening the device.
+All V4L2 drivers must support :ref:`VIDIOC_QUERYCAP <vidioc-querycap>`.
+Applications should always call this ioctl after opening the device.
.. ------------------------------------------------------------------------------
--
2.7.4
^ permalink raw reply related [flat|nested] 52+ messages in thread* [PATCH 05/51] Documentation: linux_tv/index.rst: add xrefs for document divisions
2016-07-04 11:46 [PATCH 00/51] First part of documentation fixups Mauro Carvalho Chehab
` (3 preceding siblings ...)
2016-07-04 11:46 ` [PATCH 04/51] Documentation: querycap.rst: fix troubles on some references Mauro Carvalho Chehab
@ 2016-07-04 11:46 ` Mauro Carvalho Chehab
2016-07-04 11:46 ` [PATCH 06/51] Documentation: app-pri.rst: Fix a bad reference Mauro Carvalho Chehab
` (45 subsequent siblings)
50 siblings, 0 replies; 52+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-04 11:46 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, Jonathan Corbet,
Markus Heiser, linux-doc
Make easier to navigate at the media document by adding the
links to each of the parts of the document.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
Documentation/linux_tv/index.rst | 16 ++++++++--------
1 file changed, 8 insertions(+), 8 deletions(-)
diff --git a/Documentation/linux_tv/index.rst b/Documentation/linux_tv/index.rst
index b0389cbfb1aa..edb7d56e9b8f 100644
--- a/Documentation/linux_tv/index.rst
+++ b/Documentation/linux_tv/index.rst
@@ -39,19 +39,19 @@ A typical media device hardware is shown at
The media infrastructure API was designed to control such devices. It is
divided into four parts.
-The first part covers radio, video capture and output,
+The :Ref:`first part <v4l2spec>` covers radio, video capture and output,
cameras, analog TV devices and codecs.
-The second part covers the API used for digital TV and Internet
-reception via one of the several digital tv standards. While it is
-called as DVB API, in fact it covers several different video standards
-including DVB-T/T2, DVB-S/S2, DVB-C, ATSC, ISDB-T, ISDB-S, DTMB, etc.
-The complete list of supported standards can be found at
+The :Ref:`second part <dvbapi>` covers the API used for digital TV and
+Internet reception via one of the several digital tv standards. While it
+is called as DVB API, in fact it covers several different video
+standards including DVB-T/T2, DVB-S/S2, DVB-C, ATSC, ISDB-T, ISDB-S,
+DTMB, etc. The complete list of supported standards can be found at
:ref:`fe-delivery-system-t`.
-The third part covers the Remote Controller API.
+The :Ref:`third part <remote_controllers>` covers the Remote Controller API.
-The fourth part covers the Media Controller API.
+The :Ref:`fourth part <media_controller>` covers the Media Controller API.
It should also be noted that a media device may also have audio
components, like mixers, PCM capture, PCM playback, etc, which are
--
2.7.4
^ permalink raw reply related [flat|nested] 52+ messages in thread* [PATCH 06/51] Documentation: app-pri.rst: Fix a bad reference
2016-07-04 11:46 [PATCH 00/51] First part of documentation fixups Mauro Carvalho Chehab
` (4 preceding siblings ...)
2016-07-04 11:46 ` [PATCH 05/51] Documentation: linux_tv/index.rst: add xrefs for document divisions Mauro Carvalho Chehab
@ 2016-07-04 11:46 ` Mauro Carvalho Chehab
2016-07-04 11:46 ` [PATCH 07/51] Documentation: video.rst: use reference for VIDIOC_ENUMINPUT Mauro Carvalho Chehab
` (44 subsequent siblings)
50 siblings, 0 replies; 52+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-04 11:46 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, Jonathan Corbet,
Markus Heiser, linux-doc
What should be a reference to VIDIOC_S_PRIORITY was incorrectly
defined as a constant at the DocBook. Fix it on the rst version.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
Documentation/linux_tv/media/v4l/app-pri.rst | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/Documentation/linux_tv/media/v4l/app-pri.rst b/Documentation/linux_tv/media/v4l/app-pri.rst
index 9716437ae14d..7f034852ae1f 100644
--- a/Documentation/linux_tv/media/v4l/app-pri.rst
+++ b/Documentation/linux_tv/media/v4l/app-pri.rst
@@ -21,8 +21,8 @@ defines the :ref:`VIDIOC_G_PRIORITY <vidioc-g-priority>` and
query the access priority associate with a file descriptor. Opening a
device assigns a medium priority, compatible with earlier versions of
V4L2 and drivers not supporting these ioctls. Applications requiring a
-different priority will usually call ``VIDIOC_S_PRIORITY`` after
-verifying the device with the
+different priority will usually call :ref:`VIDIOC_S_PRIORITY
+<vidioc-g-priority>` after verifying the device with the
:ref:`VIDIOC_QUERYCAP <vidioc-querycap>` ioctl.
Ioctls changing driver properties, such as
--
2.7.4
^ permalink raw reply related [flat|nested] 52+ messages in thread* [PATCH 07/51] Documentation: video.rst: use reference for VIDIOC_ENUMINPUT
2016-07-04 11:46 [PATCH 00/51] First part of documentation fixups Mauro Carvalho Chehab
` (5 preceding siblings ...)
2016-07-04 11:46 ` [PATCH 06/51] Documentation: app-pri.rst: Fix a bad reference Mauro Carvalho Chehab
@ 2016-07-04 11:46 ` Mauro Carvalho Chehab
2016-07-04 11:46 ` [PATCH 08/51] Documentation: v4l2.rst: numerate the V4L2 chapters Mauro Carvalho Chehab
` (43 subsequent siblings)
50 siblings, 0 replies; 52+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-04 11:46 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, Jonathan Corbet,
Markus Heiser, linux-doc
Instead of using const, transform it into a reference.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
Documentation/linux_tv/media/v4l/video.rst | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/Documentation/linux_tv/media/v4l/video.rst b/Documentation/linux_tv/media/v4l/video.rst
index 803bb37f4be8..f214bd835622 100644
--- a/Documentation/linux_tv/media/v4l/video.rst
+++ b/Documentation/linux_tv/media/v4l/video.rst
@@ -17,8 +17,8 @@ outputs applications can enumerate them with the
:ref:`VIDIOC_ENUMINPUT <vidioc-enuminput>` and
:ref:`VIDIOC_ENUMOUTPUT <vidioc-enumoutput>` ioctl, respectively. The
struct :ref:`v4l2_input <v4l2-input>` returned by the
-``VIDIOC_ENUMINPUT`` ioctl also contains signal status information
-applicable when the current video input is queried.
+:ref:`VIDIOC_ENUMINPUT <vidioc-enuminput>` ioctl also contains signal
+:status information applicable when the current video input is queried.
The :ref:`VIDIOC_G_INPUT <vidioc-g-input>` and
:ref:`VIDIOC_G_OUTPUT <vidioc-g-output>` ioctls return the index of
--
2.7.4
^ permalink raw reply related [flat|nested] 52+ messages in thread* [PATCH 08/51] Documentation: v4l2.rst: numerate the V4L2 chapters
2016-07-04 11:46 [PATCH 00/51] First part of documentation fixups Mauro Carvalho Chehab
` (6 preceding siblings ...)
2016-07-04 11:46 ` [PATCH 07/51] Documentation: video.rst: use reference for VIDIOC_ENUMINPUT Mauro Carvalho Chehab
@ 2016-07-04 11:46 ` Mauro Carvalho Chehab
2016-07-04 11:46 ` [PATCH 09/51] Documentation: video.rst: Restore the captions for the examples Mauro Carvalho Chehab
` (42 subsequent siblings)
50 siblings, 0 replies; 52+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-04 11:46 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, Jonathan Corbet,
Markus Heiser, linux-doc
The Video4Linux documentation is big. We want to numerate the
items, as it makes easier to reference an item while discussing
the document on meetings.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
Documentation/linux_tv/media/v4l/v4l2.rst | 2 ++
1 file changed, 2 insertions(+)
diff --git a/Documentation/linux_tv/media/v4l/v4l2.rst b/Documentation/linux_tv/media/v4l/v4l2.rst
index 1ddbd67ec466..44605ec92a50 100644
--- a/Documentation/linux_tv/media/v4l/v4l2.rst
+++ b/Documentation/linux_tv/media/v4l/v4l2.rst
@@ -10,7 +10,9 @@ Video for Linux Two API Specification
**Revision 4.5**
.. toctree::
+ :numbered:
:maxdepth: 1
+ :caption: Table of Contents
common
pixfmt
--
2.7.4
^ permalink raw reply related [flat|nested] 52+ messages in thread* [PATCH 09/51] Documentation: video.rst: Restore the captions for the examples
2016-07-04 11:46 [PATCH 00/51] First part of documentation fixups Mauro Carvalho Chehab
` (7 preceding siblings ...)
2016-07-04 11:46 ` [PATCH 08/51] Documentation: v4l2.rst: numerate the V4L2 chapters Mauro Carvalho Chehab
@ 2016-07-04 11:46 ` Mauro Carvalho Chehab
2016-07-04 11:46 ` [PATCH 10/51] Documentation: audio.rst: Fix some cross references Mauro Carvalho Chehab
` (41 subsequent siblings)
50 siblings, 0 replies; 52+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-04 11:46 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, Jonathan Corbet,
Markus Heiser, linux-doc
There are two examples in the code, but the captions of them
were lost during the ReST conversion. Manually add them again.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
Documentation/linux_tv/media/v4l/video.rst | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)
diff --git a/Documentation/linux_tv/media/v4l/video.rst b/Documentation/linux_tv/media/v4l/video.rst
index f214bd835622..fc220be52c2b 100644
--- a/Documentation/linux_tv/media/v4l/video.rst
+++ b/Documentation/linux_tv/media/v4l/video.rst
@@ -28,8 +28,8 @@ applications call the :ref:`VIDIOC_S_INPUT <vidioc-g-input>` and
implement all the input ioctls when the device has one or more inputs,
all the output ioctls when the device has one or more outputs.
-
.. code-block:: c
+ :caption: Example 1: Information about the current video input
struct v4l2_input input;
int index;
@@ -51,6 +51,7 @@ all the output ioctls when the device has one or more outputs.
.. code-block:: c
+ :caption: Example 2: Switching to the first video input
int index;
--
2.7.4
^ permalink raw reply related [flat|nested] 52+ messages in thread* [PATCH 10/51] Documentation: audio.rst: Fix some cross references
2016-07-04 11:46 [PATCH 00/51] First part of documentation fixups Mauro Carvalho Chehab
` (8 preceding siblings ...)
2016-07-04 11:46 ` [PATCH 09/51] Documentation: video.rst: Restore the captions for the examples Mauro Carvalho Chehab
@ 2016-07-04 11:46 ` Mauro Carvalho Chehab
2016-07-04 11:46 ` [PATCH 11/51] Documentation: linux_tv: Replace reference names to match ioctls Mauro Carvalho Chehab
` (40 subsequent siblings)
50 siblings, 0 replies; 52+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-04 11:46 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, Jonathan Corbet,
Markus Heiser, linux-doc
There are several constants there that should be, instead,
cross-references. Fix them.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
Documentation/linux_tv/media/v4l/audio.rst | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/Documentation/linux_tv/media/v4l/audio.rst b/Documentation/linux_tv/media/v4l/audio.rst
index 5e37adfbb49c..95622902e86e 100644
--- a/Documentation/linux_tv/media/v4l/audio.rst
+++ b/Documentation/linux_tv/media/v4l/audio.rst
@@ -30,16 +30,16 @@ outputs applications can enumerate them with the
:ref:`VIDIOC_ENUMAUDIO <vidioc-enumaudio>` and
:ref:`VIDIOC_ENUMAUDOUT <vidioc-enumaudioout>` ioctl, respectively.
The struct :ref:`v4l2_audio <v4l2-audio>` returned by the
-``VIDIOC_ENUMAUDIO`` ioctl also contains signal status information
-applicable when the current audio input is queried.
+:ref:`VIDIOC_ENUMAUDIO <vidioc-enumaudio>` ioctl also contains signal
+:status information applicable when the current audio input is queried.
The :ref:`VIDIOC_G_AUDIO <vidioc-g-audio>` and
:ref:`VIDIOC_G_AUDOUT <vidioc-g-audioout>` ioctls report the current
audio input and output, respectively. Note that, unlike
:ref:`VIDIOC_G_INPUT <vidioc-g-input>` and
:ref:`VIDIOC_G_OUTPUT <vidioc-g-output>` these ioctls return a
-structure as ``VIDIOC_ENUMAUDIO`` and ``VIDIOC_ENUMAUDOUT`` do, not just
-an index.
+structure as :ref:`VIDIOC_ENUMAUDIO <vidioc-enumaudio>` and
+:ref:`VIDIOC_ENUMAUDOUT <vidioc-enumaudioout>` do, not just an index.
To select an audio input and change its properties applications call the
:ref:`VIDIOC_S_AUDIO <vidioc-g-audio>` ioctl. To select an audio
--
2.7.4
^ permalink raw reply related [flat|nested] 52+ messages in thread* [PATCH 11/51] Documentation: linux_tv: Replace reference names to match ioctls
2016-07-04 11:46 [PATCH 00/51] First part of documentation fixups Mauro Carvalho Chehab
` (9 preceding siblings ...)
2016-07-04 11:46 ` [PATCH 10/51] Documentation: audio.rst: Fix some cross references Mauro Carvalho Chehab
@ 2016-07-04 11:46 ` Mauro Carvalho Chehab
2016-07-04 11:46 ` [PATCH 12/51] Documentation: linux_tv: simplify references Mauro Carvalho Chehab
` (39 subsequent siblings)
50 siblings, 0 replies; 52+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-04 11:46 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, Jonathan Corbet,
Markus Heiser, linux-doc
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #1: Type: text/plain; charset=true, Size: 203205 bytes --]
Due to a limitation at the DocBook language, the references
were using lowercase and slashes, instead of the name of the
ioctls. On ReST, make them identical. This will hopefully
help to cleanup the code a little bit.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
.../linux_tv/media/dvb/audio_function_calls.rst | 2 +-
.../linux_tv/media/dvb/video_function_calls.rst | 18 +--
Documentation/linux_tv/media/v4l/app-pri.rst | 10 +-
Documentation/linux_tv/media/v4l/audio.rst | 24 ++--
Documentation/linux_tv/media/v4l/buffer.rst | 44 +++----
Documentation/linux_tv/media/v4l/control.rst | 14 +--
Documentation/linux_tv/media/v4l/crop.rst | 12 +-
Documentation/linux_tv/media/v4l/dev-capture.rst | 8 +-
Documentation/linux_tv/media/v4l/dev-codec.rst | 2 +-
Documentation/linux_tv/media/v4l/dev-event.rst | 4 +-
Documentation/linux_tv/media/v4l/dev-osd.rst | 12 +-
Documentation/linux_tv/media/v4l/dev-output.rst | 8 +-
Documentation/linux_tv/media/v4l/dev-overlay.rst | 38 +++---
Documentation/linux_tv/media/v4l/dev-radio.rst | 6 +-
Documentation/linux_tv/media/v4l/dev-raw-vbi.rst | 12 +-
Documentation/linux_tv/media/v4l/dev-rds.rst | 4 +-
Documentation/linux_tv/media/v4l/dev-sdr.rst | 8 +-
.../linux_tv/media/v4l/dev-sliced-vbi.rst | 36 +++---
Documentation/linux_tv/media/v4l/dev-subdev.rst | 22 ++--
Documentation/linux_tv/media/v4l/diff-v4l.rst | 96 +++++++--------
Documentation/linux_tv/media/v4l/dmabuf.rst | 20 ++--
Documentation/linux_tv/media/v4l/dv-timings.rst | 10 +-
.../linux_tv/media/v4l/extended-controls.rst | 40 +++----
Documentation/linux_tv/media/v4l/field-order.rst | 6 +-
Documentation/linux_tv/media/v4l/format.rst | 10 +-
Documentation/linux_tv/media/v4l/func-mmap.rst | 6 +-
Documentation/linux_tv/media/v4l/func-open.rst | 2 +-
Documentation/linux_tv/media/v4l/func-poll.rst | 12 +-
Documentation/linux_tv/media/v4l/func-read.rst | 4 +-
Documentation/linux_tv/media/v4l/func-select.rst | 8 +-
Documentation/linux_tv/media/v4l/hist-v4l2.rst | 130 ++++++++++-----------
Documentation/linux_tv/media/v4l/io.rst | 4 +-
.../linux_tv/media/v4l/libv4l-introduction.rst | 12 +-
Documentation/linux_tv/media/v4l/mmap.rst | 20 ++--
Documentation/linux_tv/media/v4l/open.rst | 6 +-
Documentation/linux_tv/media/v4l/pixfmt-013.rst | 4 +-
Documentation/linux_tv/media/v4l/pixfmt.rst | 4 +-
Documentation/linux_tv/media/v4l/planar-apis.rst | 16 +--
Documentation/linux_tv/media/v4l/querycap.rst | 12 +-
Documentation/linux_tv/media/v4l/rw.rst | 2 +-
.../linux_tv/media/v4l/selection-api-004.rst | 2 +-
Documentation/linux_tv/media/v4l/standard.rst | 12 +-
Documentation/linux_tv/media/v4l/streaming-par.rst | 6 +-
Documentation/linux_tv/media/v4l/tuner.rst | 22 ++--
Documentation/linux_tv/media/v4l/userp.rst | 18 +--
Documentation/linux_tv/media/v4l/v4l2.rst | 2 +-
Documentation/linux_tv/media/v4l/video.rst | 14 +--
.../linux_tv/media/v4l/vidioc-create-bufs.rst | 8 +-
.../linux_tv/media/v4l/vidioc-cropcap.rst | 2 +-
.../linux_tv/media/v4l/vidioc-dbg-g-chip-info.rst | 2 +-
.../linux_tv/media/v4l/vidioc-dbg-g-register.rst | 6 +-
.../linux_tv/media/v4l/vidioc-decoder-cmd.rst | 8 +-
.../linux_tv/media/v4l/vidioc-dqevent.rst | 8 +-
.../linux_tv/media/v4l/vidioc-dv-timings-cap.rst | 2 +-
.../linux_tv/media/v4l/vidioc-encoder-cmd.rst | 8 +-
.../linux_tv/media/v4l/vidioc-enum-dv-timings.rst | 4 +-
.../linux_tv/media/v4l/vidioc-enum-fmt.rst | 2 +-
.../media/v4l/vidioc-enum-frameintervals.rst | 6 +-
.../linux_tv/media/v4l/vidioc-enum-framesizes.rst | 4 +-
.../linux_tv/media/v4l/vidioc-enum-freq-bands.rst | 2 +-
.../linux_tv/media/v4l/vidioc-enumaudio.rst | 4 +-
.../linux_tv/media/v4l/vidioc-enumaudioout.rst | 4 +-
.../linux_tv/media/v4l/vidioc-enuminput.rst | 2 +-
.../linux_tv/media/v4l/vidioc-enumoutput.rst | 2 +-
.../linux_tv/media/v4l/vidioc-enumstd.rst | 2 +-
Documentation/linux_tv/media/v4l/vidioc-expbuf.rst | 10 +-
.../linux_tv/media/v4l/vidioc-g-audio.rst | 2 +-
.../linux_tv/media/v4l/vidioc-g-audioout.rst | 2 +-
Documentation/linux_tv/media/v4l/vidioc-g-crop.rst | 4 +-
Documentation/linux_tv/media/v4l/vidioc-g-ctrl.rst | 10 +-
.../linux_tv/media/v4l/vidioc-g-dv-timings.rst | 4 +-
Documentation/linux_tv/media/v4l/vidioc-g-edid.rst | 10 +-
.../linux_tv/media/v4l/vidioc-g-enc-index.rst | 2 +-
.../linux_tv/media/v4l/vidioc-g-ext-ctrls.rst | 10 +-
Documentation/linux_tv/media/v4l/vidioc-g-fbuf.rst | 18 +--
Documentation/linux_tv/media/v4l/vidioc-g-fmt.rst | 2 +-
.../linux_tv/media/v4l/vidioc-g-frequency.rst | 2 +-
.../linux_tv/media/v4l/vidioc-g-input.rst | 4 +-
.../linux_tv/media/v4l/vidioc-g-jpegcomp.rst | 2 +-
.../linux_tv/media/v4l/vidioc-g-modulator.rst | 4 +-
.../linux_tv/media/v4l/vidioc-g-output.rst | 4 +-
Documentation/linux_tv/media/v4l/vidioc-g-parm.rst | 2 +-
.../linux_tv/media/v4l/vidioc-g-priority.rst | 2 +-
.../linux_tv/media/v4l/vidioc-g-selection.rst | 2 +-
.../linux_tv/media/v4l/vidioc-g-sliced-vbi-cap.rst | 4 +-
Documentation/linux_tv/media/v4l/vidioc-g-std.rst | 4 +-
.../linux_tv/media/v4l/vidioc-g-tuner.rst | 10 +-
.../linux_tv/media/v4l/vidioc-log-status.rst | 2 +-
.../linux_tv/media/v4l/vidioc-overlay.rst | 6 +-
.../linux_tv/media/v4l/vidioc-prepare-buf.rst | 2 +-
Documentation/linux_tv/media/v4l/vidioc-qbuf.rst | 14 +--
.../linux_tv/media/v4l/vidioc-query-dv-timings.rst | 4 +-
.../linux_tv/media/v4l/vidioc-querybuf.rst | 6 +-
.../linux_tv/media/v4l/vidioc-querycap.rst | 4 +-
.../linux_tv/media/v4l/vidioc-queryctrl.rst | 6 +-
.../linux_tv/media/v4l/vidioc-querystd.rst | 2 +-
.../linux_tv/media/v4l/vidioc-reqbufs.rst | 4 +-
.../linux_tv/media/v4l/vidioc-s-hw-freq-seek.rst | 6 +-
.../linux_tv/media/v4l/vidioc-streamon.rst | 8 +-
.../v4l/vidioc-subdev-enum-frame-interval.rst | 4 +-
.../media/v4l/vidioc-subdev-enum-frame-size.rst | 8 +-
.../media/v4l/vidioc-subdev-enum-mbus-code.rst | 4 +-
.../linux_tv/media/v4l/vidioc-subdev-g-crop.rst | 4 +-
.../linux_tv/media/v4l/vidioc-subdev-g-fmt.rst | 2 +-
.../media/v4l/vidioc-subdev-g-frame-interval.rst | 2 +-
.../media/v4l/vidioc-subdev-g-selection.rst | 4 +-
.../linux_tv/media/v4l/vidioc-subscribe-event.rst | 8 +-
107 files changed, 537 insertions(+), 537 deletions(-)
diff --git a/Documentation/linux_tv/media/dvb/audio_function_calls.rst b/Documentation/linux_tv/media/dvb/audio_function_calls.rst
index 41a5757ffd72..d1a5b5970b71 100644
--- a/Documentation/linux_tv/media/dvb/audio_function_calls.rst
+++ b/Documentation/linux_tv/media/dvb/audio_function_calls.rst
@@ -456,7 +456,7 @@ AUDIO_SET_MUTE
DESCRIPTION
This ioctl is for DVB devices only. To control a V4L2 decoder use the
-V4L2 :ref:`VIDIOC_DECODER_CMD <vidioc-decoder-cmd>` with the
+V4L2 :ref:`VIDIOC_DECODER_CMD <VIDIOC_DECODER_CMD>` with the
``V4L2_DEC_CMD_START_MUTE_AUDIO`` flag instead.
This ioctl call asks the audio device to mute the stream that is
diff --git a/Documentation/linux_tv/media/dvb/video_function_calls.rst b/Documentation/linux_tv/media/dvb/video_function_calls.rst
index 3add2b85450d..98c90dcdb587 100644
--- a/Documentation/linux_tv/media/dvb/video_function_calls.rst
+++ b/Documentation/linux_tv/media/dvb/video_function_calls.rst
@@ -239,7 +239,7 @@ VIDEO_STOP
DESCRIPTION
This ioctl is for DVB devices only. To control a V4L2 decoder use the
-V4L2 :ref:`VIDIOC_DECODER_CMD <vidioc-decoder-cmd>` instead.
+V4L2 :ref:`VIDIOC_DECODER_CMD <VIDIOC_DECODER_CMD>` instead.
This ioctl call asks the Video Device to stop playing the current
stream. Depending on the input parameter, the screen can be blanked out
@@ -302,7 +302,7 @@ VIDEO_PLAY
DESCRIPTION
This ioctl is for DVB devices only. To control a V4L2 decoder use the
-V4L2 :ref:`VIDIOC_DECODER_CMD <vidioc-decoder-cmd>` instead.
+V4L2 :ref:`VIDIOC_DECODER_CMD <VIDIOC_DECODER_CMD>` instead.
This ioctl call asks the Video Device to start playing a video stream
from the selected source.
@@ -348,7 +348,7 @@ VIDEO_FREEZE
DESCRIPTION
This ioctl is for DVB devices only. To control a V4L2 decoder use the
-V4L2 :ref:`VIDIOC_DECODER_CMD <vidioc-decoder-cmd>` instead.
+V4L2 :ref:`VIDIOC_DECODER_CMD <VIDIOC_DECODER_CMD>` instead.
This ioctl call suspends the live video stream being played. Decoding
and playing are frozen. It is then possible to restart the decoding and
@@ -398,7 +398,7 @@ VIDEO_CONTINUE
DESCRIPTION
This ioctl is for DVB devices only. To control a V4L2 decoder use the
-V4L2 :ref:`VIDIOC_DECODER_CMD <vidioc-decoder-cmd>` instead.
+V4L2 :ref:`VIDIOC_DECODER_CMD <VIDIOC_DECODER_CMD>` instead.
This ioctl call restarts decoding and playing processes of the video
stream which was played before a call to VIDEO_FREEZE was made.
@@ -763,7 +763,7 @@ VIDEO_GET_EVENT
DESCRIPTION
This ioctl is for DVB devices only. To get events from a V4L2 decoder
-use the V4L2 :ref:`VIDIOC_DQEVENT <vidioc-dqevent>` ioctl instead.
+use the V4L2 :ref:`VIDIOC_DQEVENT <VIDIOC_DQEVENT>` ioctl instead.
This ioctl call returns an event of type video_event if available. If
an event is not available, the behavior depends on whether the device is
@@ -844,11 +844,11 @@ DESCRIPTION
This ioctl is obsolete. Do not use in new drivers. For V4L2 decoders
this ioctl has been replaced by the
-:ref:`VIDIOC_DECODER_CMD <vidioc-decoder-cmd>` ioctl.
+:ref:`VIDIOC_DECODER_CMD <VIDIOC_DECODER_CMD>` ioctl.
This ioctl commands the decoder. The ``video_command`` struct is a
subset of the ``v4l2_decoder_cmd`` struct, so refer to the
-:ref:`VIDIOC_DECODER_CMD <vidioc-decoder-cmd>` documentation for
+:ref:`VIDIOC_DECODER_CMD <VIDIOC_DECODER_CMD>` documentation for
more information.
SYNOPSIS
@@ -900,11 +900,11 @@ DESCRIPTION
This ioctl is obsolete. Do not use in new drivers. For V4L2 decoders
this ioctl has been replaced by the
-:ref:`VIDIOC_TRY_DECODER_CMD <vidioc-decoder-cmd>` ioctl.
+:ref:`VIDIOC_TRY_DECODER_CMD <VIDIOC_DECODER_CMD>` ioctl.
This ioctl tries a decoder command. The ``video_command`` struct is a
subset of the ``v4l2_decoder_cmd`` struct, so refer to the
-:ref:`VIDIOC_TRY_DECODER_CMD <vidioc-decoder-cmd>` documentation
+:ref:`VIDIOC_TRY_DECODER_CMD <VIDIOC_DECODER_CMD>` documentation
for more information.
SYNOPSIS
diff --git a/Documentation/linux_tv/media/v4l/app-pri.rst b/Documentation/linux_tv/media/v4l/app-pri.rst
index 7f034852ae1f..bc50afca95fc 100644
--- a/Documentation/linux_tv/media/v4l/app-pri.rst
+++ b/Documentation/linux_tv/media/v4l/app-pri.rst
@@ -16,17 +16,17 @@ applications and automatically regain control of the device at a later
time.
Since these features cannot be implemented entirely in user space V4L2
-defines the :ref:`VIDIOC_G_PRIORITY <vidioc-g-priority>` and
-:ref:`VIDIOC_S_PRIORITY <vidioc-g-priority>` ioctls to request and
+defines the :ref:`VIDIOC_G_PRIORITY <VIDIOC_G_PRIORITY>` and
+:ref:`VIDIOC_S_PRIORITY <VIDIOC_G_PRIORITY>` ioctls to request and
query the access priority associate with a file descriptor. Opening a
device assigns a medium priority, compatible with earlier versions of
V4L2 and drivers not supporting these ioctls. Applications requiring a
different priority will usually call :ref:`VIDIOC_S_PRIORITY
-<vidioc-g-priority>` after verifying the device with the
-:ref:`VIDIOC_QUERYCAP <vidioc-querycap>` ioctl.
+<VIDIOC_G_PRIORITY>` after verifying the device with the
+:ref:`VIDIOC_QUERYCAP <VIDIOC_QUERYCAP>` ioctl.
Ioctls changing driver properties, such as
-:ref:`VIDIOC_S_INPUT <vidioc-g-input>`, return an EBUSY error code
+:ref:`VIDIOC_S_INPUT <VIDIOC_G_INPUT>`, return an EBUSY error code
after another application obtained higher priority.
diff --git a/Documentation/linux_tv/media/v4l/audio.rst b/Documentation/linux_tv/media/v4l/audio.rst
index 95622902e86e..fa6bf5ad8d32 100644
--- a/Documentation/linux_tv/media/v4l/audio.rst
+++ b/Documentation/linux_tv/media/v4l/audio.rst
@@ -27,31 +27,31 @@ number, starting at zero, of one audio input or output.
To learn about the number and attributes of the available inputs and
outputs applications can enumerate them with the
-:ref:`VIDIOC_ENUMAUDIO <vidioc-enumaudio>` and
-:ref:`VIDIOC_ENUMAUDOUT <vidioc-enumaudioout>` ioctl, respectively.
+:ref:`VIDIOC_ENUMAUDIO <VIDIOC_ENUMAUDIO>` and
+:ref:`VIDIOC_ENUMAUDOUT <VIDIOC_ENUMAUDIOout>` ioctl, respectively.
The struct :ref:`v4l2_audio <v4l2-audio>` returned by the
-:ref:`VIDIOC_ENUMAUDIO <vidioc-enumaudio>` ioctl also contains signal
+:ref:`VIDIOC_ENUMAUDIO <VIDIOC_ENUMAUDIO>` ioctl also contains signal
:status information applicable when the current audio input is queried.
-The :ref:`VIDIOC_G_AUDIO <vidioc-g-audio>` and
-:ref:`VIDIOC_G_AUDOUT <vidioc-g-audioout>` ioctls report the current
+The :ref:`VIDIOC_G_AUDIO <VIDIOC_G_AUDIO>` and
+:ref:`VIDIOC_G_AUDOUT <VIDIOC_G_AUDIOout>` ioctls report the current
audio input and output, respectively. Note that, unlike
-:ref:`VIDIOC_G_INPUT <vidioc-g-input>` and
-:ref:`VIDIOC_G_OUTPUT <vidioc-g-output>` these ioctls return a
-structure as :ref:`VIDIOC_ENUMAUDIO <vidioc-enumaudio>` and
-:ref:`VIDIOC_ENUMAUDOUT <vidioc-enumaudioout>` do, not just an index.
+:ref:`VIDIOC_G_INPUT <VIDIOC_G_INPUT>` and
+:ref:`VIDIOC_G_OUTPUT <VIDIOC_G_OUTPUT>` these ioctls return a
+structure as :ref:`VIDIOC_ENUMAUDIO <VIDIOC_ENUMAUDIO>` and
+:ref:`VIDIOC_ENUMAUDOUT <VIDIOC_ENUMAUDIOout>` do, not just an index.
To select an audio input and change its properties applications call the
-:ref:`VIDIOC_S_AUDIO <vidioc-g-audio>` ioctl. To select an audio
+:ref:`VIDIOC_S_AUDIO <VIDIOC_G_AUDIO>` ioctl. To select an audio
output (which presently has no changeable properties) applications call
-the :ref:`VIDIOC_S_AUDOUT <vidioc-g-audioout>` ioctl.
+the :ref:`VIDIOC_S_AUDOUT <VIDIOC_G_AUDIOout>` ioctl.
Drivers must implement all audio input ioctls when the device has
multiple selectable audio inputs, all audio output ioctls when the
device has multiple selectable audio outputs. When the device has any
audio inputs or outputs the driver must set the ``V4L2_CAP_AUDIO`` flag
in the struct :ref:`v4l2_capability <v4l2-capability>` returned by
-the :ref:`VIDIOC_QUERYCAP <vidioc-querycap>` ioctl.
+the :ref:`VIDIOC_QUERYCAP <VIDIOC_QUERYCAP>` ioctl.
.. code-block:: c
diff --git a/Documentation/linux_tv/media/v4l/buffer.rst b/Documentation/linux_tv/media/v4l/buffer.rst
index e4cec63979c2..7d96ab74500f 100644
--- a/Documentation/linux_tv/media/v4l/buffer.rst
+++ b/Documentation/linux_tv/media/v4l/buffer.rst
@@ -12,9 +12,9 @@ planes, while the buffer structure acts as a container for the planes.
Only pointers to buffers (planes) are exchanged, the data itself is not
copied. These pointers, together with meta-information like timestamps
or field parity, are stored in a struct :c:type:`struct v4l2_buffer`,
-argument to the :ref:`VIDIOC_QUERYBUF <vidioc-querybuf>`,
-:ref:`VIDIOC_QBUF <vidioc-qbuf>` and
-:ref:`VIDIOC_DQBUF <vidioc-qbuf>` ioctl. In the multi-planar API,
+argument to the :ref:`VIDIOC_QUERYBUF <VIDIOC_QUERYBUF>`,
+:ref:`VIDIOC_QBUF <VIDIOC_QBUF>` and
+:ref:`VIDIOC_DQBUF <VIDIOC_QBUF>` ioctl. In the multi-planar API,
some plane-specific members of struct :c:type:`struct v4l2_buffer`,
such as pointers and sizes for each plane, are stored in struct
:c:type:`struct v4l2_plane` instead. In that case, struct
@@ -26,8 +26,8 @@ see flags in the masks ``V4L2_BUF_FLAG_TIMESTAMP_MASK`` and
``V4L2_BUF_FLAG_TSTAMP_SRC_MASK`` in :ref:`buffer-flags`. These flags
are always valid and constant across all buffers during the whole video
stream. Changes in these flags may take place as a side effect of
-:ref:`VIDIOC_S_INPUT <vidioc-g-input>` or
-:ref:`VIDIOC_S_OUTPUT <vidioc-g-output>` however. The
+:ref:`VIDIOC_S_INPUT <VIDIOC_G_INPUT>` or
+:ref:`VIDIOC_S_OUTPUT <VIDIOC_G_OUTPUT>` however. The
``V4L2_BUF_FLAG_TIMESTAMP_COPY`` timestamp type which is used by e.g. on
mem-to-mem devices is an exception to the rule: the timestamp source
flags are copied from the OUTPUT video buffer to the CAPTURE video
@@ -50,12 +50,12 @@ buffer.
-
- Number of the buffer, set by the application except when calling
- :ref:`VIDIOC_DQBUF <vidioc-qbuf>`, then it is set by the
+ :ref:`VIDIOC_DQBUF <VIDIOC_QBUF>`, then it is set by the
driver. This field can range from zero to the number of buffers
- allocated with the :ref:`VIDIOC_REQBUFS <vidioc-reqbufs>` ioctl
+ allocated with the :ref:`VIDIOC_REQBUFS <VIDIOC_REQBUFS>` ioctl
(struct :ref:`v4l2_requestbuffers <v4l2-requestbuffers>`
``count``), plus any buffers allocated with
- :ref:`VIDIOC_CREATE_BUFS <vidioc-create-bufs>` minus one.
+ :ref:`VIDIOC_CREATE_BUFS <VIDIOC_CREATE_BUFS>` minus one.
- .. row 2
@@ -243,8 +243,8 @@ buffer.
-
- Size of the buffer (not the payload) in bytes for the
single-planar API. This is set by the driver based on the calls to
- :ref:`VIDIOC_REQBUFS <vidioc-reqbufs>` and/or
- :ref:`VIDIOC_CREATE_BUFS <vidioc-create-bufs>`. For the
+ :ref:`VIDIOC_REQBUFS <VIDIOC_REQBUFS>` and/or
+ :ref:`VIDIOC_CREATE_BUFS <VIDIOC_CREATE_BUFS>`. For the
multi-planar API the application sets this to the number of
elements in the ``planes`` array. The driver will fill in the
actual number of valid elements in that array.
@@ -303,8 +303,8 @@ buffer.
-
- Size in bytes of the plane (not its payload). This is set by the
driver based on the calls to
- :ref:`VIDIOC_REQBUFS <vidioc-reqbufs>` and/or
- :ref:`VIDIOC_CREATE_BUFS <vidioc-create-bufs>`.
+ :ref:`VIDIOC_REQBUFS <VIDIOC_REQBUFS>` and/or
+ :ref:`VIDIOC_CREATE_BUFS <VIDIOC_CREATE_BUFS>`.
- .. row 3
@@ -506,9 +506,9 @@ buffer.
- The buffer resides in device memory and has been mapped into the
application's address space, see :ref:`mmap` for details.
Drivers set or clear this flag when the
- :ref:`VIDIOC_QUERYBUF <vidioc-querybuf>`,
- :ref:`VIDIOC_QBUF <vidioc-qbuf>` or
- :ref:`VIDIOC_DQBUF <vidioc-qbuf>` ioctl is called. Set by the
+ :ref:`VIDIOC_QUERYBUF <VIDIOC_QUERYBUF>`,
+ :ref:`VIDIOC_QBUF <VIDIOC_QBUF>` or
+ :ref:`VIDIOC_DQBUF <VIDIOC_QBUF>` ioctl is called. Set by the
driver.
- .. row 2
@@ -609,10 +609,10 @@ buffer.
- The buffer has been prepared for I/O and can be queued by the
application. Drivers set or clear this flag when the
- :ref:`VIDIOC_QUERYBUF <vidioc-querybuf>`,
- :ref:`VIDIOC_PREPARE_BUF <vidioc-qbuf>`,
- :ref:`VIDIOC_QBUF <vidioc-qbuf>` or
- :ref:`VIDIOC_DQBUF <vidioc-qbuf>` ioctl is called.
+ :ref:`VIDIOC_QUERYBUF <VIDIOC_QUERYBUF>`,
+ :ref:`VIDIOC_PREPARE_BUF <VIDIOC_QBUF>`,
+ :ref:`VIDIOC_QBUF <VIDIOC_QBUF>` or
+ :ref:`VIDIOC_DQBUF <VIDIOC_QBUF>` ioctl is called.
- .. row 10
@@ -645,12 +645,12 @@ buffer.
- Last buffer produced by the hardware. mem2mem codec drivers set
this flag on the capture queue for the last buffer when the
- :ref:`VIDIOC_QUERYBUF <vidioc-querybuf>` or
- :ref:`VIDIOC_DQBUF <vidioc-qbuf>` ioctl is called. Due to
+ :ref:`VIDIOC_QUERYBUF <VIDIOC_QUERYBUF>` or
+ :ref:`VIDIOC_DQBUF <VIDIOC_QBUF>` ioctl is called. Due to
hardware limitations, the last buffer may be empty. In this case
the driver will set the ``bytesused`` field to 0, regardless of
the format. Any Any subsequent call to the
- :ref:`VIDIOC_DQBUF <vidioc-qbuf>` ioctl will not block anymore,
+ :ref:`VIDIOC_DQBUF <VIDIOC_QBUF>` ioctl will not block anymore,
but return an EPIPE error code.
- .. row 13
diff --git a/Documentation/linux_tv/media/v4l/control.rst b/Documentation/linux_tv/media/v4l/control.rst
index 16eb34472892..3e5c650707ae 100644
--- a/Documentation/linux_tv/media/v4l/control.rst
+++ b/Documentation/linux_tv/media/v4l/control.rst
@@ -47,7 +47,7 @@ changed or generally never without application request.
V4L2 specifies an event mechanism to notify applications when controls
change value (see
-:ref:`VIDIOC_SUBSCRIBE_EVENT <vidioc-subscribe-event>`, event
+:ref:`VIDIOC_SUBSCRIBE_EVENT <VIDIOC_SUBSCRIBE_EVENT>`, event
``V4L2_EVENT_CTRL``), panel applications might want to make use of that
in order to always reflect the correct control value.
@@ -311,7 +311,7 @@ Control IDs
180. Rotating the image to 90 and 270 will reverse the height and
width of the display window. It is necessary to set the new height
and width of the picture using the
- :ref:`VIDIOC_S_FMT <vidioc-g-fmt>` ioctl according to the
+ :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl according to the
rotation angle selected.
``V4L2_CID_BG_COLOR`` ``(integer)``
@@ -362,10 +362,10 @@ Control IDs
and version, see :ref:`querycap`.
Applications can enumerate the available controls with the
-:ref:`VIDIOC_QUERYCTRL <vidioc-queryctrl>` and
-:ref:`VIDIOC_QUERYMENU <vidioc-queryctrl>` ioctls, get and set a
-control value with the :ref:`VIDIOC_G_CTRL <vidioc-g-ctrl>` and
-:ref:`VIDIOC_S_CTRL <vidioc-g-ctrl>` ioctls. Drivers must implement
+:ref:`VIDIOC_QUERYCTRL <VIDIOC_QUERYCTRL>` and
+:ref:`VIDIOC_QUERYMENU <VIDIOC_QUERYCTRL>` ioctls, get and set a
+control value with the :ref:`VIDIOC_G_CTRL <VIDIOC_G_CTRL>` and
+:ref:`VIDIOC_S_CTRL <VIDIOC_G_CTRL>` ioctls. Drivers must implement
``VIDIOC_QUERYCTRL``, ``VIDIOC_G_CTRL`` and ``VIDIOC_S_CTRL`` when the
device has one or more controls, ``VIDIOC_QUERYMENU`` when it has one or
more menu type controls.
@@ -522,7 +522,7 @@ more menu type controls.
the real IDs.
Many applications today still use the ``V4L2_CID_PRIVATE_BASE`` IDs
- instead of using :ref:`VIDIOC_QUERYCTRL <vidioc-queryctrl>` with
+ instead of using :ref:`VIDIOC_QUERYCTRL <VIDIOC_QUERYCTRL>` with
the ``V4L2_CTRL_FLAG_NEXT_CTRL`` flag to enumerate all IDs, so
support for ``V4L2_CID_PRIVATE_BASE`` is still around.
diff --git a/Documentation/linux_tv/media/v4l/crop.rst b/Documentation/linux_tv/media/v4l/crop.rst
index b9014d03865f..94f2d0e77ed8 100644
--- a/Documentation/linux_tv/media/v4l/crop.rst
+++ b/Documentation/linux_tv/media/v4l/crop.rst
@@ -14,17 +14,17 @@ offset into a video signal.
Applications can use the following API to select an area in the video
signal, query the default area and the hardware limits. *Despite their
-name, the :ref:`VIDIOC_CROPCAP <vidioc-cropcap>`,
-:ref:`VIDIOC_G_CROP <vidioc-g-crop>` and
-:ref:`VIDIOC_S_CROP <vidioc-g-crop>` ioctls apply to input as well
+name, the :ref:`VIDIOC_CROPCAP <VIDIOC_CROPCAP>`,
+:ref:`VIDIOC_G_CROP <VIDIOC_G_CROP>` and
+:ref:`VIDIOC_S_CROP <VIDIOC_G_CROP>` ioctls apply to input as well
as output devices.*
Scaling requires a source and a target. On a video capture or overlay
device the source is the video signal, and the cropping ioctls determine
the area actually sampled. The target are images read by the application
or overlaid onto the graphics screen. Their size (and position for an
-overlay) is negotiated with the :ref:`VIDIOC_G_FMT <vidioc-g-fmt>`
-and :ref:`VIDIOC_S_FMT <vidioc-g-fmt>` ioctls.
+overlay) is negotiated with the :ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>`
+and :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctls.
On a video output device the source are the images passed in by the
application, and their size is again negotiated with the
@@ -108,7 +108,7 @@ they may prefer a particular image size or a certain area in the video
signal. If the driver has to adjust both to satisfy hardware
limitations, the last requested rectangle shall take priority, and the
driver should preferably adjust the opposite one. The
-:ref:`VIDIOC_TRY_FMT <vidioc-g-fmt>` ioctl however shall not change
+:ref:`VIDIOC_TRY_FMT <VIDIOC_G_FMT>` ioctl however shall not change
the driver state and therefore only adjust the requested rectangle.
Suppose scaling on a video capture device is restricted to a factor 1:1
diff --git a/Documentation/linux_tv/media/v4l/dev-capture.rst b/Documentation/linux_tv/media/v4l/dev-capture.rst
index 21207ab2e604..fd6357c995aa 100644
--- a/Documentation/linux_tv/media/v4l/dev-capture.rst
+++ b/Documentation/linux_tv/media/v4l/dev-capture.rst
@@ -25,7 +25,7 @@ Devices supporting the video capture interface set the
``V4L2_CAP_VIDEO_CAPTURE`` or ``V4L2_CAP_VIDEO_CAPTURE_MPLANE`` flag in
the ``capabilities`` field of struct
:ref:`v4l2_capability <v4l2-capability>` returned by the
-:ref:`VIDIOC_QUERYCAP <vidioc-querycap>` ioctl. As secondary device
+:ref:`VIDIOC_QUERYCAP <VIDIOC_QUERYCAP>` ioctl. As secondary device
functions they may also support the :ref:`video overlay <overlay>`
(``V4L2_CAP_VIDEO_OVERLAY``) and the :ref:`raw VBI capture <raw-vbi>`
(``V4L2_CAP_VBI_CAPTURE``) interface. At least one of the read/write or
@@ -65,7 +65,7 @@ To query the current image format applications set the ``type`` field of
a struct :ref:`v4l2_format <v4l2-format>` to
``V4L2_BUF_TYPE_VIDEO_CAPTURE`` or
``V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE`` and call the
-:ref:`VIDIOC_G_FMT <vidioc-g-fmt>` ioctl with a pointer to this
+:ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>` ioctl with a pointer to this
structure. Drivers fill the struct
:ref:`v4l2_pix_format <v4l2-pix-format>` ``pix`` or the struct
:ref:`v4l2_pix_format_mplane <v4l2-pix-format-mplane>` ``pix_mp``
@@ -75,12 +75,12 @@ To request different parameters applications set the ``type`` field of a
struct :ref:`v4l2_format <v4l2-format>` as above and initialize all
fields of the struct :ref:`v4l2_pix_format <v4l2-pix-format>`
``vbi`` member of the ``fmt`` union, or better just modify the results
-of ``VIDIOC_G_FMT``, and call the :ref:`VIDIOC_S_FMT <vidioc-g-fmt>`
+of ``VIDIOC_G_FMT``, and call the :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>`
ioctl with a pointer to this structure. Drivers may adjust the
parameters and finally return the actual parameters as ``VIDIOC_G_FMT``
does.
-Like ``VIDIOC_S_FMT`` the :ref:`VIDIOC_TRY_FMT <vidioc-g-fmt>` ioctl
+Like ``VIDIOC_S_FMT`` the :ref:`VIDIOC_TRY_FMT <VIDIOC_G_FMT>` ioctl
can be used to learn about hardware limitations without disabling I/O or
possibly time consuming hardware preparations.
diff --git a/Documentation/linux_tv/media/v4l/dev-codec.rst b/Documentation/linux_tv/media/v4l/dev-codec.rst
index f0b54c2b95c3..1540755b1735 100644
--- a/Documentation/linux_tv/media/v4l/dev-codec.rst
+++ b/Documentation/linux_tv/media/v4l/dev-codec.rst
@@ -15,7 +15,7 @@ A memory-to-memory video node acts just like a normal video node, but it
supports both output (sending frames from memory to the codec hardware)
and capture (receiving the processed frames from the codec hardware into
memory) stream I/O. An application will have to setup the stream I/O for
-both sides and finally call :ref:`VIDIOC_STREAMON <vidioc-streamon>`
+both sides and finally call :ref:`VIDIOC_STREAMON <VIDIOC_STREAMON>`
for both capture and output to start the codec.
Video compression codecs use the MPEG controls to setup their codec
diff --git a/Documentation/linux_tv/media/v4l/dev-event.rst b/Documentation/linux_tv/media/v4l/dev-event.rst
index afe24a72d8ea..5d21c6873b1a 100644
--- a/Documentation/linux_tv/media/v4l/dev-event.rst
+++ b/Documentation/linux_tv/media/v4l/dev-event.rst
@@ -14,9 +14,9 @@ events.
To receive events, the events the user is interested in first must be
subscribed using the
-:ref:`VIDIOC_SUBSCRIBE_EVENT <vidioc-subscribe-event>` ioctl. Once
+:ref:`VIDIOC_SUBSCRIBE_EVENT <VIDIOC_SUBSCRIBE_EVENT>` ioctl. Once
an event is subscribed, the events of subscribed types are dequeueable
-using the :ref:`VIDIOC_DQEVENT <vidioc-dqevent>` ioctl. Events may be
+using the :ref:`VIDIOC_DQEVENT <VIDIOC_DQEVENT>` ioctl. Events may be
unsubscribed using VIDIOC_UNSUBSCRIBE_EVENT ioctl. The special event
type V4L2_EVENT_ALL may be used to unsubscribe all the events the
driver supports.
diff --git a/Documentation/linux_tv/media/v4l/dev-osd.rst b/Documentation/linux_tv/media/v4l/dev-osd.rst
index 077e2cdc598d..93fb8f309091 100644
--- a/Documentation/linux_tv/media/v4l/dev-osd.rst
+++ b/Documentation/linux_tv/media/v4l/dev-osd.rst
@@ -17,7 +17,7 @@ The OSD function is accessible through the same character special file
as the :ref:`Video Output <capture>` function. Note the default
function of such a ``/dev/video`` device is video capturing or output.
The OSD function is only available after calling the
-:ref:`VIDIOC_S_FMT <vidioc-g-fmt>` ioctl.
+:ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl.
Querying Capabilities
@@ -26,7 +26,7 @@ Querying Capabilities
Devices supporting the *Video Output Overlay* interface set the
``V4L2_CAP_VIDEO_OUTPUT_OVERLAY`` flag in the ``capabilities`` field of
struct :ref:`v4l2_capability <v4l2-capability>` returned by the
-:ref:`VIDIOC_QUERYCAP <vidioc-querycap>` ioctl.
+:ref:`VIDIOC_QUERYCAP <VIDIOC_QUERYCAP>` ioctl.
Framebuffer
@@ -36,7 +36,7 @@ Contrary to the *Video Overlay* interface the framebuffer is normally
implemented on the TV card and not the graphics card. On Linux it is
accessible as a framebuffer device (``/dev/fbN``). Given a V4L2 device,
applications can find the corresponding framebuffer device by calling
-the :ref:`VIDIOC_G_FBUF <vidioc-g-fbuf>` ioctl. It returns, amongst
+the :ref:`VIDIOC_G_FBUF <VIDIOC_G_FBUF>` ioctl. It returns, amongst
other information, the physical address of the framebuffer in the
``base`` field of struct :ref:`v4l2_framebuffer <v4l2-framebuffer>`.
The framebuffer device ioctl ``FBIOGET_FSCREENINFO`` returns the same
@@ -115,17 +115,17 @@ clipping/blending method to be used for the overlay. To get the current
parameters applications set the ``type`` field of a struct
:ref:`v4l2_format <v4l2-format>` to
``V4L2_BUF_TYPE_VIDEO_OUTPUT_OVERLAY`` and call the
-:ref:`VIDIOC_G_FMT <vidioc-g-fmt>` ioctl. The driver fills the
+:ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>` ioctl. The driver fills the
:c:type:`struct v4l2_window` substructure named ``win``. It is not
possible to retrieve a previously programmed clipping list or bitmap.
To program the source rectangle applications set the ``type`` field of a
struct :ref:`v4l2_format <v4l2-format>` to
``V4L2_BUF_TYPE_VIDEO_OUTPUT_OVERLAY``, initialize the ``win``
-substructure and call the :ref:`VIDIOC_S_FMT <vidioc-g-fmt>` ioctl.
+substructure and call the :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl.
The driver adjusts the parameters against hardware limits and returns
the actual parameters as ``VIDIOC_G_FMT`` does. Like ``VIDIOC_S_FMT``,
-the :ref:`VIDIOC_TRY_FMT <vidioc-g-fmt>` ioctl can be used to learn
+the :ref:`VIDIOC_TRY_FMT <VIDIOC_G_FMT>` ioctl can be used to learn
about driver capabilities without actually changing driver state. Unlike
``VIDIOC_S_FMT`` this also works after the overlay has been enabled.
diff --git a/Documentation/linux_tv/media/v4l/dev-output.rst b/Documentation/linux_tv/media/v4l/dev-output.rst
index 0d46d59304b9..3efbbcc3c093 100644
--- a/Documentation/linux_tv/media/v4l/dev-output.rst
+++ b/Documentation/linux_tv/media/v4l/dev-output.rst
@@ -24,7 +24,7 @@ Devices supporting the video output interface set the
``V4L2_CAP_VIDEO_OUTPUT`` or ``V4L2_CAP_VIDEO_OUTPUT_MPLANE`` flag in
the ``capabilities`` field of struct
:ref:`v4l2_capability <v4l2-capability>` returned by the
-:ref:`VIDIOC_QUERYCAP <vidioc-querycap>` ioctl. As secondary device
+:ref:`VIDIOC_QUERYCAP <VIDIOC_QUERYCAP>` ioctl. As secondary device
functions they may also support the :ref:`raw VBI output <raw-vbi>`
(``V4L2_CAP_VBI_OUTPUT``) interface. At least one of the read/write or
streaming I/O methods must be supported. Modulators and audio outputs
@@ -62,7 +62,7 @@ defaults. An example is given in :ref:`crop`.
To query the current image format applications set the ``type`` field of
a struct :ref:`v4l2_format <v4l2-format>` to
``V4L2_BUF_TYPE_VIDEO_OUTPUT`` or ``V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE``
-and call the :ref:`VIDIOC_G_FMT <vidioc-g-fmt>` ioctl with a pointer
+and call the :ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>` ioctl with a pointer
to this structure. Drivers fill the struct
:ref:`v4l2_pix_format <v4l2-pix-format>` ``pix`` or the struct
:ref:`v4l2_pix_format_mplane <v4l2-pix-format-mplane>` ``pix_mp``
@@ -72,12 +72,12 @@ To request different parameters applications set the ``type`` field of a
struct :ref:`v4l2_format <v4l2-format>` as above and initialize all
fields of the struct :ref:`v4l2_pix_format <v4l2-pix-format>`
``vbi`` member of the ``fmt`` union, or better just modify the results
-of ``VIDIOC_G_FMT``, and call the :ref:`VIDIOC_S_FMT <vidioc-g-fmt>`
+of ``VIDIOC_G_FMT``, and call the :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>`
ioctl with a pointer to this structure. Drivers may adjust the
parameters and finally return the actual parameters as ``VIDIOC_G_FMT``
does.
-Like ``VIDIOC_S_FMT`` the :ref:`VIDIOC_TRY_FMT <vidioc-g-fmt>` ioctl
+Like ``VIDIOC_S_FMT`` the :ref:`VIDIOC_TRY_FMT <VIDIOC_G_FMT>` ioctl
can be used to learn about hardware limitations without disabling I/O or
possibly time consuming hardware preparations.
diff --git a/Documentation/linux_tv/media/v4l/dev-overlay.rst b/Documentation/linux_tv/media/v4l/dev-overlay.rst
index 50aed591284b..8a81e19a5d7c 100644
--- a/Documentation/linux_tv/media/v4l/dev-overlay.rst
+++ b/Documentation/linux_tv/media/v4l/dev-overlay.rst
@@ -20,7 +20,7 @@ Video overlay devices are accessed through the same character special
files as :ref:`video capture <capture>` devices. Note the default
function of a ``/dev/video`` device is video capturing. The overlay
function is only available after calling the
-:ref:`VIDIOC_S_FMT <vidioc-g-fmt>` ioctl.
+:ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl.
The driver may support simultaneous overlay and capturing using the
read/write and streaming I/O methods. If so, operation at the nominal
@@ -41,7 +41,7 @@ Querying Capabilities
Devices supporting the video overlay interface set the
``V4L2_CAP_VIDEO_OVERLAY`` flag in the ``capabilities`` field of struct
:ref:`v4l2_capability <v4l2-capability>` returned by the
-:ref:`VIDIOC_QUERYCAP <vidioc-querycap>` ioctl. The overlay I/O
+:ref:`VIDIOC_QUERYCAP <VIDIOC_QUERYCAP>` ioctl. The overlay I/O
method specified below must be supported. Tuners and audio inputs are
optional.
@@ -63,8 +63,8 @@ Setup
Before overlay can commence applications must program the driver with
frame buffer parameters, namely the address and size of the frame buffer
and the image format, for example RGB 5:6:5. The
-:ref:`VIDIOC_G_FBUF <vidioc-g-fbuf>` and
-:ref:`VIDIOC_S_FBUF <vidioc-g-fbuf>` ioctls are available to get and
+:ref:`VIDIOC_G_FBUF <VIDIOC_G_FBUF>` and
+:ref:`VIDIOC_S_FBUF <VIDIOC_G_FBUF>` ioctls are available to get and
set these parameters, respectively. The ``VIDIOC_S_FBUF`` ioctl is
privileged because it allows to set up DMA into physical memory,
bypassing the memory protection mechanisms of the kernel. Only the
@@ -101,8 +101,8 @@ A driver may support any (or none) of five clipping/blending methods:
When simultaneous capturing and overlay is supported and the hardware
prohibits different image and frame buffer formats, the format requested
first takes precedence. The attempt to capture
-(:ref:`VIDIOC_S_FMT <vidioc-g-fmt>`) or overlay
-(:ref:`VIDIOC_S_FBUF <vidioc-g-fbuf>`) may fail with an EBUSY error
+(:ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>`) or overlay
+(:ref:`VIDIOC_S_FBUF <VIDIOC_G_FBUF>`) may fail with an EBUSY error
code or return accordingly modified parameters..
@@ -121,17 +121,17 @@ its position over the graphics surface and the clipping to be applied.
To get the current parameters applications set the ``type`` field of a
struct :ref:`v4l2_format <v4l2-format>` to
``V4L2_BUF_TYPE_VIDEO_OVERLAY`` and call the
-:ref:`VIDIOC_G_FMT <vidioc-g-fmt>` ioctl. The driver fills the
+:ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>` ioctl. The driver fills the
:c:type:`struct v4l2_window` substructure named ``win``. It is not
possible to retrieve a previously programmed clipping list or bitmap.
To program the overlay window applications set the ``type`` field of a
struct :ref:`v4l2_format <v4l2-format>` to
``V4L2_BUF_TYPE_VIDEO_OVERLAY``, initialize the ``win`` substructure and
-call the :ref:`VIDIOC_S_FMT <vidioc-g-fmt>` ioctl. The driver
+call the :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl. The driver
adjusts the parameters against hardware limits and returns the actual
parameters as ``VIDIOC_G_FMT`` does. Like ``VIDIOC_S_FMT``, the
-:ref:`VIDIOC_TRY_FMT <vidioc-g-fmt>` ioctl can be used to learn
+:ref:`VIDIOC_TRY_FMT <VIDIOC_G_FMT>` ioctl can be used to learn
about driver capabilities without actually changing driver state. Unlike
``VIDIOC_S_FMT`` this also works after the overlay has been enabled.
@@ -142,7 +142,7 @@ of the cropping rectangle. For more information see :ref:`crop`.
When simultaneous capturing and overlay is supported and the hardware
prohibits different image and window sizes, the size requested first
takes precedence. The attempt to capture or overlay as well
-(:ref:`VIDIOC_S_FMT <vidioc-g-fmt>`) may fail with an EBUSY error
+(:ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>`) may fail with an EBUSY error
code or return accordingly modified parameters.
@@ -154,7 +154,7 @@ struct v4l2_window
``struct v4l2_rect w``
Size and position of the window relative to the top, left corner of
the frame buffer defined with
- :ref:`VIDIOC_S_FBUF <vidioc-g-fbuf>`. The window can extend the
+ :ref:`VIDIOC_S_FBUF <VIDIOC_G_FBUF>`. The window can extend the
frame buffer width and height, the ``x`` and ``y`` coordinates can
be negative, and it can lie completely outside the frame buffer. The
driver clips the window accordingly, or if that is not possible,
@@ -169,7 +169,7 @@ struct v4l2_window
``__u32 chromakey``
When chroma-keying has been negotiated with
- :ref:`VIDIOC_S_FBUF <vidioc-g-fbuf>` applications set this field
+ :ref:`VIDIOC_S_FBUF <VIDIOC_G_FBUF>` applications set this field
to the desired pixel value for the chroma key. The format is the
same as the pixel format of the framebuffer (struct
:ref:`v4l2_framebuffer <v4l2-framebuffer>` ``fmt.pixelformat``
@@ -179,7 +179,7 @@ struct v4l2_window
``struct v4l2_clip * clips``
When chroma-keying has *not* been negotiated and
- :ref:`VIDIOC_G_FBUF <vidioc-g-fbuf>` indicated this capability,
+ :ref:`VIDIOC_G_FBUF <VIDIOC_G_FBUF>` indicated this capability,
applications can set this field to point to an array of clipping
rectangles.
@@ -192,7 +192,7 @@ applications should merge adjacent rectangles. Whether this must create
x-y or y-x bands, or the order of rectangles, is not defined. When clip
lists are not supported the driver ignores this field. Its contents
after calling
-!ri!:ref:`VIDIOC_S_FMT <vidioc-g-fmt>`
+!ri!:ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>`
are undefined.
``__u32 clipcount``
@@ -204,7 +204,7 @@ are undefined.
``void * bitmap``
When chroma-keying has *not* been negotiated and
- :ref:`VIDIOC_G_FBUF <vidioc-g-fbuf>` indicated this capability,
+ :ref:`VIDIOC_G_FBUF <VIDIOC_G_FBUF>` indicated this capability,
applications can set this field to point to a clipping bit mask.
It must be of the same size as the window, ``w.width`` and ``w.height``.
@@ -220,7 +220,7 @@ bits like:
where ``0`` ≤ x < ``w.width`` and ``0`` ≤ y <``w.height``. [2]_
When a clipping bit mask is not supported the driver ignores this field,
-its contents after calling :ref:`VIDIOC_S_FMT <vidioc-g-fmt>` are
+its contents after calling :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` are
undefined. When a bit mask is supported but no clipping is desired this
field must be set to ``NULL``.
@@ -234,12 +234,12 @@ exceeded are undefined. [3]_
The global alpha value used to blend the framebuffer with video
images, if global alpha blending has been negotiated
(``V4L2_FBUF_FLAG_GLOBAL_ALPHA``, see
- :ref:`VIDIOC_S_FBUF <vidioc-g-fbuf>`,
+ :ref:`VIDIOC_S_FBUF <VIDIOC_G_FBUF>`,
:ref:`framebuffer-flags`).
Note this field was added in Linux 2.6.23, extending the structure.
However the
-!ri!:ref:`VIDIOC_G/S/TRY_FMT <vidioc-g-fmt>`
+!ri!:ref:`VIDIOC_G/S/TRY_FMT <VIDIOC_G_FMT>`
ioctls, which take a pointer to a
!ri!:ref:`v4l2_format <v4l2-format>`
parent structure with padding bytes at the end, are not affected.
@@ -289,7 +289,7 @@ Enabling Overlay
================
To start or stop the frame buffer overlay applications call the
-:ref:`VIDIOC_OVERLAY <vidioc-overlay>` ioctl.
+:ref:`VIDIOC_OVERLAY <VIDIOC_OVERLAY>` ioctl.
.. [1]
A common application of two file descriptors is the XFree86
diff --git a/Documentation/linux_tv/media/v4l/dev-radio.rst b/Documentation/linux_tv/media/v4l/dev-radio.rst
index 672540105a66..955173aaf48e 100644
--- a/Documentation/linux_tv/media/v4l/dev-radio.rst
+++ b/Documentation/linux_tv/media/v4l/dev-radio.rst
@@ -21,7 +21,7 @@ Devices supporting the radio interface set the ``V4L2_CAP_RADIO`` and
``V4L2_CAP_TUNER`` or ``V4L2_CAP_MODULATOR`` flag in the
``capabilities`` field of struct
:ref:`v4l2_capability <v4l2-capability>` returned by the
-:ref:`VIDIOC_QUERYCAP <vidioc-querycap>` ioctl. Other combinations of
+:ref:`VIDIOC_QUERYCAP <VIDIOC_QUERYCAP>` ioctl. Other combinations of
capability flags are reserved for future extensions.
@@ -47,8 +47,8 @@ discussed in :ref:`tuner`) with index number zero to select the radio
frequency and to determine if a monaural or FM stereo program is
received/emitted. Drivers switch automatically between AM and FM
depending on the selected frequency. The
-:ref:`VIDIOC_G_TUNER <vidioc-g-tuner>` or
-:ref:`VIDIOC_G_MODULATOR <vidioc-g-modulator>` ioctl reports the
+:ref:`VIDIOC_G_TUNER <VIDIOC_G_TUNER>` or
+:ref:`VIDIOC_G_MODULATOR <VIDIOC_G_MODULATOR>` ioctl reports the
supported frequency range.
diff --git a/Documentation/linux_tv/media/v4l/dev-raw-vbi.rst b/Documentation/linux_tv/media/v4l/dev-raw-vbi.rst
index 9ab5c4a4cad7..883ac4fbaeb6 100644
--- a/Documentation/linux_tv/media/v4l/dev-raw-vbi.rst
+++ b/Documentation/linux_tv/media/v4l/dev-raw-vbi.rst
@@ -28,7 +28,7 @@ applies to both input and output devices.
To address the problems of finding related video and VBI devices VBI
capturing and output is also available as device function under
``/dev/video``. To capture or output raw VBI data with these devices
-applications must call the :ref:`VIDIOC_S_FMT <vidioc-g-fmt>` ioctl.
+applications must call the :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl.
Accessed as ``/dev/vbi``, raw VBI capturing or output is the default
device function.
@@ -40,7 +40,7 @@ Devices supporting the raw VBI capturing or output API set the
``V4L2_CAP_VBI_CAPTURE`` or ``V4L2_CAP_VBI_OUTPUT`` flags, respectively,
in the ``capabilities`` field of struct
:ref:`v4l2_capability <v4l2-capability>` returned by the
-:ref:`VIDIOC_QUERYCAP <vidioc-querycap>` ioctl. At least one of the
+:ref:`VIDIOC_QUERYCAP <VIDIOC_QUERYCAP>` ioctl. At least one of the
read/write, streaming or asynchronous I/O methods must be supported. VBI
devices may or may not have a tuner or modulator.
@@ -71,7 +71,7 @@ parameters and then checking if the actual parameters are suitable.
To query the current raw VBI capture parameters applications set the
``type`` field of a struct :ref:`v4l2_format <v4l2-format>` to
``V4L2_BUF_TYPE_VBI_CAPTURE`` or ``V4L2_BUF_TYPE_VBI_OUTPUT``, and call
-the :ref:`VIDIOC_G_FMT <vidioc-g-fmt>` ioctl with a pointer to this
+the :ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>` ioctl with a pointer to this
structure. Drivers fill the struct
:ref:`v4l2_vbi_format <v4l2-vbi-format>` ``vbi`` member of the
``fmt`` union.
@@ -80,7 +80,7 @@ To request different parameters applications set the ``type`` field of a
struct :ref:`v4l2_format <v4l2-format>` as above and initialize all
fields of the struct :ref:`v4l2_vbi_format <v4l2-vbi-format>`
``vbi`` member of the ``fmt`` union, or better just modify the results
-of ``VIDIOC_G_FMT``, and call the :ref:`VIDIOC_S_FMT <vidioc-g-fmt>`
+of ``VIDIOC_G_FMT``, and call the :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>`
ioctl with a pointer to this structure. Drivers return an EINVAL error
code only when the given parameters are ambiguous, otherwise they modify
the parameters according to the hardware capabilities and return the
@@ -91,7 +91,7 @@ happen for instance when the video and VBI areas to capture would
overlap, or when the driver supports multiple opens and another process
already requested VBI capturing or output. Anyway, applications must
expect other resource allocation points which may return EBUSY, at the
-:ref:`VIDIOC_STREAMON <vidioc-streamon>` ioctl and the first read(),
+:ref:`VIDIOC_STREAMON <VIDIOC_STREAMON>` ioctl and the first read(),
write() and select() call.
VBI devices must implement both the ``VIDIOC_G_FMT`` and
@@ -339,7 +339,7 @@ A VBI device may support :ref:`read/write <rw>` and/or streaming
The latter bears the possibility of synchronizing video and VBI data by
using buffer timestamps.
-Remember the :ref:`VIDIOC_STREAMON <vidioc-streamon>` ioctl and the
+Remember the :ref:`VIDIOC_STREAMON <VIDIOC_STREAMON>` ioctl and the
first read(), write() and select() call can be resource allocation
points returning an EBUSY error code if the required hardware resources
are temporarily unavailable, for example the device is already in use by
diff --git a/Documentation/linux_tv/media/v4l/dev-rds.rst b/Documentation/linux_tv/media/v4l/dev-rds.rst
index 498752aa5eaf..af20f8fa1cdf 100644
--- a/Documentation/linux_tv/media/v4l/dev-rds.rst
+++ b/Documentation/linux_tv/media/v4l/dev-rds.rst
@@ -33,7 +33,7 @@ Querying Capabilities
Devices supporting the RDS capturing API set the
``V4L2_CAP_RDS_CAPTURE`` flag in the ``capabilities`` field of struct
:ref:`v4l2_capability <v4l2-capability>` returned by the
-:ref:`VIDIOC_QUERYCAP <vidioc-querycap>` ioctl. Any tuner that
+:ref:`VIDIOC_QUERYCAP <VIDIOC_QUERYCAP>` ioctl. Any tuner that
supports RDS will set the ``V4L2_TUNER_CAP_RDS`` flag in the
``capability`` field of struct :ref:`v4l2_tuner <v4l2-tuner>`. If the
driver only passes RDS blocks without interpreting the data the
@@ -52,7 +52,7 @@ Whether an RDS signal is present can be detected by looking at the
Devices supporting the RDS output API set the ``V4L2_CAP_RDS_OUTPUT``
flag in the ``capabilities`` field of struct
:ref:`v4l2_capability <v4l2-capability>` returned by the
-:ref:`VIDIOC_QUERYCAP <vidioc-querycap>` ioctl. Any modulator that
+:ref:`VIDIOC_QUERYCAP <VIDIOC_QUERYCAP>` ioctl. Any modulator that
supports RDS will set the ``V4L2_TUNER_CAP_RDS`` flag in the
``capability`` field of struct
:ref:`v4l2_modulator <v4l2-modulator>`. In order to enable the RDS
diff --git a/Documentation/linux_tv/media/v4l/dev-sdr.rst b/Documentation/linux_tv/media/v4l/dev-sdr.rst
index 8e9e34b8d53a..5e4f7030f644 100644
--- a/Documentation/linux_tv/media/v4l/dev-sdr.rst
+++ b/Documentation/linux_tv/media/v4l/dev-sdr.rst
@@ -22,7 +22,7 @@ Devices supporting the SDR receiver interface set the
``V4L2_CAP_SDR_CAPTURE`` and ``V4L2_CAP_TUNER`` flag in the
``capabilities`` field of struct
:ref:`v4l2_capability <v4l2-capability>` returned by the
-:ref:`VIDIOC_QUERYCAP <vidioc-querycap>` ioctl. That flag means the
+:ref:`VIDIOC_QUERYCAP <VIDIOC_QUERYCAP>` ioctl. That flag means the
device has an Analog to Digital Converter (ADC), which is a mandatory
element for the SDR receiver.
@@ -30,7 +30,7 @@ Devices supporting the SDR transmitter interface set the
``V4L2_CAP_SDR_OUTPUT`` and ``V4L2_CAP_MODULATOR`` flag in the
``capabilities`` field of struct
:ref:`v4l2_capability <v4l2-capability>` returned by the
-:ref:`VIDIOC_QUERYCAP <vidioc-querycap>` ioctl. That flag means the
+:ref:`VIDIOC_QUERYCAP <VIDIOC_QUERYCAP>` ioctl. That flag means the
device has an Digital to Analog Converter (DAC), which is a mandatory
element for the SDR transmitter.
@@ -52,7 +52,7 @@ radio frequency. The tuner index of the RF tuner (if any) must always
follow the SDR tuner index. Normally the SDR tuner is #0 and the RF
tuner is #1.
-The :ref:`VIDIOC_S_HW_FREQ_SEEK <vidioc-s-hw-freq-seek>` ioctl is
+The :ref:`VIDIOC_S_HW_FREQ_SEEK <VIDIOC_S_HW_FREQ_SEEK>` ioctl is
not supported.
@@ -63,7 +63,7 @@ The SDR device uses the :ref:`format <format>` ioctls to select the
capture and output format. Both the sampling resolution and the data
streaming format are bound to that selectable format. In addition to the
basic :ref:`format <format>` ioctls, the
-:ref:`VIDIOC_ENUM_FMT <vidioc-enum-fmt>` ioctl must be supported as
+:ref:`VIDIOC_ENUM_FMT <VIDIOC_ENUM_FMT>` ioctl must be supported as
well.
To use the :ref:`format <format>` ioctls applications set the ``type``
diff --git a/Documentation/linux_tv/media/v4l/dev-sliced-vbi.rst b/Documentation/linux_tv/media/v4l/dev-sliced-vbi.rst
index 90d879964f52..0faf178168e4 100644
--- a/Documentation/linux_tv/media/v4l/dev-sliced-vbi.rst
+++ b/Documentation/linux_tv/media/v4l/dev-sliced-vbi.rst
@@ -21,7 +21,7 @@ Sliced VBI capture and output devices are accessed through the same
character special files as raw VBI devices. When a driver supports both
interfaces, the default function of a ``/dev/vbi`` device is *raw* VBI
capturing or output, and the sliced VBI function is only available after
-calling the :ref:`VIDIOC_S_FMT <vidioc-g-fmt>` ioctl as defined
+calling the :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl as defined
below. Likewise a ``/dev/video`` device may support the sliced VBI API,
however the default function here is video capturing or output.
Different file descriptors must be used to pass raw and sliced VBI data
@@ -35,7 +35,7 @@ Devices supporting the sliced VBI capturing or output API set the
``V4L2_CAP_SLICED_VBI_CAPTURE`` or ``V4L2_CAP_SLICED_VBI_OUTPUT`` flag
respectively, in the ``capabilities`` field of struct
:ref:`v4l2_capability <v4l2-capability>` returned by the
-:ref:`VIDIOC_QUERYCAP <vidioc-querycap>` ioctl. At least one of the
+:ref:`VIDIOC_QUERYCAP <VIDIOC_QUERYCAP>` ioctl. At least one of the
read/write, streaming or asynchronous :ref:`I/O methods <io>` must be
supported. Sliced VBI devices may have a tuner or modulator.
@@ -57,10 +57,10 @@ Sliced VBI Format Negotiation
To find out which data services are supported by the hardware
applications can call the
-:ref:`VIDIOC_G_SLICED_VBI_CAP <vidioc-g-sliced-vbi-cap>` ioctl.
+:ref:`VIDIOC_G_SLICED_VBI_CAP <VIDIOC_G_SLICED_VBI_CAP>` ioctl.
All drivers implementing the sliced VBI interface must support this
ioctl. The results may differ from those of the
-:ref:`VIDIOC_S_FMT <vidioc-g-fmt>` ioctl when the number of VBI
+:ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl when the number of VBI
lines the hardware can capture or output per frame, or the number of
services it can identify on a given line are limited. For example on PAL
line 16 the hardware may be able to look for a VPS or Teletext signal,
@@ -70,13 +70,13 @@ To determine the currently selected services applications set the
``type`` field of struct :ref:`v4l2_format <v4l2-format>` to
``V4L2_BUF_TYPE_SLICED_VBI_CAPTURE`` or
``V4L2_BUF_TYPE_SLICED_VBI_OUTPUT``, and the
-:ref:`VIDIOC_G_FMT <vidioc-g-fmt>` ioctl fills the ``fmt.sliced``
+:ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>` ioctl fills the ``fmt.sliced``
member, a struct
:ref:`v4l2_sliced_vbi_format <v4l2-sliced-vbi-format>`.
Applications can request different parameters by initializing or
modifying the ``fmt.sliced`` member and calling the
-:ref:`VIDIOC_S_FMT <vidioc-g-fmt>` ioctl with a pointer to the
+:ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl with a pointer to the
:c:type:`struct v4l2_format` structure.
The sliced VBI API is more complicated than the raw VBI API because the
@@ -90,12 +90,12 @@ array according to hardware capabilities. Only if more precise control
is needed should the programmer set the ``service_lines`` array
explicitly.
-The :ref:`VIDIOC_S_FMT <vidioc-g-fmt>` ioctl modifies the parameters
+The :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl modifies the parameters
according to hardware capabilities. When the driver allocates resources
at this point, it may return an EBUSY error code if the required
resources are temporarily unavailable. Other resource allocation points
which may return EBUSY can be the
-:ref:`VIDIOC_STREAMON <vidioc-streamon>` ioctl and the first
+:ref:`VIDIOC_STREAMON <VIDIOC_STREAMON>` ioctl and the first
:ref:`read() <func-read>`, :ref:`write() <func-write>` and
:ref:`select() <func-select>` call.
@@ -117,8 +117,8 @@ which may return EBUSY can be the
- :cspan:`2`
If ``service_set`` is non-zero when passed with
- :ref:`VIDIOC_S_FMT <vidioc-g-fmt>` or
- :ref:`VIDIOC_TRY_FMT <vidioc-g-fmt>`, the ``service_lines``
+ :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` or
+ :ref:`VIDIOC_TRY_FMT <VIDIOC_G_FMT>`, the ``service_lines``
array will be filled by the driver according to the services
specified in this field. For example, if ``service_set`` is
initialized with ``V4L2_SLICED_TELETEXT_B | V4L2_SLICED_WSS_625``,
@@ -224,8 +224,8 @@ which may return EBUSY can be the
- :cspan:`2` Maximum number of bytes passed by one
:ref:`read() <func-read>` or :ref:`write() <func-write>` call,
and the buffer size in bytes for the
- :ref:`VIDIOC_QBUF <vidioc-qbuf>` and
- :ref:`VIDIOC_DQBUF <vidioc-qbuf>` ioctl. Drivers set this field
+ :ref:`VIDIOC_QBUF <VIDIOC_QBUF>` and
+ :ref:`VIDIOC_DQBUF <VIDIOC_QBUF>` ioctl. Drivers set this field
to the size of struct
:ref:`v4l2_sliced_vbi_data <v4l2-sliced-vbi-data>` times the
number of non-zero elements in the returned ``service_lines``
@@ -340,11 +340,11 @@ Drivers may return an EINVAL error code when applications attempt to
read or write data without prior format negotiation, after switching the
video standard (which may invalidate the negotiated VBI parameters) and
after switching the video input (which may change the video standard as
-a side effect). The :ref:`VIDIOC_S_FMT <vidioc-g-fmt>` ioctl may
+a side effect). The :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl may
return an EBUSY error code when applications attempt to change the
format while i/o is in progress (between a
-:ref:`VIDIOC_STREAMON <vidioc-streamon>` and
-:ref:`VIDIOC_STREAMOFF <vidioc-streamon>` call, and after the first
+:ref:`VIDIOC_STREAMON <VIDIOC_STREAMON>` and
+:ref:`VIDIOC_STREAMOFF <VIDIOC_STREAMON>` call, and after the first
:ref:`read() <func-read>` or :ref:`write() <func-write>` call).
@@ -428,12 +428,12 @@ of one video frame. The ``id`` of unused
Packets are always passed in ascending line number order, without
duplicate line numbers. The :ref:`write() <func-write>` function and
-the :ref:`VIDIOC_QBUF <vidioc-qbuf>` ioctl must return an EINVAL
+the :ref:`VIDIOC_QBUF <VIDIOC_QBUF>` ioctl must return an EINVAL
error code when applications violate this rule. They must also return an
EINVAL error code when applications pass an incorrect field or line
number, or a combination of ``field``, ``line`` and ``id`` which has not
-been negotiated with the :ref:`VIDIOC_G_FMT <vidioc-g-fmt>` or
-:ref:`VIDIOC_S_FMT <vidioc-g-fmt>` ioctl. When the line numbers are
+been negotiated with the :ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>` or
+:ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl. When the line numbers are
unknown the driver must pass the packets in transmitted order. The
driver can insert empty packets with ``id`` set to zero anywhere in the
packet array.
diff --git a/Documentation/linux_tv/media/v4l/dev-subdev.rst b/Documentation/linux_tv/media/v4l/dev-subdev.rst
index 66274eafd437..1fe594c0026f 100644
--- a/Documentation/linux_tv/media/v4l/dev-subdev.rst
+++ b/Documentation/linux_tv/media/v4l/dev-subdev.rst
@@ -86,7 +86,7 @@ Pad-level Formats
Image formats are typically negotiated on video capture and output
devices using the format and
-:ref:`selection <vidioc-subdev-g-selection>` ioctls. The driver is
+:ref:`selection <VIDIOC_SUBDEV_G_SELECTION>` ioctls. The driver is
responsible for configuring every block in the video pipeline according
to the requested format at the pipeline input and/or output.
@@ -118,18 +118,18 @@ every point in the pipeline explicitly.
Drivers that implement the :ref:`media API <media-controller-intro>`
can expose pad-level image format configuration to applications. When
they do, applications can use the
-:ref:`VIDIOC_SUBDEV_G_FMT <vidioc-subdev-g-fmt>` and
-:ref:`VIDIOC_SUBDEV_S_FMT <vidioc-subdev-g-fmt>` ioctls. to
+:ref:`VIDIOC_SUBDEV_G_FMT <VIDIOC_SUBDEV_G_FMT>` and
+:ref:`VIDIOC_SUBDEV_S_FMT <VIDIOC_SUBDEV_G_FMT>` ioctls. to
negotiate formats on a per-pad basis.
Applications are responsible for configuring coherent parameters on the
whole pipeline and making sure that connected pads have compatible
formats. The pipeline is checked for formats mismatch at
-:ref:`VIDIOC_STREAMON <vidioc-streamon>` time, and an EPIPE error
+:ref:`VIDIOC_STREAMON <VIDIOC_STREAMON>` time, and an EPIPE error
code is then returned if the configuration is invalid.
Pad-level image format configuration support can be tested by calling
-the :ref:`VIDIOC_SUBDEV_G_FMT <vidioc-subdev-g-fmt>` ioctl on pad
+the :ref:`VIDIOC_SUBDEV_G_FMT <VIDIOC_SUBDEV_G_FMT>` ioctl on pad
0. If the driver returns an EINVAL error code pad-level format
configuration is not supported by the sub-device.
@@ -146,8 +146,8 @@ formats enumeration only. A format negotiation mechanism is required.
Central to the format negotiation mechanism are the get/set format
operations. When called with the ``which`` argument set to
``V4L2_SUBDEV_FORMAT_TRY``, the
-:ref:`VIDIOC_SUBDEV_G_FMT <vidioc-subdev-g-fmt>` and
-:ref:`VIDIOC_SUBDEV_S_FMT <vidioc-subdev-g-fmt>` ioctls operate on
+:ref:`VIDIOC_SUBDEV_G_FMT <VIDIOC_SUBDEV_G_FMT>` and
+:ref:`VIDIOC_SUBDEV_S_FMT <VIDIOC_SUBDEV_G_FMT>` ioctls operate on
a set of formats parameters that are not connected to the hardware
configuration. Modifying those 'try' formats leaves the device state
untouched (this applies to both the software state stored in the driver
@@ -155,14 +155,14 @@ and the hardware state stored in the device itself).
While not kept as part of the device state, try formats are stored in
the sub-device file handles. A
-:ref:`VIDIOC_SUBDEV_G_FMT <vidioc-subdev-g-fmt>` call will return
+:ref:`VIDIOC_SUBDEV_G_FMT <VIDIOC_SUBDEV_G_FMT>` call will return
the last try format set *on the same sub-device file handle*. Several
applications querying the same sub-device at the same time will thus not
interact with each other.
To find out whether a particular format is supported by the device,
applications use the
-:ref:`VIDIOC_SUBDEV_S_FMT <vidioc-subdev-g-fmt>` ioctl. Drivers
+:ref:`VIDIOC_SUBDEV_S_FMT <VIDIOC_SUBDEV_G_FMT>` ioctl. Drivers
verify and, if needed, change the requested ``format`` based on device
requirements and return the possibly modified value. Applications can
then choose to try a different format or accept the returned value and
@@ -171,7 +171,7 @@ continue.
Formats returned by the driver during a negotiation iteration are
guaranteed to be supported by the device. In particular, drivers
guarantee that a returned format will not be further changed if passed
-to an :ref:`VIDIOC_SUBDEV_S_FMT <vidioc-subdev-g-fmt>` call as-is
+to an :ref:`VIDIOC_SUBDEV_S_FMT <VIDIOC_SUBDEV_G_FMT>` call as-is
(as long as external parameters, such as formats on other pads or links'
configuration are not changed).
@@ -353,7 +353,7 @@ struct :ref:`v4l2_rect <v4l2-rect>`.
Scaling support is optional. When supported by a subdev, the crop
rectangle on the subdev's sink pad is scaled to the size configured
using the
-:ref:`VIDIOC_SUBDEV_S_SELECTION <vidioc-subdev-g-selection>` IOCTL
+:ref:`VIDIOC_SUBDEV_S_SELECTION <VIDIOC_SUBDEV_G_SELECTION>` IOCTL
using ``V4L2_SEL_TGT_COMPOSE`` selection target on the same pad. If the
subdev supports scaling but not composing, the top and left values are
not used and must always be set to zero.
diff --git a/Documentation/linux_tv/media/v4l/diff-v4l.rst b/Documentation/linux_tv/media/v4l/diff-v4l.rst
index eef51e610c8b..0c4030d75c76 100644
--- a/Documentation/linux_tv/media/v4l/diff-v4l.rst
+++ b/Documentation/linux_tv/media/v4l/diff-v4l.rst
@@ -85,7 +85,7 @@ Querying Capabilities
=====================
The V4L ``VIDIOCGCAP`` ioctl is equivalent to V4L2's
-:ref:`VIDIOC_QUERYCAP <vidioc-querycap>`.
+:ref:`VIDIOC_QUERYCAP <VIDIOC_QUERYCAP>`.
The ``name`` field in struct :c:type:`struct video_capability` became
``card`` in struct :ref:`v4l2_capability <v4l2-capability>`, ``type``
@@ -182,8 +182,8 @@ introduction.
- This flag indicates if the hardware can scale images. The V4L2 API
implies the scale factor by setting the cropping dimensions and
- image size with the :ref:`VIDIOC_S_CROP <vidioc-g-crop>` and
- :ref:`VIDIOC_S_FMT <vidioc-g-fmt>` ioctl, respectively. The
+ image size with the :ref:`VIDIOC_S_CROP <VIDIOC_G_CROP>` and
+ :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl, respectively. The
driver returns the closest sizes possible. For more information on
cropping and scaling see :ref:`crop`.
@@ -194,7 +194,7 @@ introduction.
- ``-``
- Applications can enumerate the supported image formats with the
- :ref:`VIDIOC_ENUM_FMT <vidioc-enum-fmt>` ioctl to determine if
+ :ref:`VIDIOC_ENUM_FMT <VIDIOC_ENUM_FMT>` ioctl to determine if
the device supports grey scale capturing only. For more
information on image formats see :ref:`pixfmt`.
@@ -204,7 +204,7 @@ introduction.
- ``-``
- - Applications can call the :ref:`VIDIOC_G_CROP <vidioc-g-crop>`
+ - Applications can call the :ref:`VIDIOC_G_CROP <VIDIOC_G_CROP>`
ioctl to determine if the device supports capturing a subsection
of the full picture ("cropping" in V4L2). If not, the ioctl
returns the EINVAL error code. For more information on cropping
@@ -217,7 +217,7 @@ introduction.
- ``-``
- Applications can enumerate the supported image formats with the
- :ref:`VIDIOC_ENUM_FMT <vidioc-enum-fmt>` ioctl to determine if
+ :ref:`VIDIOC_ENUM_FMT <VIDIOC_ENUM_FMT>` ioctl to determine if
the device supports MPEG streams.
- .. row 13
@@ -248,12 +248,12 @@ introduction.
The ``audios`` field was replaced by ``capabilities`` flag
``V4L2_CAP_AUDIO``, indicating *if* the device has any audio inputs or
outputs. To determine their number applications can enumerate audio
-inputs with the :ref:`VIDIOC_G_AUDIO <vidioc-g-audio>` ioctl. The
+inputs with the :ref:`VIDIOC_G_AUDIO <VIDIOC_G_AUDIO>` ioctl. The
audio ioctls are described in :ref:`audio`.
The ``maxwidth``, ``maxheight``, ``minwidth`` and ``minheight`` fields
-were removed. Calling the :ref:`VIDIOC_S_FMT <vidioc-g-fmt>` or
-:ref:`VIDIOC_TRY_FMT <vidioc-g-fmt>` ioctl with the desired
+were removed. Calling the :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` or
+:ref:`VIDIOC_TRY_FMT <VIDIOC_G_FMT>` ioctl with the desired
dimensions returns the closest size possible, taking into account the
current video standard, cropping and scaling limitations.
@@ -264,9 +264,9 @@ Video Sources
V4L provides the ``VIDIOCGCHAN`` and ``VIDIOCSCHAN`` ioctl using struct
:c:type:`struct video_channel` to enumerate the video inputs of a V4L
device. The equivalent V4L2 ioctls are
-:ref:`VIDIOC_ENUMINPUT <vidioc-enuminput>`,
-:ref:`VIDIOC_G_INPUT <vidioc-g-input>` and
-:ref:`VIDIOC_S_INPUT <vidioc-g-input>` using struct
+:ref:`VIDIOC_ENUMINPUT <VIDIOC_ENUMINPUT>`,
+:ref:`VIDIOC_G_INPUT <VIDIOC_G_INPUT>` and
+:ref:`VIDIOC_S_INPUT <VIDIOC_G_INPUT>` using struct
:ref:`v4l2_input <v4l2-input>` as discussed in :ref:`video`.
The ``channel`` field counting inputs was renamed to ``index``, the
@@ -328,8 +328,8 @@ Tuning
The V4L ``VIDIOCGTUNER`` and ``VIDIOCSTUNER`` ioctl and struct
:c:type:`struct video_tuner` can be used to enumerate the tuners of a
V4L TV or radio device. The equivalent V4L2 ioctls are
-:ref:`VIDIOC_G_TUNER <vidioc-g-tuner>` and
-:ref:`VIDIOC_S_TUNER <vidioc-g-tuner>` using struct
+:ref:`VIDIOC_G_TUNER <VIDIOC_G_TUNER>` and
+:ref:`VIDIOC_S_TUNER <VIDIOC_G_TUNER>` using struct
:ref:`v4l2_tuner <v4l2-tuner>`. Tuners are covered in :ref:`tuner`.
The ``tuner`` field counting tuners was renamed to ``index``. The fields
@@ -360,8 +360,8 @@ the struct :ref:`v4l2_tuner <v4l2-tuner>` ``capability`` field.
The ``VIDIOCGFREQ`` and ``VIDIOCSFREQ`` ioctl to change the tuner
frequency where renamed to
-:ref:`VIDIOC_G_FREQUENCY <vidioc-g-frequency>` and
-:ref:`VIDIOC_S_FREQUENCY <vidioc-g-frequency>`. They take a pointer
+:ref:`VIDIOC_G_FREQUENCY <VIDIOC_G_FREQUENCY>` and
+:ref:`VIDIOC_S_FREQUENCY <VIDIOC_G_FREQUENCY>`. They take a pointer
to a struct :ref:`v4l2_frequency <v4l2-frequency>` instead of an
unsigned long integer.
@@ -374,9 +374,9 @@ Image Properties
V4L2 has no equivalent of the ``VIDIOCGPICT`` and ``VIDIOCSPICT`` ioctl
and struct :c:type:`struct video_picture`. The following fields where
replaced by V4L2 controls accessible with the
-:ref:`VIDIOC_QUERYCTRL <vidioc-queryctrl>`,
-:ref:`VIDIOC_G_CTRL <vidioc-g-ctrl>` and
-:ref:`VIDIOC_S_CTRL <vidioc-g-ctrl>` ioctls:
+:ref:`VIDIOC_QUERYCTRL <VIDIOC_QUERYCTRL>`,
+:ref:`VIDIOC_G_CTRL <VIDIOC_G_CTRL>` and
+:ref:`VIDIOC_S_CTRL <VIDIOC_G_CTRL>` ioctls:
@@ -425,7 +425,7 @@ replaced by V4L2 controls accessible with the
The V4L picture controls are assumed to range from 0 to 65535 with no
particular reset value. The V4L2 API permits arbitrary limits and
defaults which can be queried with the
-:ref:`VIDIOC_QUERYCTRL <vidioc-queryctrl>` ioctl. For general
+:ref:`VIDIOC_QUERYCTRL <VIDIOC_QUERYCTRL>` ioctl. For general
information about controls see :ref:`control`.
The ``depth`` (average number of bits per pixel) of a video image is
@@ -545,7 +545,7 @@ into the struct :ref:`v4l2_pix_format <v4l2-pix-format>`:
V4L2 image formats are defined in :ref:`pixfmt`. The image format can
-be selected with the :ref:`VIDIOC_S_FMT <vidioc-g-fmt>` ioctl.
+be selected with the :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl.
Audio
@@ -554,8 +554,8 @@ Audio
The ``VIDIOCGAUDIO`` and ``VIDIOCSAUDIO`` ioctl and struct
:c:type:`struct video_audio` are used to enumerate the audio inputs
of a V4L device. The equivalent V4L2 ioctls are
-:ref:`VIDIOC_G_AUDIO <vidioc-g-audio>` and
-:ref:`VIDIOC_S_AUDIO <vidioc-g-audio>` using struct
+:ref:`VIDIOC_G_AUDIO <VIDIOC_G_AUDIO>` and
+:ref:`VIDIOC_S_AUDIO <VIDIOC_G_AUDIO>` using struct
:ref:`v4l2_audio <v4l2-audio>` as discussed in :ref:`audio`.
The ``audio`` "channel number" field counting audio inputs was renamed
@@ -576,9 +576,9 @@ information on tuners. Related to audio modes struct
stereo input, regardless if the source is a tuner.
The following fields where replaced by V4L2 controls accessible with the
-:ref:`VIDIOC_QUERYCTRL <vidioc-queryctrl>`,
-:ref:`VIDIOC_G_CTRL <vidioc-g-ctrl>` and
-:ref:`VIDIOC_S_CTRL <vidioc-g-ctrl>` ioctls:
+:ref:`VIDIOC_QUERYCTRL <VIDIOC_QUERYCTRL>`,
+:ref:`VIDIOC_G_CTRL <VIDIOC_G_CTRL>` and
+:ref:`VIDIOC_S_CTRL <VIDIOC_G_CTRL>` ioctls:
@@ -621,7 +621,7 @@ The following fields where replaced by V4L2 controls accessible with the
To determine which of these controls are supported by a driver V4L
provides the ``flags`` ``VIDEO_AUDIO_VOLUME``, ``VIDEO_AUDIO_BASS``,
``VIDEO_AUDIO_TREBLE`` and ``VIDEO_AUDIO_BALANCE``. In the V4L2 API the
-:ref:`VIDIOC_QUERYCTRL <vidioc-queryctrl>` ioctl reports if the
+:ref:`VIDIOC_QUERYCTRL <VIDIOC_QUERYCTRL>` ioctl reports if the
respective control is supported. Accordingly the ``VIDEO_AUDIO_MUTABLE``
and ``VIDEO_AUDIO_MUTE`` flags where replaced by the boolean
``V4L2_CID_AUDIO_MUTE`` control.
@@ -630,7 +630,7 @@ All V4L2 controls have a ``step`` attribute replacing the struct
:c:type:`struct video_audio` ``step`` field. The V4L audio controls
are assumed to range from 0 to 65535 with no particular reset value. The
V4L2 API permits arbitrary limits and defaults which can be queried with
-the :ref:`VIDIOC_QUERYCTRL <vidioc-queryctrl>` ioctl. For general
+the :ref:`VIDIOC_QUERYCTRL <VIDIOC_QUERYCTRL>` ioctl. For general
information about controls see :ref:`control`.
@@ -638,8 +638,8 @@ Frame Buffer Overlay
====================
The V4L2 ioctls equivalent to ``VIDIOCGFBUF`` and ``VIDIOCSFBUF`` are
-:ref:`VIDIOC_G_FBUF <vidioc-g-fbuf>` and
-:ref:`VIDIOC_S_FBUF <vidioc-g-fbuf>`. The ``base`` field of struct
+:ref:`VIDIOC_G_FBUF <VIDIOC_G_FBUF>` and
+:ref:`VIDIOC_S_FBUF <VIDIOC_G_FBUF>`. The ``base`` field of struct
:c:type:`struct video_buffer` remained unchanged, except V4L2 defines
a flag to indicate non-destructive overlays instead of a ``NULL``
pointer. All other fields moved into the struct
@@ -650,8 +650,8 @@ list of RGB formats and their respective color depths.
Instead of the special ioctls ``VIDIOCGWIN`` and ``VIDIOCSWIN`` V4L2
uses the general-purpose data format negotiation ioctls
-:ref:`VIDIOC_G_FMT <vidioc-g-fmt>` and
-:ref:`VIDIOC_S_FMT <vidioc-g-fmt>`. They take a pointer to a struct
+:ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>` and
+:ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>`. They take a pointer to a struct
:ref:`v4l2_format <v4l2-format>` as argument. Here the ``win`` member
of the ``fmt`` union is used, a struct
:ref:`v4l2_window <v4l2-window>`.
@@ -678,7 +678,7 @@ has a separate ``bitmap`` pointer field for this purpose and the bitmap
size is determined by ``w.width`` and ``w.height``.
The ``VIDIOCCAPTURE`` ioctl to enable or disable overlay was renamed to
-:ref:`VIDIOC_OVERLAY <vidioc-overlay>`.
+:ref:`VIDIOC_OVERLAY <VIDIOC_OVERLAY>`.
Cropping
@@ -687,10 +687,10 @@ Cropping
To capture only a subsection of the full picture V4L defines the
``VIDIOCGCAPTURE`` and ``VIDIOCSCAPTURE`` ioctls using struct
:c:type:`struct video_capture`. The equivalent V4L2 ioctls are
-:ref:`VIDIOC_G_CROP <vidioc-g-crop>` and
-:ref:`VIDIOC_S_CROP <vidioc-g-crop>` using struct
+:ref:`VIDIOC_G_CROP <VIDIOC_G_CROP>` and
+:ref:`VIDIOC_S_CROP <VIDIOC_G_CROP>` using struct
:ref:`v4l2_crop <v4l2-crop>`, and the related
-:ref:`VIDIOC_CROPCAP <vidioc-cropcap>` ioctl. This is a rather
+:ref:`VIDIOC_CROPCAP <VIDIOC_CROPCAP>` ioctl. This is a rather
complex matter, see :ref:`crop` for details.
The ``x``, ``y``, ``width`` and ``height`` fields moved into struct
@@ -705,7 +705,7 @@ only the odd or even field, respectively, were replaced by
``field`` of struct :ref:`v4l2_pix_format <v4l2-pix-format>` and
struct :ref:`v4l2_window <v4l2-window>`. These structures are used to
select a capture or overlay format with the
-:ref:`VIDIOC_S_FMT <vidioc-g-fmt>` ioctl.
+:ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl.
Reading Images, Memory Mapping
@@ -719,15 +719,15 @@ There is no essential difference between reading images from a V4L or
V4L2 device using the :ref:`read() <func-read>` function, however V4L2
drivers are not required to support this I/O method. Applications can
determine if the function is available with the
-:ref:`VIDIOC_QUERYCAP <vidioc-querycap>` ioctl. All V4L2 devices
+:ref:`VIDIOC_QUERYCAP <VIDIOC_QUERYCAP>` ioctl. All V4L2 devices
exchanging data with applications must support the
:ref:`select() <func-select>` and :ref:`poll() <func-poll>`
functions.
To select an image format and size, V4L provides the ``VIDIOCSPICT`` and
``VIDIOCSWIN`` ioctls. V4L2 uses the general-purpose data format
-negotiation ioctls :ref:`VIDIOC_G_FMT <vidioc-g-fmt>` and
-:ref:`VIDIOC_S_FMT <vidioc-g-fmt>`. They take a pointer to a struct
+negotiation ioctls :ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>` and
+:ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>`. They take a pointer to a struct
:ref:`v4l2_format <v4l2-format>` as argument, here the struct
:ref:`v4l2_pix_format <v4l2-pix-format>` named ``pix`` of its
``fmt`` union is used.
@@ -761,7 +761,7 @@ differences.
-
- The image format must be selected before buffers are allocated,
- with the :ref:`VIDIOC_S_FMT <vidioc-g-fmt>` ioctl. When no
+ with the :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl. When no
format is selected the driver may use the last, possibly by
another application requested format.
@@ -771,7 +771,7 @@ differences.
into the driver, unless it has a module option to change the
number when the driver module is loaded.
- - The :ref:`VIDIOC_REQBUFS <vidioc-reqbufs>` ioctl allocates the
+ - The :ref:`VIDIOC_REQBUFS <VIDIOC_REQBUFS>` ioctl allocates the
desired number of buffers, this is a required step in the
initialization sequence.
@@ -785,7 +785,7 @@ differences.
- Buffers are individually mapped. The offset and size of each
buffer can be determined with the
- :ref:`VIDIOC_QUERYBUF <vidioc-querybuf>` ioctl.
+ :ref:`VIDIOC_QUERYBUF <VIDIOC_QUERYBUF>` ioctl.
- .. row 5
@@ -800,18 +800,18 @@ differences.
buffer has been filled.
- Drivers maintain an incoming and outgoing queue.
- :ref:`VIDIOC_QBUF <vidioc-qbuf>` enqueues any empty buffer into
+ :ref:`VIDIOC_QBUF <VIDIOC_QBUF>` enqueues any empty buffer into
the incoming queue. Filled buffers are dequeued from the outgoing
- queue with the :ref:`VIDIOC_DQBUF <vidioc-qbuf>` ioctl. To wait
+ queue with the :ref:`VIDIOC_DQBUF <VIDIOC_QBUF>` ioctl. To wait
until filled buffers become available this function,
:ref:`select() <func-select>` or :ref:`poll() <func-poll>` can
- be used. The :ref:`VIDIOC_STREAMON <vidioc-streamon>` ioctl
+ be used. The :ref:`VIDIOC_STREAMON <VIDIOC_STREAMON>` ioctl
must be called once after enqueuing one or more buffers to start
capturing. Its counterpart
- :ref:`VIDIOC_STREAMOFF <vidioc-streamon>` stops capturing and
+ :ref:`VIDIOC_STREAMOFF <VIDIOC_STREAMON>` stops capturing and
dequeues all buffers from both queues. Applications can query the
signal status, if known, with the
- :ref:`VIDIOC_ENUMINPUT <vidioc-enuminput>` ioctl.
+ :ref:`VIDIOC_ENUMINPUT <VIDIOC_ENUMINPUT>` ioctl.
For a more in-depth discussion of memory mapping and examples, see
diff --git a/Documentation/linux_tv/media/v4l/dmabuf.rst b/Documentation/linux_tv/media/v4l/dmabuf.rst
index ac14cf89fa38..bc2944c27e70 100644
--- a/Documentation/linux_tv/media/v4l/dmabuf.rst
+++ b/Documentation/linux_tv/media/v4l/dmabuf.rst
@@ -14,15 +14,15 @@ previously exported for a different or the same device (known as the
importer role), or both. This section describes the DMABUF importer role
API in V4L2.
-Refer to :ref:`DMABUF exporting <vidioc-expbuf>` for details about
+Refer to :ref:`DMABUF exporting <VIDIOC_EXPBUF>` for details about
exporting V4L2 buffers as DMABUF file descriptors.
Input and output devices support the streaming I/O method when the
``V4L2_CAP_STREAMING`` flag in the ``capabilities`` field of struct
:ref:`v4l2_capability <v4l2-capability>` returned by the
-:ref:`VIDIOC_QUERYCAP <vidioc-querycap>` ioctl is set. Whether
+:ref:`VIDIOC_QUERYCAP <VIDIOC_QUERYCAP>` ioctl is set. Whether
importing DMA buffers through DMABUF file descriptors is supported is
-determined by calling the :ref:`VIDIOC_REQBUFS <vidioc-reqbufs>`
+determined by calling the :ref:`VIDIOC_REQBUFS <VIDIOC_REQBUFS>`
ioctl with the memory type set to ``V4L2_MEMORY_DMABUF``.
This I/O method is dedicated to sharing DMA buffers between different
@@ -34,7 +34,7 @@ such file descriptor are exchanged. The descriptors and meta-information
are passed in struct :ref:`v4l2_buffer <v4l2-buffer>` (or in struct
:ref:`v4l2_plane <v4l2-plane>` in the multi-planar API case). The
driver must be switched into DMABUF I/O mode by calling the
-:ref:`VIDIOC_REQBUFS <vidioc-reqbufs>` with the desired buffer type.
+:ref:`VIDIOC_REQBUFS <VIDIOC_REQBUFS>` with the desired buffer type.
.. code-block:: c
@@ -56,7 +56,7 @@ driver must be switched into DMABUF I/O mode by calling the
}
The buffer (plane) file descriptor is passed on the fly with the
-:ref:`VIDIOC_QBUF <vidioc-qbuf>` ioctl. In case of multiplanar
+:ref:`VIDIOC_QBUF <VIDIOC_QBUF>` ioctl. In case of multiplanar
buffers, every plane can be associated with a different DMABUF
descriptor. Although buffers are commonly cycled, applications can pass
a different DMABUF descriptor at each ``VIDIOC_QBUF`` call.
@@ -112,11 +112,11 @@ a different DMABUF descriptor at each ``VIDIOC_QBUF`` call.
}
Captured or displayed buffers are dequeued with the
-:ref:`VIDIOC_DQBUF <vidioc-qbuf>` ioctl. The driver can unlock the
+:ref:`VIDIOC_DQBUF <VIDIOC_QBUF>` ioctl. The driver can unlock the
buffer at any time between the completion of the DMA and this ioctl. The
memory is also unlocked when
-:ref:`VIDIOC_STREAMOFF <vidioc-streamon>` is called,
-:ref:`VIDIOC_REQBUFS <vidioc-reqbufs>`, or when the device is closed.
+:ref:`VIDIOC_STREAMOFF <VIDIOC_STREAMON>` is called,
+:ref:`VIDIOC_REQBUFS <VIDIOC_REQBUFS>`, or when the device is closed.
For capturing applications it is customary to enqueue a number of empty
buffers, to start capturing and enter the read loop. Here the
@@ -134,8 +134,8 @@ immediately with an EAGAIN error code when no buffer is available. The
functions are always available.
To start and stop capturing or displaying applications call the
-:ref:`VIDIOC_STREAMON <vidioc-streamon>` and
-:ref:`VIDIOC_STREAMOFF <vidioc-streamon>` ioctls. Note that
+:ref:`VIDIOC_STREAMON <VIDIOC_STREAMON>` and
+:ref:`VIDIOC_STREAMOFF <VIDIOC_STREAMON>` ioctls. Note that
``VIDIOC_STREAMOFF`` removes all buffers from both queues and unlocks
all buffers as a side effect. Since there is no notion of doing anything
"now" on a multitasking system, if an application needs to synchronize
diff --git a/Documentation/linux_tv/media/v4l/dv-timings.rst b/Documentation/linux_tv/media/v4l/dv-timings.rst
index a347ce7cb504..d51c36ec604c 100644
--- a/Documentation/linux_tv/media/v4l/dv-timings.rst
+++ b/Documentation/linux_tv/media/v4l/dv-timings.rst
@@ -24,14 +24,14 @@ standards.
To enumerate and query the attributes of the DV timings supported by a
device applications use the
-:ref:`VIDIOC_ENUM_DV_TIMINGS <vidioc-enum-dv-timings>` and
-:ref:`VIDIOC_DV_TIMINGS_CAP <vidioc-dv-timings-cap>` ioctls. To set
+:ref:`VIDIOC_ENUM_DV_TIMINGS <VIDIOC_ENUM_DV_TIMINGS>` and
+:ref:`VIDIOC_DV_TIMINGS_CAP <VIDIOC_DV_TIMINGS_CAP>` ioctls. To set
DV timings for the device applications use the
-:ref:`VIDIOC_S_DV_TIMINGS <vidioc-g-dv-timings>` ioctl and to get
+:ref:`VIDIOC_S_DV_TIMINGS <VIDIOC_G_DV_TIMINGS>` ioctl and to get
current DV timings they use the
-:ref:`VIDIOC_G_DV_TIMINGS <vidioc-g-dv-timings>` ioctl. To detect
+:ref:`VIDIOC_G_DV_TIMINGS <VIDIOC_G_DV_TIMINGS>` ioctl. To detect
the DV timings as seen by the video receiver applications use the
-:ref:`VIDIOC_QUERY_DV_TIMINGS <vidioc-query-dv-timings>` ioctl.
+:ref:`VIDIOC_QUERY_DV_TIMINGS <VIDIOC_QUERY_DV_TIMINGS>` ioctl.
Applications can make use of the :ref:`input-capabilities` and
:ref:`output-capabilities` flags to determine whether the digital
diff --git a/Documentation/linux_tv/media/v4l/extended-controls.rst b/Documentation/linux_tv/media/v4l/extended-controls.rst
index 5f9779e94cde..66333b9f60fd 100644
--- a/Documentation/linux_tv/media/v4l/extended-controls.rst
+++ b/Documentation/linux_tv/media/v4l/extended-controls.rst
@@ -39,12 +39,12 @@ The Extended Control API
========================
Three new ioctls are available:
-:ref:`VIDIOC_G_EXT_CTRLS <vidioc-g-ext-ctrls>`,
-:ref:`VIDIOC_S_EXT_CTRLS <vidioc-g-ext-ctrls>` and
-:ref:`VIDIOC_TRY_EXT_CTRLS <vidioc-g-ext-ctrls>`. These ioctls act
+:ref:`VIDIOC_G_EXT_CTRLS <VIDIOC_G_EXT_CTRLS>`,
+:ref:`VIDIOC_S_EXT_CTRLS <VIDIOC_G_EXT_CTRLS>` and
+:ref:`VIDIOC_TRY_EXT_CTRLS <VIDIOC_G_EXT_CTRLS>`. These ioctls act
on arrays of controls (as opposed to the
-:ref:`VIDIOC_G_CTRL <vidioc-g-ctrl>` and
-:ref:`VIDIOC_S_CTRL <vidioc-g-ctrl>` ioctls that act on a single
+:ref:`VIDIOC_G_CTRL <VIDIOC_G_CTRL>` and
+:ref:`VIDIOC_S_CTRL <VIDIOC_G_CTRL>` ioctls that act on a single
control). This is needed since it is often required to atomically change
several controls at once.
@@ -79,17 +79,17 @@ with compound types should only be used programmatically.
Since such compound controls need to expose more information about
themselves than is possible with
-:ref:`VIDIOC_QUERYCTRL <vidioc-queryctrl>` the
-:ref:`VIDIOC_QUERY_EXT_CTRL <vidioc-queryctrl>` ioctl was added. In
+:ref:`VIDIOC_QUERYCTRL <VIDIOC_QUERYCTRL>` the
+:ref:`VIDIOC_QUERY_EXT_CTRL <VIDIOC_QUERYCTRL>` ioctl was added. In
particular, this ioctl gives the dimensions of the N-dimensional array
if this control consists of more than one element.
It is important to realize that due to the flexibility of controls it is
necessary to check whether the control you want to set actually is
supported in the driver and what the valid range of values is. So use
-the :ref:`VIDIOC_QUERYCTRL <vidioc-queryctrl>` (or
-:ref:`VIDIOC_QUERY_EXT_CTRL <vidioc-queryctrl>`) and
-:ref:`VIDIOC_QUERYMENU <vidioc-queryctrl>` ioctls to check this. Also
+the :ref:`VIDIOC_QUERYCTRL <VIDIOC_QUERYCTRL>` (or
+:ref:`VIDIOC_QUERY_EXT_CTRL <VIDIOC_QUERYCTRL>`) and
+:ref:`VIDIOC_QUERYMENU <VIDIOC_QUERYCTRL>` ioctls to check this. Also
note that it is possible that some of the menu indices in a control of
type ``V4L2_CTRL_TYPE_MENU`` may not be supported (``VIDIOC_QUERYMENU``
will return an error). A good example is the list of supported MPEG
@@ -103,7 +103,7 @@ Enumerating Extended Controls
=============================
The recommended way to enumerate over the extended controls is by using
-:ref:`VIDIOC_QUERYCTRL <vidioc-queryctrl>` in combination with the
+:ref:`VIDIOC_QUERYCTRL <VIDIOC_QUERYCTRL>` in combination with the
``V4L2_CTRL_FLAG_NEXT_CTRL`` flag:
@@ -169,7 +169,7 @@ within a control panel.
The flags field of struct :ref:`v4l2_queryctrl <v4l2-queryctrl>` also
contains hints on the behavior of the control. See the
-:ref:`VIDIOC_QUERYCTRL <vidioc-queryctrl>` documentation for more
+:ref:`VIDIOC_QUERYCTRL <VIDIOC_QUERYCTRL>` documentation for more
details.
@@ -198,7 +198,7 @@ Codec Control IDs
``V4L2_CID_MPEG_CLASS (class)``
The Codec class descriptor. Calling
- :ref:`VIDIOC_QUERYCTRL <vidioc-queryctrl>` for this control will
+ :ref:`VIDIOC_QUERYCTRL <VIDIOC_QUERYCTRL>` for this control will
return a description of this control class. This description can be
used as the caption of a Tab page in a GUI, for example.
@@ -1168,7 +1168,7 @@ Codec Control IDs
This read-only control returns the 33-bit video Presentation Time
Stamp as defined in ITU T-REC-H.222.0 and ISO/IEC 13818-1 of the
currently displayed frame. This is the same PTS as is used in
- :ref:`VIDIOC_DECODER_CMD <vidioc-decoder-cmd>`.
+ :ref:`VIDIOC_DECODER_CMD <VIDIOC_DECODER_CMD>`.
.. _`v4l2-mpeg-video-dec-frame`:
@@ -2781,7 +2781,7 @@ Camera Control IDs
``V4L2_CID_CAMERA_CLASS (class)``
The Camera class descriptor. Calling
- :ref:`VIDIOC_QUERYCTRL <vidioc-queryctrl>` for this control will
+ :ref:`VIDIOC_QUERYCTRL <VIDIOC_QUERYCTRL>` for this control will
return a description of this control class.
.. _`v4l2-exposure-auto-type`:
@@ -3441,7 +3441,7 @@ FM_TX Control IDs
``V4L2_CID_FM_TX_CLASS (class)``
The FM_TX class descriptor. Calling
- :ref:`VIDIOC_QUERYCTRL <vidioc-queryctrl>` for this control will
+ :ref:`VIDIOC_QUERYCTRL <VIDIOC_QUERYCTRL>` for this control will
return a description of this control class.
``V4L2_CID_RDS_TX_DEVIATION (integer)``
@@ -3870,7 +3870,7 @@ JPEG Control IDs
``V4L2_CID_JPEG_CLASS (class)``
The JPEG class descriptor. Calling
- :ref:`VIDIOC_QUERYCTRL <vidioc-queryctrl>` for this control will
+ :ref:`VIDIOC_QUERYCTRL <VIDIOC_QUERYCTRL>` for this control will
return a description of this control class.
``V4L2_CID_JPEG_CHROMA_SUBSAMPLING (menu)``
@@ -4271,7 +4271,7 @@ FM_RX Control IDs
``V4L2_CID_FM_RX_CLASS (class)``
The FM_RX class descriptor. Calling
- :ref:`VIDIOC_QUERYCTRL <vidioc-queryctrl>` for this control will
+ :ref:`VIDIOC_QUERYCTRL <VIDIOC_QUERYCTRL>` for this control will
return a description of this control class.
``V4L2_CID_RDS_RECEPTION (boolean)``
@@ -4369,7 +4369,7 @@ Detect Control IDs
``V4L2_CID_DETECT_CLASS (class)``
The Detect class descriptor. Calling
- :ref:`VIDIOC_QUERYCTRL <vidioc-queryctrl>` for this control will
+ :ref:`VIDIOC_QUERYCTRL <VIDIOC_QUERYCTRL>` for this control will
return a description of this control class.
``V4L2_CID_DETECT_MD_MODE (menu)``
@@ -4463,7 +4463,7 @@ RF_TUNER Control IDs
``V4L2_CID_RF_TUNER_CLASS (class)``
The RF_TUNER class descriptor. Calling
- :ref:`VIDIOC_QUERYCTRL <vidioc-queryctrl>` for this control will
+ :ref:`VIDIOC_QUERYCTRL <VIDIOC_QUERYCTRL>` for this control will
return a description of this control class.
``V4L2_CID_RF_TUNER_BANDWIDTH_AUTO (boolean)``
diff --git a/Documentation/linux_tv/media/v4l/field-order.rst b/Documentation/linux_tv/media/v4l/field-order.rst
index 295ec0430183..0ab52df521a8 100644
--- a/Documentation/linux_tv/media/v4l/field-order.rst
+++ b/Documentation/linux_tv/media/v4l/field-order.rst
@@ -48,7 +48,7 @@ All video capture and output devices must report the current field
order. Some drivers may permit the selection of a different order, to
this end applications initialize the ``field`` field of struct
:ref:`v4l2_pix_format <v4l2-pix-format>` before calling the
-:ref:`VIDIOC_S_FMT <vidioc-g-fmt>` ioctl. If this is not desired it
+:ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl. If this is not desired it
should have the value ``V4L2_FIELD_ANY`` (0).
@@ -73,8 +73,8 @@ should have the value ``V4L2_FIELD_ANY`` (0).
size, and return the actual field order. Drivers must never return
``V4L2_FIELD_ANY``. If multiple field orders are possible the
driver must choose one of the possible field orders during
- :ref:`VIDIOC_S_FMT <vidioc-g-fmt>` or
- :ref:`VIDIOC_TRY_FMT <vidioc-g-fmt>`. struct
+ :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` or
+ :ref:`VIDIOC_TRY_FMT <VIDIOC_G_FMT>`. struct
:ref:`v4l2_buffer <v4l2-buffer>` ``field`` can never be
``V4L2_FIELD_ANY``.
diff --git a/Documentation/linux_tv/media/v4l/format.rst b/Documentation/linux_tv/media/v4l/format.rst
index c1e30a64c833..a754fa81f707 100644
--- a/Documentation/linux_tv/media/v4l/format.rst
+++ b/Documentation/linux_tv/media/v4l/format.rst
@@ -23,9 +23,9 @@ current selection.
A single mechanism exists to negotiate all data formats using the
aggregate struct :ref:`v4l2_format <v4l2-format>` and the
-:ref:`VIDIOC_G_FMT <vidioc-g-fmt>` and
-:ref:`VIDIOC_S_FMT <vidioc-g-fmt>` ioctls. Additionally the
-:ref:`VIDIOC_TRY_FMT <vidioc-g-fmt>` ioctl can be used to examine
+:ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>` and
+:ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctls. Additionally the
+:ref:`VIDIOC_TRY_FMT <VIDIOC_G_FMT>` ioctl can be used to examine
what the hardware *could* do, without actually selecting a new data
format. The data formats supported by the V4L2 API are covered in the
respective device section in :ref:`devices`. For a closer look at
@@ -52,7 +52,7 @@ image size.
When applications omit the ``VIDIOC_S_FMT`` ioctl its locking side
effects are implied by the next step, the selection of an I/O method
-with the :ref:`VIDIOC_REQBUFS <vidioc-reqbufs>` ioctl or implicit
+with the :ref:`VIDIOC_REQBUFS <VIDIOC_REQBUFS>` ioctl or implicit
with the first :ref:`read() <func-read>` or
:ref:`write() <func-write>` call.
@@ -75,7 +75,7 @@ Apart of the generic format negotiation functions a special ioctl to
enumerate all image formats supported by video capture, overlay or
output devices is available. [1]_
-The :ref:`VIDIOC_ENUM_FMT <vidioc-enum-fmt>` ioctl must be supported
+The :ref:`VIDIOC_ENUM_FMT <VIDIOC_ENUM_FMT>` ioctl must be supported
by all drivers exchanging image data with applications.
**Important**
diff --git a/Documentation/linux_tv/media/v4l/func-mmap.rst b/Documentation/linux_tv/media/v4l/func-mmap.rst
index fb6e4cd52e24..7243142384bb 100644
--- a/Documentation/linux_tv/media/v4l/func-mmap.rst
+++ b/Documentation/linux_tv/media/v4l/func-mmap.rst
@@ -98,8 +98,8 @@ application address space, preferably at address ``start``. This latter
address is a hint only, and is usually specified as 0.
Suitable length and offset parameters are queried with the
-:ref:`VIDIOC_QUERYBUF <vidioc-querybuf>` ioctl. Buffers must be
-allocated with the :ref:`VIDIOC_REQBUFS <vidioc-reqbufs>` ioctl
+:ref:`VIDIOC_QUERYBUF <VIDIOC_QUERYBUF>` ioctl. Buffers must be
+allocated with the :ref:`VIDIOC_REQBUFS <VIDIOC_REQBUFS>` ioctl
before they can be queried.
To unmap buffers the :ref:`munmap() <func-munmap>` function is used.
@@ -125,7 +125,7 @@ EINVAL
The ``flags`` or ``prot`` value is not supported.
No buffers have been allocated with the
- :ref:`VIDIOC_REQBUFS <vidioc-reqbufs>` ioctl.
+ :ref:`VIDIOC_REQBUFS <VIDIOC_REQBUFS>` ioctl.
ENOMEM
Not enough physical or virtual memory was available to complete the
diff --git a/Documentation/linux_tv/media/v4l/func-open.rst b/Documentation/linux_tv/media/v4l/func-open.rst
index 21b1dfddc118..370a6858d65d 100644
--- a/Documentation/linux_tv/media/v4l/func-open.rst
+++ b/Documentation/linux_tv/media/v4l/func-open.rst
@@ -33,7 +33,7 @@ Arguments
devices only writing.
When the ``O_NONBLOCK`` flag is given, the read() function and the
- :ref:`VIDIOC_DQBUF <vidioc-qbuf>` ioctl will return the EAGAIN
+ :ref:`VIDIOC_DQBUF <VIDIOC_QBUF>` ioctl will return the EAGAIN
error code when no data is available or no buffer is in the driver
outgoing queue, otherwise these functions block until data becomes
available. All V4L2 drivers exchanging data with applications must
diff --git a/Documentation/linux_tv/media/v4l/func-poll.rst b/Documentation/linux_tv/media/v4l/func-poll.rst
index d3ad7b8d1a90..28a769af9309 100644
--- a/Documentation/linux_tv/media/v4l/func-poll.rst
+++ b/Documentation/linux_tv/media/v4l/func-poll.rst
@@ -30,9 +30,9 @@ output.
When streaming I/O has been negotiated this function waits until a
buffer has been filled by the capture device and can be dequeued with
-the :ref:`VIDIOC_DQBUF <vidioc-qbuf>` ioctl. For output devices this
+the :ref:`VIDIOC_DQBUF <VIDIOC_QBUF>` ioctl. For output devices this
function waits until the device is ready to accept a new buffer to be
-queued up with the :ref:`VIDIOC_QBUF <vidioc-qbuf>` ioctl for
+queued up with the :ref:`VIDIOC_QBUF <VIDIOC_QBUF>` ioctl for
display. When buffers are already in the outgoing queue of the driver
(capture) or the incoming queue isn't full (display) the function
returns immediately.
@@ -45,17 +45,17 @@ flags in the ``revents`` field, output devices the ``POLLOUT`` and
``POLLWRNORM`` flags. When the function timed out it returns a value of
zero, on failure it returns -1 and the ``errno`` variable is set
appropriately. When the application did not call
-:ref:`VIDIOC_STREAMON <vidioc-streamon>` the :c:func:`poll()`
+:ref:`VIDIOC_STREAMON <VIDIOC_STREAMON>` the :c:func:`poll()`
function succeeds, but sets the ``POLLERR`` flag in the ``revents``
field. When the application has called
-:ref:`VIDIOC_STREAMON <vidioc-streamon>` for a capture device but
-hasn't yet called :ref:`VIDIOC_QBUF <vidioc-qbuf>`, the
+:ref:`VIDIOC_STREAMON <VIDIOC_STREAMON>` for a capture device but
+hasn't yet called :ref:`VIDIOC_QBUF <VIDIOC_QBUF>`, the
:c:func:`poll()` function succeeds and sets the ``POLLERR`` flag in
the ``revents`` field. For output devices this same situation will cause
:c:func:`poll()` to succeed as well, but it sets the ``POLLOUT`` and
``POLLWRNORM`` flags in the ``revents`` field.
-If an event occurred (see :ref:`VIDIOC_DQEVENT <vidioc-dqevent>`)
+If an event occurred (see :ref:`VIDIOC_DQEVENT <VIDIOC_DQEVENT>`)
then ``POLLPRI`` will be set in the ``revents`` field and
:c:func:`poll()` will return.
diff --git a/Documentation/linux_tv/media/v4l/func-read.rst b/Documentation/linux_tv/media/v4l/func-read.rst
index b46cbbdeeab7..497bc9a9dd5a 100644
--- a/Documentation/linux_tv/media/v4l/func-read.rst
+++ b/Documentation/linux_tv/media/v4l/func-read.rst
@@ -85,8 +85,8 @@ enough. Again, the behavior when the driver runs out of free buffers
depends on the discarding policy.
Applications can get and set the number of buffers used internally by
-the driver with the :ref:`VIDIOC_G_PARM <vidioc-g-parm>` and
-:ref:`VIDIOC_S_PARM <vidioc-g-parm>` ioctls. They are optional,
+the driver with the :ref:`VIDIOC_G_PARM <VIDIOC_G_PARM>` and
+:ref:`VIDIOC_S_PARM <VIDIOC_G_PARM>` ioctls. They are optional,
however. The discarding policy is not reported and cannot be changed.
For minimum requirements see :ref:`devices`.
diff --git a/Documentation/linux_tv/media/v4l/func-select.rst b/Documentation/linux_tv/media/v4l/func-select.rst
index 7c9706838cb3..77fdf33648b3 100644
--- a/Documentation/linux_tv/media/v4l/func-select.rst
+++ b/Documentation/linux_tv/media/v4l/func-select.rst
@@ -32,17 +32,17 @@ for output.
When streaming I/O has been negotiated this function waits until a
buffer has been filled or displayed and can be dequeued with the
-:ref:`VIDIOC_DQBUF <vidioc-qbuf>` ioctl. When buffers are already in
+:ref:`VIDIOC_DQBUF <VIDIOC_QBUF>` ioctl. When buffers are already in
the outgoing queue of the driver the function returns immediately.
On success :c:func:`select()` returns the total number of bits set in
the :c:type:`struct fd_set`s. When the function timed out it returns
a value of zero. On failure it returns -1 and the ``errno`` variable is
set appropriately. When the application did not call
-:ref:`VIDIOC_QBUF <vidioc-qbuf>` or
-:ref:`VIDIOC_STREAMON <vidioc-streamon>` yet the :c:func:`select()`
+:ref:`VIDIOC_QBUF <VIDIOC_QBUF>` or
+:ref:`VIDIOC_STREAMON <VIDIOC_STREAMON>` yet the :c:func:`select()`
function succeeds, setting the bit of the file descriptor in ``readfds``
-or ``writefds``, but subsequent :ref:`VIDIOC_DQBUF <vidioc-qbuf>`
+or ``writefds``, but subsequent :ref:`VIDIOC_DQBUF <VIDIOC_QBUF>`
calls will fail. [1]_
When use of the :c:func:`read()` function has been negotiated and the
diff --git a/Documentation/linux_tv/media/v4l/hist-v4l2.rst b/Documentation/linux_tv/media/v4l/hist-v4l2.rst
index 32f999b3c1a4..ab18331710f7 100644
--- a/Documentation/linux_tv/media/v4l/hist-v4l2.rst
+++ b/Documentation/linux_tv/media/v4l/hist-v4l2.rst
@@ -38,10 +38,10 @@ enumerable.
1998-10-02: The ``id`` field was removed from struct
:c:type:`struct video_standard` and the color subcarrier fields were
-renamed. The :ref:`VIDIOC_QUERYSTD <vidioc-querystd>` ioctl was
-renamed to :ref:`VIDIOC_ENUMSTD <vidioc-enumstd>`,
-:ref:`VIDIOC_G_INPUT <vidioc-g-input>` to
-:ref:`VIDIOC_ENUMINPUT <vidioc-enuminput>`. A first draft of the
+renamed. The :ref:`VIDIOC_QUERYSTD <VIDIOC_QUERYSTD>` ioctl was
+renamed to :ref:`VIDIOC_ENUMSTD <VIDIOC_ENUMSTD>`,
+:ref:`VIDIOC_G_INPUT <VIDIOC_G_INPUT>` to
+:ref:`VIDIOC_ENUMINPUT <VIDIOC_ENUMINPUT>`. A first draft of the
Codec API was released.
1998-11-08: Many minor changes. Most symbols have been renamed. Some
@@ -52,8 +52,8 @@ material changes to struct :ref:`v4l2_capability <v4l2-capability>`.
1998-11-14: ``V4L2_PIX_FMT_RGB24`` changed to ``V4L2_PIX_FMT_BGR24``,
and ``V4L2_PIX_FMT_RGB32`` changed to ``V4L2_PIX_FMT_BGR32``. Audio
controls are now accessible with the
-:ref:`VIDIOC_G_CTRL <vidioc-g-ctrl>` and
-:ref:`VIDIOC_S_CTRL <vidioc-g-ctrl>` ioctls under names starting
+:ref:`VIDIOC_G_CTRL <VIDIOC_G_CTRL>` and
+:ref:`VIDIOC_S_CTRL <VIDIOC_G_CTRL>` ioctls under names starting
with ``V4L2_CID_AUDIO``. The ``V4L2_MAJOR`` define was removed from
``videodev.h`` since it was only used once in the ``videodev`` kernel
module. The ``YUV422`` and ``YUV411`` planar image formats were added.
@@ -142,8 +142,8 @@ common Linux driver API conventions.
int a = V4L2_XXX; err = ioctl(fd, VIDIOC_XXX, &a);
4. All the different get- and set-format commands were swept into one
- :ref:`VIDIOC_G_FMT <vidioc-g-fmt>` and
- :ref:`VIDIOC_S_FMT <vidioc-g-fmt>` ioctl taking a union and a
+ :ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>` and
+ :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl taking a union and a
type field selecting the union member as parameter. Purpose is to
simplify the API by eliminating several ioctls and to allow new and
driver private data streams without adding new ioctls.
@@ -246,14 +246,14 @@ correctly through the backward compatibility layer. [Solution?]
2001-04-13: Big endian 16-bit RGB formats were added.
2001-09-17: New YUV formats and the
-:ref:`VIDIOC_G_FREQUENCY <vidioc-g-frequency>` and
-:ref:`VIDIOC_S_FREQUENCY <vidioc-g-frequency>` ioctls were added.
+:ref:`VIDIOC_G_FREQUENCY <VIDIOC_G_FREQUENCY>` and
+:ref:`VIDIOC_S_FREQUENCY <VIDIOC_G_FREQUENCY>` ioctls were added.
(The old ``VIDIOC_G_FREQ`` and ``VIDIOC_S_FREQ`` ioctls did not take
multiple tuners into account.)
2000-09-18: ``V4L2_BUF_TYPE_VBI`` was added. This may *break
-compatibility* as the :ref:`VIDIOC_G_FMT <vidioc-g-fmt>` and
-:ref:`VIDIOC_S_FMT <vidioc-g-fmt>` ioctls may fail now if the struct
+compatibility* as the :ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>` and
+:ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctls may fail now if the struct
:c:type:`struct v4l2_fmt` ``type`` field does not contain
``V4L2_BUF_TYPE_VBI``. In the documentation of the struct
:ref:`v4l2_vbi_format <v4l2-vbi-format>` ``offset`` field the
@@ -286,7 +286,7 @@ A number of changes were made to the raw VBI interface.
as proposed earlier. Why this feature was dropped is unclear. This
change may *break compatibility* with applications depending on the
start values being positive. The use of ``EBUSY`` and ``EINVAL``
- error codes with the :ref:`VIDIOC_S_FMT <vidioc-g-fmt>` ioctl was
+ error codes with the :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl was
clarified. The EBUSY error code was finally documented, and the
``reserved2`` field which was previously mentioned only in the
``videodev.h`` header file.
@@ -325,7 +325,7 @@ This unnamed version was finally merged into Linux 2.5.46.
dramatically. Note that also the size of the structure changed,
which is encoded in the ioctl request code, thus older V4L2 devices
will respond with an EINVAL error code to the new
- :ref:`VIDIOC_QUERYCAP <vidioc-querycap>` ioctl.
+ :ref:`VIDIOC_QUERYCAP <VIDIOC_QUERYCAP>` ioctl.
There are new fields to identify the driver, a new RDS device
function ``V4L2_CAP_RDS_CAPTURE``, the ``V4L2_CAP_AUDIO`` flag
@@ -401,13 +401,13 @@ This unnamed version was finally merged into Linux 2.5.46.
supported standards with an ioctl applications can now refer to
standards by :ref:`v4l2_std_id <v4l2-std-id>` and symbols
defined in the ``videodev2.h`` header file. For details see
- :ref:`standard`. The :ref:`VIDIOC_G_STD <vidioc-g-std>` and
- :ref:`VIDIOC_S_STD <vidioc-g-std>` now take a pointer to this
- type as argument. :ref:`VIDIOC_QUERYSTD <vidioc-querystd>` was
+ :ref:`standard`. The :ref:`VIDIOC_G_STD <VIDIOC_G_STD>` and
+ :ref:`VIDIOC_S_STD <VIDIOC_G_STD>` now take a pointer to this
+ type as argument. :ref:`VIDIOC_QUERYSTD <VIDIOC_QUERYSTD>` was
added to autodetect the received standard, if the hardware has this
capability. In struct :ref:`v4l2_standard <v4l2-standard>` an
``index`` field was added for
- :ref:`VIDIOC_ENUMSTD <vidioc-enumstd>`. A
+ :ref:`VIDIOC_ENUMSTD <VIDIOC_ENUMSTD>`. A
:ref:`v4l2_std_id <v4l2-std-id>` field named ``id`` was added as
machine readable identifier, also replacing the ``transmission``
field. The misleading ``framerate`` field was renamed to
@@ -416,7 +416,7 @@ This unnamed version was finally merged into Linux 2.5.46.
removed.
Struct :c:type:`struct v4l2_enumstd` ceased to be.
- :ref:`VIDIOC_ENUMSTD <vidioc-enumstd>` now takes a pointer to a
+ :ref:`VIDIOC_ENUMSTD <VIDIOC_ENUMSTD>` now takes a pointer to a
struct :ref:`v4l2_standard <v4l2-standard>` directly. The
information which standards are supported by a particular video
input or output moved into struct :ref:`v4l2_input <v4l2-input>`
@@ -427,9 +427,9 @@ This unnamed version was finally merged into Linux 2.5.46.
``category`` and ``group`` did not catch on and/or were not
implemented as expected and therefore removed.
-9. The :ref:`VIDIOC_TRY_FMT <vidioc-g-fmt>` ioctl was added to
+9. The :ref:`VIDIOC_TRY_FMT <VIDIOC_G_FMT>` ioctl was added to
negotiate data formats as with
- :ref:`VIDIOC_S_FMT <vidioc-g-fmt>`, but without the overhead of
+ :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>`, but without the overhead of
programming the hardware and regardless of I/O in progress.
In struct :ref:`v4l2_format <v4l2-format>` the ``fmt`` union was
@@ -538,7 +538,7 @@ This unnamed version was finally merged into Linux 2.5.46.
added as in struct :ref:`v4l2_format <v4l2-format>`. The
``VIDIOC_ENUM_FBUFFMT`` ioctl is no longer needed and was removed.
These calls can be replaced by
- :ref:`VIDIOC_ENUM_FMT <vidioc-enum-fmt>` with type
+ :ref:`VIDIOC_ENUM_FMT <VIDIOC_ENUM_FMT>` with type
``V4L2_BUF_TYPE_VIDEO_OVERLAY``.
11. In struct :ref:`v4l2_pix_format <v4l2-pix-format>` the ``depth``
@@ -716,25 +716,25 @@ V4L2 2003-06-19
3. The audio input and output interface was found to be incomplete.
- Previously the :ref:`VIDIOC_G_AUDIO <vidioc-g-audio>` ioctl would
+ Previously the :ref:`VIDIOC_G_AUDIO <VIDIOC_G_AUDIO>` ioctl would
enumerate the available audio inputs. An ioctl to determine the
current audio input, if more than one combines with the current video
input, did not exist. So ``VIDIOC_G_AUDIO`` was renamed to
``VIDIOC_G_AUDIO_OLD``, this ioctl was removed on Kernel 2.6.39. The
- :ref:`VIDIOC_ENUMAUDIO <vidioc-enumaudio>` ioctl was added to
+ :ref:`VIDIOC_ENUMAUDIO <VIDIOC_ENUMAUDIO>` ioctl was added to
enumerate audio inputs, while
- :ref:`VIDIOC_G_AUDIO <vidioc-g-audio>` now reports the current
+ :ref:`VIDIOC_G_AUDIO <VIDIOC_G_AUDIO>` now reports the current
audio input.
The same changes were made to
- :ref:`VIDIOC_G_AUDOUT <vidioc-g-audioout>` and
- :ref:`VIDIOC_ENUMAUDOUT <vidioc-enumaudioout>`.
+ :ref:`VIDIOC_G_AUDOUT <VIDIOC_G_AUDIOout>` and
+ :ref:`VIDIOC_ENUMAUDOUT <VIDIOC_ENUMAUDIOout>`.
Until further the "videodev" module will automatically translate
between the old and new ioctls, but drivers and applications must be
updated to successfully compile again.
-4. The :ref:`VIDIOC_OVERLAY <vidioc-overlay>` ioctl was incorrectly
+4. The :ref:`VIDIOC_OVERLAY <VIDIOC_OVERLAY>` ioctl was incorrectly
defined with write-read parameter. It was changed to write-only,
while the write-read version was renamed to ``VIDIOC_OVERLAY_OLD``.
The old ioctl was removed on Kernel 2.6.39. Until further the
@@ -746,8 +746,8 @@ V4L2 2003-06-19
rectangles define regions where *no* video shall be displayed and so
the graphics surface can be seen.
-6. The :ref:`VIDIOC_S_PARM <vidioc-g-parm>` and
- :ref:`VIDIOC_S_CTRL <vidioc-g-ctrl>` ioctls were defined with
+6. The :ref:`VIDIOC_S_PARM <VIDIOC_G_PARM>` and
+ :ref:`VIDIOC_S_CTRL <VIDIOC_G_CTRL>` ioctls were defined with
write-only parameter, inconsistent with other ioctls modifying their
argument. They were changed to write-read, while a ``_OLD`` suffix
was added to the write-only versions. The old ioctls were removed on
@@ -824,7 +824,7 @@ V4L2 2003-11-05
V4L2 in Linux 2.6.6, 2004-05-09
===============================
-1. The :ref:`VIDIOC_CROPCAP <vidioc-cropcap>` ioctl was incorrectly
+1. The :ref:`VIDIOC_CROPCAP <VIDIOC_CROPCAP>` ioctl was incorrectly
defined with read-only parameter. It is now defined as write-read
ioctl, while the read-only version was renamed to
``VIDIOC_CROPCAP_OLD``. The old ioctl was removed on Kernel 2.6.39.
@@ -852,8 +852,8 @@ V4L2 spec erratum 2004-08-01
3. In the Current Audio Input example the ``VIDIOC_G_AUDIO`` ioctl took
the wrong argument.
-4. The documentation of the :ref:`VIDIOC_QBUF <vidioc-qbuf>` and
- :ref:`VIDIOC_DQBUF <vidioc-qbuf>` ioctls did not mention the
+4. The documentation of the :ref:`VIDIOC_QBUF <VIDIOC_QBUF>` and
+ :ref:`VIDIOC_DQBUF <VIDIOC_QBUF>` ioctls did not mention the
struct :ref:`v4l2_buffer <v4l2-buffer>` ``memory`` field. It was
also missing from examples. Also on the ``VIDIOC_DQBUF`` page the EIO
error code was not documented.
@@ -870,7 +870,7 @@ V4L2 in Linux 2.6.14
V4L2 in Linux 2.6.15
====================
-1. The :ref:`VIDIOC_LOG_STATUS <vidioc-log-status>` ioctl was added.
+1. The :ref:`VIDIOC_LOG_STATUS <VIDIOC_LOG_STATUS>` ioctl was added.
2. New video standards ``V4L2_STD_NTSC_443``, ``V4L2_STD_SECAM_LC``,
``V4L2_STD_SECAM_DK`` (a set of SECAM D, K and K1), and
@@ -891,9 +891,9 @@ V4L2 spec erratum 2005-11-27
============================
The capture example in :ref:`capture-example` called the
-:ref:`VIDIOC_S_CROP <vidioc-g-crop>` ioctl without checking if
+:ref:`VIDIOC_S_CROP <VIDIOC_G_CROP>` ioctl without checking if
cropping is supported. In the video standard selection example in
-:ref:`standard` the :ref:`VIDIOC_S_STD <vidioc-g-std>` call used
+:ref:`standard` the :ref:`VIDIOC_S_STD <VIDIOC_G_STD>` call used
the wrong argument type.
@@ -906,7 +906,7 @@ V4L2 spec erratum 2006-01-10
disables color decoding when it detects no color in the video signal
to improve the image quality.)
-2. :ref:`VIDIOC_S_PARM <vidioc-g-parm>` is a write-read ioctl, not
+2. :ref:`VIDIOC_S_PARM <VIDIOC_G_PARM>` is a write-read ioctl, not
write-only as stated on its reference page. The ioctl changed in 2003
as noted above.
@@ -940,7 +940,7 @@ V4L2 in Linux 2.6.17
2. A new ``V4L2_TUNER_MODE_LANG1_LANG2`` was defined to record both
languages of a bilingual program. The use of
``V4L2_TUNER_MODE_STEREO`` for this purpose is deprecated now. See
- the :ref:`VIDIOC_G_TUNER <vidioc-g-tuner>` section for details.
+ the :ref:`VIDIOC_G_TUNER <VIDIOC_G_TUNER>` section for details.
V4L2 spec erratum 2006-09-23 (Draft 0.15)
@@ -950,16 +950,16 @@ V4L2 spec erratum 2006-09-23 (Draft 0.15)
``V4L2_BUF_TYPE_SLICED_VBI_OUTPUT`` of the sliced VBI interface were
not mentioned along with other buffer types.
-2. In :ref:`vidioc-g-audio` it was clarified that the struct
+2. In :ref:`VIDIOC_G_AUDIO` it was clarified that the struct
:ref:`v4l2_audio <v4l2-audio>` ``mode`` field is a flags field.
-3. :ref:`vidioc-querycap` did not mention the sliced VBI and radio
+3. :ref:`VIDIOC_QUERYCAP` did not mention the sliced VBI and radio
capability flags.
-4. In :ref:`vidioc-g-frequency` it was clarified that applications
+4. In :ref:`VIDIOC_G_FREQUENCY` it was clarified that applications
must initialize the tuner ``type`` field of struct
:ref:`v4l2_frequency <v4l2-frequency>` before calling
- :ref:`VIDIOC_S_FREQUENCY <vidioc-g-frequency>`.
+ :ref:`VIDIOC_S_FREQUENCY <VIDIOC_G_FREQUENCY>`.
5. The ``reserved`` array in struct
:ref:`v4l2_requestbuffers <v4l2-requestbuffers>` has 2 elements,
@@ -976,11 +976,11 @@ V4L2 spec erratum 2006-09-23 (Draft 0.15)
V4L2 in Linux 2.6.18
====================
-1. New ioctls :ref:`VIDIOC_G_EXT_CTRLS <vidioc-g-ext-ctrls>`,
- :ref:`VIDIOC_S_EXT_CTRLS <vidioc-g-ext-ctrls>` and
- :ref:`VIDIOC_TRY_EXT_CTRLS <vidioc-g-ext-ctrls>` were added, a
+1. New ioctls :ref:`VIDIOC_G_EXT_CTRLS <VIDIOC_G_EXT_CTRLS>`,
+ :ref:`VIDIOC_S_EXT_CTRLS <VIDIOC_G_EXT_CTRLS>` and
+ :ref:`VIDIOC_TRY_EXT_CTRLS <VIDIOC_G_EXT_CTRLS>` were added, a
flag to skip unsupported controls with
- :ref:`VIDIOC_QUERYCTRL <vidioc-queryctrl>`, new control types
+ :ref:`VIDIOC_QUERYCTRL <VIDIOC_QUERYCTRL>`, new control types
``V4L2_CTRL_TYPE_INTEGER64`` and ``V4L2_CTRL_TYPE_CTRL_CLASS``
(:ref:`v4l2-ctrl-type`), and new control flags
``V4L2_CTRL_FLAG_READ_ONLY``, ``V4L2_CTRL_FLAG_UPDATE``,
@@ -995,15 +995,15 @@ V4L2 in Linux 2.6.19
buffer type field was added replacing a reserved field. Note on
architectures where the size of enum types differs from int types the
size of the structure changed. The
- :ref:`VIDIOC_G_SLICED_VBI_CAP <vidioc-g-sliced-vbi-cap>` ioctl
+ :ref:`VIDIOC_G_SLICED_VBI_CAP <VIDIOC_G_SLICED_VBI_CAP>` ioctl
was redefined from being read-only to write-read. Applications must
initialize the type field and clear the reserved fields now. These
changes may *break the compatibility* with older drivers and
applications.
-2. The ioctls :ref:`VIDIOC_ENUM_FRAMESIZES <vidioc-enum-framesizes>`
+2. The ioctls :ref:`VIDIOC_ENUM_FRAMESIZES <VIDIOC_ENUM_FRAMESIZES>`
and
- :ref:`VIDIOC_ENUM_FRAMEINTERVALS <vidioc-enum-frameintervals>`
+ :ref:`VIDIOC_ENUM_FRAMEINTERVALS <VIDIOC_ENUM_FRAMEINTERVALS>`
were added.
3. A new pixel format ``V4L2_PIX_FMT_RGB444`` (:ref:`rgb-formats`) was
@@ -1034,14 +1034,14 @@ V4L2 in Linux 2.6.22
2. Three new clipping/blending methods with a global or straight or
inverted local alpha value were added to the video overlay interface.
- See the description of the :ref:`VIDIOC_G_FBUF <vidioc-g-fbuf>`
- and :ref:`VIDIOC_S_FBUF <vidioc-g-fbuf>` ioctls for details.
+ See the description of the :ref:`VIDIOC_G_FBUF <VIDIOC_G_FBUF>`
+ and :ref:`VIDIOC_S_FBUF <VIDIOC_G_FBUF>` ioctls for details.
A new ``global_alpha`` field was added to
:ref:`v4l2_window <v4l2-window>`, extending the structure. This
may *break compatibility* with applications using a struct
:c:type:`struct v4l2_window` directly. However the
- :ref:`VIDIOC_G/S/TRY_FMT <vidioc-g-fmt>` ioctls, which take a
+ :ref:`VIDIOC_G/S/TRY_FMT <VIDIOC_G_FMT>` ioctls, which take a
pointer to a :ref:`v4l2_format <v4l2-format>` parent structure
with padding bytes at the end, are not affected.
@@ -1100,7 +1100,7 @@ V4L2 in Linux 2.6.26
V4L2 in Linux 2.6.27
====================
-1. The :ref:`VIDIOC_S_HW_FREQ_SEEK <vidioc-s-hw-freq-seek>` ioctl
+1. The :ref:`VIDIOC_S_HW_FREQ_SEEK <VIDIOC_S_HW_FREQ_SEEK>` ioctl
and the ``V4L2_CAP_HW_FREQ_SEEK`` capability were added.
2. The pixel formats ``V4L2_PIX_FMT_YVYU``, ``V4L2_PIX_FMT_PCA501``,
@@ -1244,9 +1244,9 @@ V4L2 in Linux 3.4
1. Added :ref:`JPEG compression control class <jpeg-controls>`.
2. Extended the DV Timings API:
- :ref:`VIDIOC_ENUM_DV_TIMINGS <vidioc-enum-dv-timings>`,
- :ref:`VIDIOC_QUERY_DV_TIMINGS <vidioc-query-dv-timings>` and
- :ref:`VIDIOC_DV_TIMINGS_CAP <vidioc-dv-timings-cap>`.
+ :ref:`VIDIOC_ENUM_DV_TIMINGS <VIDIOC_ENUM_DV_TIMINGS>`,
+ :ref:`VIDIOC_QUERY_DV_TIMINGS <VIDIOC_QUERY_DV_TIMINGS>` and
+ :ref:`VIDIOC_DV_TIMINGS_CAP <VIDIOC_DV_TIMINGS_CAP>`.
V4L2 in Linux 3.5
@@ -1256,8 +1256,8 @@ V4L2 in Linux 3.5
V4L2_CTRL_TYPE_INTEGER_MENU.
2. Added selection API for V4L2 subdev interface:
- :ref:`VIDIOC_SUBDEV_G_SELECTION <vidioc-subdev-g-selection>` and
- :ref:`VIDIOC_SUBDEV_S_SELECTION <vidioc-subdev-g-selection>`.
+ :ref:`VIDIOC_SUBDEV_G_SELECTION <VIDIOC_SUBDEV_G_SELECTION>` and
+ :ref:`VIDIOC_SUBDEV_S_SELECTION <VIDIOC_SUBDEV_G_SELECTION>`.
3. Added ``V4L2_COLORFX_ANTIQUE``, ``V4L2_COLORFX_ART_FREEZE``,
``V4L2_COLORFX_AQUA``, ``V4L2_COLORFX_SILHOUETTE``,
@@ -1286,7 +1286,7 @@ V4L2 in Linux 3.6
capabilities.
3. Added support for frequency band enumerations:
- :ref:`VIDIOC_ENUM_FREQ_BANDS <vidioc-enum-freq-bands>`.
+ :ref:`VIDIOC_ENUM_FREQ_BANDS <VIDIOC_ENUM_FREQ_BANDS>`.
V4L2 in Linux 3.9
@@ -1308,7 +1308,7 @@ V4L2 in Linux 3.10
capability flags V4L2_IN_CAP_PRESETS and V4L2_OUT_CAP_PRESETS.
2. Added new debugging ioctl
- :ref:`VIDIOC_DBG_G_CHIP_INFO <vidioc-dbg-g-chip-info>`.
+ :ref:`VIDIOC_DBG_G_CHIP_INFO <VIDIOC_DBG_G_CHIP_INFO>`.
V4L2 in Linux 3.11
@@ -1343,7 +1343,7 @@ V4L2 in Linux 3.17
format flags.
2. Added compound control types and
- :ref:`VIDIOC_QUERY_EXT_CTRL <vidioc-queryctrl>`.
+ :ref:`VIDIOC_QUERY_EXT_CTRL <VIDIOC_QUERYCTRL>`.
V4L2 in Linux 3.18
@@ -1452,10 +1452,10 @@ Experimental API Elements
The following V4L2 API elements are currently experimental and may
change in the future.
-- :ref:`VIDIOC_DBG_G_REGISTER <vidioc-dbg-g-register>` and
- :ref:`VIDIOC_DBG_S_REGISTER <vidioc-dbg-g-register>` ioctls.
+- :ref:`VIDIOC_DBG_G_REGISTER <VIDIOC_DBG_G_REGISTER>` and
+ :ref:`VIDIOC_DBG_S_REGISTER <VIDIOC_DBG_G_REGISTER>` ioctls.
-- :ref:`VIDIOC_DBG_G_CHIP_INFO <vidioc-dbg-g-chip-info>` ioctl.
+- :ref:`VIDIOC_DBG_G_CHIP_INFO <VIDIOC_DBG_G_CHIP_INFO>` ioctl.
.. _obsolete:
@@ -1475,7 +1475,7 @@ should not be implemented in new drivers.
- ``VIDIOC_SUBDEV_G_CROP`` and ``VIDIOC_SUBDEV_S_CROP`` ioctls. Use
``VIDIOC_SUBDEV_G_SELECTION`` and ``VIDIOC_SUBDEV_S_SELECTION``,
- :ref:`vidioc-subdev-g-selection`.
+ :ref:`VIDIOC_SUBDEV_G_SELECTION`.
.. [1]
This is not implemented in XFree86.
diff --git a/Documentation/linux_tv/media/v4l/io.rst b/Documentation/linux_tv/media/v4l/io.rst
index a7ca0d5fc5dd..2bc04e597c90 100644
--- a/Documentation/linux_tv/media/v4l/io.rst
+++ b/Documentation/linux_tv/media/v4l/io.rst
@@ -16,12 +16,12 @@ read or write will fail at any time.
Other methods must be negotiated. To select the streaming I/O method
with memory mapped or user buffers applications call the
-:ref:`VIDIOC_REQBUFS <vidioc-reqbufs>` ioctl. The asynchronous I/O
+:ref:`VIDIOC_REQBUFS <VIDIOC_REQBUFS>` ioctl. The asynchronous I/O
method is not defined yet.
Video overlay can be considered another I/O method, although the
application does not directly receive the image data. It is selected by
-initiating video overlay with the :ref:`VIDIOC_S_FMT <vidioc-g-fmt>`
+initiating video overlay with the :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>`
ioctl. For more information see :ref:`overlay`.
Generally exactly one I/O method, including overlay, is associated with
diff --git a/Documentation/linux_tv/media/v4l/libv4l-introduction.rst b/Documentation/linux_tv/media/v4l/libv4l-introduction.rst
index 533ea4e18770..4fd87ec33260 100644
--- a/Documentation/linux_tv/media/v4l/libv4l-introduction.rst
+++ b/Documentation/linux_tv/media/v4l/libv4l-introduction.rst
@@ -91,17 +91,17 @@ and to enhance the image quality.
In most cases, libv4l2 just passes the calls directly through to the
v4l2 driver, intercepting the calls to
-:ref:`VIDIOC_TRY_FMT <vidioc-g-fmt>`,
-:ref:`VIDIOC_G_FMT <vidioc-g-fmt>`
-:ref:`VIDIOC_S_FMT <vidioc-g-fmt>`
-:ref:`VIDIOC_ENUM_FRAMESIZES <vidioc-enum-framesizes>` and
-:ref:`VIDIOC_ENUM_FRAMEINTERVALS <vidioc-enum-frameintervals>` in
+:ref:`VIDIOC_TRY_FMT <VIDIOC_G_FMT>`,
+:ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>`
+:ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>`
+:ref:`VIDIOC_ENUM_FRAMESIZES <VIDIOC_ENUM_FRAMESIZES>` and
+:ref:`VIDIOC_ENUM_FRAMEINTERVALS <VIDIOC_ENUM_FRAMEINTERVALS>` in
order to emulate the formats
:ref:`V4L2_PIX_FMT_BGR24 <V4L2-PIX-FMT-BGR24>`,
:ref:`V4L2_PIX_FMT_RGB24 <V4L2-PIX-FMT-RGB24>`,
:ref:`V4L2_PIX_FMT_YUV420 <V4L2-PIX-FMT-YUV420>`, and
:ref:`V4L2_PIX_FMT_YVU420 <V4L2-PIX-FMT-YVU420>`, if they aren't
-available in the driver. :ref:`VIDIOC_ENUM_FMT <vidioc-enum-fmt>`
+available in the driver. :ref:`VIDIOC_ENUM_FMT <VIDIOC_ENUM_FMT>`
keeps enumerating the hardware supported formats, plus the emulated
formats offered by libv4l at the end.
diff --git a/Documentation/linux_tv/media/v4l/mmap.rst b/Documentation/linux_tv/media/v4l/mmap.rst
index 54eb3b607587..de144028ec56 100644
--- a/Documentation/linux_tv/media/v4l/mmap.rst
+++ b/Documentation/linux_tv/media/v4l/mmap.rst
@@ -9,10 +9,10 @@ Streaming I/O (Memory Mapping)
Input and output devices support this I/O method when the
``V4L2_CAP_STREAMING`` flag in the ``capabilities`` field of struct
:ref:`v4l2_capability <v4l2-capability>` returned by the
-:ref:`VIDIOC_QUERYCAP <vidioc-querycap>` ioctl is set. There are two
+:ref:`VIDIOC_QUERYCAP <VIDIOC_QUERYCAP>` ioctl is set. There are two
streaming methods, to determine if the memory mapping flavor is
supported applications must call the
-:ref:`VIDIOC_REQBUFS <vidioc-reqbufs>` ioctl.
+:ref:`VIDIOC_REQBUFS <VIDIOC_REQBUFS>` ioctl.
Streaming is an I/O method where only pointers to buffers are exchanged
between application and driver, the data itself is not copied. Memory
@@ -29,7 +29,7 @@ a different type of data. To access different sets at the same time
different file descriptors must be used. [1]_
To allocate device buffers applications call the
-:ref:`VIDIOC_REQBUFS <vidioc-reqbufs>` ioctl with the desired number
+:ref:`VIDIOC_REQBUFS <VIDIOC_REQBUFS>` ioctl with the desired number
of buffers and buffer type, for example ``V4L2_BUF_TYPE_VIDEO_CAPTURE``.
This ioctl can also be used to change the number of buffers or to free
the allocated memory, provided none of the buffers are still mapped.
@@ -37,7 +37,7 @@ the allocated memory, provided none of the buffers are still mapped.
Before applications can access the buffers they must map them into their
address space with the :ref:`mmap() <func-mmap>` function. The
location of the buffers in device memory can be determined with the
-:ref:`VIDIOC_QUERYBUF <vidioc-querybuf>` ioctl. In the single-planar
+:ref:`VIDIOC_QUERYBUF <VIDIOC_QUERYBUF>` ioctl. In the single-planar
API case, the ``m.offset`` and ``length`` returned in a struct
:ref:`v4l2_buffer <v4l2-buffer>` are passed as sixth and second
parameter to the :c:func:`mmap()` function. When using the
@@ -227,10 +227,10 @@ when the application runs out of free buffers, it must wait until an
empty buffer can be dequeued and reused.
To enqueue and dequeue a buffer applications use the
-:ref:`VIDIOC_QBUF <vidioc-qbuf>` and
-:ref:`VIDIOC_DQBUF <vidioc-qbuf>` ioctl. The status of a buffer being
+:ref:`VIDIOC_QBUF <VIDIOC_QBUF>` and
+:ref:`VIDIOC_DQBUF <VIDIOC_QBUF>` ioctl. The status of a buffer being
mapped, enqueued, full or empty can be determined at any time using the
-:ref:`VIDIOC_QUERYBUF <vidioc-querybuf>` ioctl. Two methods exist to
+:ref:`VIDIOC_QUERYBUF <VIDIOC_QUERYBUF>` ioctl. Two methods exist to
suspend execution of the application until one or more buffers can be
dequeued. By default ``VIDIOC_DQBUF`` blocks when no buffer is in the
outgoing queue. When the ``O_NONBLOCK`` flag was given to the
@@ -240,8 +240,8 @@ immediately with an EAGAIN error code when no buffer is available. The
are always available.
To start and stop capturing or output applications call the
-:ref:`VIDIOC_STREAMON <vidioc-streamon>` and
-:ref:`VIDIOC_STREAMOFF <vidioc-streamon>` ioctl. Note
+:ref:`VIDIOC_STREAMON <VIDIOC_STREAMON>` and
+:ref:`VIDIOC_STREAMOFF <VIDIOC_STREAMON>` ioctl. Note
``VIDIOC_STREAMOFF`` removes all buffers from both queues as a side
effect. Since there is no notion of doing anything "now" on a
multitasking system, if an application needs to synchronize with another
@@ -258,7 +258,7 @@ the :c:func:`mmap()`, :c:func:`munmap()`, :c:func:`select()` and
.. [1]
One could use one file descriptor and set the buffer type field
- accordingly when calling :ref:`VIDIOC_QBUF <vidioc-qbuf>` etc.,
+ accordingly when calling :ref:`VIDIOC_QBUF <VIDIOC_QBUF>` etc.,
but it makes the :c:func:`select()` function ambiguous. We also
like the clean approach of one file descriptor per logical stream.
Video overlay for example is also a logical stream, although the CPU
diff --git a/Documentation/linux_tv/media/v4l/open.rst b/Documentation/linux_tv/media/v4l/open.rst
index 7df540fae201..4c34d61a5253 100644
--- a/Documentation/linux_tv/media/v4l/open.rst
+++ b/Documentation/linux_tv/media/v4l/open.rst
@@ -108,13 +108,13 @@ are comparable to an ALSA audio mixer application. Just opening a V4L2
device should not change the state of the device. [2]_
Once an application has allocated the memory buffers needed for
-streaming data (by calling the :ref:`VIDIOC_REQBUFS <vidioc-reqbufs>`
-or :ref:`VIDIOC_CREATE_BUFS <vidioc-create-bufs>` ioctls, or
+streaming data (by calling the :ref:`VIDIOC_REQBUFS <VIDIOC_REQBUFS>`
+or :ref:`VIDIOC_CREATE_BUFS <VIDIOC_CREATE_BUFS>` ioctls, or
implicitly by calling the :ref:`read() <func-read>` or
:ref:`write() <func-write>` functions) that application (filehandle)
becomes the owner of the device. It is no longer allowed to make changes
that would affect the buffer sizes (e.g. by calling the
-:ref:`VIDIOC_S_FMT <vidioc-g-fmt>` ioctl) and other applications are
+:ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl) and other applications are
no longer allowed to allocate buffers or start or stop streaming. The
EBUSY error code will be returned instead.
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-013.rst b/Documentation/linux_tv/media/v4l/pixfmt-013.rst
index 384876e377b2..b3cb7c48eb74 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-013.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-013.rst
@@ -27,8 +27,8 @@ Compressed Formats
- 'JPEG'
- - TBD. See also :ref:`VIDIOC_G_JPEGCOMP <vidioc-g-jpegcomp>`,
- :ref:`VIDIOC_S_JPEGCOMP <vidioc-g-jpegcomp>`.
+ - TBD. See also :ref:`VIDIOC_G_JPEGCOMP <VIDIOC_G_JPEGCOMP>`,
+ :ref:`VIDIOC_S_JPEGCOMP <VIDIOC_G_JPEGCOMP>`.
- .. _`V4L2-PIX-FMT-MPEG`:
diff --git a/Documentation/linux_tv/media/v4l/pixfmt.rst b/Documentation/linux_tv/media/v4l/pixfmt.rst
index f5148ac6d781..f2c599aaa502 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt.rst
@@ -11,9 +11,9 @@ with applications. The :c:type:`struct v4l2_pix_format` and
format and layout of an image in memory. The former is used with the
single-planar API, while the latter is used with the multi-planar
version (see :ref:`planar-apis`). Image formats are negotiated with
-the :ref:`VIDIOC_S_FMT <vidioc-g-fmt>` ioctl. (The explanations here
+the :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl. (The explanations here
focus on video capturing and output, for overlay frame buffer formats
-see also :ref:`VIDIOC_G_FBUF <vidioc-g-fbuf>`.)
+see also :ref:`VIDIOC_G_FBUF <VIDIOC_G_FBUF>`.)
.. toctree::
diff --git a/Documentation/linux_tv/media/v4l/planar-apis.rst b/Documentation/linux_tv/media/v4l/planar-apis.rst
index 4c01adcbf525..017f412a6231 100644
--- a/Documentation/linux_tv/media/v4l/planar-apis.rst
+++ b/Documentation/linux_tv/media/v4l/planar-apis.rst
@@ -39,29 +39,29 @@ handle multi-planar formats.
Calls that distinguish between single and multi-planar APIs
===========================================================
-:ref:`VIDIOC_QUERYCAP <vidioc-querycap>`
+:ref:`VIDIOC_QUERYCAP <VIDIOC_QUERYCAP>`
Two additional multi-planar capabilities are added. They can be set
together with non-multi-planar ones for devices that handle both
single- and multi-planar formats.
-:ref:`VIDIOC_G_FMT <vidioc-g-fmt>`,
-:ref:`VIDIOC_S_FMT <vidioc-g-fmt>`,
-:ref:`VIDIOC_TRY_FMT <vidioc-g-fmt>`
+:ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>`,
+:ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>`,
+:ref:`VIDIOC_TRY_FMT <VIDIOC_G_FMT>`
New structures for describing multi-planar formats are added: struct
:ref:`v4l2_pix_format_mplane <v4l2-pix-format-mplane>` and
struct :ref:`v4l2_plane_pix_format <v4l2-plane-pix-format>`.
Drivers may define new multi-planar formats, which have distinct
FourCC codes from the existing single-planar ones.
-:ref:`VIDIOC_QBUF <vidioc-qbuf>`,
-:ref:`VIDIOC_DQBUF <vidioc-qbuf>`,
-:ref:`VIDIOC_QUERYBUF <vidioc-querybuf>`
+:ref:`VIDIOC_QBUF <VIDIOC_QBUF>`,
+:ref:`VIDIOC_DQBUF <VIDIOC_QBUF>`,
+:ref:`VIDIOC_QUERYBUF <VIDIOC_QUERYBUF>`
A new struct :ref:`v4l2_plane <v4l2-plane>` structure for
describing planes is added. Arrays of this structure are passed in
the new ``m.planes`` field of struct
:ref:`v4l2_buffer <v4l2-buffer>`.
-:ref:`VIDIOC_REQBUFS <vidioc-reqbufs>`
+:ref:`VIDIOC_REQBUFS <VIDIOC_REQBUFS>`
Will allocate multi-planar buffers as requested.
diff --git a/Documentation/linux_tv/media/v4l/querycap.rst b/Documentation/linux_tv/media/v4l/querycap.rst
index ce0c0e3f9b53..d8f080a68195 100644
--- a/Documentation/linux_tv/media/v4l/querycap.rst
+++ b/Documentation/linux_tv/media/v4l/querycap.rst
@@ -11,26 +11,26 @@ are equally applicable to all types of devices. Furthermore devices of
the same type have different capabilities and this specification permits
the omission of a few complicated and less important parts of the API.
-The :ref:`VIDIOC_QUERYCAP <vidioc-querycap>` ioctl is available to
+The :ref:`VIDIOC_QUERYCAP <VIDIOC_QUERYCAP>` ioctl is available to
check if the kernel device is compatible with this specification, and to
query the :ref:`functions <devices>` and :ref:`I/O methods <io>`
supported by the device.
-Starting with kernel version 3.1, :ref:`VIDIOC_QUERYCAP <vidioc-querycap>`
+Starting with kernel version 3.1, :ref:`VIDIOC_QUERYCAP <VIDIOC_QUERYCAP>`
will return the V4L2 API version used by the driver, with generally
matches the Kernel version. There's no need of using
-:ref:`VIDIOC_QUERYCAP <vidioc-querycap>` to check if a specific ioctl
+:ref:`VIDIOC_QUERYCAP <VIDIOC_QUERYCAP>` to check if a specific ioctl
is supported, the V4L2 core now returns ENOTTY if a driver doesn't
provide support for an ioctl.
Other features can be queried by calling the respective ioctl, for
-example :ref:`VIDIOC_ENUMINPUT <vidioc-enuminput>` to learn about the
+example :ref:`VIDIOC_ENUMINPUT <VIDIOC_ENUMINPUT>` to learn about the
number, types and names of video connectors on the device. Although
abstraction is a major objective of this API, the
-:ref:`VIDIOC_QUERYCAP <vidioc-querycap>` ioctl also allows driver
+:ref:`VIDIOC_QUERYCAP <VIDIOC_QUERYCAP>` ioctl also allows driver
specific applications to reliably identify the driver.
-All V4L2 drivers must support :ref:`VIDIOC_QUERYCAP <vidioc-querycap>`.
+All V4L2 drivers must support :ref:`VIDIOC_QUERYCAP <VIDIOC_QUERYCAP>`.
Applications should always call this ioctl after opening the device.
diff --git a/Documentation/linux_tv/media/v4l/rw.rst b/Documentation/linux_tv/media/v4l/rw.rst
index c123d3a1bfbb..ad365a6e435d 100644
--- a/Documentation/linux_tv/media/v4l/rw.rst
+++ b/Documentation/linux_tv/media/v4l/rw.rst
@@ -10,7 +10,7 @@ Input and output devices support the :c:func:`read()` and
:c:func:`write()` function, respectively, when the
``V4L2_CAP_READWRITE`` flag in the ``capabilities`` field of struct
:ref:`v4l2_capability <v4l2-capability>` returned by the
-:ref:`VIDIOC_QUERYCAP <vidioc-querycap>` ioctl is set.
+:ref:`VIDIOC_QUERYCAP <VIDIOC_QUERYCAP>` ioctl is set.
Drivers may need the CPU to copy the data, but they may also support DMA
to or from user memory, so this I/O method is not necessarily less
diff --git a/Documentation/linux_tv/media/v4l/selection-api-004.rst b/Documentation/linux_tv/media/v4l/selection-api-004.rst
index d023cd022295..4890815e268e 100644
--- a/Documentation/linux_tv/media/v4l/selection-api-004.rst
+++ b/Documentation/linux_tv/media/v4l/selection-api-004.rst
@@ -4,7 +4,7 @@
Configuration
*************
-Applications can use the :ref:`selection API <vidioc-g-selection>` to
+Applications can use the :ref:`selection API <VIDIOC_G_SELECTION>` to
select an area in a video signal or a buffer, and to query for default
settings and hardware limits.
diff --git a/Documentation/linux_tv/media/v4l/standard.rst b/Documentation/linux_tv/media/v4l/standard.rst
index db80861c1446..da0b8101b6cc 100644
--- a/Documentation/linux_tv/media/v4l/standard.rst
+++ b/Documentation/linux_tv/media/v4l/standard.rst
@@ -11,8 +11,8 @@ variations of standards. Each video input and output may support another
set of standards. This set is reported by the ``std`` field of struct
:ref:`v4l2_input <v4l2-input>` and struct
:ref:`v4l2_output <v4l2-output>` returned by the
-:ref:`VIDIOC_ENUMINPUT <vidioc-enuminput>` and
-:ref:`VIDIOC_ENUMOUTPUT <vidioc-enumoutput>` ioctls, respectively.
+:ref:`VIDIOC_ENUMINPUT <VIDIOC_ENUMINPUT>` and
+:ref:`VIDIOC_ENUMOUTPUT <VIDIOC_ENUMOUTPUT>` ioctls, respectively.
V4L2 defines one bit for each analog video standard currently in use
worldwide, and sets aside bits for driver defined standards, e. g.
@@ -20,7 +20,7 @@ hybrid standards to watch NTSC video tapes on PAL TVs and vice versa.
Applications can use the predefined bits to select a particular
standard, although presenting the user a menu of supported standards is
preferred. To enumerate and query the attributes of the supported
-standards applications use the :ref:`VIDIOC_ENUMSTD <vidioc-enumstd>`
+standards applications use the :ref:`VIDIOC_ENUMSTD <VIDIOC_ENUMSTD>`
ioctl.
Many of the defined standards are actually just variations of a few
@@ -36,10 +36,10 @@ Composite input may collapse standards, enumerating "PAL-B/G/H/I",
"NTSC-M" and "SECAM-D/K". [1]_
To query and select the standard used by the current video input or
-output applications call the :ref:`VIDIOC_G_STD <vidioc-g-std>` and
-:ref:`VIDIOC_S_STD <vidioc-g-std>` ioctl, respectively. The
+output applications call the :ref:`VIDIOC_G_STD <VIDIOC_G_STD>` and
+:ref:`VIDIOC_S_STD <VIDIOC_G_STD>` ioctl, respectively. The
*received* standard can be sensed with the
-:ref:`VIDIOC_QUERYSTD <vidioc-querystd>` ioctl. Note that the
+:ref:`VIDIOC_QUERYSTD <VIDIOC_QUERYSTD>` ioctl. Note that the
parameter of all these ioctls is a pointer to a
:ref:`v4l2_std_id <v4l2-std-id>` type (a standard set), *not* an
index into the standard enumeration. Drivers must implement all video
diff --git a/Documentation/linux_tv/media/v4l/streaming-par.rst b/Documentation/linux_tv/media/v4l/streaming-par.rst
index 53f4d7c23a8a..bb8100b6ef87 100644
--- a/Documentation/linux_tv/media/v4l/streaming-par.rst
+++ b/Documentation/linux_tv/media/v4l/streaming-par.rst
@@ -8,7 +8,7 @@ Streaming Parameters
Streaming parameters are intended to optimize the video capture process
as well as I/O. Presently applications can request a high quality
-capture mode with the :ref:`VIDIOC_S_PARM <vidioc-g-parm>` ioctl.
+capture mode with the :ref:`VIDIOC_S_PARM <VIDIOC_G_PARM>` ioctl.
The current video standard determines a nominal number of frames per
second. If less than this number of frames is to be captured or output,
@@ -23,8 +23,8 @@ internally by a driver in read/write mode. For implications see the
section discussing the :ref:`read() <func-read>` function.
To get and set the streaming parameters applications call the
-:ref:`VIDIOC_G_PARM <vidioc-g-parm>` and
-:ref:`VIDIOC_S_PARM <vidioc-g-parm>` ioctl, respectively. They take
+:ref:`VIDIOC_G_PARM <VIDIOC_G_PARM>` and
+:ref:`VIDIOC_S_PARM <VIDIOC_G_PARM>` ioctl, respectively. They take
a pointer to a struct :ref:`v4l2_streamparm <v4l2-streamparm>`, which
contains a union holding separate parameters for input and output
devices.
diff --git a/Documentation/linux_tv/media/v4l/tuner.rst b/Documentation/linux_tv/media/v4l/tuner.rst
index bc22a99579e3..15c2e6c373ab 100644
--- a/Documentation/linux_tv/media/v4l/tuner.rst
+++ b/Documentation/linux_tv/media/v4l/tuner.rst
@@ -14,7 +14,7 @@ Video input devices can have one or more tuners demodulating a RF
signal. Each tuner is associated with one or more video inputs,
depending on the number of RF connectors on the tuner. The ``type``
field of the respective struct :ref:`v4l2_input <v4l2-input>`
-returned by the :ref:`VIDIOC_ENUMINPUT <vidioc-enuminput>` ioctl is
+returned by the :ref:`VIDIOC_ENUMINPUT <VIDIOC_ENUMINPUT>` ioctl is
set to ``V4L2_INPUT_TYPE_TUNER`` and its ``tuner`` field contains the
index number of the tuner.
@@ -22,8 +22,8 @@ Radio input devices have exactly one tuner with index zero, no video
inputs.
To query and change tuner properties applications use the
-:ref:`VIDIOC_G_TUNER <vidioc-g-tuner>` and
-:ref:`VIDIOC_S_TUNER <vidioc-g-tuner>` ioctls, respectively. The
+:ref:`VIDIOC_G_TUNER <VIDIOC_G_TUNER>` and
+:ref:`VIDIOC_S_TUNER <VIDIOC_G_TUNER>` ioctls, respectively. The
struct :ref:`v4l2_tuner <v4l2-tuner>` returned by ``VIDIOC_G_TUNER``
also contains signal status information applicable when the tuner of the
current video or radio input is queried. Note that ``VIDIOC_S_TUNER``
@@ -31,7 +31,7 @@ does not switch the current tuner, when there is more than one at all.
The tuner is solely determined by the current video input. Drivers must
support both ioctls and set the ``V4L2_CAP_TUNER`` flag in the struct
:ref:`v4l2_capability <v4l2-capability>` returned by the
-:ref:`VIDIOC_QUERYCAP <vidioc-querycap>` ioctl when the device has
+:ref:`VIDIOC_QUERYCAP <VIDIOC_QUERYCAP>` ioctl when the device has
one or more tuners.
@@ -44,7 +44,7 @@ set or video recorder. Each modulator is associated with one or more
video outputs, depending on the number of RF connectors on the
modulator. The ``type`` field of the respective struct
:ref:`v4l2_output <v4l2-output>` returned by the
-:ref:`VIDIOC_ENUMOUTPUT <vidioc-enumoutput>` ioctl is set to
+:ref:`VIDIOC_ENUMOUTPUT <VIDIOC_ENUMOUTPUT>` ioctl is set to
``V4L2_OUTPUT_TYPE_MODULATOR`` and its ``modulator`` field contains the
index number of the modulator.
@@ -55,18 +55,18 @@ A video or radio device cannot support both a tuner and a modulator. Two
separate device nodes will have to be used for such hardware, one that
supports the tuner functionality and one that supports the modulator
functionality. The reason is a limitation with the
-:ref:`VIDIOC_S_FREQUENCY <vidioc-g-frequency>` ioctl where you
+:ref:`VIDIOC_S_FREQUENCY <VIDIOC_G_FREQUENCY>` ioctl where you
cannot specify whether the frequency is for a tuner or a modulator.
To query and change modulator properties applications use the
-:ref:`VIDIOC_G_MODULATOR <vidioc-g-modulator>` and
-:ref:`VIDIOC_S_MODULATOR <vidioc-g-modulator>` ioctl. Note that
+:ref:`VIDIOC_G_MODULATOR <VIDIOC_G_MODULATOR>` and
+:ref:`VIDIOC_S_MODULATOR <VIDIOC_G_MODULATOR>` ioctl. Note that
``VIDIOC_S_MODULATOR`` does not switch the current modulator, when there
is more than one at all. The modulator is solely determined by the
current video output. Drivers must support both ioctls and set the
``V4L2_CAP_MODULATOR`` flag in the struct
:ref:`v4l2_capability <v4l2-capability>` returned by the
-:ref:`VIDIOC_QUERYCAP <vidioc-querycap>` ioctl when the device has
+:ref:`VIDIOC_QUERYCAP <VIDIOC_QUERYCAP>` ioctl when the device has
one or more modulators.
@@ -74,8 +74,8 @@ Radio Frequency
===============
To get and set the tuner or modulator radio frequency applications use
-the :ref:`VIDIOC_G_FREQUENCY <vidioc-g-frequency>` and
-:ref:`VIDIOC_S_FREQUENCY <vidioc-g-frequency>` ioctl which both take
+the :ref:`VIDIOC_G_FREQUENCY <VIDIOC_G_FREQUENCY>` and
+:ref:`VIDIOC_S_FREQUENCY <VIDIOC_G_FREQUENCY>` ioctl which both take
a pointer to a struct :ref:`v4l2_frequency <v4l2-frequency>`. These
ioctls are used for TV and radio devices alike. Drivers must support
both ioctls when the tuner or modulator ioctls are supported, or when
diff --git a/Documentation/linux_tv/media/v4l/userp.rst b/Documentation/linux_tv/media/v4l/userp.rst
index 83558d27bd69..5433025d41d9 100644
--- a/Documentation/linux_tv/media/v4l/userp.rst
+++ b/Documentation/linux_tv/media/v4l/userp.rst
@@ -9,10 +9,10 @@ Streaming I/O (User Pointers)
Input and output devices support this I/O method when the
``V4L2_CAP_STREAMING`` flag in the ``capabilities`` field of struct
:ref:`v4l2_capability <v4l2-capability>` returned by the
-:ref:`VIDIOC_QUERYCAP <vidioc-querycap>` ioctl is set. If the
+:ref:`VIDIOC_QUERYCAP <VIDIOC_QUERYCAP>` ioctl is set. If the
particular user pointer method (not only memory mapping) is supported
must be determined by calling the
-:ref:`VIDIOC_REQBUFS <vidioc-reqbufs>` ioctl.
+:ref:`VIDIOC_REQBUFS <VIDIOC_REQBUFS>` ioctl.
This I/O method combines advantages of the read/write and memory mapping
methods. Buffers (planes) are allocated by the application itself, and
@@ -21,7 +21,7 @@ data are exchanged, these pointers and meta-information are passed in
struct :ref:`v4l2_buffer <v4l2-buffer>` (or in struct
:ref:`v4l2_plane <v4l2-plane>` in the multi-planar API case). The
driver must be switched into user pointer I/O mode by calling the
-:ref:`VIDIOC_REQBUFS <vidioc-reqbufs>` with the desired buffer type.
+:ref:`VIDIOC_REQBUFS <VIDIOC_REQBUFS>` with the desired buffer type.
No buffers (planes) are allocated beforehand, consequently they are not
indexed and cannot be queried like mapped buffers with the
``VIDIOC_QUERYBUF`` ioctl.
@@ -45,7 +45,7 @@ indexed and cannot be queried like mapped buffers with the
}
Buffer (plane) addresses and sizes are passed on the fly with the
-:ref:`VIDIOC_QBUF <vidioc-qbuf>` ioctl. Although buffers are commonly
+:ref:`VIDIOC_QBUF <VIDIOC_QBUF>` ioctl. Although buffers are commonly
cycled, applications can pass different addresses and sizes at each
``VIDIOC_QBUF`` call. If required by the hardware the driver swaps
memory pages within physical memory to create a continuous area of
@@ -55,11 +55,11 @@ to disk they are brought back and finally locked in physical memory for
DMA. [1]_
Filled or displayed buffers are dequeued with the
-:ref:`VIDIOC_DQBUF <vidioc-qbuf>` ioctl. The driver can unlock the
+:ref:`VIDIOC_DQBUF <VIDIOC_QBUF>` ioctl. The driver can unlock the
memory pages at any time between the completion of the DMA and this
ioctl. The memory is also unlocked when
-:ref:`VIDIOC_STREAMOFF <vidioc-streamon>` is called,
-:ref:`VIDIOC_REQBUFS <vidioc-reqbufs>`, or when the device is closed.
+:ref:`VIDIOC_STREAMOFF <VIDIOC_STREAMON>` is called,
+:ref:`VIDIOC_REQBUFS <VIDIOC_REQBUFS>`, or when the device is closed.
Applications must take care not to free buffers without dequeuing. For
once, the buffers remain locked until further, wasting physical memory.
Second the driver will not be notified when the memory is returned to
@@ -82,8 +82,8 @@ immediately with an EAGAIN error code when no buffer is available. The
are always available.
To start and stop capturing or output applications call the
-:ref:`VIDIOC_STREAMON <vidioc-streamon>` and
-:ref:`VIDIOC_STREAMOFF <vidioc-streamon>` ioctl. Note
+:ref:`VIDIOC_STREAMON <VIDIOC_STREAMON>` and
+:ref:`VIDIOC_STREAMOFF <VIDIOC_STREAMON>` ioctl. Note
``VIDIOC_STREAMOFF`` removes all buffers from both queues and unlocks
all buffers as a side effect. Since there is no notion of doing anything
"now" on a multitasking system, if an application needs to synchronize
diff --git a/Documentation/linux_tv/media/v4l/v4l2.rst b/Documentation/linux_tv/media/v4l/v4l2.rst
index 44605ec92a50..c9ba2859ebe5 100644
--- a/Documentation/linux_tv/media/v4l/v4l2.rst
+++ b/Documentation/linux_tv/media/v4l/v4l2.rst
@@ -86,7 +86,7 @@ Revision History
:revision: 4.5 / 2015-10-29 (*rr*)
-Extend vidioc-g-ext-ctrls;. Replace ctrl_class with a new union with
+Extend VIDIOC_G_EXT_CTRLS;. Replace ctrl_class with a new union with
ctrl_class and which. Which is used to select the current value of the
control or the default value.
diff --git a/Documentation/linux_tv/media/v4l/video.rst b/Documentation/linux_tv/media/v4l/video.rst
index fc220be52c2b..e4e543b56989 100644
--- a/Documentation/linux_tv/media/v4l/video.rst
+++ b/Documentation/linux_tv/media/v4l/video.rst
@@ -14,17 +14,17 @@ Radio devices have no video inputs or outputs.
To learn about the number and attributes of the available inputs and
outputs applications can enumerate them with the
-:ref:`VIDIOC_ENUMINPUT <vidioc-enuminput>` and
-:ref:`VIDIOC_ENUMOUTPUT <vidioc-enumoutput>` ioctl, respectively. The
+:ref:`VIDIOC_ENUMINPUT <VIDIOC_ENUMINPUT>` and
+:ref:`VIDIOC_ENUMOUTPUT <VIDIOC_ENUMOUTPUT>` ioctl, respectively. The
struct :ref:`v4l2_input <v4l2-input>` returned by the
-:ref:`VIDIOC_ENUMINPUT <vidioc-enuminput>` ioctl also contains signal
+:ref:`VIDIOC_ENUMINPUT <VIDIOC_ENUMINPUT>` ioctl also contains signal
:status information applicable when the current video input is queried.
-The :ref:`VIDIOC_G_INPUT <vidioc-g-input>` and
-:ref:`VIDIOC_G_OUTPUT <vidioc-g-output>` ioctls return the index of
+The :ref:`VIDIOC_G_INPUT <VIDIOC_G_INPUT>` and
+:ref:`VIDIOC_G_OUTPUT <VIDIOC_G_OUTPUT>` ioctls return the index of
the current video input or output. To select a different input or output
-applications call the :ref:`VIDIOC_S_INPUT <vidioc-g-input>` and
-:ref:`VIDIOC_S_OUTPUT <vidioc-g-output>` ioctls. Drivers must
+applications call the :ref:`VIDIOC_S_INPUT <VIDIOC_G_INPUT>` and
+:ref:`VIDIOC_S_OUTPUT <VIDIOC_G_OUTPUT>` ioctls. Drivers must
implement all the input ioctls when the device has one or more inputs,
all the output ioctls when the device has one or more outputs.
diff --git a/Documentation/linux_tv/media/v4l/vidioc-create-bufs.rst b/Documentation/linux_tv/media/v4l/vidioc-create-bufs.rst
index e512fe26569e..9c2a011f389c 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-create-bufs.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-create-bufs.rst
@@ -1,6 +1,6 @@
.. -*- coding: utf-8; mode: rst -*-
-.. _vidioc-create-bufs:
+.. _VIDIOC_CREATE_BUFS:
************************
ioctl VIDIOC_CREATE_BUFS
@@ -34,7 +34,7 @@ Description
This ioctl is used to create buffers for :ref:`memory mapped <mmap>`
or :ref:`user pointer <userp>` or :ref:`DMA buffer <dmabuf>` I/O. It
can be used as an alternative or in addition to the
-:ref:`VIDIOC_REQBUFS <vidioc-reqbufs>` ioctl, when a tighter control
+:ref:`VIDIOC_REQBUFS <VIDIOC_REQBUFS>` ioctl, when a tighter control
over buffers is required. This ioctl can be called multiple times to
create buffers of different sizes.
@@ -47,8 +47,8 @@ array must be zeroed.
The ``format`` field specifies the image format that the buffers must be
able to handle. The application has to fill in this struct
:ref:`v4l2_format <v4l2-format>`. Usually this will be done using the
-:ref:`VIDIOC_TRY_FMT <vidioc-g-fmt>` or
-:ref:`VIDIOC_G_FMT <vidioc-g-fmt>` ioctls to ensure that the
+:ref:`VIDIOC_TRY_FMT <VIDIOC_G_FMT>` or
+:ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>` ioctls to ensure that the
requested format is supported by the driver. Based on the format's
``type`` field the requested buffer size (for single-planar) or plane
sizes (for multi-planar formats) will be used for the allocated buffers.
diff --git a/Documentation/linux_tv/media/v4l/vidioc-cropcap.rst b/Documentation/linux_tv/media/v4l/vidioc-cropcap.rst
index 7fa9e2750457..22b5efe1d2e4 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-cropcap.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-cropcap.rst
@@ -1,6 +1,6 @@
.. -*- coding: utf-8; mode: rst -*-
-.. _vidioc-cropcap:
+.. _VIDIOC_CROPCAP:
********************
ioctl VIDIOC_CROPCAP
diff --git a/Documentation/linux_tv/media/v4l/vidioc-dbg-g-chip-info.rst b/Documentation/linux_tv/media/v4l/vidioc-dbg-g-chip-info.rst
index 0bb92acd1729..0a92e2550ce0 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-dbg-g-chip-info.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-dbg-g-chip-info.rst
@@ -1,6 +1,6 @@
.. -*- coding: utf-8; mode: rst -*-
-.. _vidioc-dbg-g-chip-info:
+.. _VIDIOC_DBG_G_CHIP_INFO:
****************************
ioctl VIDIOC_DBG_G_CHIP_INFO
diff --git a/Documentation/linux_tv/media/v4l/vidioc-dbg-g-register.rst b/Documentation/linux_tv/media/v4l/vidioc-dbg-g-register.rst
index 613fd256d9bc..1b86abcc44c7 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-dbg-g-register.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-dbg-g-register.rst
@@ -1,6 +1,6 @@
.. -*- coding: utf-8; mode: rst -*-
-.. _vidioc-dbg-g-register:
+.. _VIDIOC_DBG_G_REGISTER:
**************************************************
ioctl VIDIOC_DBG_G_REGISTER, VIDIOC_DBG_S_REGISTER
@@ -65,14 +65,14 @@ When ``match.type`` is ``V4L2_CHIP_MATCH_BRIDGE``, ``match.addr``
selects the nth non-sub-device chip on the TV card. The number zero
always selects the host chip, e. g. the chip connected to the PCI or USB
bus. You can find out which chips are present with the
-:ref:`VIDIOC_DBG_G_CHIP_INFO <vidioc-dbg-g-chip-info>` ioctl.
+:ref:`VIDIOC_DBG_G_CHIP_INFO <VIDIOC_DBG_G_CHIP_INFO>` ioctl.
When ``match.type`` is ``V4L2_CHIP_MATCH_SUBDEV``, ``match.addr``
selects the nth sub-device.
These ioctls are optional, not all drivers may support them. However
when a driver supports these ioctls it must also support
-:ref:`VIDIOC_DBG_G_CHIP_INFO <vidioc-dbg-g-chip-info>`. Conversely
+:ref:`VIDIOC_DBG_G_CHIP_INFO <VIDIOC_DBG_G_CHIP_INFO>`. Conversely
it may support ``VIDIOC_DBG_G_CHIP_INFO`` but not these ioctls.
``VIDIOC_DBG_G_REGISTER`` and ``VIDIOC_DBG_S_REGISTER`` were introduced
diff --git a/Documentation/linux_tv/media/v4l/vidioc-decoder-cmd.rst b/Documentation/linux_tv/media/v4l/vidioc-decoder-cmd.rst
index 77c7bdfb90df..ec9dfed09f76 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-decoder-cmd.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-decoder-cmd.rst
@@ -1,6 +1,6 @@
.. -*- coding: utf-8; mode: rst -*-
-.. _vidioc-decoder-cmd:
+.. _VIDIOC_DECODER_CMD:
************************************************
ioctl VIDIOC_DECODER_CMD, VIDIOC_TRY_DECODER_CMD
@@ -43,11 +43,11 @@ this structure.
The ``cmd`` field must contain the command code. Some commands use the
``flags`` field for additional information.
-A :c:func:`write()`() or :ref:`VIDIOC_STREAMON <vidioc-streamon>`
+A :c:func:`write()`() or :ref:`VIDIOC_STREAMON <VIDIOC_STREAMON>`
call sends an implicit START command to the decoder if it has not been
started yet.
-A :c:func:`close()`() or :ref:`VIDIOC_STREAMOFF <vidioc-streamon>`
+A :c:func:`close()`() or :ref:`VIDIOC_STREAMOFF <VIDIOC_STREAMON>`
call of a streaming file descriptor sends an implicit immediate STOP
command to the decoder, and all buffered data is discarded.
@@ -224,7 +224,7 @@ introduced in Linux 3.3.
new buffers produced to dequeue. This buffer may be empty,
indicated by the driver setting the ``bytesused`` field to 0. Once
the ``V4L2_BUF_FLAG_LAST`` flag was set, the
- :ref:`VIDIOC_DQBUF <vidioc-qbuf>` ioctl will not block anymore,
+ :ref:`VIDIOC_DQBUF <VIDIOC_QBUF>` ioctl will not block anymore,
but return an EPIPE error code. If
``V4L2_DEC_CMD_STOP_IMMEDIATELY`` is set, then the decoder stops
immediately (ignoring the ``pts`` value), otherwise it will keep
diff --git a/Documentation/linux_tv/media/v4l/vidioc-dqevent.rst b/Documentation/linux_tv/media/v4l/vidioc-dqevent.rst
index 108348e4df29..45320997344d 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-dqevent.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-dqevent.rst
@@ -1,6 +1,6 @@
.. -*- coding: utf-8; mode: rst -*-
-.. _vidioc-dqevent:
+.. _VIDIOC_DQEVENT:
********************
ioctl VIDIOC_DQEVENT
@@ -226,8 +226,8 @@ call.
:ref:`v4l2_control <v4l2-control>`.
If the event is generated due to a call to
- :ref:`VIDIOC_S_CTRL <vidioc-g-ctrl>` or
- :ref:`VIDIOC_S_EXT_CTRLS <vidioc-g-ext-ctrls>`, then the
+ :ref:`VIDIOC_S_CTRL <VIDIOC_G_CTRL>` or
+ :ref:`VIDIOC_S_EXT_CTRLS <VIDIOC_G_EXT_CTRLS>`, then the
event will *not* be sent to the file handle that called the ioctl
function. This prevents nasty feedback loops. If you *do* want to
get the event, then set the ``V4L2_EVENT_SUB_FL_ALLOW_FEEDBACK``
@@ -363,7 +363,7 @@ call.
- The 32-bit value of the control for 32-bit control types. This is
0 for string controls since the value of a string cannot be passed
- using :ref:`VIDIOC_DQEVENT <vidioc-dqevent>`.
+ using :ref:`VIDIOC_DQEVENT <VIDIOC_DQEVENT>`.
- .. row 5
diff --git a/Documentation/linux_tv/media/v4l/vidioc-dv-timings-cap.rst b/Documentation/linux_tv/media/v4l/vidioc-dv-timings-cap.rst
index d8222ad0df52..b5b8e41dc693 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-dv-timings-cap.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-dv-timings-cap.rst
@@ -1,6 +1,6 @@
.. -*- coding: utf-8; mode: rst -*-
-.. _vidioc-dv-timings-cap:
+.. _VIDIOC_DV_TIMINGS_CAP:
*********************************************************
ioctl VIDIOC_DV_TIMINGS_CAP, VIDIOC_SUBDEV_DV_TIMINGS_CAP
diff --git a/Documentation/linux_tv/media/v4l/vidioc-encoder-cmd.rst b/Documentation/linux_tv/media/v4l/vidioc-encoder-cmd.rst
index 018f31e38c6d..ffa363eeaa36 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-encoder-cmd.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-encoder-cmd.rst
@@ -1,6 +1,6 @@
.. -*- coding: utf-8; mode: rst -*-
-.. _vidioc-encoder-cmd:
+.. _VIDIOC_ENCODER_CMD:
************************************************
ioctl VIDIOC_ENCODER_CMD, VIDIOC_TRY_ENCODER_CMD
@@ -48,14 +48,14 @@ currently only used by the STOP command and contains one bit: If the
until the end of the current *Group Of Pictures*, otherwise it will stop
immediately.
-A :c:func:`read()`() or :ref:`VIDIOC_STREAMON <vidioc-streamon>`
+A :c:func:`read()`() or :ref:`VIDIOC_STREAMON <VIDIOC_STREAMON>`
call sends an implicit START command to the encoder if it has not been
started yet. After a STOP command, :c:func:`read()`() calls will read
the remaining data buffered by the driver. When the buffer is empty,
:c:func:`read()`() will return zero and the next :c:func:`read()`()
call will restart the encoder.
-A :c:func:`close()`() or :ref:`VIDIOC_STREAMOFF <vidioc-streamon>`
+A :c:func:`close()`() or :ref:`VIDIOC_STREAMOFF <VIDIOC_STREAMON>`
call of a streaming file descriptor sends an implicit immediate STOP to
the encoder, and all buffered data is discarded.
@@ -134,7 +134,7 @@ introduced in Linux 2.6.21.
produced to dequeue. This buffer may be empty, indicated by the
driver setting the ``bytesused`` field to 0. Once the
``V4L2_BUF_FLAG_LAST`` flag was set, the
- :ref:`VIDIOC_DQBUF <vidioc-qbuf>` ioctl will not block anymore,
+ :ref:`VIDIOC_DQBUF <VIDIOC_QBUF>` ioctl will not block anymore,
but return an EPIPE error code.
- .. row 3
diff --git a/Documentation/linux_tv/media/v4l/vidioc-enum-dv-timings.rst b/Documentation/linux_tv/media/v4l/vidioc-enum-dv-timings.rst
index b328829cbf76..5b8f17422fdb 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-enum-dv-timings.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-enum-dv-timings.rst
@@ -1,6 +1,6 @@
.. -*- coding: utf-8; mode: rst -*-
-.. _vidioc-enum-dv-timings:
+.. _VIDIOC_ENUM_DV_TIMINGS:
***********************************************************
ioctl VIDIOC_ENUM_DV_TIMINGS, VIDIOC_SUBDEV_ENUM_DV_TIMINGS
@@ -35,7 +35,7 @@ Description
While some DV receivers or transmitters support a wide range of timings,
others support only a limited number of timings. With this ioctl
applications can enumerate a list of known supported timings. Call
-:ref:`VIDIOC_DV_TIMINGS_CAP <vidioc-dv-timings-cap>` to check if it
+:ref:`VIDIOC_DV_TIMINGS_CAP <VIDIOC_DV_TIMINGS_CAP>` to check if it
also supports other standards or even custom timings that are not in
this list.
diff --git a/Documentation/linux_tv/media/v4l/vidioc-enum-fmt.rst b/Documentation/linux_tv/media/v4l/vidioc-enum-fmt.rst
index bcf7eda8bfdf..f4fc2723f01e 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-enum-fmt.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-enum-fmt.rst
@@ -1,6 +1,6 @@
.. -*- coding: utf-8; mode: rst -*-
-.. _vidioc-enum-fmt:
+.. _VIDIOC_ENUM_FMT:
*********************
ioctl VIDIOC_ENUM_FMT
diff --git a/Documentation/linux_tv/media/v4l/vidioc-enum-frameintervals.rst b/Documentation/linux_tv/media/v4l/vidioc-enum-frameintervals.rst
index 245e01ff2e58..2c69866c8d9e 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-enum-frameintervals.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-enum-frameintervals.rst
@@ -1,6 +1,6 @@
.. -*- coding: utf-8; mode: rst -*-
-.. _vidioc-enum-frameintervals:
+.. _VIDIOC_ENUM_FRAMEINTERVALS:
********************************
ioctl VIDIOC_ENUM_FRAMEINTERVALS
@@ -38,8 +38,8 @@ This ioctl allows applications to enumerate all frame intervals that the
device supports for the given pixel format and frame size.
The supported pixel formats and frame sizes can be obtained by using the
-:ref:`VIDIOC_ENUM_FMT <vidioc-enum-fmt>` and
-:ref:`VIDIOC_ENUM_FRAMESIZES <vidioc-enum-framesizes>` functions.
+:ref:`VIDIOC_ENUM_FMT <VIDIOC_ENUM_FMT>` and
+:ref:`VIDIOC_ENUM_FRAMESIZES <VIDIOC_ENUM_FRAMESIZES>` functions.
The return value and the content of the ``v4l2_frmivalenum.type`` field
depend on the type of frame intervals the device supports. Here are the
diff --git a/Documentation/linux_tv/media/v4l/vidioc-enum-framesizes.rst b/Documentation/linux_tv/media/v4l/vidioc-enum-framesizes.rst
index e3d2ad50db74..9b763ca9d0d8 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-enum-framesizes.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-enum-framesizes.rst
@@ -1,6 +1,6 @@
.. -*- coding: utf-8; mode: rst -*-
-.. _vidioc-enum-framesizes:
+.. _VIDIOC_ENUM_FRAMESIZES:
****************************
ioctl VIDIOC_ENUM_FRAMESIZES
@@ -39,7 +39,7 @@ and height in pixels) that the device supports for the given pixel
format.
The supported pixel formats can be obtained by using the
-:ref:`VIDIOC_ENUM_FMT <vidioc-enum-fmt>` function.
+:ref:`VIDIOC_ENUM_FMT <VIDIOC_ENUM_FMT>` function.
The return value and the content of the ``v4l2_frmsizeenum.type`` field
depend on the type of frame sizes the device supports. Here are the
diff --git a/Documentation/linux_tv/media/v4l/vidioc-enum-freq-bands.rst b/Documentation/linux_tv/media/v4l/vidioc-enum-freq-bands.rst
index 7bb726d519be..2f5dbe0583b4 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-enum-freq-bands.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-enum-freq-bands.rst
@@ -1,6 +1,6 @@
.. -*- coding: utf-8; mode: rst -*-
-.. _vidioc-enum-freq-bands:
+.. _VIDIOC_ENUM_FREQ_BANDS:
****************************
ioctl VIDIOC_ENUM_FREQ_BANDS
diff --git a/Documentation/linux_tv/media/v4l/vidioc-enumaudio.rst b/Documentation/linux_tv/media/v4l/vidioc-enumaudio.rst
index c42e13bf0578..dcca0591864e 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-enumaudio.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-enumaudio.rst
@@ -1,6 +1,6 @@
.. -*- coding: utf-8; mode: rst -*-
-.. _vidioc-enumaudio:
+.. _VIDIOC_ENUMAUDIO:
**********************
ioctl VIDIOC_ENUMAUDIO
@@ -39,7 +39,7 @@ structure or return an EINVAL error code when the index is out of
bounds. To enumerate all audio inputs applications shall begin at index
zero, incrementing by one until the driver returns EINVAL.
-See :ref:`vidioc-g-audio` for a description of struct
+See :ref:`VIDIOC_G_AUDIO` for a description of struct
:ref:`v4l2_audio <v4l2-audio>`.
diff --git a/Documentation/linux_tv/media/v4l/vidioc-enumaudioout.rst b/Documentation/linux_tv/media/v4l/vidioc-enumaudioout.rst
index 54157607d90d..29735eddac5d 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-enumaudioout.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-enumaudioout.rst
@@ -1,6 +1,6 @@
.. -*- coding: utf-8; mode: rst -*-
-.. _vidioc-enumaudioout:
+.. _VIDIOC_ENUMAUDIOOUT:
***********************
ioctl VIDIOC_ENUMAUDOUT
@@ -42,7 +42,7 @@ zero, incrementing by one until the driver returns EINVAL.
Note connectors on a TV card to loop back the received audio signal to a
sound card are not audio outputs in this sense.
-See :ref:`vidioc-g-audioout` for a description of struct
+See :ref:`VIDIOC_G_AUDIOout` for a description of struct
:ref:`v4l2_audioout <v4l2-audioout>`.
diff --git a/Documentation/linux_tv/media/v4l/vidioc-enuminput.rst b/Documentation/linux_tv/media/v4l/vidioc-enuminput.rst
index 32c8dac7f400..644d50679aa2 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-enuminput.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-enuminput.rst
@@ -1,6 +1,6 @@
.. -*- coding: utf-8; mode: rst -*-
-.. _vidioc-enuminput:
+.. _VIDIOC_ENUMINPUT:
**********************
ioctl VIDIOC_ENUMINPUT
diff --git a/Documentation/linux_tv/media/v4l/vidioc-enumoutput.rst b/Documentation/linux_tv/media/v4l/vidioc-enumoutput.rst
index 89cccda0ccaa..6ccb3d094dc8 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-enumoutput.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-enumoutput.rst
@@ -1,6 +1,6 @@
.. -*- coding: utf-8; mode: rst -*-
-.. _vidioc-enumoutput:
+.. _VIDIOC_ENUMOUTPUT:
***********************
ioctl VIDIOC_ENUMOUTPUT
diff --git a/Documentation/linux_tv/media/v4l/vidioc-enumstd.rst b/Documentation/linux_tv/media/v4l/vidioc-enumstd.rst
index d82c49028d83..d16a9494d03b 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-enumstd.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-enumstd.rst
@@ -1,6 +1,6 @@
.. -*- coding: utf-8; mode: rst -*-
-.. _vidioc-enumstd:
+.. _VIDIOC_ENUMSTD:
********************
ioctl VIDIOC_ENUMSTD
diff --git a/Documentation/linux_tv/media/v4l/vidioc-expbuf.rst b/Documentation/linux_tv/media/v4l/vidioc-expbuf.rst
index 0de48b945a01..a389cbc75970 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-expbuf.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-expbuf.rst
@@ -1,6 +1,6 @@
.. -*- coding: utf-8; mode: rst -*-
-.. _vidioc-expbuf:
+.. _VIDIOC_EXPBUF:
*******************
ioctl VIDIOC_EXPBUF
@@ -35,7 +35,7 @@ This ioctl is an extension to the :ref:`memory mapping <mmap>` I/O
method, therefore it is available only for ``V4L2_MEMORY_MMAP`` buffers.
It can be used to export a buffer as a DMABUF file at any time after
buffers have been allocated with the
-:ref:`VIDIOC_REQBUFS <vidioc-reqbufs>` ioctl.
+:ref:`VIDIOC_REQBUFS <VIDIOC_REQBUFS>` ioctl.
To export a buffer, applications fill struct
:ref:`v4l2_exportbuffer <v4l2-exportbuffer>`. The ``type`` field is
@@ -43,7 +43,7 @@ set to the same buffer type as was previously used with struct
:ref:`v4l2_requestbuffers <v4l2-requestbuffers>` ``type``.
Applications must also set the ``index`` field. Valid index numbers
range from zero to the number of buffers allocated with
-:ref:`VIDIOC_REQBUFS <vidioc-reqbufs>` (struct
+:ref:`VIDIOC_REQBUFS <VIDIOC_REQBUFS>` (struct
:ref:`v4l2_requestbuffers <v4l2-requestbuffers>` ``count``) minus
one. For the multi-planar API, applications set the ``plane`` field to
the index of the plane to be exported. Valid planes range from zero to
@@ -142,8 +142,8 @@ Examples
- Number of the buffer, set by the application. This field is only
used for :ref:`memory mapping <mmap>` I/O and can range from
zero to the number of buffers allocated with the
- :ref:`VIDIOC_REQBUFS <vidioc-reqbufs>` and/or
- :ref:`VIDIOC_CREATE_BUFS <vidioc-create-bufs>` ioctls.
+ :ref:`VIDIOC_REQBUFS <VIDIOC_REQBUFS>` and/or
+ :ref:`VIDIOC_CREATE_BUFS <VIDIOC_CREATE_BUFS>` ioctls.
- .. row 3
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-audio.rst b/Documentation/linux_tv/media/v4l/vidioc-g-audio.rst
index 05df90f084e8..2a81d01a1c00 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-audio.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-audio.rst
@@ -1,6 +1,6 @@
.. -*- coding: utf-8; mode: rst -*-
-.. _vidioc-g-audio:
+.. _VIDIOC_G_AUDIO:
************************************
ioctl VIDIOC_G_AUDIO, VIDIOC_S_AUDIO
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-audioout.rst b/Documentation/linux_tv/media/v4l/vidioc-g-audioout.rst
index ef4dce35992e..1da1e7ad51a6 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-audioout.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-audioout.rst
@@ -1,6 +1,6 @@
.. -*- coding: utf-8; mode: rst -*-
-.. _vidioc-g-audioout:
+.. _VIDIOC_G_AUDIOOUT:
**************************************
ioctl VIDIOC_G_AUDOUT, VIDIOC_S_AUDOUT
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-crop.rst b/Documentation/linux_tv/media/v4l/vidioc-g-crop.rst
index 35f70134ac81..457a6cc6b63e 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-crop.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-crop.rst
@@ -1,6 +1,6 @@
.. -*- coding: utf-8; mode: rst -*-
-.. _vidioc-g-crop:
+.. _VIDIOC_G_CROP:
**********************************
ioctl VIDIOC_G_CROP, VIDIOC_S_CROP
@@ -66,7 +66,7 @@ vertical scaling factor.
Finally the driver programs the hardware with the actual cropping and
image parameters. ``VIDIOC_S_CROP`` is a write-only ioctl, it does not
return the actual parameters. To query them applications must call
-``VIDIOC_G_CROP`` and :ref:`VIDIOC_G_FMT <vidioc-g-fmt>`. When the
+``VIDIOC_G_CROP`` and :ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>`. When the
parameters are unsuitable the application may modify the cropping or
image parameters and repeat the cycle until satisfactory parameters have
been negotiated.
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-ctrl.rst b/Documentation/linux_tv/media/v4l/vidioc-g-ctrl.rst
index 6381d7c13d58..6b2b157ba9c7 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-ctrl.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-ctrl.rst
@@ -1,6 +1,6 @@
.. -*- coding: utf-8; mode: rst -*-
-.. _vidioc-g-ctrl:
+.. _VIDIOC_G_CTRL:
**********************************
ioctl VIDIOC_G_CTRL, VIDIOC_S_CTRL
@@ -48,9 +48,9 @@ actual new value. If the ``value`` is inappropriate for the control
EINVAL error code is returned as well.
These ioctls work only with user controls. For other control classes the
-:ref:`VIDIOC_G_EXT_CTRLS <vidioc-g-ext-ctrls>`,
-:ref:`VIDIOC_S_EXT_CTRLS <vidioc-g-ext-ctrls>` or
-:ref:`VIDIOC_TRY_EXT_CTRLS <vidioc-g-ext-ctrls>` must be used.
+:ref:`VIDIOC_G_EXT_CTRLS <VIDIOC_G_EXT_CTRLS>`,
+:ref:`VIDIOC_S_EXT_CTRLS <VIDIOC_G_EXT_CTRLS>` or
+:ref:`VIDIOC_TRY_EXT_CTRLS <VIDIOC_G_EXT_CTRLS>` must be used.
.. _v4l2-control:
@@ -90,7 +90,7 @@ EINVAL
The struct :ref:`v4l2_control <v4l2-control>` ``id`` is invalid
or the ``value`` is inappropriate for the given control (i.e. if a
menu item is selected that is not supported by the driver according
- to :ref:`VIDIOC_QUERYMENU <vidioc-queryctrl>`).
+ to :ref:`VIDIOC_QUERYMENU <VIDIOC_QUERYCTRL>`).
ERANGE
The struct :ref:`v4l2_control <v4l2-control>` ``value`` is out of
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-dv-timings.rst b/Documentation/linux_tv/media/v4l/vidioc-g-dv-timings.rst
index 19598b10d425..84f9db487822 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-dv-timings.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-dv-timings.rst
@@ -1,6 +1,6 @@
.. -*- coding: utf-8; mode: rst -*-
-.. _vidioc-g-dv-timings:
+.. _VIDIOC_G_DV_TIMINGS:
**********************************************
ioctl VIDIOC_G_DV_TIMINGS, VIDIOC_S_DV_TIMINGS
@@ -47,7 +47,7 @@ values are not correct, the driver returns EINVAL error code.
The ``linux/v4l2-dv-timings.h`` header can be used to get the timings of
the formats in the :ref:`cea861` and :ref:`vesadmt` standards. If
the current input or output does not support DV timings (e.g. if
-:ref:`VIDIOC_ENUMINPUT <vidioc-enuminput>` does not set the
+:ref:`VIDIOC_ENUMINPUT <VIDIOC_ENUMINPUT>` does not set the
``V4L2_IN_CAP_DV_TIMINGS`` flag), then ENODATA error code is returned.
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-edid.rst b/Documentation/linux_tv/media/v4l/vidioc-g-edid.rst
index 3138cfe7a26e..26bbf060aa51 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-edid.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-edid.rst
@@ -1,6 +1,6 @@
.. -*- coding: utf-8; mode: rst -*-
-.. _vidioc-g-edid:
+.. _VIDIOC_G_EDID:
******************************************************************************
ioctl VIDIOC_G_EDID, VIDIOC_S_EDID, VIDIOC_SUBDEV_G_EDID, VIDIOC_SUBDEV_S_EDID
@@ -44,8 +44,8 @@ with subdevice nodes (/dev/v4l-subdevX) or with video nodes
When used with video nodes the ``pad`` field represents the input (for
video capture devices) or output (for video output devices) index as is
-returned by :ref:`VIDIOC_ENUMINPUT <vidioc-enuminput>` and
-:ref:`VIDIOC_ENUMOUTPUT <vidioc-enumoutput>` respectively. When used
+returned by :ref:`VIDIOC_ENUMINPUT <VIDIOC_ENUMINPUT>` and
+:ref:`VIDIOC_ENUMOUTPUT <VIDIOC_ENUMOUTPUT>` respectively. When used
with subdevice nodes the ``pad`` field represents the input or output
pad of the subdevice. If there is no EDID support for the given ``pad``
value, then the EINVAL error code will be returned.
@@ -105,8 +105,8 @@ EDID is no longer available.
- Pad for which to get/set the EDID blocks. When used with a video
device node the pad represents the input or output index as
- returned by :ref:`VIDIOC_ENUMINPUT <vidioc-enuminput>` and
- :ref:`VIDIOC_ENUMOUTPUT <vidioc-enumoutput>` respectively.
+ returned by :ref:`VIDIOC_ENUMINPUT <VIDIOC_ENUMINPUT>` and
+ :ref:`VIDIOC_ENUMOUTPUT <VIDIOC_ENUMOUTPUT>` respectively.
- .. row 2
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-enc-index.rst b/Documentation/linux_tv/media/v4l/vidioc-g-enc-index.rst
index 5edf9cb46d15..68af83d964f6 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-enc-index.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-enc-index.rst
@@ -1,6 +1,6 @@
.. -*- coding: utf-8; mode: rst -*-
-.. _vidioc-g-enc-index:
+.. _VIDIOC_G_ENC_INDEX:
************************
ioctl VIDIOC_G_ENC_INDEX
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-ext-ctrls.rst b/Documentation/linux_tv/media/v4l/vidioc-g-ext-ctrls.rst
index 66dce741a3c0..f800458d9dfe 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-ext-ctrls.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-ext-ctrls.rst
@@ -1,6 +1,6 @@
.. -*- coding: utf-8; mode: rst -*-
-.. _vidioc-g-ext-ctrls:
+.. _VIDIOC_G_EXT_CTRLS:
******************************************************************
ioctl VIDIOC_G_EXT_CTRLS, VIDIOC_S_EXT_CTRLS, VIDIOC_TRY_EXT_CTRLS
@@ -58,14 +58,14 @@ set ``size`` to a valid value and return an ENOSPC error code. You
should re-allocate the memory to this new size and try again. For the
string type it is possible that the same issue occurs again if the
string has grown in the meantime. It is recommended to call
-:ref:`VIDIOC_QUERYCTRL <vidioc-queryctrl>` first and use
+:ref:`VIDIOC_QUERYCTRL <VIDIOC_QUERYCTRL>` first and use
``maximum``\ +1 as the new ``size`` value. It is guaranteed that that is
sufficient memory.
N-dimensional arrays are set and retrieved row-by-row. You cannot set a
partial array, all elements have to be set or retrieved. The total size
is calculated as ``elems`` * ``elem_size``. These values can be obtained
-by calling :ref:`VIDIOC_QUERY_EXT_CTRL <vidioc-queryctrl>`.
+by calling :ref:`VIDIOC_QUERY_EXT_CTRL <VIDIOC_QUERYCTRL>`.
To change the value of a set of controls applications initialize the
``id``, ``size``, ``reserved2`` and ``value/value64/string/ptr`` fields
@@ -366,8 +366,8 @@ still cause this situation.
- The class containing user controls. These controls are described
in :ref:`control`. All controls that can be set using the
- :ref:`VIDIOC_S_CTRL <vidioc-g-ctrl>` and
- :ref:`VIDIOC_G_CTRL <vidioc-g-ctrl>` ioctl belong to this
+ :ref:`VIDIOC_S_CTRL <VIDIOC_G_CTRL>` and
+ :ref:`VIDIOC_G_CTRL <VIDIOC_G_CTRL>` ioctl belong to this
class.
- .. row 2
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-fbuf.rst b/Documentation/linux_tv/media/v4l/vidioc-g-fbuf.rst
index 499881e92a28..f4703b3449b3 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-fbuf.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-fbuf.rst
@@ -1,6 +1,6 @@
.. -*- coding: utf-8; mode: rst -*-
-.. _vidioc-g-fbuf:
+.. _VIDIOC_G_FBUF:
**********************************
ioctl VIDIOC_G_FBUF, VIDIOC_S_FBUF
@@ -39,7 +39,7 @@ to get and set the framebuffer parameters for a
:ref:`Video Overlay <overlay>` or :ref:`Video Output Overlay <osd>`
(OSD). The type of overlay is implied by the device type (capture or
output device) and can be determined with the
-:ref:`VIDIOC_QUERYCAP <vidioc-querycap>` ioctl. One ``/dev/videoN``
+:ref:`VIDIOC_QUERYCAP <VIDIOC_QUERYCAP>` ioctl. One ``/dev/videoN``
device must not support both kinds of overlay.
The V4L2 API distinguishes destructive and non-destructive overlays. A
@@ -202,7 +202,7 @@ destructive video overlay.
- Drivers and applications shall ignore this field. If applicable,
the field order is selected with the
- :ref:`VIDIOC_S_FMT <vidioc-g-fmt>` ioctl, using the ``field``
+ :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl, using the ``field``
field of struct :ref:`v4l2_window <v4l2-window>`.
- .. row 13
@@ -396,12 +396,12 @@ destructive video overlay.
- If this flag is set for a video capture device, then the driver
will set the initial overlay size to cover the full framebuffer
size, otherwise the existing overlay size (as set by
- :ref:`VIDIOC_S_FMT <vidioc-g-fmt>`) will be used. Only one
+ :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>`) will be used. Only one
video capture driver (bttv) supports this flag. The use of this
flag for capture devices is deprecated. There is no way to detect
which drivers support this flag, so the only reliable method of
setting the overlay size is through
- :ref:`VIDIOC_S_FMT <vidioc-g-fmt>`. If this flag is set for a
+ :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>`. If this flag is set for a
video output device, then the video output overlay window is
relative to the top-left corner of the framebuffer and restricted
to the size of the framebuffer. If it is cleared, then the video
@@ -415,14 +415,14 @@ destructive video overlay.
- Use chroma-keying. The chroma-key color is determined by the
``chromakey`` field of struct :ref:`v4l2_window <v4l2-window>`
- and negotiated with the :ref:`VIDIOC_S_FMT <vidioc-g-fmt>`
+ and negotiated with the :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>`
ioctl, see :ref:`overlay` and :ref:`osd`.
- .. row 4
- :cspan:`2` There are no flags to enable clipping using a list of
clip rectangles or a bitmap. These methods are negotiated with the
- :ref:`VIDIOC_S_FMT <vidioc-g-fmt>` ioctl, see :ref:`overlay`
+ :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl, see :ref:`overlay`
and :ref:`osd`.
- .. row 5
@@ -447,7 +447,7 @@ destructive video overlay.
+ video pixel * (255 - alpha)) / 255. The alpha value is
determined by the ``global_alpha`` field of struct
:ref:`v4l2_window <v4l2-window>` and negotiated with the
- :ref:`VIDIOC_S_FMT <vidioc-g-fmt>` ioctl, see :ref:`overlay`
+ :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl, see :ref:`overlay`
and :ref:`osd`.
- .. row 7
@@ -471,7 +471,7 @@ destructive video overlay.
- Use source chroma-keying. The source chroma-key color is
determined by the ``chromakey`` field of struct
:ref:`v4l2_window <v4l2-window>` and negotiated with the
- :ref:`VIDIOC_S_FMT <vidioc-g-fmt>` ioctl, see :ref:`overlay`
+ :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl, see :ref:`overlay`
and :ref:`osd`. Both chroma-keying are mutual exclusive to each
other, so same ``chromakey`` field of struct
:ref:`v4l2_window <v4l2-window>` is being used.
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-fmt.rst b/Documentation/linux_tv/media/v4l/vidioc-g-fmt.rst
index ed1daa32122b..1d392e6c538d 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-fmt.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-fmt.rst
@@ -1,6 +1,6 @@
.. -*- coding: utf-8; mode: rst -*-
-.. _vidioc-g-fmt:
+.. _VIDIOC_G_FMT:
************************************************
ioctl VIDIOC_G_FMT, VIDIOC_S_FMT, VIDIOC_TRY_FMT
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-frequency.rst b/Documentation/linux_tv/media/v4l/vidioc-g-frequency.rst
index 1d9f0fe86fb0..ce247577c3a0 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-frequency.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-frequency.rst
@@ -1,6 +1,6 @@
.. -*- coding: utf-8; mode: rst -*-
-.. _vidioc-g-frequency:
+.. _VIDIOC_G_FREQUENCY:
********************************************
ioctl VIDIOC_G_FREQUENCY, VIDIOC_S_FREQUENCY
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-input.rst b/Documentation/linux_tv/media/v4l/vidioc-g-input.rst
index fffba83242ed..62990976ff9b 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-input.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-input.rst
@@ -1,6 +1,6 @@
.. -*- coding: utf-8; mode: rst -*-
-.. _vidioc-g-input:
+.. _VIDIOC_G_INPUT:
************************************
ioctl VIDIOC_G_INPUT, VIDIOC_S_INPUT
@@ -47,7 +47,7 @@ applications must select an input before querying or negotiating any
other parameters.
Information about video inputs is available using the
-:ref:`VIDIOC_ENUMINPUT <vidioc-enuminput>` ioctl.
+:ref:`VIDIOC_ENUMINPUT <VIDIOC_ENUMINPUT>` ioctl.
Return Value
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-jpegcomp.rst b/Documentation/linux_tv/media/v4l/vidioc-g-jpegcomp.rst
index 05d4ebf221e2..acd05bf0d7b6 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-jpegcomp.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-jpegcomp.rst
@@ -1,6 +1,6 @@
.. -*- coding: utf-8; mode: rst -*-
-.. _vidioc-g-jpegcomp:
+.. _VIDIOC_G_JPEGCOMP:
******************************************
ioctl VIDIOC_G_JPEGCOMP, VIDIOC_S_JPEGCOMP
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-modulator.rst b/Documentation/linux_tv/media/v4l/vidioc-g-modulator.rst
index 3a8ae0a5891a..4399a13f94c1 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-modulator.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-modulator.rst
@@ -1,6 +1,6 @@
.. -*- coding: utf-8; mode: rst -*-
-.. _vidioc-g-modulator:
+.. _VIDIOC_G_MODULATOR:
********************************************
ioctl VIDIOC_G_MODULATOR, VIDIOC_S_MODULATOR
@@ -57,7 +57,7 @@ initialized to zero. The term 'modulator' means SDR transmitter in this
context.
To change the radio frequency the
-:ref:`VIDIOC_S_FREQUENCY <vidioc-g-frequency>` ioctl is available.
+:ref:`VIDIOC_S_FREQUENCY <VIDIOC_G_FREQUENCY>` ioctl is available.
.. _v4l2-modulator:
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-output.rst b/Documentation/linux_tv/media/v4l/vidioc-g-output.rst
index 8341f1f8a45c..3b9ea56e3b9e 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-output.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-output.rst
@@ -1,6 +1,6 @@
.. -*- coding: utf-8; mode: rst -*-
-.. _vidioc-g-output:
+.. _VIDIOC_G_OUTPUT:
**************************************
ioctl VIDIOC_G_OUTPUT, VIDIOC_S_OUTPUT
@@ -48,7 +48,7 @@ effects applications must select an output before querying or
negotiating any other parameters.
Information about video outputs is available using the
-:ref:`VIDIOC_ENUMOUTPUT <vidioc-enumoutput>` ioctl.
+:ref:`VIDIOC_ENUMOUTPUT <VIDIOC_ENUMOUTPUT>` ioctl.
Return Value
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-parm.rst b/Documentation/linux_tv/media/v4l/vidioc-g-parm.rst
index 2892653b5bc4..07432d386356 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-parm.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-parm.rst
@@ -1,6 +1,6 @@
.. -*- coding: utf-8; mode: rst -*-
-.. _vidioc-g-parm:
+.. _VIDIOC_G_PARM:
**********************************
ioctl VIDIOC_G_PARM, VIDIOC_S_PARM
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-priority.rst b/Documentation/linux_tv/media/v4l/vidioc-g-priority.rst
index 0706f2f85a79..ee80c9e0c7d4 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-priority.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-priority.rst
@@ -1,6 +1,6 @@
.. -*- coding: utf-8; mode: rst -*-
-.. _vidioc-g-priority:
+.. _VIDIOC_G_PRIORITY:
******************************************
ioctl VIDIOC_G_PRIORITY, VIDIOC_S_PRIORITY
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-selection.rst b/Documentation/linux_tv/media/v4l/vidioc-g-selection.rst
index 7846553dc4de..fd07c87a369c 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-selection.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-selection.rst
@@ -1,6 +1,6 @@
.. -*- coding: utf-8; mode: rst -*-
-.. _vidioc-g-selection:
+.. _VIDIOC_G_SELECTION:
********************************************
ioctl VIDIOC_G_SELECTION, VIDIOC_S_SELECTION
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-sliced-vbi-cap.rst b/Documentation/linux_tv/media/v4l/vidioc-g-sliced-vbi-cap.rst
index c76f5682ad0a..8c86d2b41a5b 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-sliced-vbi-cap.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-sliced-vbi-cap.rst
@@ -1,6 +1,6 @@
.. -*- coding: utf-8; mode: rst -*-
-.. _vidioc-g-sliced-vbi-cap:
+.. _VIDIOC_G_SLICED_VBI_CAP:
*****************************
ioctl VIDIOC_G_SLICED_VBI_CAP
@@ -134,7 +134,7 @@ to write-read, in Linux 2.6.19.
given line may be limited. For example on PAL line 16 the hardware
may be able to look for a VPS or Teletext signal, but not both at
the same time. Applications can learn about these limits using the
- :ref:`VIDIOC_S_FMT <vidioc-g-fmt>` ioctl as described in
+ :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl as described in
:ref:`sliced`.
- .. row 10
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-std.rst b/Documentation/linux_tv/media/v4l/vidioc-g-std.rst
index c01e8c1f51d0..9cbf2d2995c6 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-std.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-std.rst
@@ -1,6 +1,6 @@
.. -*- coding: utf-8; mode: rst -*-
-.. _vidioc-g-std:
+.. _VIDIOC_G_STD:
********************************
ioctl VIDIOC_G_STD, VIDIOC_S_STD
@@ -48,7 +48,7 @@ no flags are given or the current input does not support the requested
standard the driver returns an EINVAL error code. When the standard set
is ambiguous drivers may return EINVAL or choose any of the requested
standards. If the current input or output does not support standard
-video timings (e.g. if :ref:`VIDIOC_ENUMINPUT <vidioc-enuminput>`
+video timings (e.g. if :ref:`VIDIOC_ENUMINPUT <VIDIOC_ENUMINPUT>`
does not set the ``V4L2_IN_CAP_STD`` flag), then ENODATA error code is
returned.
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-tuner.rst b/Documentation/linux_tv/media/v4l/vidioc-g-tuner.rst
index d897f6862b9d..1ad5107a0ad5 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-tuner.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-tuner.rst
@@ -1,6 +1,6 @@
.. -*- coding: utf-8; mode: rst -*-
-.. _vidioc-g-tuner:
+.. _VIDIOC_G_TUNER:
************************************
ioctl VIDIOC_G_TUNER, VIDIOC_S_TUNER
@@ -56,7 +56,7 @@ selected audio mode.
to zero. The term 'tuner' means SDR receiver in this context.
To change the radio frequency the
-:ref:`VIDIOC_S_FREQUENCY <vidioc-g-frequency>` ioctl is available.
+:ref:`VIDIOC_S_FREQUENCY <VIDIOC_G_FREQUENCY>` ioctl is available.
.. _v4l2-tuner:
@@ -323,7 +323,7 @@ To change the radio frequency the
determined from the frequency band.) The set of supported video
standards is available from the struct
:ref:`v4l2_input <v4l2-input>` pointing to this tuner, see the
- description of ioctl :ref:`VIDIOC_ENUMINPUT <vidioc-enuminput>`
+ description of ioctl :ref:`VIDIOC_ENUMINPUT <VIDIOC_ENUMINPUT>`
for details. Only ``V4L2_TUNER_ANALOG_TV`` tuners can have this
capability.
@@ -425,7 +425,7 @@ To change the radio frequency the
- 0x0400
- - The :ref:`VIDIOC_ENUM_FREQ_BANDS <vidioc-enum-freq-bands>`
+ - The :ref:`VIDIOC_ENUM_FREQ_BANDS <VIDIOC_ENUM_FREQ_BANDS>`
ioctl can be used to enumerate the available frequency bands.
- .. row 13
@@ -436,7 +436,7 @@ To change the radio frequency the
- The range to search when using the hardware seek functionality is
programmable, see
- :ref:`VIDIOC_S_HW_FREQ_SEEK <vidioc-s-hw-freq-seek>` for
+ :ref:`VIDIOC_S_HW_FREQ_SEEK <VIDIOC_S_HW_FREQ_SEEK>` for
details.
- .. row 14
diff --git a/Documentation/linux_tv/media/v4l/vidioc-log-status.rst b/Documentation/linux_tv/media/v4l/vidioc-log-status.rst
index 0706274ff6a3..6df7c2fd5b6c 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-log-status.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-log-status.rst
@@ -1,6 +1,6 @@
.. -*- coding: utf-8; mode: rst -*-
-.. _vidioc-log-status:
+.. _VIDIOC_LOG_STATUS:
***********************
ioctl VIDIOC_LOG_STATUS
diff --git a/Documentation/linux_tv/media/v4l/vidioc-overlay.rst b/Documentation/linux_tv/media/v4l/vidioc-overlay.rst
index d82d24fd7fb2..e0373a9d6f14 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-overlay.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-overlay.rst
@@ -1,6 +1,6 @@
.. -*- coding: utf-8; mode: rst -*-
-.. _vidioc-overlay:
+.. _VIDIOC_OVERLAY:
********************
ioctl VIDIOC_OVERLAY
@@ -36,8 +36,8 @@ Applications call ``VIDIOC_OVERLAY`` to start or stop the overlay. It
takes a pointer to an integer which must be set to zero by the
application to stop overlay, to one to start.
-Drivers do not support :ref:`VIDIOC_STREAMON <vidioc-streamon>` or
-:ref:`VIDIOC_STREAMOFF <vidioc-streamon>` with
+Drivers do not support :ref:`VIDIOC_STREAMON <VIDIOC_STREAMON>` or
+:ref:`VIDIOC_STREAMOFF <VIDIOC_STREAMON>` with
``V4L2_BUF_TYPE_VIDEO_OVERLAY``.
diff --git a/Documentation/linux_tv/media/v4l/vidioc-prepare-buf.rst b/Documentation/linux_tv/media/v4l/vidioc-prepare-buf.rst
index c29757f38066..fb3ac38b3db2 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-prepare-buf.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-prepare-buf.rst
@@ -1,6 +1,6 @@
.. -*- coding: utf-8; mode: rst -*-
-.. _vidioc-prepare-buf:
+.. _VIDIOC_PREPARE_BUF:
************************
ioctl VIDIOC_PREPARE_BUF
diff --git a/Documentation/linux_tv/media/v4l/vidioc-qbuf.rst b/Documentation/linux_tv/media/v4l/vidioc-qbuf.rst
index 6912780b0e3d..045fa53e0417 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-qbuf.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-qbuf.rst
@@ -1,6 +1,6 @@
.. -*- coding: utf-8; mode: rst -*-
-.. _vidioc-qbuf:
+.. _VIDIOC_QBUF:
*******************************
ioctl VIDIOC_QBUF, VIDIOC_DQBUF
@@ -42,10 +42,10 @@ previously used with struct :ref:`v4l2_format <v4l2-format>` ``type``
and struct :ref:`v4l2_requestbuffers <v4l2-requestbuffers>` ``type``.
Applications must also set the ``index`` field. Valid index numbers
range from zero to the number of buffers allocated with
-:ref:`VIDIOC_REQBUFS <vidioc-reqbufs>` (struct
+:ref:`VIDIOC_REQBUFS <VIDIOC_REQBUFS>` (struct
:ref:`v4l2_requestbuffers <v4l2-requestbuffers>` ``count``) minus
one. The contents of the struct :c:type:`struct v4l2_buffer` returned
-by a :ref:`VIDIOC_QUERYBUF <vidioc-querybuf>` ioctl will do as well.
+by a :ref:`VIDIOC_QUERYBUF <VIDIOC_QUERYBUF>` ioctl will do as well.
When the buffer is intended for output (``type`` is
``V4L2_BUF_TYPE_VIDEO_OUTPUT``, ``V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE``,
or ``V4L2_BUF_TYPE_VBI_OUTPUT``) applications must also initialize the
@@ -75,8 +75,8 @@ the driver sets the ``V4L2_BUF_FLAG_QUEUED`` flag and clears the
``flags`` field, or it returns an error code. This ioctl locks the
memory pages of the buffer in physical memory, they cannot be swapped
out to disk. Buffers remain locked until dequeued, until the
-:ref:`VIDIOC_STREAMOFF <vidioc-streamon>` or
-:ref:`VIDIOC_REQBUFS <vidioc-reqbufs>` ioctl is called, or until the
+:ref:`VIDIOC_STREAMOFF <VIDIOC_STREAMON>` or
+:ref:`VIDIOC_REQBUFS <VIDIOC_REQBUFS>` ioctl is called, or until the
device is closed.
To enqueue a :ref:`DMABUF <dmabuf>` buffer applications set the
@@ -91,8 +91,8 @@ sets the ``V4L2_BUF_FLAG_QUEUED`` flag and clears the
buffer. Locking a buffer means passing it to a driver for a hardware
access (usually DMA). If an application accesses (reads/writes) a locked
buffer then the result is undefined. Buffers remain locked until
-dequeued, until the :ref:`VIDIOC_STREAMOFF <vidioc-streamon>` or
-:ref:`VIDIOC_REQBUFS <vidioc-reqbufs>` ioctl is called, or until the
+dequeued, until the :ref:`VIDIOC_STREAMOFF <VIDIOC_STREAMON>` or
+:ref:`VIDIOC_REQBUFS <VIDIOC_REQBUFS>` ioctl is called, or until the
device is closed.
Applications call the ``VIDIOC_DQBUF`` ioctl to dequeue a filled
diff --git a/Documentation/linux_tv/media/v4l/vidioc-query-dv-timings.rst b/Documentation/linux_tv/media/v4l/vidioc-query-dv-timings.rst
index 567faa73e23b..88aedbd1fcae 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-query-dv-timings.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-query-dv-timings.rst
@@ -1,6 +1,6 @@
.. -*- coding: utf-8; mode: rst -*-
-.. _vidioc-query-dv-timings:
+.. _VIDIOC_QUERY_DV_TIMINGS:
*****************************
ioctl VIDIOC_QUERY_DV_TIMINGS
@@ -56,7 +56,7 @@ the receiver could lock to the signal, but the format is unsupported
(e.g. because the pixelclock is out of range of the hardware
capabilities), then the driver fills in whatever timings it could find
and returns ERANGE. In that case the application can call
-:ref:`VIDIOC_DV_TIMINGS_CAP <vidioc-dv-timings-cap>` to compare the
+:ref:`VIDIOC_DV_TIMINGS_CAP <VIDIOC_DV_TIMINGS_CAP>` to compare the
found timings with the hardware's capabilities in order to give more
precise feedback to the user.
diff --git a/Documentation/linux_tv/media/v4l/vidioc-querybuf.rst b/Documentation/linux_tv/media/v4l/vidioc-querybuf.rst
index 092ed4586a18..baa3ad6591c7 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-querybuf.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-querybuf.rst
@@ -1,6 +1,6 @@
.. -*- coding: utf-8; mode: rst -*-
-.. _vidioc-querybuf:
+.. _VIDIOC_QUERYBUF:
*********************
ioctl VIDIOC_QUERYBUF
@@ -33,7 +33,7 @@ Description
This ioctl is part of the :ref:`streaming <mmap>` I/O method. It can
be used to query the status of a buffer at any time after buffers have
-been allocated with the :ref:`VIDIOC_REQBUFS <vidioc-reqbufs>` ioctl.
+been allocated with the :ref:`VIDIOC_REQBUFS <VIDIOC_REQBUFS>` ioctl.
Applications set the ``type`` field of a struct
:ref:`v4l2_buffer <v4l2-buffer>` to the same buffer type as was
@@ -41,7 +41,7 @@ previously used with struct :ref:`v4l2_format <v4l2-format>` ``type``
and struct :ref:`v4l2_requestbuffers <v4l2-requestbuffers>` ``type``,
and the ``index`` field. Valid index numbers range from zero to the
number of buffers allocated with
-:ref:`VIDIOC_REQBUFS <vidioc-reqbufs>` (struct
+:ref:`VIDIOC_REQBUFS <VIDIOC_REQBUFS>` (struct
:ref:`v4l2_requestbuffers <v4l2-requestbuffers>` ``count``) minus
one. The ``reserved`` and ``reserved2`` fields must be set to 0. When
using the :ref:`multi-planar API <planar-apis>`, the ``m.planes``
diff --git a/Documentation/linux_tv/media/v4l/vidioc-querycap.rst b/Documentation/linux_tv/media/v4l/vidioc-querycap.rst
index 54f86443dfcc..3032a9ee1c6b 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-querycap.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-querycap.rst
@@ -1,6 +1,6 @@
.. -*- coding: utf-8; mode: rst -*-
-.. _vidioc-querycap:
+.. _VIDIOC_QUERYCAP:
*********************
ioctl VIDIOC_QUERYCAP
@@ -308,7 +308,7 @@ specification the ioctl returns an EINVAL error code.
- 0x00000400
- The device supports the
- :ref:`VIDIOC_S_HW_FREQ_SEEK <vidioc-s-hw-freq-seek>` ioctl
+ :ref:`VIDIOC_S_HW_FREQ_SEEK <VIDIOC_S_HW_FREQ_SEEK>` ioctl
for hardware frequency seeking.
- .. row 15
diff --git a/Documentation/linux_tv/media/v4l/vidioc-queryctrl.rst b/Documentation/linux_tv/media/v4l/vidioc-queryctrl.rst
index 116b69c1f818..7d38a51c4f73 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-queryctrl.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-queryctrl.rst
@@ -1,6 +1,6 @@
.. -*- coding: utf-8; mode: rst -*-
-.. _vidioc-queryctrl:
+.. _VIDIOC_QUERYCTRL:
***************************************************************
ioctl VIDIOC_QUERYCTRL, VIDIOC_QUERY_EXT_CTRL, VIDIOC_QUERYMENU
@@ -566,10 +566,10 @@ See also the examples in :ref:`control`.
the string must be (minimum + N * step) characters long for N ≥ 0.
These lengths do not include the terminating zero, so in order to
pass a string of length 8 to
- :ref:`VIDIOC_S_EXT_CTRLS <vidioc-g-ext-ctrls>` you need to
+ :ref:`VIDIOC_S_EXT_CTRLS <VIDIOC_G_EXT_CTRLS>` you need to
set the ``size`` field of struct
:ref:`v4l2_ext_control <v4l2-ext-control>` to 9. For
- :ref:`VIDIOC_G_EXT_CTRLS <vidioc-g-ext-ctrls>` you can set
+ :ref:`VIDIOC_G_EXT_CTRLS <VIDIOC_G_EXT_CTRLS>` you can set
the ``size`` field to ``maximum`` + 1. Which character encoding is
used will depend on the string control itself and should be part
of the control documentation.
diff --git a/Documentation/linux_tv/media/v4l/vidioc-querystd.rst b/Documentation/linux_tv/media/v4l/vidioc-querystd.rst
index 8e22ba4b9c99..1d825fff9d15 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-querystd.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-querystd.rst
@@ -1,6 +1,6 @@
.. -*- coding: utf-8; mode: rst -*-
-.. _vidioc-querystd:
+.. _VIDIOC_QUERYSTD:
*********************
ioctl VIDIOC_QUERYSTD
diff --git a/Documentation/linux_tv/media/v4l/vidioc-reqbufs.rst b/Documentation/linux_tv/media/v4l/vidioc-reqbufs.rst
index 621e3c1e054d..c17d3b0465d6 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-reqbufs.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-reqbufs.rst
@@ -1,6 +1,6 @@
.. -*- coding: utf-8; mode: rst -*-
-.. _vidioc-reqbufs:
+.. _VIDIOC_REQBUFS:
********************
ioctl VIDIOC_REQBUFS
@@ -62,7 +62,7 @@ Applications can call ``VIDIOC_REQBUFS`` again to change the number of
buffers, however this cannot succeed when any buffers are still mapped.
A ``count`` value of zero frees all buffers, after aborting or finishing
any DMA in progress, an implicit
-:ref:`VIDIOC_STREAMOFF <vidioc-streamon>`.
+:ref:`VIDIOC_STREAMOFF <VIDIOC_STREAMON>`.
.. _v4l2-requestbuffers:
diff --git a/Documentation/linux_tv/media/v4l/vidioc-s-hw-freq-seek.rst b/Documentation/linux_tv/media/v4l/vidioc-s-hw-freq-seek.rst
index 72ae6ba6bada..19c2e0afd7de 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-s-hw-freq-seek.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-s-hw-freq-seek.rst
@@ -1,6 +1,6 @@
.. -*- coding: utf-8; mode: rst -*-
-.. _vidioc-s-hw-freq-seek:
+.. _VIDIOC_S_HW_FREQ_SEEK:
***************************
ioctl VIDIOC_S_HW_FREQ_SEEK
@@ -43,10 +43,10 @@ to tell the driver to search a specific band. If the struct
:ref:`v4l2_tuner <v4l2-tuner>` ``capability`` field has the
``V4L2_TUNER_CAP_HWSEEK_PROG_LIM`` flag set, these values must fall
within one of the bands returned by
-:ref:`VIDIOC_ENUM_FREQ_BANDS <vidioc-enum-freq-bands>`. If the
+:ref:`VIDIOC_ENUM_FREQ_BANDS <VIDIOC_ENUM_FREQ_BANDS>`. If the
``V4L2_TUNER_CAP_HWSEEK_PROG_LIM`` flag is not set, then these values
must exactly match those of one of the bands returned by
-:ref:`VIDIOC_ENUM_FREQ_BANDS <vidioc-enum-freq-bands>`. If the
+:ref:`VIDIOC_ENUM_FREQ_BANDS <VIDIOC_ENUM_FREQ_BANDS>`. If the
current frequency of the tuner does not fall within the selected band it
will be clamped to fit in the band before the seek is started.
diff --git a/Documentation/linux_tv/media/v4l/vidioc-streamon.rst b/Documentation/linux_tv/media/v4l/vidioc-streamon.rst
index 0f7f6e00a759..349204d81334 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-streamon.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-streamon.rst
@@ -1,6 +1,6 @@
.. -*- coding: utf-8; mode: rst -*-
-.. _vidioc-streamon:
+.. _VIDIOC_STREAMON:
***************************************
ioctl VIDIOC_STREAMON, VIDIOC_STREAMOFF
@@ -55,14 +55,14 @@ and it removes all buffers from the incoming and outgoing queues. That
means all images captured but not dequeued yet will be lost, likewise
all images enqueued for output but not transmitted yet. I/O returns to
the same state as after calling
-:ref:`VIDIOC_REQBUFS <vidioc-reqbufs>` and can be restarted
+:ref:`VIDIOC_REQBUFS <VIDIOC_REQBUFS>` and can be restarted
accordingly.
-If buffers have been queued with :ref:`VIDIOC_QBUF <vidioc-qbuf>` and
+If buffers have been queued with :ref:`VIDIOC_QBUF <VIDIOC_QBUF>` and
``VIDIOC_STREAMOFF`` is called without ever having called
``VIDIOC_STREAMON``, then those queued buffers will also be removed from
the incoming queue and all are returned to the same state as after
-calling :ref:`VIDIOC_REQBUFS <vidioc-reqbufs>` and can be restarted
+calling :ref:`VIDIOC_REQBUFS <VIDIOC_REQBUFS>` and can be restarted
accordingly.
Both ioctls take a pointer to an integer, the desired buffer or stream
diff --git a/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-frame-interval.rst b/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-frame-interval.rst
index 87506d6b0e53..d9f27e32eb60 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-frame-interval.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-frame-interval.rst
@@ -1,6 +1,6 @@
.. -*- coding: utf-8; mode: rst -*-
-.. _vidioc-subdev-enum-frame-interval:
+.. _VIDIOC_SUBDEV_ENUM_FRAME_INTERVAL:
***************************************
ioctl VIDIOC_SUBDEV_ENUM_FRAME_INTERVAL
@@ -52,7 +52,7 @@ one until EINVAL is returned.
Available frame intervals may depend on the current 'try' formats at
other pads of the sub-device, as well as on the current active links.
-See :ref:`VIDIOC_SUBDEV_G_FMT <vidioc-subdev-g-fmt>` for more
+See :ref:`VIDIOC_SUBDEV_G_FMT <VIDIOC_SUBDEV_G_FMT>` for more
information about the try formats.
Sub-devices that support the frame interval enumeration ioctl should
diff --git a/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-frame-size.rst b/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-frame-size.rst
index 7f867e2930be..49be2eefaa57 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-frame-size.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-frame-size.rst
@@ -1,6 +1,6 @@
.. -*- coding: utf-8; mode: rst -*-
-.. _vidioc-subdev-enum-frame-size:
+.. _VIDIOC_SUBDEV_ENUM_FRAME_SIZE:
***********************************
ioctl VIDIOC_SUBDEV_ENUM_FRAME_SIZE
@@ -34,7 +34,7 @@ Description
This ioctl allows applications to enumerate all frame sizes supported by
a sub-device on the given pad for the given media bus format. Supported
formats can be retrieved with the
-:ref:`VIDIOC_SUBDEV_ENUM_MBUS_CODE <vidioc-subdev-enum-mbus-code>`
+:ref:`VIDIOC_SUBDEV_ENUM_MBUS_CODE <VIDIOC_SUBDEV_ENUM_MBUS_CODE>`
ioctl.
To enumerate frame sizes applications initialize the ``pad``, ``which``
@@ -52,13 +52,13 @@ Not all possible sizes in given [minimum, maximum] ranges need to be
supported. For instance, a scaler that uses a fixed-point scaling ratio
might not be able to produce every frame size between the minimum and
maximum values. Applications must use the
-:ref:`VIDIOC_SUBDEV_S_FMT <vidioc-subdev-g-fmt>` ioctl to try the
+:ref:`VIDIOC_SUBDEV_S_FMT <VIDIOC_SUBDEV_G_FMT>` ioctl to try the
sub-device for an exact supported frame size.
Available frame sizes may depend on the current 'try' formats at other
pads of the sub-device, as well as on the current active links and the
current values of V4L2 controls. See
-:ref:`VIDIOC_SUBDEV_G_FMT <vidioc-subdev-g-fmt>` for more
+:ref:`VIDIOC_SUBDEV_G_FMT <VIDIOC_SUBDEV_G_FMT>` for more
information about try formats.
diff --git a/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-mbus-code.rst b/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-mbus-code.rst
index 97534457db6a..a9b0baba2633 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-mbus-code.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-mbus-code.rst
@@ -1,6 +1,6 @@
.. -*- coding: utf-8; mode: rst -*-
-.. _vidioc-subdev-enum-mbus-code:
+.. _VIDIOC_SUBDEV_ENUM_MBUS_CODE:
**********************************
ioctl VIDIOC_SUBDEV_ENUM_MBUS_CODE
@@ -43,7 +43,7 @@ one until EINVAL is returned.
Available media bus formats may depend on the current 'try' formats at
other pads of the sub-device, as well as on the current active links.
-See :ref:`VIDIOC_SUBDEV_G_FMT <vidioc-subdev-g-fmt>` for more
+See :ref:`VIDIOC_SUBDEV_G_FMT <VIDIOC_SUBDEV_G_FMT>` for more
information about the try formats.
diff --git a/Documentation/linux_tv/media/v4l/vidioc-subdev-g-crop.rst b/Documentation/linux_tv/media/v4l/vidioc-subdev-g-crop.rst
index e54a07c8ba1d..bef416cfe46c 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-subdev-g-crop.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-subdev-g-crop.rst
@@ -1,6 +1,6 @@
.. -*- coding: utf-8; mode: rst -*-
-.. _vidioc-subdev-g-crop:
+.. _VIDIOC_SUBDEV_G_CROP:
************************************************
ioctl VIDIOC_SUBDEV_G_CROP, VIDIOC_SUBDEV_S_CROP
@@ -38,7 +38,7 @@ Description
This is an :ref:`obsolete <obsolete>` interface and may be removed
in the future. It is superseded by
- :ref:`the selection API <vidioc-subdev-g-selection>`.
+ :ref:`the selection API <VIDIOC_SUBDEV_G_SELECTION>`.
To retrieve the current crop rectangle applications set the ``pad``
field of a struct :ref:`v4l2_subdev_crop <v4l2-subdev-crop>` to the
diff --git a/Documentation/linux_tv/media/v4l/vidioc-subdev-g-fmt.rst b/Documentation/linux_tv/media/v4l/vidioc-subdev-g-fmt.rst
index 5dcbc03b4ffc..789277a2647a 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-subdev-g-fmt.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-subdev-g-fmt.rst
@@ -1,6 +1,6 @@
.. -*- coding: utf-8; mode: rst -*-
-.. _vidioc-subdev-g-fmt:
+.. _VIDIOC_SUBDEV_G_FMT:
**********************************************
ioctl VIDIOC_SUBDEV_G_FMT, VIDIOC_SUBDEV_S_FMT
diff --git a/Documentation/linux_tv/media/v4l/vidioc-subdev-g-frame-interval.rst b/Documentation/linux_tv/media/v4l/vidioc-subdev-g-frame-interval.rst
index af0918900f8a..bcc54e2e396f 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-subdev-g-frame-interval.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-subdev-g-frame-interval.rst
@@ -1,6 +1,6 @@
.. -*- coding: utf-8; mode: rst -*-
-.. _vidioc-subdev-g-frame-interval:
+.. _VIDIOC_SUBDEV_G_FRAME_INTERVAL:
********************************************************************
ioctl VIDIOC_SUBDEV_G_FRAME_INTERVAL, VIDIOC_SUBDEV_S_FRAME_INTERVAL
diff --git a/Documentation/linux_tv/media/v4l/vidioc-subdev-g-selection.rst b/Documentation/linux_tv/media/v4l/vidioc-subdev-g-selection.rst
index 8e4c8e10494e..7b60c9b99aad 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-subdev-g-selection.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-subdev-g-selection.rst
@@ -1,6 +1,6 @@
.. -*- coding: utf-8; mode: rst -*-
-.. _vidioc-subdev-g-selection:
+.. _VIDIOC_SUBDEV_G_SELECTION:
**********************************************************
ioctl VIDIOC_SUBDEV_G_SELECTION, VIDIOC_SUBDEV_S_SELECTION
@@ -37,7 +37,7 @@ functionality performed by the subdevs which affect the image size. This
currently includes cropping, scaling and composition.
The selection API replaces
-:ref:`the old subdev crop API <vidioc-subdev-g-crop>`. All the
+:ref:`the old subdev crop API <VIDIOC_SUBDEV_G_CROP>`. All the
function of the crop API, and more, are supported by the selections API.
See :ref:`subdev` for more information on how each selection target
diff --git a/Documentation/linux_tv/media/v4l/vidioc-subscribe-event.rst b/Documentation/linux_tv/media/v4l/vidioc-subscribe-event.rst
index f12981c38f63..8d0e346461e9 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-subscribe-event.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-subscribe-event.rst
@@ -1,6 +1,6 @@
.. -*- coding: utf-8; mode: rst -*-
-.. _vidioc-subscribe-event:
+.. _VIDIOC_SUBSCRIBE_EVENT:
******************************************************
ioctl VIDIOC_SUBSCRIBE_EVENT, VIDIOC_UNSUBSCRIBE_EVENT
@@ -33,7 +33,7 @@ Description
===========
Subscribe or unsubscribe V4L2 event. Subscribed events are dequeued by
-using the :ref:`VIDIOC_DQEVENT <vidioc-dqevent>` ioctl.
+using the :ref:`VIDIOC_DQEVENT <VIDIOC_DQEVENT>` ioctl.
.. _v4l2-event-subscription:
@@ -110,7 +110,7 @@ using the :ref:`VIDIOC_DQEVENT <vidioc-dqevent>` ioctl.
- If set, then events directly caused by an ioctl will also be sent
to the filehandle that called that ioctl. For example, changing a
- control using :ref:`VIDIOC_S_CTRL <vidioc-g-ctrl>` will cause
+ control using :ref:`VIDIOC_S_CTRL <VIDIOC_G_CTRL>` will cause
a V4L2_EVENT_CTRL to be sent back to that same filehandle.
Normally such events are suppressed to prevent feedback loops
where an application changes a control to a one value and then
@@ -118,7 +118,7 @@ using the :ref:`VIDIOC_DQEVENT <vidioc-dqevent>` ioctl.
has changed to the first value.
Since it can't tell whether that event was caused by another
- application or by the :ref:`VIDIOC_S_CTRL <vidioc-g-ctrl>`
+ application or by the :ref:`VIDIOC_S_CTRL <VIDIOC_G_CTRL>`
call it is hard to decide whether to set the control to the value
in the event, or ignore it.
--
2.7.4
^ permalink raw reply related [flat|nested] 52+ messages in thread* [PATCH 12/51] Documentation: linux_tv: simplify references
2016-07-04 11:46 [PATCH 00/51] First part of documentation fixups Mauro Carvalho Chehab
` (10 preceding siblings ...)
2016-07-04 11:46 ` [PATCH 11/51] Documentation: linux_tv: Replace reference names to match ioctls Mauro Carvalho Chehab
@ 2016-07-04 11:46 ` Mauro Carvalho Chehab
2016-07-04 11:46 ` [PATCH 13/51] Documentation: linux_tv: convert lots of consts to references Mauro Carvalho Chehab
` (38 subsequent siblings)
50 siblings, 0 replies; 52+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-04 11:46 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, Jonathan Corbet,
Markus Heiser, linux-doc
There are lots of internal references in the form:
:ref:`foo <foo>`
Simplify them to be just: :ref:`foo`.
Patch generated via this small script:
for j in $(find . -name '*.rst'); do echo $j; perl -ne 'if (m/\`(\S+)\s*\<(\S+)\>\`/) { if (!($1=~'http') && $1 eq $2) { s,\s*\<(\S+)\>,,; } } print $_' <$j >a && mv a $j; done
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
.../media/dvb/FE_DISHNETWORK_SEND_LEGACY_CMD.rst | 2 +-
Documentation/linux_tv/media/dvb/FE_GET_EVENT.rst | 2 +-
.../linux_tv/media/dvb/FE_GET_FRONTEND.rst | 4 +-
Documentation/linux_tv/media/dvb/FE_READ_BER.rst | 4 +-
.../linux_tv/media/dvb/FE_READ_SIGNAL_STRENGTH.rst | 4 +-
Documentation/linux_tv/media/dvb/FE_READ_SNR.rst | 4 +-
.../media/dvb/FE_READ_UNCORRECTED_BLOCKS.rst | 4 +-
.../linux_tv/media/dvb/FE_SET_FRONTEND.rst | 8 +--
.../linux_tv/media/dvb/audio_function_calls.rst | 2 +-
.../linux_tv/media/dvb/dvb-fe-read-status.rst | 4 +-
.../media/dvb/frontend-stat-properties.rst | 2 +-
.../linux_tv/media/dvb/frontend_f_open.rst | 2 +-
.../linux_tv/media/dvb/query-dvb-frontend-info.rst | 2 +-
.../linux_tv/media/dvb/video_function_calls.rst | 14 ++--
Documentation/linux_tv/media/v4l/app-pri.rst | 4 +-
Documentation/linux_tv/media/v4l/audio.rst | 14 ++--
Documentation/linux_tv/media/v4l/buffer.rst | 26 ++++----
Documentation/linux_tv/media/v4l/control.rst | 8 +--
Documentation/linux_tv/media/v4l/crop.rst | 6 +-
Documentation/linux_tv/media/v4l/dev-capture.rst | 6 +-
Documentation/linux_tv/media/v4l/dev-codec.rst | 2 +-
Documentation/linux_tv/media/v4l/dev-event.rst | 4 +-
Documentation/linux_tv/media/v4l/dev-osd.rst | 6 +-
Documentation/linux_tv/media/v4l/dev-output.rst | 4 +-
Documentation/linux_tv/media/v4l/dev-overlay.rst | 14 ++--
Documentation/linux_tv/media/v4l/dev-radio.rst | 6 +-
Documentation/linux_tv/media/v4l/dev-raw-vbi.rst | 8 +--
Documentation/linux_tv/media/v4l/dev-rds.rst | 4 +-
Documentation/linux_tv/media/v4l/dev-sdr.rst | 16 ++---
.../linux_tv/media/v4l/dev-sliced-vbi.rst | 18 +++---
Documentation/linux_tv/media/v4l/dev-subdev.rst | 10 +--
Documentation/linux_tv/media/v4l/dev-teletext.rst | 2 +-
Documentation/linux_tv/media/v4l/diff-v4l.rst | 58 ++++++++---------
Documentation/linux_tv/media/v4l/dmabuf.rst | 12 ++--
Documentation/linux_tv/media/v4l/dv-timings.rst | 8 +--
.../linux_tv/media/v4l/extended-controls.rst | 28 ++++----
Documentation/linux_tv/media/v4l/format.rst | 6 +-
Documentation/linux_tv/media/v4l/func-mmap.rst | 6 +-
Documentation/linux_tv/media/v4l/func-poll.rst | 10 +--
Documentation/linux_tv/media/v4l/func-read.rst | 2 +-
Documentation/linux_tv/media/v4l/func-select.rst | 4 +-
Documentation/linux_tv/media/v4l/hist-v4l2.rst | 74 +++++++++++-----------
Documentation/linux_tv/media/v4l/io.rst | 2 +-
.../linux_tv/media/v4l/libv4l-introduction.rst | 8 +--
Documentation/linux_tv/media/v4l/mmap.rst | 16 ++---
Documentation/linux_tv/media/v4l/open.rst | 4 +-
Documentation/linux_tv/media/v4l/pixfmt-013.rst | 2 +-
.../linux_tv/media/v4l/pixfmt-packed-rgb.rst | 2 +-
Documentation/linux_tv/media/v4l/pixfmt.rst | 2 +-
Documentation/linux_tv/media/v4l/planar-apis.rst | 10 +--
Documentation/linux_tv/media/v4l/querycap.rst | 12 ++--
Documentation/linux_tv/media/v4l/rw.rst | 2 +-
Documentation/linux_tv/media/v4l/standard.rst | 10 +--
Documentation/linux_tv/media/v4l/streaming-par.rst | 2 +-
Documentation/linux_tv/media/v4l/tuner.rst | 14 ++--
Documentation/linux_tv/media/v4l/userp.rst | 12 ++--
Documentation/linux_tv/media/v4l/video.rst | 10 +--
.../linux_tv/media/v4l/vidioc-create-bufs.rst | 4 +-
.../linux_tv/media/v4l/vidioc-dbg-g-chip-info.rst | 2 +-
.../linux_tv/media/v4l/vidioc-dbg-g-register.rst | 6 +-
.../linux_tv/media/v4l/vidioc-decoder-cmd.rst | 2 +-
.../linux_tv/media/v4l/vidioc-dqevent.rst | 2 +-
.../linux_tv/media/v4l/vidioc-encoder-cmd.rst | 2 +-
.../linux_tv/media/v4l/vidioc-enum-dv-timings.rst | 2 +-
.../media/v4l/vidioc-enum-frameintervals.rst | 4 +-
.../linux_tv/media/v4l/vidioc-enum-framesizes.rst | 2 +-
Documentation/linux_tv/media/v4l/vidioc-expbuf.rst | 8 +--
Documentation/linux_tv/media/v4l/vidioc-g-crop.rst | 2 +-
Documentation/linux_tv/media/v4l/vidioc-g-ctrl.rst | 2 +-
.../linux_tv/media/v4l/vidioc-g-dv-timings.rst | 2 +-
Documentation/linux_tv/media/v4l/vidioc-g-edid.rst | 8 +--
.../linux_tv/media/v4l/vidioc-g-ext-ctrls.rst | 4 +-
Documentation/linux_tv/media/v4l/vidioc-g-fbuf.rst | 2 +-
.../linux_tv/media/v4l/vidioc-g-input.rst | 2 +-
.../linux_tv/media/v4l/vidioc-g-output.rst | 2 +-
Documentation/linux_tv/media/v4l/vidioc-g-std.rst | 2 +-
.../linux_tv/media/v4l/vidioc-g-tuner.rst | 8 +--
.../linux_tv/media/v4l/vidioc-overlay.rst | 2 +-
Documentation/linux_tv/media/v4l/vidioc-qbuf.rst | 8 +--
.../linux_tv/media/v4l/vidioc-query-dv-timings.rst | 2 +-
.../linux_tv/media/v4l/vidioc-querybuf.rst | 4 +-
.../linux_tv/media/v4l/vidioc-querycap.rst | 2 +-
.../linux_tv/media/v4l/vidioc-queryctrl.rst | 2 +-
.../linux_tv/media/v4l/vidioc-s-hw-freq-seek.rst | 4 +-
.../linux_tv/media/v4l/vidioc-streamon.rst | 6 +-
.../v4l/vidioc-subdev-enum-frame-interval.rst | 2 +-
.../media/v4l/vidioc-subdev-enum-frame-size.rst | 4 +-
.../media/v4l/vidioc-subdev-enum-mbus-code.rst | 2 +-
.../linux_tv/media/v4l/vidioc-subdev-g-crop.rst | 2 +-
.../linux_tv/media/v4l/vidioc-subscribe-event.rst | 2 +-
90 files changed, 321 insertions(+), 321 deletions(-)
diff --git a/Documentation/linux_tv/media/dvb/FE_DISHNETWORK_SEND_LEGACY_CMD.rst b/Documentation/linux_tv/media/dvb/FE_DISHNETWORK_SEND_LEGACY_CMD.rst
index f4effaab9a1a..a01cafad8d3c 100644
--- a/Documentation/linux_tv/media/dvb/FE_DISHNETWORK_SEND_LEGACY_CMD.rst
+++ b/Documentation/linux_tv/media/dvb/FE_DISHNETWORK_SEND_LEGACY_CMD.rst
@@ -20,7 +20,7 @@ dishes were already legacy in 2004.
SYNOPSIS
int ioctl(int fd, int request =
-:ref:`FE_DISHNETWORK_SEND_LEGACY_CMD <FE_DISHNETWORK_SEND_LEGACY_CMD>`,
+:ref:`FE_DISHNETWORK_SEND_LEGACY_CMD`,
unsigned long cmd);
PARAMETERS
diff --git a/Documentation/linux_tv/media/dvb/FE_GET_EVENT.rst b/Documentation/linux_tv/media/dvb/FE_GET_EVENT.rst
index 75eab893c184..8d1caedd2f97 100644
--- a/Documentation/linux_tv/media/dvb/FE_GET_EVENT.rst
+++ b/Documentation/linux_tv/media/dvb/FE_GET_EVENT.rst
@@ -38,7 +38,7 @@ PARAMETERS
- int request
- - Equals :ref:`FE_GET_EVENT <FE_GET_EVENT>` for this command.
+ - Equals :ref:`FE_GET_EVENT` for this command.
- .. row 3
diff --git a/Documentation/linux_tv/media/dvb/FE_GET_FRONTEND.rst b/Documentation/linux_tv/media/dvb/FE_GET_FRONTEND.rst
index 30c85cf0423c..2e60b239d1da 100644
--- a/Documentation/linux_tv/media/dvb/FE_GET_FRONTEND.rst
+++ b/Documentation/linux_tv/media/dvb/FE_GET_FRONTEND.rst
@@ -14,7 +14,7 @@ this command, read-only access to the device is sufficient.
SYNOPSIS
int ioctl(int fd, int request =
-:ref:`FE_GET_FRONTEND <FE_GET_FRONTEND>`, struct
+:ref:`FE_GET_FRONTEND`, struct
dvb_frontend_parameters *p);
PARAMETERS
@@ -36,7 +36,7 @@ PARAMETERS
- int request
- - Equals :ref:`FE_SET_FRONTEND <FE_SET_FRONTEND>` for this
+ - Equals :ref:`FE_SET_FRONTEND` for this
command.
- .. row 3
diff --git a/Documentation/linux_tv/media/dvb/FE_READ_BER.rst b/Documentation/linux_tv/media/dvb/FE_READ_BER.rst
index e21451886dc2..935c0e50b0fd 100644
--- a/Documentation/linux_tv/media/dvb/FE_READ_BER.rst
+++ b/Documentation/linux_tv/media/dvb/FE_READ_BER.rst
@@ -14,7 +14,7 @@ access to the device is sufficient.
SYNOPSIS
-int ioctl(int fd, int request = :ref:`FE_READ_BER <FE_READ_BER>`,
+int ioctl(int fd, int request = :ref:`FE_READ_BER`,
uint32_t *ber);
PARAMETERS
@@ -36,7 +36,7 @@ PARAMETERS
- int request
- - Equals :ref:`FE_READ_BER <FE_READ_BER>` for this command.
+ - Equals :ref:`FE_READ_BER` for this command.
- .. row 3
diff --git a/Documentation/linux_tv/media/dvb/FE_READ_SIGNAL_STRENGTH.rst b/Documentation/linux_tv/media/dvb/FE_READ_SIGNAL_STRENGTH.rst
index 3e34bea21b6c..01180e20e4d4 100644
--- a/Documentation/linux_tv/media/dvb/FE_READ_SIGNAL_STRENGTH.rst
+++ b/Documentation/linux_tv/media/dvb/FE_READ_SIGNAL_STRENGTH.rst
@@ -15,7 +15,7 @@ to the device is sufficient.
SYNOPSIS
int ioctl( int fd, int request =
-:ref:`FE_READ_SIGNAL_STRENGTH <FE_READ_SIGNAL_STRENGTH>`,
+:ref:`FE_READ_SIGNAL_STRENGTH`,
uint16_t *strength);
PARAMETERS
@@ -38,7 +38,7 @@ PARAMETERS
- int request
- Equals
- :ref:`FE_READ_SIGNAL_STRENGTH <FE_READ_SIGNAL_STRENGTH>`
+ :ref:`FE_READ_SIGNAL_STRENGTH`
for this command.
- .. row 3
diff --git a/Documentation/linux_tv/media/dvb/FE_READ_SNR.rst b/Documentation/linux_tv/media/dvb/FE_READ_SNR.rst
index b8a639706e9e..0ccc7d71d8a4 100644
--- a/Documentation/linux_tv/media/dvb/FE_READ_SNR.rst
+++ b/Documentation/linux_tv/media/dvb/FE_READ_SNR.rst
@@ -14,7 +14,7 @@ to the device is sufficient.
SYNOPSIS
-int ioctl(int fd, int request = :ref:`FE_READ_SNR <FE_READ_SNR>`,
+int ioctl(int fd, int request = :ref:`FE_READ_SNR`,
uint16_t *snr);
PARAMETERS
@@ -36,7 +36,7 @@ PARAMETERS
- int request
- - Equals :ref:`FE_READ_SNR <FE_READ_SNR>` for this command.
+ - Equals :ref:`FE_READ_SNR` for this command.
- .. row 3
diff --git a/Documentation/linux_tv/media/dvb/FE_READ_UNCORRECTED_BLOCKS.rst b/Documentation/linux_tv/media/dvb/FE_READ_UNCORRECTED_BLOCKS.rst
index 261eb20ddadf..3827c7b953e1 100644
--- a/Documentation/linux_tv/media/dvb/FE_READ_UNCORRECTED_BLOCKS.rst
+++ b/Documentation/linux_tv/media/dvb/FE_READ_UNCORRECTED_BLOCKS.rst
@@ -17,7 +17,7 @@ sufficient.
SYNOPSIS
int ioctl( int fd, int request =
-:ref:`FE_READ_UNCORRECTED_BLOCKS <FE_READ_UNCORRECTED_BLOCKS>`,
+:ref:`FE_READ_UNCORRECTED_BLOCKS`,
uint32_t *ublocks);
PARAMETERS
@@ -40,7 +40,7 @@ PARAMETERS
- int request
- Equals
- :ref:`FE_READ_UNCORRECTED_BLOCKS <FE_READ_UNCORRECTED_BLOCKS>`
+ :ref:`FE_READ_UNCORRECTED_BLOCKS`
for this command.
- .. row 3
diff --git a/Documentation/linux_tv/media/dvb/FE_SET_FRONTEND.rst b/Documentation/linux_tv/media/dvb/FE_SET_FRONTEND.rst
index 885f9e3ceb59..f18e12cb3dff 100644
--- a/Documentation/linux_tv/media/dvb/FE_SET_FRONTEND.rst
+++ b/Documentation/linux_tv/media/dvb/FE_SET_FRONTEND.rst
@@ -12,8 +12,8 @@ This ioctl call starts a tuning operation using specified parameters.
The result of this call will be successful if the parameters were valid
and the tuning could be initiated. The result of the tuning operation in
itself, however, will arrive asynchronously as an event (see
-documentation for :ref:`FE_GET_EVENT <FE_GET_EVENT>` and
-FrontendEvent.) If a new :ref:`FE_SET_FRONTEND <FE_SET_FRONTEND>`
+documentation for :ref:`FE_GET_EVENT` and
+FrontendEvent.) If a new :ref:`FE_SET_FRONTEND`
operation is initiated before the previous one was completed, the
previous operation will be aborted in favor of the new one. This command
requires read/write access to the device.
@@ -21,7 +21,7 @@ requires read/write access to the device.
SYNOPSIS
int ioctl(int fd, int request =
-:ref:`FE_SET_FRONTEND <FE_SET_FRONTEND>`, struct
+:ref:`FE_SET_FRONTEND`, struct
dvb_frontend_parameters *p);
PARAMETERS
@@ -43,7 +43,7 @@ PARAMETERS
- int request
- - Equals :ref:`FE_SET_FRONTEND <FE_SET_FRONTEND>` for this
+ - Equals :ref:`FE_SET_FRONTEND` for this
command.
- .. row 3
diff --git a/Documentation/linux_tv/media/dvb/audio_function_calls.rst b/Documentation/linux_tv/media/dvb/audio_function_calls.rst
index d1a5b5970b71..a68149e16116 100644
--- a/Documentation/linux_tv/media/dvb/audio_function_calls.rst
+++ b/Documentation/linux_tv/media/dvb/audio_function_calls.rst
@@ -456,7 +456,7 @@ AUDIO_SET_MUTE
DESCRIPTION
This ioctl is for DVB devices only. To control a V4L2 decoder use the
-V4L2 :ref:`VIDIOC_DECODER_CMD <VIDIOC_DECODER_CMD>` with the
+V4L2 :ref:`VIDIOC_DECODER_CMD` with the
``V4L2_DEC_CMD_START_MUTE_AUDIO`` flag instead.
This ioctl call asks the audio device to mute the stream that is
diff --git a/Documentation/linux_tv/media/dvb/dvb-fe-read-status.rst b/Documentation/linux_tv/media/dvb/dvb-fe-read-status.rst
index 12d8749e9e05..e36cd134007e 100644
--- a/Documentation/linux_tv/media/dvb/dvb-fe-read-status.rst
+++ b/Documentation/linux_tv/media/dvb/dvb-fe-read-status.rst
@@ -12,10 +12,10 @@ tuner lock status and provide statistics about the quality of the
signal.
The information about the frontend tuner locking status can be queried
-using :ref:`FE_READ_STATUS <FE_READ_STATUS>`.
+using :ref:`FE_READ_STATUS`.
Signal statistics are provided via
-:ref:`FE_GET_PROPERTY <FE_GET_PROPERTY>`. Please note that several
+:ref:`FE_GET_PROPERTY`. Please note that several
statistics require the demodulator to be fully locked (e. g. with
FE_HAS_LOCK bit set). See
:ref:`Frontend statistics indicators <frontend-stat-properties>` for
diff --git a/Documentation/linux_tv/media/dvb/frontend-stat-properties.rst b/Documentation/linux_tv/media/dvb/frontend-stat-properties.rst
index 36461d65a661..7f3999db3e5d 100644
--- a/Documentation/linux_tv/media/dvb/frontend-stat-properties.rst
+++ b/Documentation/linux_tv/media/dvb/frontend-stat-properties.rst
@@ -234,7 +234,7 @@ measurement was taken.
It can be used to calculate the PER indicator, by dividing
:ref:`DTV_STAT_ERROR_BLOCK_COUNT <DTV-STAT-ERROR-BLOCK-COUNT>` by
-:ref:`DTV-STAT-TOTAL-BLOCK-COUNT <DTV-STAT-TOTAL-BLOCK-COUNT>`.
+:ref:`DTV-STAT-TOTAL-BLOCK-COUNT`.
Possible scales for this metric are:
diff --git a/Documentation/linux_tv/media/dvb/frontend_f_open.rst b/Documentation/linux_tv/media/dvb/frontend_f_open.rst
index 676ae922338d..91ac9ef8c356 100644
--- a/Documentation/linux_tv/media/dvb/frontend_f_open.rst
+++ b/Documentation/linux_tv/media/dvb/frontend_f_open.rst
@@ -49,7 +49,7 @@ Description
This system call opens a named frontend device
(``/dev/dvb/adapter?/frontend?``) for subsequent use. Usually the first
thing to do after a successful open is to find out the frontend type
-with :ref:`FE_GET_INFO <FE_GET_INFO>`.
+with :ref:`FE_GET_INFO`.
The device can be opened in read-only mode, which only allows monitoring
of device status and statistics, or read/write mode, which allows any
diff --git a/Documentation/linux_tv/media/dvb/query-dvb-frontend-info.rst b/Documentation/linux_tv/media/dvb/query-dvb-frontend-info.rst
index 4a4fd5af6e0f..a3da1b8376bc 100644
--- a/Documentation/linux_tv/media/dvb/query-dvb-frontend-info.rst
+++ b/Documentation/linux_tv/media/dvb/query-dvb-frontend-info.rst
@@ -8,7 +8,7 @@ Querying frontend information
Usually, the first thing to do when the frontend is opened is to check
the frontend capabilities. This is done using
-:ref:`FE_GET_INFO <FE_GET_INFO>`. This ioctl will enumerate the
+:ref:`FE_GET_INFO`. This ioctl will enumerate the
DVB API version and other characteristics about the frontend, and can be
opened either in read only or read/write mode.
diff --git a/Documentation/linux_tv/media/dvb/video_function_calls.rst b/Documentation/linux_tv/media/dvb/video_function_calls.rst
index 98c90dcdb587..78917bdf51ed 100644
--- a/Documentation/linux_tv/media/dvb/video_function_calls.rst
+++ b/Documentation/linux_tv/media/dvb/video_function_calls.rst
@@ -239,7 +239,7 @@ VIDEO_STOP
DESCRIPTION
This ioctl is for DVB devices only. To control a V4L2 decoder use the
-V4L2 :ref:`VIDIOC_DECODER_CMD <VIDIOC_DECODER_CMD>` instead.
+V4L2 :ref:`VIDIOC_DECODER_CMD` instead.
This ioctl call asks the Video Device to stop playing the current
stream. Depending on the input parameter, the screen can be blanked out
@@ -302,7 +302,7 @@ VIDEO_PLAY
DESCRIPTION
This ioctl is for DVB devices only. To control a V4L2 decoder use the
-V4L2 :ref:`VIDIOC_DECODER_CMD <VIDIOC_DECODER_CMD>` instead.
+V4L2 :ref:`VIDIOC_DECODER_CMD` instead.
This ioctl call asks the Video Device to start playing a video stream
from the selected source.
@@ -348,7 +348,7 @@ VIDEO_FREEZE
DESCRIPTION
This ioctl is for DVB devices only. To control a V4L2 decoder use the
-V4L2 :ref:`VIDIOC_DECODER_CMD <VIDIOC_DECODER_CMD>` instead.
+V4L2 :ref:`VIDIOC_DECODER_CMD` instead.
This ioctl call suspends the live video stream being played. Decoding
and playing are frozen. It is then possible to restart the decoding and
@@ -398,7 +398,7 @@ VIDEO_CONTINUE
DESCRIPTION
This ioctl is for DVB devices only. To control a V4L2 decoder use the
-V4L2 :ref:`VIDIOC_DECODER_CMD <VIDIOC_DECODER_CMD>` instead.
+V4L2 :ref:`VIDIOC_DECODER_CMD` instead.
This ioctl call restarts decoding and playing processes of the video
stream which was played before a call to VIDEO_FREEZE was made.
@@ -763,7 +763,7 @@ VIDEO_GET_EVENT
DESCRIPTION
This ioctl is for DVB devices only. To get events from a V4L2 decoder
-use the V4L2 :ref:`VIDIOC_DQEVENT <VIDIOC_DQEVENT>` ioctl instead.
+use the V4L2 :ref:`VIDIOC_DQEVENT` ioctl instead.
This ioctl call returns an event of type video_event if available. If
an event is not available, the behavior depends on whether the device is
@@ -844,11 +844,11 @@ DESCRIPTION
This ioctl is obsolete. Do not use in new drivers. For V4L2 decoders
this ioctl has been replaced by the
-:ref:`VIDIOC_DECODER_CMD <VIDIOC_DECODER_CMD>` ioctl.
+:ref:`VIDIOC_DECODER_CMD` ioctl.
This ioctl commands the decoder. The ``video_command`` struct is a
subset of the ``v4l2_decoder_cmd`` struct, so refer to the
-:ref:`VIDIOC_DECODER_CMD <VIDIOC_DECODER_CMD>` documentation for
+:ref:`VIDIOC_DECODER_CMD` documentation for
more information.
SYNOPSIS
diff --git a/Documentation/linux_tv/media/v4l/app-pri.rst b/Documentation/linux_tv/media/v4l/app-pri.rst
index bc50afca95fc..4faf9042f612 100644
--- a/Documentation/linux_tv/media/v4l/app-pri.rst
+++ b/Documentation/linux_tv/media/v4l/app-pri.rst
@@ -16,14 +16,14 @@ applications and automatically regain control of the device at a later
time.
Since these features cannot be implemented entirely in user space V4L2
-defines the :ref:`VIDIOC_G_PRIORITY <VIDIOC_G_PRIORITY>` and
+defines the :ref:`VIDIOC_G_PRIORITY` and
:ref:`VIDIOC_S_PRIORITY <VIDIOC_G_PRIORITY>` ioctls to request and
query the access priority associate with a file descriptor. Opening a
device assigns a medium priority, compatible with earlier versions of
V4L2 and drivers not supporting these ioctls. Applications requiring a
different priority will usually call :ref:`VIDIOC_S_PRIORITY
<VIDIOC_G_PRIORITY>` after verifying the device with the
-:ref:`VIDIOC_QUERYCAP <VIDIOC_QUERYCAP>` ioctl.
+:ref:`VIDIOC_QUERYCAP` ioctl.
Ioctls changing driver properties, such as
:ref:`VIDIOC_S_INPUT <VIDIOC_G_INPUT>`, return an EBUSY error code
diff --git a/Documentation/linux_tv/media/v4l/audio.rst b/Documentation/linux_tv/media/v4l/audio.rst
index fa6bf5ad8d32..21db1b97b83c 100644
--- a/Documentation/linux_tv/media/v4l/audio.rst
+++ b/Documentation/linux_tv/media/v4l/audio.rst
@@ -27,18 +27,18 @@ number, starting at zero, of one audio input or output.
To learn about the number and attributes of the available inputs and
outputs applications can enumerate them with the
-:ref:`VIDIOC_ENUMAUDIO <VIDIOC_ENUMAUDIO>` and
+:ref:`VIDIOC_ENUMAUDIO` and
:ref:`VIDIOC_ENUMAUDOUT <VIDIOC_ENUMAUDIOout>` ioctl, respectively.
The struct :ref:`v4l2_audio <v4l2-audio>` returned by the
-:ref:`VIDIOC_ENUMAUDIO <VIDIOC_ENUMAUDIO>` ioctl also contains signal
+:ref:`VIDIOC_ENUMAUDIO` ioctl also contains signal
:status information applicable when the current audio input is queried.
-The :ref:`VIDIOC_G_AUDIO <VIDIOC_G_AUDIO>` and
+The :ref:`VIDIOC_G_AUDIO` and
:ref:`VIDIOC_G_AUDOUT <VIDIOC_G_AUDIOout>` ioctls report the current
audio input and output, respectively. Note that, unlike
-:ref:`VIDIOC_G_INPUT <VIDIOC_G_INPUT>` and
-:ref:`VIDIOC_G_OUTPUT <VIDIOC_G_OUTPUT>` these ioctls return a
-structure as :ref:`VIDIOC_ENUMAUDIO <VIDIOC_ENUMAUDIO>` and
+:ref:`VIDIOC_G_INPUT` and
+:ref:`VIDIOC_G_OUTPUT` these ioctls return a
+structure as :ref:`VIDIOC_ENUMAUDIO` and
:ref:`VIDIOC_ENUMAUDOUT <VIDIOC_ENUMAUDIOout>` do, not just an index.
To select an audio input and change its properties applications call the
@@ -51,7 +51,7 @@ multiple selectable audio inputs, all audio output ioctls when the
device has multiple selectable audio outputs. When the device has any
audio inputs or outputs the driver must set the ``V4L2_CAP_AUDIO`` flag
in the struct :ref:`v4l2_capability <v4l2-capability>` returned by
-the :ref:`VIDIOC_QUERYCAP <VIDIOC_QUERYCAP>` ioctl.
+the :ref:`VIDIOC_QUERYCAP` ioctl.
.. code-block:: c
diff --git a/Documentation/linux_tv/media/v4l/buffer.rst b/Documentation/linux_tv/media/v4l/buffer.rst
index 7d96ab74500f..374e9ba6b4bb 100644
--- a/Documentation/linux_tv/media/v4l/buffer.rst
+++ b/Documentation/linux_tv/media/v4l/buffer.rst
@@ -12,8 +12,8 @@ planes, while the buffer structure acts as a container for the planes.
Only pointers to buffers (planes) are exchanged, the data itself is not
copied. These pointers, together with meta-information like timestamps
or field parity, are stored in a struct :c:type:`struct v4l2_buffer`,
-argument to the :ref:`VIDIOC_QUERYBUF <VIDIOC_QUERYBUF>`,
-:ref:`VIDIOC_QBUF <VIDIOC_QBUF>` and
+argument to the :ref:`VIDIOC_QUERYBUF`,
+:ref:`VIDIOC_QBUF` and
:ref:`VIDIOC_DQBUF <VIDIOC_QBUF>` ioctl. In the multi-planar API,
some plane-specific members of struct :c:type:`struct v4l2_buffer`,
such as pointers and sizes for each plane, are stored in struct
@@ -52,10 +52,10 @@ buffer.
- Number of the buffer, set by the application except when calling
:ref:`VIDIOC_DQBUF <VIDIOC_QBUF>`, then it is set by the
driver. This field can range from zero to the number of buffers
- allocated with the :ref:`VIDIOC_REQBUFS <VIDIOC_REQBUFS>` ioctl
+ allocated with the :ref:`VIDIOC_REQBUFS` ioctl
(struct :ref:`v4l2_requestbuffers <v4l2-requestbuffers>`
``count``), plus any buffers allocated with
- :ref:`VIDIOC_CREATE_BUFS <VIDIOC_CREATE_BUFS>` minus one.
+ :ref:`VIDIOC_CREATE_BUFS` minus one.
- .. row 2
@@ -243,8 +243,8 @@ buffer.
-
- Size of the buffer (not the payload) in bytes for the
single-planar API. This is set by the driver based on the calls to
- :ref:`VIDIOC_REQBUFS <VIDIOC_REQBUFS>` and/or
- :ref:`VIDIOC_CREATE_BUFS <VIDIOC_CREATE_BUFS>`. For the
+ :ref:`VIDIOC_REQBUFS` and/or
+ :ref:`VIDIOC_CREATE_BUFS`. For the
multi-planar API the application sets this to the number of
elements in the ``planes`` array. The driver will fill in the
actual number of valid elements in that array.
@@ -303,8 +303,8 @@ buffer.
-
- Size in bytes of the plane (not its payload). This is set by the
driver based on the calls to
- :ref:`VIDIOC_REQBUFS <VIDIOC_REQBUFS>` and/or
- :ref:`VIDIOC_CREATE_BUFS <VIDIOC_CREATE_BUFS>`.
+ :ref:`VIDIOC_REQBUFS` and/or
+ :ref:`VIDIOC_CREATE_BUFS`.
- .. row 3
@@ -506,8 +506,8 @@ buffer.
- The buffer resides in device memory and has been mapped into the
application's address space, see :ref:`mmap` for details.
Drivers set or clear this flag when the
- :ref:`VIDIOC_QUERYBUF <VIDIOC_QUERYBUF>`,
- :ref:`VIDIOC_QBUF <VIDIOC_QBUF>` or
+ :ref:`VIDIOC_QUERYBUF`,
+ :ref:`VIDIOC_QBUF` or
:ref:`VIDIOC_DQBUF <VIDIOC_QBUF>` ioctl is called. Set by the
driver.
@@ -609,9 +609,9 @@ buffer.
- The buffer has been prepared for I/O and can be queued by the
application. Drivers set or clear this flag when the
- :ref:`VIDIOC_QUERYBUF <VIDIOC_QUERYBUF>`,
+ :ref:`VIDIOC_QUERYBUF`,
:ref:`VIDIOC_PREPARE_BUF <VIDIOC_QBUF>`,
- :ref:`VIDIOC_QBUF <VIDIOC_QBUF>` or
+ :ref:`VIDIOC_QBUF` or
:ref:`VIDIOC_DQBUF <VIDIOC_QBUF>` ioctl is called.
- .. row 10
@@ -645,7 +645,7 @@ buffer.
- Last buffer produced by the hardware. mem2mem codec drivers set
this flag on the capture queue for the last buffer when the
- :ref:`VIDIOC_QUERYBUF <VIDIOC_QUERYBUF>` or
+ :ref:`VIDIOC_QUERYBUF` or
:ref:`VIDIOC_DQBUF <VIDIOC_QBUF>` ioctl is called. Due to
hardware limitations, the last buffer may be empty. In this case
the driver will set the ``bytesused`` field to 0, regardless of
diff --git a/Documentation/linux_tv/media/v4l/control.rst b/Documentation/linux_tv/media/v4l/control.rst
index 3e5c650707ae..02bd455a2616 100644
--- a/Documentation/linux_tv/media/v4l/control.rst
+++ b/Documentation/linux_tv/media/v4l/control.rst
@@ -47,7 +47,7 @@ changed or generally never without application request.
V4L2 specifies an event mechanism to notify applications when controls
change value (see
-:ref:`VIDIOC_SUBSCRIBE_EVENT <VIDIOC_SUBSCRIBE_EVENT>`, event
+:ref:`VIDIOC_SUBSCRIBE_EVENT`, event
``V4L2_EVENT_CTRL``), panel applications might want to make use of that
in order to always reflect the correct control value.
@@ -362,9 +362,9 @@ Control IDs
and version, see :ref:`querycap`.
Applications can enumerate the available controls with the
-:ref:`VIDIOC_QUERYCTRL <VIDIOC_QUERYCTRL>` and
+:ref:`VIDIOC_QUERYCTRL` and
:ref:`VIDIOC_QUERYMENU <VIDIOC_QUERYCTRL>` ioctls, get and set a
-control value with the :ref:`VIDIOC_G_CTRL <VIDIOC_G_CTRL>` and
+control value with the :ref:`VIDIOC_G_CTRL` and
:ref:`VIDIOC_S_CTRL <VIDIOC_G_CTRL>` ioctls. Drivers must implement
``VIDIOC_QUERYCTRL``, ``VIDIOC_G_CTRL`` and ``VIDIOC_S_CTRL`` when the
device has one or more controls, ``VIDIOC_QUERYMENU`` when it has one or
@@ -522,7 +522,7 @@ more menu type controls.
the real IDs.
Many applications today still use the ``V4L2_CID_PRIVATE_BASE`` IDs
- instead of using :ref:`VIDIOC_QUERYCTRL <VIDIOC_QUERYCTRL>` with
+ instead of using :ref:`VIDIOC_QUERYCTRL` with
the ``V4L2_CTRL_FLAG_NEXT_CTRL`` flag to enumerate all IDs, so
support for ``V4L2_CID_PRIVATE_BASE`` is still around.
diff --git a/Documentation/linux_tv/media/v4l/crop.rst b/Documentation/linux_tv/media/v4l/crop.rst
index 94f2d0e77ed8..41a5efaaa679 100644
--- a/Documentation/linux_tv/media/v4l/crop.rst
+++ b/Documentation/linux_tv/media/v4l/crop.rst
@@ -14,8 +14,8 @@ offset into a video signal.
Applications can use the following API to select an area in the video
signal, query the default area and the hardware limits. *Despite their
-name, the :ref:`VIDIOC_CROPCAP <VIDIOC_CROPCAP>`,
-:ref:`VIDIOC_G_CROP <VIDIOC_G_CROP>` and
+name, the :ref:`VIDIOC_CROPCAP`,
+:ref:`VIDIOC_G_CROP` and
:ref:`VIDIOC_S_CROP <VIDIOC_G_CROP>` ioctls apply to input as well
as output devices.*
@@ -23,7 +23,7 @@ Scaling requires a source and a target. On a video capture or overlay
device the source is the video signal, and the cropping ioctls determine
the area actually sampled. The target are images read by the application
or overlaid onto the graphics screen. Their size (and position for an
-overlay) is negotiated with the :ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>`
+overlay) is negotiated with the :ref:`VIDIOC_G_FMT`
and :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctls.
On a video output device the source are the images passed in by the
diff --git a/Documentation/linux_tv/media/v4l/dev-capture.rst b/Documentation/linux_tv/media/v4l/dev-capture.rst
index fd6357c995aa..eb5c1522905d 100644
--- a/Documentation/linux_tv/media/v4l/dev-capture.rst
+++ b/Documentation/linux_tv/media/v4l/dev-capture.rst
@@ -25,7 +25,7 @@ Devices supporting the video capture interface set the
``V4L2_CAP_VIDEO_CAPTURE`` or ``V4L2_CAP_VIDEO_CAPTURE_MPLANE`` flag in
the ``capabilities`` field of struct
:ref:`v4l2_capability <v4l2-capability>` returned by the
-:ref:`VIDIOC_QUERYCAP <VIDIOC_QUERYCAP>` ioctl. As secondary device
+:ref:`VIDIOC_QUERYCAP` ioctl. As secondary device
functions they may also support the :ref:`video overlay <overlay>`
(``V4L2_CAP_VIDEO_OVERLAY``) and the :ref:`raw VBI capture <raw-vbi>`
(``V4L2_CAP_VBI_CAPTURE``) interface. At least one of the read/write or
@@ -37,7 +37,7 @@ Supplemental Functions
======================
Video capture devices shall support :ref:`audio input <audio>`,
-:ref:`tuner <tuner>`, :ref:`controls <control>`,
+:ref:`tuner`, :ref:`controls <control>`,
:ref:`cropping and scaling <crop>` and
:ref:`streaming parameter <streaming-par>` ioctls as needed. The
:ref:`video input <video>` and :ref:`video standard <standard>`
@@ -65,7 +65,7 @@ To query the current image format applications set the ``type`` field of
a struct :ref:`v4l2_format <v4l2-format>` to
``V4L2_BUF_TYPE_VIDEO_CAPTURE`` or
``V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE`` and call the
-:ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>` ioctl with a pointer to this
+:ref:`VIDIOC_G_FMT` ioctl with a pointer to this
structure. Drivers fill the struct
:ref:`v4l2_pix_format <v4l2-pix-format>` ``pix`` or the struct
:ref:`v4l2_pix_format_mplane <v4l2-pix-format-mplane>` ``pix_mp``
diff --git a/Documentation/linux_tv/media/v4l/dev-codec.rst b/Documentation/linux_tv/media/v4l/dev-codec.rst
index 1540755b1735..170954acc049 100644
--- a/Documentation/linux_tv/media/v4l/dev-codec.rst
+++ b/Documentation/linux_tv/media/v4l/dev-codec.rst
@@ -15,7 +15,7 @@ A memory-to-memory video node acts just like a normal video node, but it
supports both output (sending frames from memory to the codec hardware)
and capture (receiving the processed frames from the codec hardware into
memory) stream I/O. An application will have to setup the stream I/O for
-both sides and finally call :ref:`VIDIOC_STREAMON <VIDIOC_STREAMON>`
+both sides and finally call :ref:`VIDIOC_STREAMON`
for both capture and output to start the codec.
Video compression codecs use the MPEG controls to setup their codec
diff --git a/Documentation/linux_tv/media/v4l/dev-event.rst b/Documentation/linux_tv/media/v4l/dev-event.rst
index 5d21c6873b1a..385a8a342903 100644
--- a/Documentation/linux_tv/media/v4l/dev-event.rst
+++ b/Documentation/linux_tv/media/v4l/dev-event.rst
@@ -14,9 +14,9 @@ events.
To receive events, the events the user is interested in first must be
subscribed using the
-:ref:`VIDIOC_SUBSCRIBE_EVENT <VIDIOC_SUBSCRIBE_EVENT>` ioctl. Once
+:ref:`VIDIOC_SUBSCRIBE_EVENT` ioctl. Once
an event is subscribed, the events of subscribed types are dequeueable
-using the :ref:`VIDIOC_DQEVENT <VIDIOC_DQEVENT>` ioctl. Events may be
+using the :ref:`VIDIOC_DQEVENT` ioctl. Events may be
unsubscribed using VIDIOC_UNSUBSCRIBE_EVENT ioctl. The special event
type V4L2_EVENT_ALL may be used to unsubscribe all the events the
driver supports.
diff --git a/Documentation/linux_tv/media/v4l/dev-osd.rst b/Documentation/linux_tv/media/v4l/dev-osd.rst
index 93fb8f309091..27d2cfbf3d9c 100644
--- a/Documentation/linux_tv/media/v4l/dev-osd.rst
+++ b/Documentation/linux_tv/media/v4l/dev-osd.rst
@@ -26,7 +26,7 @@ Querying Capabilities
Devices supporting the *Video Output Overlay* interface set the
``V4L2_CAP_VIDEO_OUTPUT_OVERLAY`` flag in the ``capabilities`` field of
struct :ref:`v4l2_capability <v4l2-capability>` returned by the
-:ref:`VIDIOC_QUERYCAP <VIDIOC_QUERYCAP>` ioctl.
+:ref:`VIDIOC_QUERYCAP` ioctl.
Framebuffer
@@ -36,7 +36,7 @@ Contrary to the *Video Overlay* interface the framebuffer is normally
implemented on the TV card and not the graphics card. On Linux it is
accessible as a framebuffer device (``/dev/fbN``). Given a V4L2 device,
applications can find the corresponding framebuffer device by calling
-the :ref:`VIDIOC_G_FBUF <VIDIOC_G_FBUF>` ioctl. It returns, amongst
+the :ref:`VIDIOC_G_FBUF` ioctl. It returns, amongst
other information, the physical address of the framebuffer in the
``base`` field of struct :ref:`v4l2_framebuffer <v4l2-framebuffer>`.
The framebuffer device ioctl ``FBIOGET_FSCREENINFO`` returns the same
@@ -115,7 +115,7 @@ clipping/blending method to be used for the overlay. To get the current
parameters applications set the ``type`` field of a struct
:ref:`v4l2_format <v4l2-format>` to
``V4L2_BUF_TYPE_VIDEO_OUTPUT_OVERLAY`` and call the
-:ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>` ioctl. The driver fills the
+:ref:`VIDIOC_G_FMT` ioctl. The driver fills the
:c:type:`struct v4l2_window` substructure named ``win``. It is not
possible to retrieve a previously programmed clipping list or bitmap.
diff --git a/Documentation/linux_tv/media/v4l/dev-output.rst b/Documentation/linux_tv/media/v4l/dev-output.rst
index 3efbbcc3c093..1ca0e5873a86 100644
--- a/Documentation/linux_tv/media/v4l/dev-output.rst
+++ b/Documentation/linux_tv/media/v4l/dev-output.rst
@@ -24,7 +24,7 @@ Devices supporting the video output interface set the
``V4L2_CAP_VIDEO_OUTPUT`` or ``V4L2_CAP_VIDEO_OUTPUT_MPLANE`` flag in
the ``capabilities`` field of struct
:ref:`v4l2_capability <v4l2-capability>` returned by the
-:ref:`VIDIOC_QUERYCAP <VIDIOC_QUERYCAP>` ioctl. As secondary device
+:ref:`VIDIOC_QUERYCAP` ioctl. As secondary device
functions they may also support the :ref:`raw VBI output <raw-vbi>`
(``V4L2_CAP_VBI_OUTPUT``) interface. At least one of the read/write or
streaming I/O methods must be supported. Modulators and audio outputs
@@ -62,7 +62,7 @@ defaults. An example is given in :ref:`crop`.
To query the current image format applications set the ``type`` field of
a struct :ref:`v4l2_format <v4l2-format>` to
``V4L2_BUF_TYPE_VIDEO_OUTPUT`` or ``V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE``
-and call the :ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>` ioctl with a pointer
+and call the :ref:`VIDIOC_G_FMT` ioctl with a pointer
to this structure. Drivers fill the struct
:ref:`v4l2_pix_format <v4l2-pix-format>` ``pix`` or the struct
:ref:`v4l2_pix_format_mplane <v4l2-pix-format-mplane>` ``pix_mp``
diff --git a/Documentation/linux_tv/media/v4l/dev-overlay.rst b/Documentation/linux_tv/media/v4l/dev-overlay.rst
index 8a81e19a5d7c..acbcfb4cbe57 100644
--- a/Documentation/linux_tv/media/v4l/dev-overlay.rst
+++ b/Documentation/linux_tv/media/v4l/dev-overlay.rst
@@ -41,7 +41,7 @@ Querying Capabilities
Devices supporting the video overlay interface set the
``V4L2_CAP_VIDEO_OVERLAY`` flag in the ``capabilities`` field of struct
:ref:`v4l2_capability <v4l2-capability>` returned by the
-:ref:`VIDIOC_QUERYCAP <VIDIOC_QUERYCAP>` ioctl. The overlay I/O
+:ref:`VIDIOC_QUERYCAP` ioctl. The overlay I/O
method specified below must be supported. Tuners and audio inputs are
optional.
@@ -50,7 +50,7 @@ Supplemental Functions
======================
Video overlay devices shall support :ref:`audio input <audio>`,
-:ref:`tuner <tuner>`, :ref:`controls <control>`,
+:ref:`tuner`, :ref:`controls <control>`,
:ref:`cropping and scaling <crop>` and
:ref:`streaming parameter <streaming-par>` ioctls as needed. The
:ref:`video input <video>` and :ref:`video standard <standard>`
@@ -63,7 +63,7 @@ Setup
Before overlay can commence applications must program the driver with
frame buffer parameters, namely the address and size of the frame buffer
and the image format, for example RGB 5:6:5. The
-:ref:`VIDIOC_G_FBUF <VIDIOC_G_FBUF>` and
+:ref:`VIDIOC_G_FBUF` and
:ref:`VIDIOC_S_FBUF <VIDIOC_G_FBUF>` ioctls are available to get and
set these parameters, respectively. The ``VIDIOC_S_FBUF`` ioctl is
privileged because it allows to set up DMA into physical memory,
@@ -121,7 +121,7 @@ its position over the graphics surface and the clipping to be applied.
To get the current parameters applications set the ``type`` field of a
struct :ref:`v4l2_format <v4l2-format>` to
``V4L2_BUF_TYPE_VIDEO_OVERLAY`` and call the
-:ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>` ioctl. The driver fills the
+:ref:`VIDIOC_G_FMT` ioctl. The driver fills the
:c:type:`struct v4l2_window` substructure named ``win``. It is not
possible to retrieve a previously programmed clipping list or bitmap.
@@ -179,7 +179,7 @@ struct v4l2_window
``struct v4l2_clip * clips``
When chroma-keying has *not* been negotiated and
- :ref:`VIDIOC_G_FBUF <VIDIOC_G_FBUF>` indicated this capability,
+ :ref:`VIDIOC_G_FBUF` indicated this capability,
applications can set this field to point to an array of clipping
rectangles.
@@ -204,7 +204,7 @@ are undefined.
``void * bitmap``
When chroma-keying has *not* been negotiated and
- :ref:`VIDIOC_G_FBUF <VIDIOC_G_FBUF>` indicated this capability,
+ :ref:`VIDIOC_G_FBUF` indicated this capability,
applications can set this field to point to a clipping bit mask.
It must be of the same size as the window, ``w.width`` and ``w.height``.
@@ -289,7 +289,7 @@ Enabling Overlay
================
To start or stop the frame buffer overlay applications call the
-:ref:`VIDIOC_OVERLAY <VIDIOC_OVERLAY>` ioctl.
+:ref:`VIDIOC_OVERLAY` ioctl.
.. [1]
A common application of two file descriptors is the XFree86
diff --git a/Documentation/linux_tv/media/v4l/dev-radio.rst b/Documentation/linux_tv/media/v4l/dev-radio.rst
index 955173aaf48e..7a0d25a143a6 100644
--- a/Documentation/linux_tv/media/v4l/dev-radio.rst
+++ b/Documentation/linux_tv/media/v4l/dev-radio.rst
@@ -21,7 +21,7 @@ Devices supporting the radio interface set the ``V4L2_CAP_RADIO`` and
``V4L2_CAP_TUNER`` or ``V4L2_CAP_MODULATOR`` flag in the
``capabilities`` field of struct
:ref:`v4l2_capability <v4l2-capability>` returned by the
-:ref:`VIDIOC_QUERYCAP <VIDIOC_QUERYCAP>` ioctl. Other combinations of
+:ref:`VIDIOC_QUERYCAP` ioctl. Other combinations of
capability flags are reserved for future extensions.
@@ -47,8 +47,8 @@ discussed in :ref:`tuner`) with index number zero to select the radio
frequency and to determine if a monaural or FM stereo program is
received/emitted. Drivers switch automatically between AM and FM
depending on the selected frequency. The
-:ref:`VIDIOC_G_TUNER <VIDIOC_G_TUNER>` or
-:ref:`VIDIOC_G_MODULATOR <VIDIOC_G_MODULATOR>` ioctl reports the
+:ref:`VIDIOC_G_TUNER` or
+:ref:`VIDIOC_G_MODULATOR` ioctl reports the
supported frequency range.
diff --git a/Documentation/linux_tv/media/v4l/dev-raw-vbi.rst b/Documentation/linux_tv/media/v4l/dev-raw-vbi.rst
index 883ac4fbaeb6..ca61dde3ad38 100644
--- a/Documentation/linux_tv/media/v4l/dev-raw-vbi.rst
+++ b/Documentation/linux_tv/media/v4l/dev-raw-vbi.rst
@@ -40,7 +40,7 @@ Devices supporting the raw VBI capturing or output API set the
``V4L2_CAP_VBI_CAPTURE`` or ``V4L2_CAP_VBI_OUTPUT`` flags, respectively,
in the ``capabilities`` field of struct
:ref:`v4l2_capability <v4l2-capability>` returned by the
-:ref:`VIDIOC_QUERYCAP <VIDIOC_QUERYCAP>` ioctl. At least one of the
+:ref:`VIDIOC_QUERYCAP` ioctl. At least one of the
read/write, streaming or asynchronous I/O methods must be supported. VBI
devices may or may not have a tuner or modulator.
@@ -71,7 +71,7 @@ parameters and then checking if the actual parameters are suitable.
To query the current raw VBI capture parameters applications set the
``type`` field of a struct :ref:`v4l2_format <v4l2-format>` to
``V4L2_BUF_TYPE_VBI_CAPTURE`` or ``V4L2_BUF_TYPE_VBI_OUTPUT``, and call
-the :ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>` ioctl with a pointer to this
+the :ref:`VIDIOC_G_FMT` ioctl with a pointer to this
structure. Drivers fill the struct
:ref:`v4l2_vbi_format <v4l2-vbi-format>` ``vbi`` member of the
``fmt`` union.
@@ -91,7 +91,7 @@ happen for instance when the video and VBI areas to capture would
overlap, or when the driver supports multiple opens and another process
already requested VBI capturing or output. Anyway, applications must
expect other resource allocation points which may return EBUSY, at the
-:ref:`VIDIOC_STREAMON <VIDIOC_STREAMON>` ioctl and the first read(),
+:ref:`VIDIOC_STREAMON` ioctl and the first read(),
write() and select() call.
VBI devices must implement both the ``VIDIOC_G_FMT`` and
@@ -339,7 +339,7 @@ A VBI device may support :ref:`read/write <rw>` and/or streaming
The latter bears the possibility of synchronizing video and VBI data by
using buffer timestamps.
-Remember the :ref:`VIDIOC_STREAMON <VIDIOC_STREAMON>` ioctl and the
+Remember the :ref:`VIDIOC_STREAMON` ioctl and the
first read(), write() and select() call can be resource allocation
points returning an EBUSY error code if the required hardware resources
are temporarily unavailable, for example the device is already in use by
diff --git a/Documentation/linux_tv/media/v4l/dev-rds.rst b/Documentation/linux_tv/media/v4l/dev-rds.rst
index af20f8fa1cdf..223df4971405 100644
--- a/Documentation/linux_tv/media/v4l/dev-rds.rst
+++ b/Documentation/linux_tv/media/v4l/dev-rds.rst
@@ -33,7 +33,7 @@ Querying Capabilities
Devices supporting the RDS capturing API set the
``V4L2_CAP_RDS_CAPTURE`` flag in the ``capabilities`` field of struct
:ref:`v4l2_capability <v4l2-capability>` returned by the
-:ref:`VIDIOC_QUERYCAP <VIDIOC_QUERYCAP>` ioctl. Any tuner that
+:ref:`VIDIOC_QUERYCAP` ioctl. Any tuner that
supports RDS will set the ``V4L2_TUNER_CAP_RDS`` flag in the
``capability`` field of struct :ref:`v4l2_tuner <v4l2-tuner>`. If the
driver only passes RDS blocks without interpreting the data the
@@ -52,7 +52,7 @@ Whether an RDS signal is present can be detected by looking at the
Devices supporting the RDS output API set the ``V4L2_CAP_RDS_OUTPUT``
flag in the ``capabilities`` field of struct
:ref:`v4l2_capability <v4l2-capability>` returned by the
-:ref:`VIDIOC_QUERYCAP <VIDIOC_QUERYCAP>` ioctl. Any modulator that
+:ref:`VIDIOC_QUERYCAP` ioctl. Any modulator that
supports RDS will set the ``V4L2_TUNER_CAP_RDS`` flag in the
``capability`` field of struct
:ref:`v4l2_modulator <v4l2-modulator>`. In order to enable the RDS
diff --git a/Documentation/linux_tv/media/v4l/dev-sdr.rst b/Documentation/linux_tv/media/v4l/dev-sdr.rst
index 5e4f7030f644..0cae31c93dd0 100644
--- a/Documentation/linux_tv/media/v4l/dev-sdr.rst
+++ b/Documentation/linux_tv/media/v4l/dev-sdr.rst
@@ -22,7 +22,7 @@ Devices supporting the SDR receiver interface set the
``V4L2_CAP_SDR_CAPTURE`` and ``V4L2_CAP_TUNER`` flag in the
``capabilities`` field of struct
:ref:`v4l2_capability <v4l2-capability>` returned by the
-:ref:`VIDIOC_QUERYCAP <VIDIOC_QUERYCAP>` ioctl. That flag means the
+:ref:`VIDIOC_QUERYCAP` ioctl. That flag means the
device has an Analog to Digital Converter (ADC), which is a mandatory
element for the SDR receiver.
@@ -30,7 +30,7 @@ Devices supporting the SDR transmitter interface set the
``V4L2_CAP_SDR_OUTPUT`` and ``V4L2_CAP_MODULATOR`` flag in the
``capabilities`` field of struct
:ref:`v4l2_capability <v4l2-capability>` returned by the
-:ref:`VIDIOC_QUERYCAP <VIDIOC_QUERYCAP>` ioctl. That flag means the
+:ref:`VIDIOC_QUERYCAP` ioctl. That flag means the
device has an Digital to Analog Converter (DAC), which is a mandatory
element for the SDR transmitter.
@@ -42,7 +42,7 @@ Supplemental Functions
======================
SDR devices can support :ref:`controls <control>`, and must support
-the :ref:`tuner <tuner>` ioctls. Tuner ioctls are used for setting the
+the :ref:`tuner` ioctls. Tuner ioctls are used for setting the
ADC/DAC sampling rate (sampling frequency) and the possible radio
frequency (RF).
@@ -52,21 +52,21 @@ radio frequency. The tuner index of the RF tuner (if any) must always
follow the SDR tuner index. Normally the SDR tuner is #0 and the RF
tuner is #1.
-The :ref:`VIDIOC_S_HW_FREQ_SEEK <VIDIOC_S_HW_FREQ_SEEK>` ioctl is
+The :ref:`VIDIOC_S_HW_FREQ_SEEK` ioctl is
not supported.
Data Format Negotiation
=======================
-The SDR device uses the :ref:`format <format>` ioctls to select the
+The SDR device uses the :ref:`format` ioctls to select the
capture and output format. Both the sampling resolution and the data
streaming format are bound to that selectable format. In addition to the
-basic :ref:`format <format>` ioctls, the
-:ref:`VIDIOC_ENUM_FMT <VIDIOC_ENUM_FMT>` ioctl must be supported as
+basic :ref:`format` ioctls, the
+:ref:`VIDIOC_ENUM_FMT` ioctl must be supported as
well.
-To use the :ref:`format <format>` ioctls applications set the ``type``
+To use the :ref:`format` ioctls applications set the ``type``
field of a struct :ref:`v4l2_format <v4l2-format>` to
``V4L2_BUF_TYPE_SDR_CAPTURE`` or ``V4L2_BUF_TYPE_SDR_OUTPUT`` and use
the struct :ref:`v4l2_sdr_format <v4l2-sdr-format>` ``sdr`` member
diff --git a/Documentation/linux_tv/media/v4l/dev-sliced-vbi.rst b/Documentation/linux_tv/media/v4l/dev-sliced-vbi.rst
index 0faf178168e4..d53353afbedf 100644
--- a/Documentation/linux_tv/media/v4l/dev-sliced-vbi.rst
+++ b/Documentation/linux_tv/media/v4l/dev-sliced-vbi.rst
@@ -35,7 +35,7 @@ Devices supporting the sliced VBI capturing or output API set the
``V4L2_CAP_SLICED_VBI_CAPTURE`` or ``V4L2_CAP_SLICED_VBI_OUTPUT`` flag
respectively, in the ``capabilities`` field of struct
:ref:`v4l2_capability <v4l2-capability>` returned by the
-:ref:`VIDIOC_QUERYCAP <VIDIOC_QUERYCAP>` ioctl. At least one of the
+:ref:`VIDIOC_QUERYCAP` ioctl. At least one of the
read/write, streaming or asynchronous :ref:`I/O methods <io>` must be
supported. Sliced VBI devices may have a tuner or modulator.
@@ -45,7 +45,7 @@ Supplemental Functions
Sliced VBI devices shall support :ref:`video input or output <video>`
and :ref:`tuner or modulator <tuner>` ioctls if they have these
-capabilities, and they may support :ref:`control <control>` ioctls.
+capabilities, and they may support :ref:`control` ioctls.
The :ref:`video standard <standard>` ioctls provide information vital
to program a sliced VBI device, therefore must be supported.
@@ -57,7 +57,7 @@ Sliced VBI Format Negotiation
To find out which data services are supported by the hardware
applications can call the
-:ref:`VIDIOC_G_SLICED_VBI_CAP <VIDIOC_G_SLICED_VBI_CAP>` ioctl.
+:ref:`VIDIOC_G_SLICED_VBI_CAP` ioctl.
All drivers implementing the sliced VBI interface must support this
ioctl. The results may differ from those of the
:ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl when the number of VBI
@@ -70,7 +70,7 @@ To determine the currently selected services applications set the
``type`` field of struct :ref:`v4l2_format <v4l2-format>` to
``V4L2_BUF_TYPE_SLICED_VBI_CAPTURE`` or
``V4L2_BUF_TYPE_SLICED_VBI_OUTPUT``, and the
-:ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>` ioctl fills the ``fmt.sliced``
+:ref:`VIDIOC_G_FMT` ioctl fills the ``fmt.sliced``
member, a struct
:ref:`v4l2_sliced_vbi_format <v4l2-sliced-vbi-format>`.
@@ -95,7 +95,7 @@ according to hardware capabilities. When the driver allocates resources
at this point, it may return an EBUSY error code if the required
resources are temporarily unavailable. Other resource allocation points
which may return EBUSY can be the
-:ref:`VIDIOC_STREAMON <VIDIOC_STREAMON>` ioctl and the first
+:ref:`VIDIOC_STREAMON` ioctl and the first
:ref:`read() <func-read>`, :ref:`write() <func-write>` and
:ref:`select() <func-select>` call.
@@ -224,7 +224,7 @@ which may return EBUSY can be the
- :cspan:`2` Maximum number of bytes passed by one
:ref:`read() <func-read>` or :ref:`write() <func-write>` call,
and the buffer size in bytes for the
- :ref:`VIDIOC_QBUF <VIDIOC_QBUF>` and
+ :ref:`VIDIOC_QBUF` and
:ref:`VIDIOC_DQBUF <VIDIOC_QBUF>` ioctl. Drivers set this field
to the size of struct
:ref:`v4l2_sliced_vbi_data <v4l2-sliced-vbi-data>` times the
@@ -343,7 +343,7 @@ after switching the video input (which may change the video standard as
a side effect). The :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl may
return an EBUSY error code when applications attempt to change the
format while i/o is in progress (between a
-:ref:`VIDIOC_STREAMON <VIDIOC_STREAMON>` and
+:ref:`VIDIOC_STREAMON` and
:ref:`VIDIOC_STREAMOFF <VIDIOC_STREAMON>` call, and after the first
:ref:`read() <func-read>` or :ref:`write() <func-write>` call).
@@ -428,11 +428,11 @@ of one video frame. The ``id`` of unused
Packets are always passed in ascending line number order, without
duplicate line numbers. The :ref:`write() <func-write>` function and
-the :ref:`VIDIOC_QBUF <VIDIOC_QBUF>` ioctl must return an EINVAL
+the :ref:`VIDIOC_QBUF` ioctl must return an EINVAL
error code when applications violate this rule. They must also return an
EINVAL error code when applications pass an incorrect field or line
number, or a combination of ``field``, ``line`` and ``id`` which has not
-been negotiated with the :ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>` or
+been negotiated with the :ref:`VIDIOC_G_FMT` or
:ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl. When the line numbers are
unknown the driver must pass the packets in transmitted order. The
driver can insert empty packets with ``id`` set to zero anywhere in the
diff --git a/Documentation/linux_tv/media/v4l/dev-subdev.rst b/Documentation/linux_tv/media/v4l/dev-subdev.rst
index 1fe594c0026f..67732da53be5 100644
--- a/Documentation/linux_tv/media/v4l/dev-subdev.rst
+++ b/Documentation/linux_tv/media/v4l/dev-subdev.rst
@@ -118,18 +118,18 @@ every point in the pipeline explicitly.
Drivers that implement the :ref:`media API <media-controller-intro>`
can expose pad-level image format configuration to applications. When
they do, applications can use the
-:ref:`VIDIOC_SUBDEV_G_FMT <VIDIOC_SUBDEV_G_FMT>` and
+:ref:`VIDIOC_SUBDEV_G_FMT` and
:ref:`VIDIOC_SUBDEV_S_FMT <VIDIOC_SUBDEV_G_FMT>` ioctls. to
negotiate formats on a per-pad basis.
Applications are responsible for configuring coherent parameters on the
whole pipeline and making sure that connected pads have compatible
formats. The pipeline is checked for formats mismatch at
-:ref:`VIDIOC_STREAMON <VIDIOC_STREAMON>` time, and an EPIPE error
+:ref:`VIDIOC_STREAMON` time, and an EPIPE error
code is then returned if the configuration is invalid.
Pad-level image format configuration support can be tested by calling
-the :ref:`VIDIOC_SUBDEV_G_FMT <VIDIOC_SUBDEV_G_FMT>` ioctl on pad
+the :ref:`VIDIOC_SUBDEV_G_FMT` ioctl on pad
0. If the driver returns an EINVAL error code pad-level format
configuration is not supported by the sub-device.
@@ -146,7 +146,7 @@ formats enumeration only. A format negotiation mechanism is required.
Central to the format negotiation mechanism are the get/set format
operations. When called with the ``which`` argument set to
``V4L2_SUBDEV_FORMAT_TRY``, the
-:ref:`VIDIOC_SUBDEV_G_FMT <VIDIOC_SUBDEV_G_FMT>` and
+:ref:`VIDIOC_SUBDEV_G_FMT` and
:ref:`VIDIOC_SUBDEV_S_FMT <VIDIOC_SUBDEV_G_FMT>` ioctls operate on
a set of formats parameters that are not connected to the hardware
configuration. Modifying those 'try' formats leaves the device state
@@ -155,7 +155,7 @@ and the hardware state stored in the device itself).
While not kept as part of the device state, try formats are stored in
the sub-device file handles. A
-:ref:`VIDIOC_SUBDEV_G_FMT <VIDIOC_SUBDEV_G_FMT>` call will return
+:ref:`VIDIOC_SUBDEV_G_FMT` call will return
the last try format set *on the same sub-device file handle*. Several
applications querying the same sub-device at the same time will thus not
interact with each other.
diff --git a/Documentation/linux_tv/media/v4l/dev-teletext.rst b/Documentation/linux_tv/media/v4l/dev-teletext.rst
index ed69e0fb6371..501e68077af2 100644
--- a/Documentation/linux_tv/media/v4l/dev-teletext.rst
+++ b/Documentation/linux_tv/media/v4l/dev-teletext.rst
@@ -31,7 +31,7 @@ them. So the decision was made to finally remove support for the
Teletext API in kernel 2.6.37.
Modern devices all use the :ref:`raw <raw-vbi>` or
-:ref:`sliced <sliced>` VBI API.
+:ref:`sliced` VBI API.
.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/diff-v4l.rst b/Documentation/linux_tv/media/v4l/diff-v4l.rst
index 0c4030d75c76..06fdd877d77d 100644
--- a/Documentation/linux_tv/media/v4l/diff-v4l.rst
+++ b/Documentation/linux_tv/media/v4l/diff-v4l.rst
@@ -85,7 +85,7 @@ Querying Capabilities
=====================
The V4L ``VIDIOCGCAP`` ioctl is equivalent to V4L2's
-:ref:`VIDIOC_QUERYCAP <VIDIOC_QUERYCAP>`.
+:ref:`VIDIOC_QUERYCAP`.
The ``name`` field in struct :c:type:`struct video_capability` became
``card`` in struct :ref:`v4l2_capability <v4l2-capability>`, ``type``
@@ -194,7 +194,7 @@ introduction.
- ``-``
- Applications can enumerate the supported image formats with the
- :ref:`VIDIOC_ENUM_FMT <VIDIOC_ENUM_FMT>` ioctl to determine if
+ :ref:`VIDIOC_ENUM_FMT` ioctl to determine if
the device supports grey scale capturing only. For more
information on image formats see :ref:`pixfmt`.
@@ -204,7 +204,7 @@ introduction.
- ``-``
- - Applications can call the :ref:`VIDIOC_G_CROP <VIDIOC_G_CROP>`
+ - Applications can call the :ref:`VIDIOC_G_CROP`
ioctl to determine if the device supports capturing a subsection
of the full picture ("cropping" in V4L2). If not, the ioctl
returns the EINVAL error code. For more information on cropping
@@ -217,7 +217,7 @@ introduction.
- ``-``
- Applications can enumerate the supported image formats with the
- :ref:`VIDIOC_ENUM_FMT <VIDIOC_ENUM_FMT>` ioctl to determine if
+ :ref:`VIDIOC_ENUM_FMT` ioctl to determine if
the device supports MPEG streams.
- .. row 13
@@ -248,7 +248,7 @@ introduction.
The ``audios`` field was replaced by ``capabilities`` flag
``V4L2_CAP_AUDIO``, indicating *if* the device has any audio inputs or
outputs. To determine their number applications can enumerate audio
-inputs with the :ref:`VIDIOC_G_AUDIO <VIDIOC_G_AUDIO>` ioctl. The
+inputs with the :ref:`VIDIOC_G_AUDIO` ioctl. The
audio ioctls are described in :ref:`audio`.
The ``maxwidth``, ``maxheight``, ``minwidth`` and ``minheight`` fields
@@ -264,8 +264,8 @@ Video Sources
V4L provides the ``VIDIOCGCHAN`` and ``VIDIOCSCHAN`` ioctl using struct
:c:type:`struct video_channel` to enumerate the video inputs of a V4L
device. The equivalent V4L2 ioctls are
-:ref:`VIDIOC_ENUMINPUT <VIDIOC_ENUMINPUT>`,
-:ref:`VIDIOC_G_INPUT <VIDIOC_G_INPUT>` and
+:ref:`VIDIOC_ENUMINPUT`,
+:ref:`VIDIOC_G_INPUT` and
:ref:`VIDIOC_S_INPUT <VIDIOC_G_INPUT>` using struct
:ref:`v4l2_input <v4l2-input>` as discussed in :ref:`video`.
@@ -328,7 +328,7 @@ Tuning
The V4L ``VIDIOCGTUNER`` and ``VIDIOCSTUNER`` ioctl and struct
:c:type:`struct video_tuner` can be used to enumerate the tuners of a
V4L TV or radio device. The equivalent V4L2 ioctls are
-:ref:`VIDIOC_G_TUNER <VIDIOC_G_TUNER>` and
+:ref:`VIDIOC_G_TUNER` and
:ref:`VIDIOC_S_TUNER <VIDIOC_G_TUNER>` using struct
:ref:`v4l2_tuner <v4l2-tuner>`. Tuners are covered in :ref:`tuner`.
@@ -360,7 +360,7 @@ the struct :ref:`v4l2_tuner <v4l2-tuner>` ``capability`` field.
The ``VIDIOCGFREQ`` and ``VIDIOCSFREQ`` ioctl to change the tuner
frequency where renamed to
-:ref:`VIDIOC_G_FREQUENCY <VIDIOC_G_FREQUENCY>` and
+:ref:`VIDIOC_G_FREQUENCY` and
:ref:`VIDIOC_S_FREQUENCY <VIDIOC_G_FREQUENCY>`. They take a pointer
to a struct :ref:`v4l2_frequency <v4l2-frequency>` instead of an
unsigned long integer.
@@ -374,8 +374,8 @@ Image Properties
V4L2 has no equivalent of the ``VIDIOCGPICT`` and ``VIDIOCSPICT`` ioctl
and struct :c:type:`struct video_picture`. The following fields where
replaced by V4L2 controls accessible with the
-:ref:`VIDIOC_QUERYCTRL <VIDIOC_QUERYCTRL>`,
-:ref:`VIDIOC_G_CTRL <VIDIOC_G_CTRL>` and
+:ref:`VIDIOC_QUERYCTRL`,
+:ref:`VIDIOC_G_CTRL` and
:ref:`VIDIOC_S_CTRL <VIDIOC_G_CTRL>` ioctls:
@@ -425,7 +425,7 @@ replaced by V4L2 controls accessible with the
The V4L picture controls are assumed to range from 0 to 65535 with no
particular reset value. The V4L2 API permits arbitrary limits and
defaults which can be queried with the
-:ref:`VIDIOC_QUERYCTRL <VIDIOC_QUERYCTRL>` ioctl. For general
+:ref:`VIDIOC_QUERYCTRL` ioctl. For general
information about controls see :ref:`control`.
The ``depth`` (average number of bits per pixel) of a video image is
@@ -554,7 +554,7 @@ Audio
The ``VIDIOCGAUDIO`` and ``VIDIOCSAUDIO`` ioctl and struct
:c:type:`struct video_audio` are used to enumerate the audio inputs
of a V4L device. The equivalent V4L2 ioctls are
-:ref:`VIDIOC_G_AUDIO <VIDIOC_G_AUDIO>` and
+:ref:`VIDIOC_G_AUDIO` and
:ref:`VIDIOC_S_AUDIO <VIDIOC_G_AUDIO>` using struct
:ref:`v4l2_audio <v4l2-audio>` as discussed in :ref:`audio`.
@@ -576,8 +576,8 @@ information on tuners. Related to audio modes struct
stereo input, regardless if the source is a tuner.
The following fields where replaced by V4L2 controls accessible with the
-:ref:`VIDIOC_QUERYCTRL <VIDIOC_QUERYCTRL>`,
-:ref:`VIDIOC_G_CTRL <VIDIOC_G_CTRL>` and
+:ref:`VIDIOC_QUERYCTRL`,
+:ref:`VIDIOC_G_CTRL` and
:ref:`VIDIOC_S_CTRL <VIDIOC_G_CTRL>` ioctls:
@@ -621,7 +621,7 @@ The following fields where replaced by V4L2 controls accessible with the
To determine which of these controls are supported by a driver V4L
provides the ``flags`` ``VIDEO_AUDIO_VOLUME``, ``VIDEO_AUDIO_BASS``,
``VIDEO_AUDIO_TREBLE`` and ``VIDEO_AUDIO_BALANCE``. In the V4L2 API the
-:ref:`VIDIOC_QUERYCTRL <VIDIOC_QUERYCTRL>` ioctl reports if the
+:ref:`VIDIOC_QUERYCTRL` ioctl reports if the
respective control is supported. Accordingly the ``VIDEO_AUDIO_MUTABLE``
and ``VIDEO_AUDIO_MUTE`` flags where replaced by the boolean
``V4L2_CID_AUDIO_MUTE`` control.
@@ -630,7 +630,7 @@ All V4L2 controls have a ``step`` attribute replacing the struct
:c:type:`struct video_audio` ``step`` field. The V4L audio controls
are assumed to range from 0 to 65535 with no particular reset value. The
V4L2 API permits arbitrary limits and defaults which can be queried with
-the :ref:`VIDIOC_QUERYCTRL <VIDIOC_QUERYCTRL>` ioctl. For general
+the :ref:`VIDIOC_QUERYCTRL` ioctl. For general
information about controls see :ref:`control`.
@@ -638,7 +638,7 @@ Frame Buffer Overlay
====================
The V4L2 ioctls equivalent to ``VIDIOCGFBUF`` and ``VIDIOCSFBUF`` are
-:ref:`VIDIOC_G_FBUF <VIDIOC_G_FBUF>` and
+:ref:`VIDIOC_G_FBUF` and
:ref:`VIDIOC_S_FBUF <VIDIOC_G_FBUF>`. The ``base`` field of struct
:c:type:`struct video_buffer` remained unchanged, except V4L2 defines
a flag to indicate non-destructive overlays instead of a ``NULL``
@@ -650,7 +650,7 @@ list of RGB formats and their respective color depths.
Instead of the special ioctls ``VIDIOCGWIN`` and ``VIDIOCSWIN`` V4L2
uses the general-purpose data format negotiation ioctls
-:ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>` and
+:ref:`VIDIOC_G_FMT` and
:ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>`. They take a pointer to a struct
:ref:`v4l2_format <v4l2-format>` as argument. Here the ``win`` member
of the ``fmt`` union is used, a struct
@@ -678,7 +678,7 @@ has a separate ``bitmap`` pointer field for this purpose and the bitmap
size is determined by ``w.width`` and ``w.height``.
The ``VIDIOCCAPTURE`` ioctl to enable or disable overlay was renamed to
-:ref:`VIDIOC_OVERLAY <VIDIOC_OVERLAY>`.
+:ref:`VIDIOC_OVERLAY`.
Cropping
@@ -687,10 +687,10 @@ Cropping
To capture only a subsection of the full picture V4L defines the
``VIDIOCGCAPTURE`` and ``VIDIOCSCAPTURE`` ioctls using struct
:c:type:`struct video_capture`. The equivalent V4L2 ioctls are
-:ref:`VIDIOC_G_CROP <VIDIOC_G_CROP>` and
+:ref:`VIDIOC_G_CROP` and
:ref:`VIDIOC_S_CROP <VIDIOC_G_CROP>` using struct
:ref:`v4l2_crop <v4l2-crop>`, and the related
-:ref:`VIDIOC_CROPCAP <VIDIOC_CROPCAP>` ioctl. This is a rather
+:ref:`VIDIOC_CROPCAP` ioctl. This is a rather
complex matter, see :ref:`crop` for details.
The ``x``, ``y``, ``width`` and ``height`` fields moved into struct
@@ -719,14 +719,14 @@ There is no essential difference between reading images from a V4L or
V4L2 device using the :ref:`read() <func-read>` function, however V4L2
drivers are not required to support this I/O method. Applications can
determine if the function is available with the
-:ref:`VIDIOC_QUERYCAP <VIDIOC_QUERYCAP>` ioctl. All V4L2 devices
+:ref:`VIDIOC_QUERYCAP` ioctl. All V4L2 devices
exchanging data with applications must support the
:ref:`select() <func-select>` and :ref:`poll() <func-poll>`
functions.
To select an image format and size, V4L provides the ``VIDIOCSPICT`` and
``VIDIOCSWIN`` ioctls. V4L2 uses the general-purpose data format
-negotiation ioctls :ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>` and
+negotiation ioctls :ref:`VIDIOC_G_FMT` and
:ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>`. They take a pointer to a struct
:ref:`v4l2_format <v4l2-format>` as argument, here the struct
:ref:`v4l2_pix_format <v4l2-pix-format>` named ``pix`` of its
@@ -771,7 +771,7 @@ differences.
into the driver, unless it has a module option to change the
number when the driver module is loaded.
- - The :ref:`VIDIOC_REQBUFS <VIDIOC_REQBUFS>` ioctl allocates the
+ - The :ref:`VIDIOC_REQBUFS` ioctl allocates the
desired number of buffers, this is a required step in the
initialization sequence.
@@ -785,7 +785,7 @@ differences.
- Buffers are individually mapped. The offset and size of each
buffer can be determined with the
- :ref:`VIDIOC_QUERYBUF <VIDIOC_QUERYBUF>` ioctl.
+ :ref:`VIDIOC_QUERYBUF` ioctl.
- .. row 5
@@ -800,18 +800,18 @@ differences.
buffer has been filled.
- Drivers maintain an incoming and outgoing queue.
- :ref:`VIDIOC_QBUF <VIDIOC_QBUF>` enqueues any empty buffer into
+ :ref:`VIDIOC_QBUF` enqueues any empty buffer into
the incoming queue. Filled buffers are dequeued from the outgoing
queue with the :ref:`VIDIOC_DQBUF <VIDIOC_QBUF>` ioctl. To wait
until filled buffers become available this function,
:ref:`select() <func-select>` or :ref:`poll() <func-poll>` can
- be used. The :ref:`VIDIOC_STREAMON <VIDIOC_STREAMON>` ioctl
+ be used. The :ref:`VIDIOC_STREAMON` ioctl
must be called once after enqueuing one or more buffers to start
capturing. Its counterpart
:ref:`VIDIOC_STREAMOFF <VIDIOC_STREAMON>` stops capturing and
dequeues all buffers from both queues. Applications can query the
signal status, if known, with the
- :ref:`VIDIOC_ENUMINPUT <VIDIOC_ENUMINPUT>` ioctl.
+ :ref:`VIDIOC_ENUMINPUT` ioctl.
For a more in-depth discussion of memory mapping and examples, see
diff --git a/Documentation/linux_tv/media/v4l/dmabuf.rst b/Documentation/linux_tv/media/v4l/dmabuf.rst
index bc2944c27e70..773d39308fd6 100644
--- a/Documentation/linux_tv/media/v4l/dmabuf.rst
+++ b/Documentation/linux_tv/media/v4l/dmabuf.rst
@@ -20,9 +20,9 @@ exporting V4L2 buffers as DMABUF file descriptors.
Input and output devices support the streaming I/O method when the
``V4L2_CAP_STREAMING`` flag in the ``capabilities`` field of struct
:ref:`v4l2_capability <v4l2-capability>` returned by the
-:ref:`VIDIOC_QUERYCAP <VIDIOC_QUERYCAP>` ioctl is set. Whether
+:ref:`VIDIOC_QUERYCAP` ioctl is set. Whether
importing DMA buffers through DMABUF file descriptors is supported is
-determined by calling the :ref:`VIDIOC_REQBUFS <VIDIOC_REQBUFS>`
+determined by calling the :ref:`VIDIOC_REQBUFS`
ioctl with the memory type set to ``V4L2_MEMORY_DMABUF``.
This I/O method is dedicated to sharing DMA buffers between different
@@ -34,7 +34,7 @@ such file descriptor are exchanged. The descriptors and meta-information
are passed in struct :ref:`v4l2_buffer <v4l2-buffer>` (or in struct
:ref:`v4l2_plane <v4l2-plane>` in the multi-planar API case). The
driver must be switched into DMABUF I/O mode by calling the
-:ref:`VIDIOC_REQBUFS <VIDIOC_REQBUFS>` with the desired buffer type.
+:ref:`VIDIOC_REQBUFS` with the desired buffer type.
.. code-block:: c
@@ -56,7 +56,7 @@ driver must be switched into DMABUF I/O mode by calling the
}
The buffer (plane) file descriptor is passed on the fly with the
-:ref:`VIDIOC_QBUF <VIDIOC_QBUF>` ioctl. In case of multiplanar
+:ref:`VIDIOC_QBUF` ioctl. In case of multiplanar
buffers, every plane can be associated with a different DMABUF
descriptor. Although buffers are commonly cycled, applications can pass
a different DMABUF descriptor at each ``VIDIOC_QBUF`` call.
@@ -116,7 +116,7 @@ Captured or displayed buffers are dequeued with the
buffer at any time between the completion of the DMA and this ioctl. The
memory is also unlocked when
:ref:`VIDIOC_STREAMOFF <VIDIOC_STREAMON>` is called,
-:ref:`VIDIOC_REQBUFS <VIDIOC_REQBUFS>`, or when the device is closed.
+:ref:`VIDIOC_REQBUFS`, or when the device is closed.
For capturing applications it is customary to enqueue a number of empty
buffers, to start capturing and enter the read loop. Here the
@@ -134,7 +134,7 @@ immediately with an EAGAIN error code when no buffer is available. The
functions are always available.
To start and stop capturing or displaying applications call the
-:ref:`VIDIOC_STREAMON <VIDIOC_STREAMON>` and
+:ref:`VIDIOC_STREAMON` and
:ref:`VIDIOC_STREAMOFF <VIDIOC_STREAMON>` ioctls. Note that
``VIDIOC_STREAMOFF`` removes all buffers from both queues and unlocks
all buffers as a side effect. Since there is no notion of doing anything
diff --git a/Documentation/linux_tv/media/v4l/dv-timings.rst b/Documentation/linux_tv/media/v4l/dv-timings.rst
index d51c36ec604c..4b22b1b0fccb 100644
--- a/Documentation/linux_tv/media/v4l/dv-timings.rst
+++ b/Documentation/linux_tv/media/v4l/dv-timings.rst
@@ -24,14 +24,14 @@ standards.
To enumerate and query the attributes of the DV timings supported by a
device applications use the
-:ref:`VIDIOC_ENUM_DV_TIMINGS <VIDIOC_ENUM_DV_TIMINGS>` and
-:ref:`VIDIOC_DV_TIMINGS_CAP <VIDIOC_DV_TIMINGS_CAP>` ioctls. To set
+:ref:`VIDIOC_ENUM_DV_TIMINGS` and
+:ref:`VIDIOC_DV_TIMINGS_CAP` ioctls. To set
DV timings for the device applications use the
:ref:`VIDIOC_S_DV_TIMINGS <VIDIOC_G_DV_TIMINGS>` ioctl and to get
current DV timings they use the
-:ref:`VIDIOC_G_DV_TIMINGS <VIDIOC_G_DV_TIMINGS>` ioctl. To detect
+:ref:`VIDIOC_G_DV_TIMINGS` ioctl. To detect
the DV timings as seen by the video receiver applications use the
-:ref:`VIDIOC_QUERY_DV_TIMINGS <VIDIOC_QUERY_DV_TIMINGS>` ioctl.
+:ref:`VIDIOC_QUERY_DV_TIMINGS` ioctl.
Applications can make use of the :ref:`input-capabilities` and
:ref:`output-capabilities` flags to determine whether the digital
diff --git a/Documentation/linux_tv/media/v4l/extended-controls.rst b/Documentation/linux_tv/media/v4l/extended-controls.rst
index 66333b9f60fd..9a10edc50fa0 100644
--- a/Documentation/linux_tv/media/v4l/extended-controls.rst
+++ b/Documentation/linux_tv/media/v4l/extended-controls.rst
@@ -39,11 +39,11 @@ The Extended Control API
========================
Three new ioctls are available:
-:ref:`VIDIOC_G_EXT_CTRLS <VIDIOC_G_EXT_CTRLS>`,
+:ref:`VIDIOC_G_EXT_CTRLS`,
:ref:`VIDIOC_S_EXT_CTRLS <VIDIOC_G_EXT_CTRLS>` and
:ref:`VIDIOC_TRY_EXT_CTRLS <VIDIOC_G_EXT_CTRLS>`. These ioctls act
on arrays of controls (as opposed to the
-:ref:`VIDIOC_G_CTRL <VIDIOC_G_CTRL>` and
+:ref:`VIDIOC_G_CTRL` and
:ref:`VIDIOC_S_CTRL <VIDIOC_G_CTRL>` ioctls that act on a single
control). This is needed since it is often required to atomically change
several controls at once.
@@ -79,7 +79,7 @@ with compound types should only be used programmatically.
Since such compound controls need to expose more information about
themselves than is possible with
-:ref:`VIDIOC_QUERYCTRL <VIDIOC_QUERYCTRL>` the
+:ref:`VIDIOC_QUERYCTRL` the
:ref:`VIDIOC_QUERY_EXT_CTRL <VIDIOC_QUERYCTRL>` ioctl was added. In
particular, this ioctl gives the dimensions of the N-dimensional array
if this control consists of more than one element.
@@ -87,7 +87,7 @@ if this control consists of more than one element.
It is important to realize that due to the flexibility of controls it is
necessary to check whether the control you want to set actually is
supported in the driver and what the valid range of values is. So use
-the :ref:`VIDIOC_QUERYCTRL <VIDIOC_QUERYCTRL>` (or
+the :ref:`VIDIOC_QUERYCTRL` (or
:ref:`VIDIOC_QUERY_EXT_CTRL <VIDIOC_QUERYCTRL>`) and
:ref:`VIDIOC_QUERYMENU <VIDIOC_QUERYCTRL>` ioctls to check this. Also
note that it is possible that some of the menu indices in a control of
@@ -103,7 +103,7 @@ Enumerating Extended Controls
=============================
The recommended way to enumerate over the extended controls is by using
-:ref:`VIDIOC_QUERYCTRL <VIDIOC_QUERYCTRL>` in combination with the
+:ref:`VIDIOC_QUERYCTRL` in combination with the
``V4L2_CTRL_FLAG_NEXT_CTRL`` flag:
@@ -169,7 +169,7 @@ within a control panel.
The flags field of struct :ref:`v4l2_queryctrl <v4l2-queryctrl>` also
contains hints on the behavior of the control. See the
-:ref:`VIDIOC_QUERYCTRL <VIDIOC_QUERYCTRL>` documentation for more
+:ref:`VIDIOC_QUERYCTRL` documentation for more
details.
@@ -198,7 +198,7 @@ Codec Control IDs
``V4L2_CID_MPEG_CLASS (class)``
The Codec class descriptor. Calling
- :ref:`VIDIOC_QUERYCTRL <VIDIOC_QUERYCTRL>` for this control will
+ :ref:`VIDIOC_QUERYCTRL` for this control will
return a description of this control class. This description can be
used as the caption of a Tab page in a GUI, for example.
@@ -1168,7 +1168,7 @@ Codec Control IDs
This read-only control returns the 33-bit video Presentation Time
Stamp as defined in ITU T-REC-H.222.0 and ISO/IEC 13818-1 of the
currently displayed frame. This is the same PTS as is used in
- :ref:`VIDIOC_DECODER_CMD <VIDIOC_DECODER_CMD>`.
+ :ref:`VIDIOC_DECODER_CMD`.
.. _`v4l2-mpeg-video-dec-frame`:
@@ -2781,7 +2781,7 @@ Camera Control IDs
``V4L2_CID_CAMERA_CLASS (class)``
The Camera class descriptor. Calling
- :ref:`VIDIOC_QUERYCTRL <VIDIOC_QUERYCTRL>` for this control will
+ :ref:`VIDIOC_QUERYCTRL` for this control will
return a description of this control class.
.. _`v4l2-exposure-auto-type`:
@@ -3441,7 +3441,7 @@ FM_TX Control IDs
``V4L2_CID_FM_TX_CLASS (class)``
The FM_TX class descriptor. Calling
- :ref:`VIDIOC_QUERYCTRL <VIDIOC_QUERYCTRL>` for this control will
+ :ref:`VIDIOC_QUERYCTRL` for this control will
return a description of this control class.
``V4L2_CID_RDS_TX_DEVIATION (integer)``
@@ -3870,7 +3870,7 @@ JPEG Control IDs
``V4L2_CID_JPEG_CLASS (class)``
The JPEG class descriptor. Calling
- :ref:`VIDIOC_QUERYCTRL <VIDIOC_QUERYCTRL>` for this control will
+ :ref:`VIDIOC_QUERYCTRL` for this control will
return a description of this control class.
``V4L2_CID_JPEG_CHROMA_SUBSAMPLING (menu)``
@@ -4271,7 +4271,7 @@ FM_RX Control IDs
``V4L2_CID_FM_RX_CLASS (class)``
The FM_RX class descriptor. Calling
- :ref:`VIDIOC_QUERYCTRL <VIDIOC_QUERYCTRL>` for this control will
+ :ref:`VIDIOC_QUERYCTRL` for this control will
return a description of this control class.
``V4L2_CID_RDS_RECEPTION (boolean)``
@@ -4369,7 +4369,7 @@ Detect Control IDs
``V4L2_CID_DETECT_CLASS (class)``
The Detect class descriptor. Calling
- :ref:`VIDIOC_QUERYCTRL <VIDIOC_QUERYCTRL>` for this control will
+ :ref:`VIDIOC_QUERYCTRL` for this control will
return a description of this control class.
``V4L2_CID_DETECT_MD_MODE (menu)``
@@ -4463,7 +4463,7 @@ RF_TUNER Control IDs
``V4L2_CID_RF_TUNER_CLASS (class)``
The RF_TUNER class descriptor. Calling
- :ref:`VIDIOC_QUERYCTRL <VIDIOC_QUERYCTRL>` for this control will
+ :ref:`VIDIOC_QUERYCTRL` for this control will
return a description of this control class.
``V4L2_CID_RF_TUNER_BANDWIDTH_AUTO (boolean)``
diff --git a/Documentation/linux_tv/media/v4l/format.rst b/Documentation/linux_tv/media/v4l/format.rst
index a754fa81f707..46f740a0092e 100644
--- a/Documentation/linux_tv/media/v4l/format.rst
+++ b/Documentation/linux_tv/media/v4l/format.rst
@@ -23,7 +23,7 @@ current selection.
A single mechanism exists to negotiate all data formats using the
aggregate struct :ref:`v4l2_format <v4l2-format>` and the
-:ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>` and
+:ref:`VIDIOC_G_FMT` and
:ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctls. Additionally the
:ref:`VIDIOC_TRY_FMT <VIDIOC_G_FMT>` ioctl can be used to examine
what the hardware *could* do, without actually selecting a new data
@@ -52,7 +52,7 @@ image size.
When applications omit the ``VIDIOC_S_FMT`` ioctl its locking side
effects are implied by the next step, the selection of an I/O method
-with the :ref:`VIDIOC_REQBUFS <VIDIOC_REQBUFS>` ioctl or implicit
+with the :ref:`VIDIOC_REQBUFS` ioctl or implicit
with the first :ref:`read() <func-read>` or
:ref:`write() <func-write>` call.
@@ -75,7 +75,7 @@ Apart of the generic format negotiation functions a special ioctl to
enumerate all image formats supported by video capture, overlay or
output devices is available. [1]_
-The :ref:`VIDIOC_ENUM_FMT <VIDIOC_ENUM_FMT>` ioctl must be supported
+The :ref:`VIDIOC_ENUM_FMT` ioctl must be supported
by all drivers exchanging image data with applications.
**Important**
diff --git a/Documentation/linux_tv/media/v4l/func-mmap.rst b/Documentation/linux_tv/media/v4l/func-mmap.rst
index 7243142384bb..b908c0253c07 100644
--- a/Documentation/linux_tv/media/v4l/func-mmap.rst
+++ b/Documentation/linux_tv/media/v4l/func-mmap.rst
@@ -98,8 +98,8 @@ application address space, preferably at address ``start``. This latter
address is a hint only, and is usually specified as 0.
Suitable length and offset parameters are queried with the
-:ref:`VIDIOC_QUERYBUF <VIDIOC_QUERYBUF>` ioctl. Buffers must be
-allocated with the :ref:`VIDIOC_REQBUFS <VIDIOC_REQBUFS>` ioctl
+:ref:`VIDIOC_QUERYBUF` ioctl. Buffers must be
+allocated with the :ref:`VIDIOC_REQBUFS` ioctl
before they can be queried.
To unmap buffers the :ref:`munmap() <func-munmap>` function is used.
@@ -125,7 +125,7 @@ EINVAL
The ``flags`` or ``prot`` value is not supported.
No buffers have been allocated with the
- :ref:`VIDIOC_REQBUFS <VIDIOC_REQBUFS>` ioctl.
+ :ref:`VIDIOC_REQBUFS` ioctl.
ENOMEM
Not enough physical or virtual memory was available to complete the
diff --git a/Documentation/linux_tv/media/v4l/func-poll.rst b/Documentation/linux_tv/media/v4l/func-poll.rst
index 28a769af9309..782531fe964c 100644
--- a/Documentation/linux_tv/media/v4l/func-poll.rst
+++ b/Documentation/linux_tv/media/v4l/func-poll.rst
@@ -32,7 +32,7 @@ When streaming I/O has been negotiated this function waits until a
buffer has been filled by the capture device and can be dequeued with
the :ref:`VIDIOC_DQBUF <VIDIOC_QBUF>` ioctl. For output devices this
function waits until the device is ready to accept a new buffer to be
-queued up with the :ref:`VIDIOC_QBUF <VIDIOC_QBUF>` ioctl for
+queued up with the :ref:`VIDIOC_QBUF` ioctl for
display. When buffers are already in the outgoing queue of the driver
(capture) or the incoming queue isn't full (display) the function
returns immediately.
@@ -45,17 +45,17 @@ flags in the ``revents`` field, output devices the ``POLLOUT`` and
``POLLWRNORM`` flags. When the function timed out it returns a value of
zero, on failure it returns -1 and the ``errno`` variable is set
appropriately. When the application did not call
-:ref:`VIDIOC_STREAMON <VIDIOC_STREAMON>` the :c:func:`poll()`
+:ref:`VIDIOC_STREAMON` the :c:func:`poll()`
function succeeds, but sets the ``POLLERR`` flag in the ``revents``
field. When the application has called
-:ref:`VIDIOC_STREAMON <VIDIOC_STREAMON>` for a capture device but
-hasn't yet called :ref:`VIDIOC_QBUF <VIDIOC_QBUF>`, the
+:ref:`VIDIOC_STREAMON` for a capture device but
+hasn't yet called :ref:`VIDIOC_QBUF`, the
:c:func:`poll()` function succeeds and sets the ``POLLERR`` flag in
the ``revents`` field. For output devices this same situation will cause
:c:func:`poll()` to succeed as well, but it sets the ``POLLOUT`` and
``POLLWRNORM`` flags in the ``revents`` field.
-If an event occurred (see :ref:`VIDIOC_DQEVENT <VIDIOC_DQEVENT>`)
+If an event occurred (see :ref:`VIDIOC_DQEVENT`)
then ``POLLPRI`` will be set in the ``revents`` field and
:c:func:`poll()` will return.
diff --git a/Documentation/linux_tv/media/v4l/func-read.rst b/Documentation/linux_tv/media/v4l/func-read.rst
index 497bc9a9dd5a..0eae26288189 100644
--- a/Documentation/linux_tv/media/v4l/func-read.rst
+++ b/Documentation/linux_tv/media/v4l/func-read.rst
@@ -85,7 +85,7 @@ enough. Again, the behavior when the driver runs out of free buffers
depends on the discarding policy.
Applications can get and set the number of buffers used internally by
-the driver with the :ref:`VIDIOC_G_PARM <VIDIOC_G_PARM>` and
+the driver with the :ref:`VIDIOC_G_PARM` and
:ref:`VIDIOC_S_PARM <VIDIOC_G_PARM>` ioctls. They are optional,
however. The discarding policy is not reported and cannot be changed.
For minimum requirements see :ref:`devices`.
diff --git a/Documentation/linux_tv/media/v4l/func-select.rst b/Documentation/linux_tv/media/v4l/func-select.rst
index 77fdf33648b3..77302800e6ca 100644
--- a/Documentation/linux_tv/media/v4l/func-select.rst
+++ b/Documentation/linux_tv/media/v4l/func-select.rst
@@ -39,8 +39,8 @@ On success :c:func:`select()` returns the total number of bits set in
the :c:type:`struct fd_set`s. When the function timed out it returns
a value of zero. On failure it returns -1 and the ``errno`` variable is
set appropriately. When the application did not call
-:ref:`VIDIOC_QBUF <VIDIOC_QBUF>` or
-:ref:`VIDIOC_STREAMON <VIDIOC_STREAMON>` yet the :c:func:`select()`
+:ref:`VIDIOC_QBUF` or
+:ref:`VIDIOC_STREAMON` yet the :c:func:`select()`
function succeeds, setting the bit of the file descriptor in ``readfds``
or ``writefds``, but subsequent :ref:`VIDIOC_DQBUF <VIDIOC_QBUF>`
calls will fail. [1]_
diff --git a/Documentation/linux_tv/media/v4l/hist-v4l2.rst b/Documentation/linux_tv/media/v4l/hist-v4l2.rst
index ab18331710f7..4bd621b3aa03 100644
--- a/Documentation/linux_tv/media/v4l/hist-v4l2.rst
+++ b/Documentation/linux_tv/media/v4l/hist-v4l2.rst
@@ -38,10 +38,10 @@ enumerable.
1998-10-02: The ``id`` field was removed from struct
:c:type:`struct video_standard` and the color subcarrier fields were
-renamed. The :ref:`VIDIOC_QUERYSTD <VIDIOC_QUERYSTD>` ioctl was
-renamed to :ref:`VIDIOC_ENUMSTD <VIDIOC_ENUMSTD>`,
-:ref:`VIDIOC_G_INPUT <VIDIOC_G_INPUT>` to
-:ref:`VIDIOC_ENUMINPUT <VIDIOC_ENUMINPUT>`. A first draft of the
+renamed. The :ref:`VIDIOC_QUERYSTD` ioctl was
+renamed to :ref:`VIDIOC_ENUMSTD`,
+:ref:`VIDIOC_G_INPUT` to
+:ref:`VIDIOC_ENUMINPUT`. A first draft of the
Codec API was released.
1998-11-08: Many minor changes. Most symbols have been renamed. Some
@@ -52,7 +52,7 @@ material changes to struct :ref:`v4l2_capability <v4l2-capability>`.
1998-11-14: ``V4L2_PIX_FMT_RGB24`` changed to ``V4L2_PIX_FMT_BGR24``,
and ``V4L2_PIX_FMT_RGB32`` changed to ``V4L2_PIX_FMT_BGR32``. Audio
controls are now accessible with the
-:ref:`VIDIOC_G_CTRL <VIDIOC_G_CTRL>` and
+:ref:`VIDIOC_G_CTRL` and
:ref:`VIDIOC_S_CTRL <VIDIOC_G_CTRL>` ioctls under names starting
with ``V4L2_CID_AUDIO``. The ``V4L2_MAJOR`` define was removed from
``videodev.h`` since it was only used once in the ``videodev`` kernel
@@ -142,7 +142,7 @@ common Linux driver API conventions.
int a = V4L2_XXX; err = ioctl(fd, VIDIOC_XXX, &a);
4. All the different get- and set-format commands were swept into one
- :ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>` and
+ :ref:`VIDIOC_G_FMT` and
:ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl taking a union and a
type field selecting the union member as parameter. Purpose is to
simplify the API by eliminating several ioctls and to allow new and
@@ -246,13 +246,13 @@ correctly through the backward compatibility layer. [Solution?]
2001-04-13: Big endian 16-bit RGB formats were added.
2001-09-17: New YUV formats and the
-:ref:`VIDIOC_G_FREQUENCY <VIDIOC_G_FREQUENCY>` and
+:ref:`VIDIOC_G_FREQUENCY` and
:ref:`VIDIOC_S_FREQUENCY <VIDIOC_G_FREQUENCY>` ioctls were added.
(The old ``VIDIOC_G_FREQ`` and ``VIDIOC_S_FREQ`` ioctls did not take
multiple tuners into account.)
2000-09-18: ``V4L2_BUF_TYPE_VBI`` was added. This may *break
-compatibility* as the :ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>` and
+compatibility* as the :ref:`VIDIOC_G_FMT` and
:ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctls may fail now if the struct
:c:type:`struct v4l2_fmt` ``type`` field does not contain
``V4L2_BUF_TYPE_VBI``. In the documentation of the struct
@@ -325,7 +325,7 @@ This unnamed version was finally merged into Linux 2.5.46.
dramatically. Note that also the size of the structure changed,
which is encoded in the ioctl request code, thus older V4L2 devices
will respond with an EINVAL error code to the new
- :ref:`VIDIOC_QUERYCAP <VIDIOC_QUERYCAP>` ioctl.
+ :ref:`VIDIOC_QUERYCAP` ioctl.
There are new fields to identify the driver, a new RDS device
function ``V4L2_CAP_RDS_CAPTURE``, the ``V4L2_CAP_AUDIO`` flag
@@ -401,13 +401,13 @@ This unnamed version was finally merged into Linux 2.5.46.
supported standards with an ioctl applications can now refer to
standards by :ref:`v4l2_std_id <v4l2-std-id>` and symbols
defined in the ``videodev2.h`` header file. For details see
- :ref:`standard`. The :ref:`VIDIOC_G_STD <VIDIOC_G_STD>` and
+ :ref:`standard`. The :ref:`VIDIOC_G_STD` and
:ref:`VIDIOC_S_STD <VIDIOC_G_STD>` now take a pointer to this
- type as argument. :ref:`VIDIOC_QUERYSTD <VIDIOC_QUERYSTD>` was
+ type as argument. :ref:`VIDIOC_QUERYSTD` was
added to autodetect the received standard, if the hardware has this
capability. In struct :ref:`v4l2_standard <v4l2-standard>` an
``index`` field was added for
- :ref:`VIDIOC_ENUMSTD <VIDIOC_ENUMSTD>`. A
+ :ref:`VIDIOC_ENUMSTD`. A
:ref:`v4l2_std_id <v4l2-std-id>` field named ``id`` was added as
machine readable identifier, also replacing the ``transmission``
field. The misleading ``framerate`` field was renamed to
@@ -416,7 +416,7 @@ This unnamed version was finally merged into Linux 2.5.46.
removed.
Struct :c:type:`struct v4l2_enumstd` ceased to be.
- :ref:`VIDIOC_ENUMSTD <VIDIOC_ENUMSTD>` now takes a pointer to a
+ :ref:`VIDIOC_ENUMSTD` now takes a pointer to a
struct :ref:`v4l2_standard <v4l2-standard>` directly. The
information which standards are supported by a particular video
input or output moved into struct :ref:`v4l2_input <v4l2-input>`
@@ -538,7 +538,7 @@ This unnamed version was finally merged into Linux 2.5.46.
added as in struct :ref:`v4l2_format <v4l2-format>`. The
``VIDIOC_ENUM_FBUFFMT`` ioctl is no longer needed and was removed.
These calls can be replaced by
- :ref:`VIDIOC_ENUM_FMT <VIDIOC_ENUM_FMT>` with type
+ :ref:`VIDIOC_ENUM_FMT` with type
``V4L2_BUF_TYPE_VIDEO_OVERLAY``.
11. In struct :ref:`v4l2_pix_format <v4l2-pix-format>` the ``depth``
@@ -716,14 +716,14 @@ V4L2 2003-06-19
3. The audio input and output interface was found to be incomplete.
- Previously the :ref:`VIDIOC_G_AUDIO <VIDIOC_G_AUDIO>` ioctl would
+ Previously the :ref:`VIDIOC_G_AUDIO` ioctl would
enumerate the available audio inputs. An ioctl to determine the
current audio input, if more than one combines with the current video
input, did not exist. So ``VIDIOC_G_AUDIO`` was renamed to
``VIDIOC_G_AUDIO_OLD``, this ioctl was removed on Kernel 2.6.39. The
- :ref:`VIDIOC_ENUMAUDIO <VIDIOC_ENUMAUDIO>` ioctl was added to
+ :ref:`VIDIOC_ENUMAUDIO` ioctl was added to
enumerate audio inputs, while
- :ref:`VIDIOC_G_AUDIO <VIDIOC_G_AUDIO>` now reports the current
+ :ref:`VIDIOC_G_AUDIO` now reports the current
audio input.
The same changes were made to
@@ -734,7 +734,7 @@ V4L2 2003-06-19
between the old and new ioctls, but drivers and applications must be
updated to successfully compile again.
-4. The :ref:`VIDIOC_OVERLAY <VIDIOC_OVERLAY>` ioctl was incorrectly
+4. The :ref:`VIDIOC_OVERLAY` ioctl was incorrectly
defined with write-read parameter. It was changed to write-only,
while the write-read version was renamed to ``VIDIOC_OVERLAY_OLD``.
The old ioctl was removed on Kernel 2.6.39. Until further the
@@ -824,7 +824,7 @@ V4L2 2003-11-05
V4L2 in Linux 2.6.6, 2004-05-09
===============================
-1. The :ref:`VIDIOC_CROPCAP <VIDIOC_CROPCAP>` ioctl was incorrectly
+1. The :ref:`VIDIOC_CROPCAP` ioctl was incorrectly
defined with read-only parameter. It is now defined as write-read
ioctl, while the read-only version was renamed to
``VIDIOC_CROPCAP_OLD``. The old ioctl was removed on Kernel 2.6.39.
@@ -852,7 +852,7 @@ V4L2 spec erratum 2004-08-01
3. In the Current Audio Input example the ``VIDIOC_G_AUDIO`` ioctl took
the wrong argument.
-4. The documentation of the :ref:`VIDIOC_QBUF <VIDIOC_QBUF>` and
+4. The documentation of the :ref:`VIDIOC_QBUF` and
:ref:`VIDIOC_DQBUF <VIDIOC_QBUF>` ioctls did not mention the
struct :ref:`v4l2_buffer <v4l2-buffer>` ``memory`` field. It was
also missing from examples. Also on the ``VIDIOC_DQBUF`` page the EIO
@@ -870,7 +870,7 @@ V4L2 in Linux 2.6.14
V4L2 in Linux 2.6.15
====================
-1. The :ref:`VIDIOC_LOG_STATUS <VIDIOC_LOG_STATUS>` ioctl was added.
+1. The :ref:`VIDIOC_LOG_STATUS` ioctl was added.
2. New video standards ``V4L2_STD_NTSC_443``, ``V4L2_STD_SECAM_LC``,
``V4L2_STD_SECAM_DK`` (a set of SECAM D, K and K1), and
@@ -940,7 +940,7 @@ V4L2 in Linux 2.6.17
2. A new ``V4L2_TUNER_MODE_LANG1_LANG2`` was defined to record both
languages of a bilingual program. The use of
``V4L2_TUNER_MODE_STEREO`` for this purpose is deprecated now. See
- the :ref:`VIDIOC_G_TUNER <VIDIOC_G_TUNER>` section for details.
+ the :ref:`VIDIOC_G_TUNER` section for details.
V4L2 spec erratum 2006-09-23 (Draft 0.15)
@@ -976,11 +976,11 @@ V4L2 spec erratum 2006-09-23 (Draft 0.15)
V4L2 in Linux 2.6.18
====================
-1. New ioctls :ref:`VIDIOC_G_EXT_CTRLS <VIDIOC_G_EXT_CTRLS>`,
+1. New ioctls :ref:`VIDIOC_G_EXT_CTRLS`,
:ref:`VIDIOC_S_EXT_CTRLS <VIDIOC_G_EXT_CTRLS>` and
:ref:`VIDIOC_TRY_EXT_CTRLS <VIDIOC_G_EXT_CTRLS>` were added, a
flag to skip unsupported controls with
- :ref:`VIDIOC_QUERYCTRL <VIDIOC_QUERYCTRL>`, new control types
+ :ref:`VIDIOC_QUERYCTRL`, new control types
``V4L2_CTRL_TYPE_INTEGER64`` and ``V4L2_CTRL_TYPE_CTRL_CLASS``
(:ref:`v4l2-ctrl-type`), and new control flags
``V4L2_CTRL_FLAG_READ_ONLY``, ``V4L2_CTRL_FLAG_UPDATE``,
@@ -995,15 +995,15 @@ V4L2 in Linux 2.6.19
buffer type field was added replacing a reserved field. Note on
architectures where the size of enum types differs from int types the
size of the structure changed. The
- :ref:`VIDIOC_G_SLICED_VBI_CAP <VIDIOC_G_SLICED_VBI_CAP>` ioctl
+ :ref:`VIDIOC_G_SLICED_VBI_CAP` ioctl
was redefined from being read-only to write-read. Applications must
initialize the type field and clear the reserved fields now. These
changes may *break the compatibility* with older drivers and
applications.
-2. The ioctls :ref:`VIDIOC_ENUM_FRAMESIZES <VIDIOC_ENUM_FRAMESIZES>`
+2. The ioctls :ref:`VIDIOC_ENUM_FRAMESIZES`
and
- :ref:`VIDIOC_ENUM_FRAMEINTERVALS <VIDIOC_ENUM_FRAMEINTERVALS>`
+ :ref:`VIDIOC_ENUM_FRAMEINTERVALS`
were added.
3. A new pixel format ``V4L2_PIX_FMT_RGB444`` (:ref:`rgb-formats`) was
@@ -1034,7 +1034,7 @@ V4L2 in Linux 2.6.22
2. Three new clipping/blending methods with a global or straight or
inverted local alpha value were added to the video overlay interface.
- See the description of the :ref:`VIDIOC_G_FBUF <VIDIOC_G_FBUF>`
+ See the description of the :ref:`VIDIOC_G_FBUF`
and :ref:`VIDIOC_S_FBUF <VIDIOC_G_FBUF>` ioctls for details.
A new ``global_alpha`` field was added to
@@ -1100,7 +1100,7 @@ V4L2 in Linux 2.6.26
V4L2 in Linux 2.6.27
====================
-1. The :ref:`VIDIOC_S_HW_FREQ_SEEK <VIDIOC_S_HW_FREQ_SEEK>` ioctl
+1. The :ref:`VIDIOC_S_HW_FREQ_SEEK` ioctl
and the ``V4L2_CAP_HW_FREQ_SEEK`` capability were added.
2. The pixel formats ``V4L2_PIX_FMT_YVYU``, ``V4L2_PIX_FMT_PCA501``,
@@ -1244,9 +1244,9 @@ V4L2 in Linux 3.4
1. Added :ref:`JPEG compression control class <jpeg-controls>`.
2. Extended the DV Timings API:
- :ref:`VIDIOC_ENUM_DV_TIMINGS <VIDIOC_ENUM_DV_TIMINGS>`,
- :ref:`VIDIOC_QUERY_DV_TIMINGS <VIDIOC_QUERY_DV_TIMINGS>` and
- :ref:`VIDIOC_DV_TIMINGS_CAP <VIDIOC_DV_TIMINGS_CAP>`.
+ :ref:`VIDIOC_ENUM_DV_TIMINGS`,
+ :ref:`VIDIOC_QUERY_DV_TIMINGS` and
+ :ref:`VIDIOC_DV_TIMINGS_CAP`.
V4L2 in Linux 3.5
@@ -1256,7 +1256,7 @@ V4L2 in Linux 3.5
V4L2_CTRL_TYPE_INTEGER_MENU.
2. Added selection API for V4L2 subdev interface:
- :ref:`VIDIOC_SUBDEV_G_SELECTION <VIDIOC_SUBDEV_G_SELECTION>` and
+ :ref:`VIDIOC_SUBDEV_G_SELECTION` and
:ref:`VIDIOC_SUBDEV_S_SELECTION <VIDIOC_SUBDEV_G_SELECTION>`.
3. Added ``V4L2_COLORFX_ANTIQUE``, ``V4L2_COLORFX_ART_FREEZE``,
@@ -1286,7 +1286,7 @@ V4L2 in Linux 3.6
capabilities.
3. Added support for frequency band enumerations:
- :ref:`VIDIOC_ENUM_FREQ_BANDS <VIDIOC_ENUM_FREQ_BANDS>`.
+ :ref:`VIDIOC_ENUM_FREQ_BANDS`.
V4L2 in Linux 3.9
@@ -1308,7 +1308,7 @@ V4L2 in Linux 3.10
capability flags V4L2_IN_CAP_PRESETS and V4L2_OUT_CAP_PRESETS.
2. Added new debugging ioctl
- :ref:`VIDIOC_DBG_G_CHIP_INFO <VIDIOC_DBG_G_CHIP_INFO>`.
+ :ref:`VIDIOC_DBG_G_CHIP_INFO`.
V4L2 in Linux 3.11
@@ -1452,10 +1452,10 @@ Experimental API Elements
The following V4L2 API elements are currently experimental and may
change in the future.
-- :ref:`VIDIOC_DBG_G_REGISTER <VIDIOC_DBG_G_REGISTER>` and
+- :ref:`VIDIOC_DBG_G_REGISTER` and
:ref:`VIDIOC_DBG_S_REGISTER <VIDIOC_DBG_G_REGISTER>` ioctls.
-- :ref:`VIDIOC_DBG_G_CHIP_INFO <VIDIOC_DBG_G_CHIP_INFO>` ioctl.
+- :ref:`VIDIOC_DBG_G_CHIP_INFO` ioctl.
.. _obsolete:
diff --git a/Documentation/linux_tv/media/v4l/io.rst b/Documentation/linux_tv/media/v4l/io.rst
index 2bc04e597c90..651d4530c703 100644
--- a/Documentation/linux_tv/media/v4l/io.rst
+++ b/Documentation/linux_tv/media/v4l/io.rst
@@ -16,7 +16,7 @@ read or write will fail at any time.
Other methods must be negotiated. To select the streaming I/O method
with memory mapped or user buffers applications call the
-:ref:`VIDIOC_REQBUFS <VIDIOC_REQBUFS>` ioctl. The asynchronous I/O
+:ref:`VIDIOC_REQBUFS` ioctl. The asynchronous I/O
method is not defined yet.
Video overlay can be considered another I/O method, although the
diff --git a/Documentation/linux_tv/media/v4l/libv4l-introduction.rst b/Documentation/linux_tv/media/v4l/libv4l-introduction.rst
index 4fd87ec33260..bc3eb48e1d9f 100644
--- a/Documentation/linux_tv/media/v4l/libv4l-introduction.rst
+++ b/Documentation/linux_tv/media/v4l/libv4l-introduction.rst
@@ -92,16 +92,16 @@ and to enhance the image quality.
In most cases, libv4l2 just passes the calls directly through to the
v4l2 driver, intercepting the calls to
:ref:`VIDIOC_TRY_FMT <VIDIOC_G_FMT>`,
-:ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>`
+:ref:`VIDIOC_G_FMT`
:ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>`
-:ref:`VIDIOC_ENUM_FRAMESIZES <VIDIOC_ENUM_FRAMESIZES>` and
-:ref:`VIDIOC_ENUM_FRAMEINTERVALS <VIDIOC_ENUM_FRAMEINTERVALS>` in
+:ref:`VIDIOC_ENUM_FRAMESIZES` and
+:ref:`VIDIOC_ENUM_FRAMEINTERVALS` in
order to emulate the formats
:ref:`V4L2_PIX_FMT_BGR24 <V4L2-PIX-FMT-BGR24>`,
:ref:`V4L2_PIX_FMT_RGB24 <V4L2-PIX-FMT-RGB24>`,
:ref:`V4L2_PIX_FMT_YUV420 <V4L2-PIX-FMT-YUV420>`, and
:ref:`V4L2_PIX_FMT_YVU420 <V4L2-PIX-FMT-YVU420>`, if they aren't
-available in the driver. :ref:`VIDIOC_ENUM_FMT <VIDIOC_ENUM_FMT>`
+available in the driver. :ref:`VIDIOC_ENUM_FMT`
keeps enumerating the hardware supported formats, plus the emulated
formats offered by libv4l at the end.
diff --git a/Documentation/linux_tv/media/v4l/mmap.rst b/Documentation/linux_tv/media/v4l/mmap.rst
index de144028ec56..2013e882f0d4 100644
--- a/Documentation/linux_tv/media/v4l/mmap.rst
+++ b/Documentation/linux_tv/media/v4l/mmap.rst
@@ -9,10 +9,10 @@ Streaming I/O (Memory Mapping)
Input and output devices support this I/O method when the
``V4L2_CAP_STREAMING`` flag in the ``capabilities`` field of struct
:ref:`v4l2_capability <v4l2-capability>` returned by the
-:ref:`VIDIOC_QUERYCAP <VIDIOC_QUERYCAP>` ioctl is set. There are two
+:ref:`VIDIOC_QUERYCAP` ioctl is set. There are two
streaming methods, to determine if the memory mapping flavor is
supported applications must call the
-:ref:`VIDIOC_REQBUFS <VIDIOC_REQBUFS>` ioctl.
+:ref:`VIDIOC_REQBUFS` ioctl.
Streaming is an I/O method where only pointers to buffers are exchanged
between application and driver, the data itself is not copied. Memory
@@ -29,7 +29,7 @@ a different type of data. To access different sets at the same time
different file descriptors must be used. [1]_
To allocate device buffers applications call the
-:ref:`VIDIOC_REQBUFS <VIDIOC_REQBUFS>` ioctl with the desired number
+:ref:`VIDIOC_REQBUFS` ioctl with the desired number
of buffers and buffer type, for example ``V4L2_BUF_TYPE_VIDEO_CAPTURE``.
This ioctl can also be used to change the number of buffers or to free
the allocated memory, provided none of the buffers are still mapped.
@@ -37,7 +37,7 @@ the allocated memory, provided none of the buffers are still mapped.
Before applications can access the buffers they must map them into their
address space with the :ref:`mmap() <func-mmap>` function. The
location of the buffers in device memory can be determined with the
-:ref:`VIDIOC_QUERYBUF <VIDIOC_QUERYBUF>` ioctl. In the single-planar
+:ref:`VIDIOC_QUERYBUF` ioctl. In the single-planar
API case, the ``m.offset`` and ``length`` returned in a struct
:ref:`v4l2_buffer <v4l2-buffer>` are passed as sixth and second
parameter to the :c:func:`mmap()` function. When using the
@@ -227,10 +227,10 @@ when the application runs out of free buffers, it must wait until an
empty buffer can be dequeued and reused.
To enqueue and dequeue a buffer applications use the
-:ref:`VIDIOC_QBUF <VIDIOC_QBUF>` and
+:ref:`VIDIOC_QBUF` and
:ref:`VIDIOC_DQBUF <VIDIOC_QBUF>` ioctl. The status of a buffer being
mapped, enqueued, full or empty can be determined at any time using the
-:ref:`VIDIOC_QUERYBUF <VIDIOC_QUERYBUF>` ioctl. Two methods exist to
+:ref:`VIDIOC_QUERYBUF` ioctl. Two methods exist to
suspend execution of the application until one or more buffers can be
dequeued. By default ``VIDIOC_DQBUF`` blocks when no buffer is in the
outgoing queue. When the ``O_NONBLOCK`` flag was given to the
@@ -240,7 +240,7 @@ immediately with an EAGAIN error code when no buffer is available. The
are always available.
To start and stop capturing or output applications call the
-:ref:`VIDIOC_STREAMON <VIDIOC_STREAMON>` and
+:ref:`VIDIOC_STREAMON` and
:ref:`VIDIOC_STREAMOFF <VIDIOC_STREAMON>` ioctl. Note
``VIDIOC_STREAMOFF`` removes all buffers from both queues as a side
effect. Since there is no notion of doing anything "now" on a
@@ -258,7 +258,7 @@ the :c:func:`mmap()`, :c:func:`munmap()`, :c:func:`select()` and
.. [1]
One could use one file descriptor and set the buffer type field
- accordingly when calling :ref:`VIDIOC_QBUF <VIDIOC_QBUF>` etc.,
+ accordingly when calling :ref:`VIDIOC_QBUF` etc.,
but it makes the :c:func:`select()` function ambiguous. We also
like the clean approach of one file descriptor per logical stream.
Video overlay for example is also a logical stream, although the CPU
diff --git a/Documentation/linux_tv/media/v4l/open.rst b/Documentation/linux_tv/media/v4l/open.rst
index 4c34d61a5253..ec6b456e37f0 100644
--- a/Documentation/linux_tv/media/v4l/open.rst
+++ b/Documentation/linux_tv/media/v4l/open.rst
@@ -108,8 +108,8 @@ are comparable to an ALSA audio mixer application. Just opening a V4L2
device should not change the state of the device. [2]_
Once an application has allocated the memory buffers needed for
-streaming data (by calling the :ref:`VIDIOC_REQBUFS <VIDIOC_REQBUFS>`
-or :ref:`VIDIOC_CREATE_BUFS <VIDIOC_CREATE_BUFS>` ioctls, or
+streaming data (by calling the :ref:`VIDIOC_REQBUFS`
+or :ref:`VIDIOC_CREATE_BUFS` ioctls, or
implicitly by calling the :ref:`read() <func-read>` or
:ref:`write() <func-write>` functions) that application (filehandle)
becomes the owner of the device. It is no longer allowed to make changes
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-013.rst b/Documentation/linux_tv/media/v4l/pixfmt-013.rst
index b3cb7c48eb74..7584cb2e5702 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-013.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-013.rst
@@ -27,7 +27,7 @@ Compressed Formats
- 'JPEG'
- - TBD. See also :ref:`VIDIOC_G_JPEGCOMP <VIDIOC_G_JPEGCOMP>`,
+ - TBD. See also :ref:`VIDIOC_G_JPEGCOMP`,
:ref:`VIDIOC_S_JPEGCOMP <VIDIOC_G_JPEGCOMP>`.
- .. _`V4L2-PIX-FMT-MPEG`:
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-packed-rgb.rst b/Documentation/linux_tv/media/v4l/pixfmt-packed-rgb.rst
index 2caf9ccea69a..2b4a6c725d4c 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-packed-rgb.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-packed-rgb.rst
@@ -967,7 +967,7 @@ XBGR) must be used instead of an alpha format.
The XRGB and XBGR formats contain undefined bits (-). Applications,
devices and drivers must ignore those bits, for both
-:ref:`capture <capture>` and :ref:`output <output>` devices.
+:ref:`capture` and :ref:`output` devices.
**Byte Order..**
diff --git a/Documentation/linux_tv/media/v4l/pixfmt.rst b/Documentation/linux_tv/media/v4l/pixfmt.rst
index f2c599aaa502..b0e6a95a7205 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt.rst
@@ -13,7 +13,7 @@ single-planar API, while the latter is used with the multi-planar
version (see :ref:`planar-apis`). Image formats are negotiated with
the :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl. (The explanations here
focus on video capturing and output, for overlay frame buffer formats
-see also :ref:`VIDIOC_G_FBUF <VIDIOC_G_FBUF>`.)
+see also :ref:`VIDIOC_G_FBUF`.)
.. toctree::
diff --git a/Documentation/linux_tv/media/v4l/planar-apis.rst b/Documentation/linux_tv/media/v4l/planar-apis.rst
index 017f412a6231..0546210f868f 100644
--- a/Documentation/linux_tv/media/v4l/planar-apis.rst
+++ b/Documentation/linux_tv/media/v4l/planar-apis.rst
@@ -39,12 +39,12 @@ handle multi-planar formats.
Calls that distinguish between single and multi-planar APIs
===========================================================
-:ref:`VIDIOC_QUERYCAP <VIDIOC_QUERYCAP>`
+:ref:`VIDIOC_QUERYCAP`
Two additional multi-planar capabilities are added. They can be set
together with non-multi-planar ones for devices that handle both
single- and multi-planar formats.
-:ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>`,
+:ref:`VIDIOC_G_FMT`,
:ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>`,
:ref:`VIDIOC_TRY_FMT <VIDIOC_G_FMT>`
New structures for describing multi-planar formats are added: struct
@@ -53,15 +53,15 @@ Calls that distinguish between single and multi-planar APIs
Drivers may define new multi-planar formats, which have distinct
FourCC codes from the existing single-planar ones.
-:ref:`VIDIOC_QBUF <VIDIOC_QBUF>`,
+:ref:`VIDIOC_QBUF`,
:ref:`VIDIOC_DQBUF <VIDIOC_QBUF>`,
-:ref:`VIDIOC_QUERYBUF <VIDIOC_QUERYBUF>`
+:ref:`VIDIOC_QUERYBUF`
A new struct :ref:`v4l2_plane <v4l2-plane>` structure for
describing planes is added. Arrays of this structure are passed in
the new ``m.planes`` field of struct
:ref:`v4l2_buffer <v4l2-buffer>`.
-:ref:`VIDIOC_REQBUFS <VIDIOC_REQBUFS>`
+:ref:`VIDIOC_REQBUFS`
Will allocate multi-planar buffers as requested.
diff --git a/Documentation/linux_tv/media/v4l/querycap.rst b/Documentation/linux_tv/media/v4l/querycap.rst
index d8f080a68195..bb905eb82c08 100644
--- a/Documentation/linux_tv/media/v4l/querycap.rst
+++ b/Documentation/linux_tv/media/v4l/querycap.rst
@@ -11,26 +11,26 @@ are equally applicable to all types of devices. Furthermore devices of
the same type have different capabilities and this specification permits
the omission of a few complicated and less important parts of the API.
-The :ref:`VIDIOC_QUERYCAP <VIDIOC_QUERYCAP>` ioctl is available to
+The :ref:`VIDIOC_QUERYCAP` ioctl is available to
check if the kernel device is compatible with this specification, and to
query the :ref:`functions <devices>` and :ref:`I/O methods <io>`
supported by the device.
-Starting with kernel version 3.1, :ref:`VIDIOC_QUERYCAP <VIDIOC_QUERYCAP>`
+Starting with kernel version 3.1, :ref:`VIDIOC_QUERYCAP`
will return the V4L2 API version used by the driver, with generally
matches the Kernel version. There's no need of using
-:ref:`VIDIOC_QUERYCAP <VIDIOC_QUERYCAP>` to check if a specific ioctl
+:ref:`VIDIOC_QUERYCAP` to check if a specific ioctl
is supported, the V4L2 core now returns ENOTTY if a driver doesn't
provide support for an ioctl.
Other features can be queried by calling the respective ioctl, for
-example :ref:`VIDIOC_ENUMINPUT <VIDIOC_ENUMINPUT>` to learn about the
+example :ref:`VIDIOC_ENUMINPUT` to learn about the
number, types and names of video connectors on the device. Although
abstraction is a major objective of this API, the
-:ref:`VIDIOC_QUERYCAP <VIDIOC_QUERYCAP>` ioctl also allows driver
+:ref:`VIDIOC_QUERYCAP` ioctl also allows driver
specific applications to reliably identify the driver.
-All V4L2 drivers must support :ref:`VIDIOC_QUERYCAP <VIDIOC_QUERYCAP>`.
+All V4L2 drivers must support :ref:`VIDIOC_QUERYCAP`.
Applications should always call this ioctl after opening the device.
diff --git a/Documentation/linux_tv/media/v4l/rw.rst b/Documentation/linux_tv/media/v4l/rw.rst
index ad365a6e435d..c840ee0fd14c 100644
--- a/Documentation/linux_tv/media/v4l/rw.rst
+++ b/Documentation/linux_tv/media/v4l/rw.rst
@@ -10,7 +10,7 @@ Input and output devices support the :c:func:`read()` and
:c:func:`write()` function, respectively, when the
``V4L2_CAP_READWRITE`` flag in the ``capabilities`` field of struct
:ref:`v4l2_capability <v4l2-capability>` returned by the
-:ref:`VIDIOC_QUERYCAP <VIDIOC_QUERYCAP>` ioctl is set.
+:ref:`VIDIOC_QUERYCAP` ioctl is set.
Drivers may need the CPU to copy the data, but they may also support DMA
to or from user memory, so this I/O method is not necessarily less
diff --git a/Documentation/linux_tv/media/v4l/standard.rst b/Documentation/linux_tv/media/v4l/standard.rst
index da0b8101b6cc..3c0f6cb97f13 100644
--- a/Documentation/linux_tv/media/v4l/standard.rst
+++ b/Documentation/linux_tv/media/v4l/standard.rst
@@ -11,8 +11,8 @@ variations of standards. Each video input and output may support another
set of standards. This set is reported by the ``std`` field of struct
:ref:`v4l2_input <v4l2-input>` and struct
:ref:`v4l2_output <v4l2-output>` returned by the
-:ref:`VIDIOC_ENUMINPUT <VIDIOC_ENUMINPUT>` and
-:ref:`VIDIOC_ENUMOUTPUT <VIDIOC_ENUMOUTPUT>` ioctls, respectively.
+:ref:`VIDIOC_ENUMINPUT` and
+:ref:`VIDIOC_ENUMOUTPUT` ioctls, respectively.
V4L2 defines one bit for each analog video standard currently in use
worldwide, and sets aside bits for driver defined standards, e. g.
@@ -20,7 +20,7 @@ hybrid standards to watch NTSC video tapes on PAL TVs and vice versa.
Applications can use the predefined bits to select a particular
standard, although presenting the user a menu of supported standards is
preferred. To enumerate and query the attributes of the supported
-standards applications use the :ref:`VIDIOC_ENUMSTD <VIDIOC_ENUMSTD>`
+standards applications use the :ref:`VIDIOC_ENUMSTD`
ioctl.
Many of the defined standards are actually just variations of a few
@@ -36,10 +36,10 @@ Composite input may collapse standards, enumerating "PAL-B/G/H/I",
"NTSC-M" and "SECAM-D/K". [1]_
To query and select the standard used by the current video input or
-output applications call the :ref:`VIDIOC_G_STD <VIDIOC_G_STD>` and
+output applications call the :ref:`VIDIOC_G_STD` and
:ref:`VIDIOC_S_STD <VIDIOC_G_STD>` ioctl, respectively. The
*received* standard can be sensed with the
-:ref:`VIDIOC_QUERYSTD <VIDIOC_QUERYSTD>` ioctl. Note that the
+:ref:`VIDIOC_QUERYSTD` ioctl. Note that the
parameter of all these ioctls is a pointer to a
:ref:`v4l2_std_id <v4l2-std-id>` type (a standard set), *not* an
index into the standard enumeration. Drivers must implement all video
diff --git a/Documentation/linux_tv/media/v4l/streaming-par.rst b/Documentation/linux_tv/media/v4l/streaming-par.rst
index bb8100b6ef87..10420478a3b0 100644
--- a/Documentation/linux_tv/media/v4l/streaming-par.rst
+++ b/Documentation/linux_tv/media/v4l/streaming-par.rst
@@ -23,7 +23,7 @@ internally by a driver in read/write mode. For implications see the
section discussing the :ref:`read() <func-read>` function.
To get and set the streaming parameters applications call the
-:ref:`VIDIOC_G_PARM <VIDIOC_G_PARM>` and
+:ref:`VIDIOC_G_PARM` and
:ref:`VIDIOC_S_PARM <VIDIOC_G_PARM>` ioctl, respectively. They take
a pointer to a struct :ref:`v4l2_streamparm <v4l2-streamparm>`, which
contains a union holding separate parameters for input and output
diff --git a/Documentation/linux_tv/media/v4l/tuner.rst b/Documentation/linux_tv/media/v4l/tuner.rst
index 15c2e6c373ab..b1be27bd297e 100644
--- a/Documentation/linux_tv/media/v4l/tuner.rst
+++ b/Documentation/linux_tv/media/v4l/tuner.rst
@@ -14,7 +14,7 @@ Video input devices can have one or more tuners demodulating a RF
signal. Each tuner is associated with one or more video inputs,
depending on the number of RF connectors on the tuner. The ``type``
field of the respective struct :ref:`v4l2_input <v4l2-input>`
-returned by the :ref:`VIDIOC_ENUMINPUT <VIDIOC_ENUMINPUT>` ioctl is
+returned by the :ref:`VIDIOC_ENUMINPUT` ioctl is
set to ``V4L2_INPUT_TYPE_TUNER`` and its ``tuner`` field contains the
index number of the tuner.
@@ -22,7 +22,7 @@ Radio input devices have exactly one tuner with index zero, no video
inputs.
To query and change tuner properties applications use the
-:ref:`VIDIOC_G_TUNER <VIDIOC_G_TUNER>` and
+:ref:`VIDIOC_G_TUNER` and
:ref:`VIDIOC_S_TUNER <VIDIOC_G_TUNER>` ioctls, respectively. The
struct :ref:`v4l2_tuner <v4l2-tuner>` returned by ``VIDIOC_G_TUNER``
also contains signal status information applicable when the tuner of the
@@ -31,7 +31,7 @@ does not switch the current tuner, when there is more than one at all.
The tuner is solely determined by the current video input. Drivers must
support both ioctls and set the ``V4L2_CAP_TUNER`` flag in the struct
:ref:`v4l2_capability <v4l2-capability>` returned by the
-:ref:`VIDIOC_QUERYCAP <VIDIOC_QUERYCAP>` ioctl when the device has
+:ref:`VIDIOC_QUERYCAP` ioctl when the device has
one or more tuners.
@@ -44,7 +44,7 @@ set or video recorder. Each modulator is associated with one or more
video outputs, depending on the number of RF connectors on the
modulator. The ``type`` field of the respective struct
:ref:`v4l2_output <v4l2-output>` returned by the
-:ref:`VIDIOC_ENUMOUTPUT <VIDIOC_ENUMOUTPUT>` ioctl is set to
+:ref:`VIDIOC_ENUMOUTPUT` ioctl is set to
``V4L2_OUTPUT_TYPE_MODULATOR`` and its ``modulator`` field contains the
index number of the modulator.
@@ -59,14 +59,14 @@ functionality. The reason is a limitation with the
cannot specify whether the frequency is for a tuner or a modulator.
To query and change modulator properties applications use the
-:ref:`VIDIOC_G_MODULATOR <VIDIOC_G_MODULATOR>` and
+:ref:`VIDIOC_G_MODULATOR` and
:ref:`VIDIOC_S_MODULATOR <VIDIOC_G_MODULATOR>` ioctl. Note that
``VIDIOC_S_MODULATOR`` does not switch the current modulator, when there
is more than one at all. The modulator is solely determined by the
current video output. Drivers must support both ioctls and set the
``V4L2_CAP_MODULATOR`` flag in the struct
:ref:`v4l2_capability <v4l2-capability>` returned by the
-:ref:`VIDIOC_QUERYCAP <VIDIOC_QUERYCAP>` ioctl when the device has
+:ref:`VIDIOC_QUERYCAP` ioctl when the device has
one or more modulators.
@@ -74,7 +74,7 @@ Radio Frequency
===============
To get and set the tuner or modulator radio frequency applications use
-the :ref:`VIDIOC_G_FREQUENCY <VIDIOC_G_FREQUENCY>` and
+the :ref:`VIDIOC_G_FREQUENCY` and
:ref:`VIDIOC_S_FREQUENCY <VIDIOC_G_FREQUENCY>` ioctl which both take
a pointer to a struct :ref:`v4l2_frequency <v4l2-frequency>`. These
ioctls are used for TV and radio devices alike. Drivers must support
diff --git a/Documentation/linux_tv/media/v4l/userp.rst b/Documentation/linux_tv/media/v4l/userp.rst
index 5433025d41d9..a5426d10ceb8 100644
--- a/Documentation/linux_tv/media/v4l/userp.rst
+++ b/Documentation/linux_tv/media/v4l/userp.rst
@@ -9,10 +9,10 @@ Streaming I/O (User Pointers)
Input and output devices support this I/O method when the
``V4L2_CAP_STREAMING`` flag in the ``capabilities`` field of struct
:ref:`v4l2_capability <v4l2-capability>` returned by the
-:ref:`VIDIOC_QUERYCAP <VIDIOC_QUERYCAP>` ioctl is set. If the
+:ref:`VIDIOC_QUERYCAP` ioctl is set. If the
particular user pointer method (not only memory mapping) is supported
must be determined by calling the
-:ref:`VIDIOC_REQBUFS <VIDIOC_REQBUFS>` ioctl.
+:ref:`VIDIOC_REQBUFS` ioctl.
This I/O method combines advantages of the read/write and memory mapping
methods. Buffers (planes) are allocated by the application itself, and
@@ -21,7 +21,7 @@ data are exchanged, these pointers and meta-information are passed in
struct :ref:`v4l2_buffer <v4l2-buffer>` (or in struct
:ref:`v4l2_plane <v4l2-plane>` in the multi-planar API case). The
driver must be switched into user pointer I/O mode by calling the
-:ref:`VIDIOC_REQBUFS <VIDIOC_REQBUFS>` with the desired buffer type.
+:ref:`VIDIOC_REQBUFS` with the desired buffer type.
No buffers (planes) are allocated beforehand, consequently they are not
indexed and cannot be queried like mapped buffers with the
``VIDIOC_QUERYBUF`` ioctl.
@@ -45,7 +45,7 @@ indexed and cannot be queried like mapped buffers with the
}
Buffer (plane) addresses and sizes are passed on the fly with the
-:ref:`VIDIOC_QBUF <VIDIOC_QBUF>` ioctl. Although buffers are commonly
+:ref:`VIDIOC_QBUF` ioctl. Although buffers are commonly
cycled, applications can pass different addresses and sizes at each
``VIDIOC_QBUF`` call. If required by the hardware the driver swaps
memory pages within physical memory to create a continuous area of
@@ -59,7 +59,7 @@ Filled or displayed buffers are dequeued with the
memory pages at any time between the completion of the DMA and this
ioctl. The memory is also unlocked when
:ref:`VIDIOC_STREAMOFF <VIDIOC_STREAMON>` is called,
-:ref:`VIDIOC_REQBUFS <VIDIOC_REQBUFS>`, or when the device is closed.
+:ref:`VIDIOC_REQBUFS`, or when the device is closed.
Applications must take care not to free buffers without dequeuing. For
once, the buffers remain locked until further, wasting physical memory.
Second the driver will not be notified when the memory is returned to
@@ -82,7 +82,7 @@ immediately with an EAGAIN error code when no buffer is available. The
are always available.
To start and stop capturing or output applications call the
-:ref:`VIDIOC_STREAMON <VIDIOC_STREAMON>` and
+:ref:`VIDIOC_STREAMON` and
:ref:`VIDIOC_STREAMOFF <VIDIOC_STREAMON>` ioctl. Note
``VIDIOC_STREAMOFF`` removes all buffers from both queues and unlocks
all buffers as a side effect. Since there is no notion of doing anything
diff --git a/Documentation/linux_tv/media/v4l/video.rst b/Documentation/linux_tv/media/v4l/video.rst
index e4e543b56989..9f2dc4ee4fcd 100644
--- a/Documentation/linux_tv/media/v4l/video.rst
+++ b/Documentation/linux_tv/media/v4l/video.rst
@@ -14,14 +14,14 @@ Radio devices have no video inputs or outputs.
To learn about the number and attributes of the available inputs and
outputs applications can enumerate them with the
-:ref:`VIDIOC_ENUMINPUT <VIDIOC_ENUMINPUT>` and
-:ref:`VIDIOC_ENUMOUTPUT <VIDIOC_ENUMOUTPUT>` ioctl, respectively. The
+:ref:`VIDIOC_ENUMINPUT` and
+:ref:`VIDIOC_ENUMOUTPUT` ioctl, respectively. The
struct :ref:`v4l2_input <v4l2-input>` returned by the
-:ref:`VIDIOC_ENUMINPUT <VIDIOC_ENUMINPUT>` ioctl also contains signal
+:ref:`VIDIOC_ENUMINPUT` ioctl also contains signal
:status information applicable when the current video input is queried.
-The :ref:`VIDIOC_G_INPUT <VIDIOC_G_INPUT>` and
-:ref:`VIDIOC_G_OUTPUT <VIDIOC_G_OUTPUT>` ioctls return the index of
+The :ref:`VIDIOC_G_INPUT` and
+:ref:`VIDIOC_G_OUTPUT` ioctls return the index of
the current video input or output. To select a different input or output
applications call the :ref:`VIDIOC_S_INPUT <VIDIOC_G_INPUT>` and
:ref:`VIDIOC_S_OUTPUT <VIDIOC_G_OUTPUT>` ioctls. Drivers must
diff --git a/Documentation/linux_tv/media/v4l/vidioc-create-bufs.rst b/Documentation/linux_tv/media/v4l/vidioc-create-bufs.rst
index 9c2a011f389c..9220bcea1259 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-create-bufs.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-create-bufs.rst
@@ -34,7 +34,7 @@ Description
This ioctl is used to create buffers for :ref:`memory mapped <mmap>`
or :ref:`user pointer <userp>` or :ref:`DMA buffer <dmabuf>` I/O. It
can be used as an alternative or in addition to the
-:ref:`VIDIOC_REQBUFS <VIDIOC_REQBUFS>` ioctl, when a tighter control
+:ref:`VIDIOC_REQBUFS` ioctl, when a tighter control
over buffers is required. This ioctl can be called multiple times to
create buffers of different sizes.
@@ -48,7 +48,7 @@ The ``format`` field specifies the image format that the buffers must be
able to handle. The application has to fill in this struct
:ref:`v4l2_format <v4l2-format>`. Usually this will be done using the
:ref:`VIDIOC_TRY_FMT <VIDIOC_G_FMT>` or
-:ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>` ioctls to ensure that the
+:ref:`VIDIOC_G_FMT` ioctls to ensure that the
requested format is supported by the driver. Based on the format's
``type`` field the requested buffer size (for single-planar) or plane
sizes (for multi-planar formats) will be used for the allocated buffers.
diff --git a/Documentation/linux_tv/media/v4l/vidioc-dbg-g-chip-info.rst b/Documentation/linux_tv/media/v4l/vidioc-dbg-g-chip-info.rst
index 0a92e2550ce0..12c2e5df48ac 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-dbg-g-chip-info.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-dbg-g-chip-info.rst
@@ -33,7 +33,7 @@ Description
**Note**
- This is an :ref:`experimental <experimental>` interface and may
+ This is an :ref:`experimental` interface and may
change in the future.
For driver debugging purposes this ioctl allows test applications to
diff --git a/Documentation/linux_tv/media/v4l/vidioc-dbg-g-register.rst b/Documentation/linux_tv/media/v4l/vidioc-dbg-g-register.rst
index 1b86abcc44c7..b50c1be72f15 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-dbg-g-register.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-dbg-g-register.rst
@@ -36,7 +36,7 @@ Description
**Note**
- This is an :ref:`experimental <experimental>` interface and may
+ This is an :ref:`experimental` interface and may
change in the future.
For driver debugging purposes these ioctls allow test applications to
@@ -65,14 +65,14 @@ When ``match.type`` is ``V4L2_CHIP_MATCH_BRIDGE``, ``match.addr``
selects the nth non-sub-device chip on the TV card. The number zero
always selects the host chip, e. g. the chip connected to the PCI or USB
bus. You can find out which chips are present with the
-:ref:`VIDIOC_DBG_G_CHIP_INFO <VIDIOC_DBG_G_CHIP_INFO>` ioctl.
+:ref:`VIDIOC_DBG_G_CHIP_INFO` ioctl.
When ``match.type`` is ``V4L2_CHIP_MATCH_SUBDEV``, ``match.addr``
selects the nth sub-device.
These ioctls are optional, not all drivers may support them. However
when a driver supports these ioctls it must also support
-:ref:`VIDIOC_DBG_G_CHIP_INFO <VIDIOC_DBG_G_CHIP_INFO>`. Conversely
+:ref:`VIDIOC_DBG_G_CHIP_INFO`. Conversely
it may support ``VIDIOC_DBG_G_CHIP_INFO`` but not these ioctls.
``VIDIOC_DBG_G_REGISTER`` and ``VIDIOC_DBG_S_REGISTER`` were introduced
diff --git a/Documentation/linux_tv/media/v4l/vidioc-decoder-cmd.rst b/Documentation/linux_tv/media/v4l/vidioc-decoder-cmd.rst
index ec9dfed09f76..a56c5fc1ed6f 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-decoder-cmd.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-decoder-cmd.rst
@@ -43,7 +43,7 @@ this structure.
The ``cmd`` field must contain the command code. Some commands use the
``flags`` field for additional information.
-A :c:func:`write()`() or :ref:`VIDIOC_STREAMON <VIDIOC_STREAMON>`
+A :c:func:`write()`() or :ref:`VIDIOC_STREAMON`
call sends an implicit START command to the decoder if it has not been
started yet.
diff --git a/Documentation/linux_tv/media/v4l/vidioc-dqevent.rst b/Documentation/linux_tv/media/v4l/vidioc-dqevent.rst
index 45320997344d..9e41fc818b90 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-dqevent.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-dqevent.rst
@@ -363,7 +363,7 @@ call.
- The 32-bit value of the control for 32-bit control types. This is
0 for string controls since the value of a string cannot be passed
- using :ref:`VIDIOC_DQEVENT <VIDIOC_DQEVENT>`.
+ using :ref:`VIDIOC_DQEVENT`.
- .. row 5
diff --git a/Documentation/linux_tv/media/v4l/vidioc-encoder-cmd.rst b/Documentation/linux_tv/media/v4l/vidioc-encoder-cmd.rst
index ffa363eeaa36..43c7a3928e7b 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-encoder-cmd.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-encoder-cmd.rst
@@ -48,7 +48,7 @@ currently only used by the STOP command and contains one bit: If the
until the end of the current *Group Of Pictures*, otherwise it will stop
immediately.
-A :c:func:`read()`() or :ref:`VIDIOC_STREAMON <VIDIOC_STREAMON>`
+A :c:func:`read()`() or :ref:`VIDIOC_STREAMON`
call sends an implicit START command to the encoder if it has not been
started yet. After a STOP command, :c:func:`read()`() calls will read
the remaining data buffered by the driver. When the buffer is empty,
diff --git a/Documentation/linux_tv/media/v4l/vidioc-enum-dv-timings.rst b/Documentation/linux_tv/media/v4l/vidioc-enum-dv-timings.rst
index 5b8f17422fdb..07462519cbf4 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-enum-dv-timings.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-enum-dv-timings.rst
@@ -35,7 +35,7 @@ Description
While some DV receivers or transmitters support a wide range of timings,
others support only a limited number of timings. With this ioctl
applications can enumerate a list of known supported timings. Call
-:ref:`VIDIOC_DV_TIMINGS_CAP <VIDIOC_DV_TIMINGS_CAP>` to check if it
+:ref:`VIDIOC_DV_TIMINGS_CAP` to check if it
also supports other standards or even custom timings that are not in
this list.
diff --git a/Documentation/linux_tv/media/v4l/vidioc-enum-frameintervals.rst b/Documentation/linux_tv/media/v4l/vidioc-enum-frameintervals.rst
index 2c69866c8d9e..a9182898b6dc 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-enum-frameintervals.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-enum-frameintervals.rst
@@ -38,8 +38,8 @@ This ioctl allows applications to enumerate all frame intervals that the
device supports for the given pixel format and frame size.
The supported pixel formats and frame sizes can be obtained by using the
-:ref:`VIDIOC_ENUM_FMT <VIDIOC_ENUM_FMT>` and
-:ref:`VIDIOC_ENUM_FRAMESIZES <VIDIOC_ENUM_FRAMESIZES>` functions.
+:ref:`VIDIOC_ENUM_FMT` and
+:ref:`VIDIOC_ENUM_FRAMESIZES` functions.
The return value and the content of the ``v4l2_frmivalenum.type`` field
depend on the type of frame intervals the device supports. Here are the
diff --git a/Documentation/linux_tv/media/v4l/vidioc-enum-framesizes.rst b/Documentation/linux_tv/media/v4l/vidioc-enum-framesizes.rst
index 9b763ca9d0d8..5e171dbc975c 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-enum-framesizes.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-enum-framesizes.rst
@@ -39,7 +39,7 @@ and height in pixels) that the device supports for the given pixel
format.
The supported pixel formats can be obtained by using the
-:ref:`VIDIOC_ENUM_FMT <VIDIOC_ENUM_FMT>` function.
+:ref:`VIDIOC_ENUM_FMT` function.
The return value and the content of the ``v4l2_frmsizeenum.type`` field
depend on the type of frame sizes the device supports. Here are the
diff --git a/Documentation/linux_tv/media/v4l/vidioc-expbuf.rst b/Documentation/linux_tv/media/v4l/vidioc-expbuf.rst
index a389cbc75970..e71925f3f13e 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-expbuf.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-expbuf.rst
@@ -35,7 +35,7 @@ This ioctl is an extension to the :ref:`memory mapping <mmap>` I/O
method, therefore it is available only for ``V4L2_MEMORY_MMAP`` buffers.
It can be used to export a buffer as a DMABUF file at any time after
buffers have been allocated with the
-:ref:`VIDIOC_REQBUFS <VIDIOC_REQBUFS>` ioctl.
+:ref:`VIDIOC_REQBUFS` ioctl.
To export a buffer, applications fill struct
:ref:`v4l2_exportbuffer <v4l2-exportbuffer>`. The ``type`` field is
@@ -43,7 +43,7 @@ set to the same buffer type as was previously used with struct
:ref:`v4l2_requestbuffers <v4l2-requestbuffers>` ``type``.
Applications must also set the ``index`` field. Valid index numbers
range from zero to the number of buffers allocated with
-:ref:`VIDIOC_REQBUFS <VIDIOC_REQBUFS>` (struct
+:ref:`VIDIOC_REQBUFS` (struct
:ref:`v4l2_requestbuffers <v4l2-requestbuffers>` ``count``) minus
one. For the multi-planar API, applications set the ``plane`` field to
the index of the plane to be exported. Valid planes range from zero to
@@ -142,8 +142,8 @@ Examples
- Number of the buffer, set by the application. This field is only
used for :ref:`memory mapping <mmap>` I/O and can range from
zero to the number of buffers allocated with the
- :ref:`VIDIOC_REQBUFS <VIDIOC_REQBUFS>` and/or
- :ref:`VIDIOC_CREATE_BUFS <VIDIOC_CREATE_BUFS>` ioctls.
+ :ref:`VIDIOC_REQBUFS` and/or
+ :ref:`VIDIOC_CREATE_BUFS` ioctls.
- .. row 3
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-crop.rst b/Documentation/linux_tv/media/v4l/vidioc-g-crop.rst
index 457a6cc6b63e..e66f8c213535 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-crop.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-crop.rst
@@ -66,7 +66,7 @@ vertical scaling factor.
Finally the driver programs the hardware with the actual cropping and
image parameters. ``VIDIOC_S_CROP`` is a write-only ioctl, it does not
return the actual parameters. To query them applications must call
-``VIDIOC_G_CROP`` and :ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>`. When the
+``VIDIOC_G_CROP`` and :ref:`VIDIOC_G_FMT`. When the
parameters are unsuitable the application may modify the cropping or
image parameters and repeat the cycle until satisfactory parameters have
been negotiated.
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-ctrl.rst b/Documentation/linux_tv/media/v4l/vidioc-g-ctrl.rst
index 6b2b157ba9c7..2c2677a76462 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-ctrl.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-ctrl.rst
@@ -48,7 +48,7 @@ actual new value. If the ``value`` is inappropriate for the control
EINVAL error code is returned as well.
These ioctls work only with user controls. For other control classes the
-:ref:`VIDIOC_G_EXT_CTRLS <VIDIOC_G_EXT_CTRLS>`,
+:ref:`VIDIOC_G_EXT_CTRLS`,
:ref:`VIDIOC_S_EXT_CTRLS <VIDIOC_G_EXT_CTRLS>` or
:ref:`VIDIOC_TRY_EXT_CTRLS <VIDIOC_G_EXT_CTRLS>` must be used.
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-dv-timings.rst b/Documentation/linux_tv/media/v4l/vidioc-g-dv-timings.rst
index 84f9db487822..8a7fa1c0facf 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-dv-timings.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-dv-timings.rst
@@ -47,7 +47,7 @@ values are not correct, the driver returns EINVAL error code.
The ``linux/v4l2-dv-timings.h`` header can be used to get the timings of
the formats in the :ref:`cea861` and :ref:`vesadmt` standards. If
the current input or output does not support DV timings (e.g. if
-:ref:`VIDIOC_ENUMINPUT <VIDIOC_ENUMINPUT>` does not set the
+:ref:`VIDIOC_ENUMINPUT` does not set the
``V4L2_IN_CAP_DV_TIMINGS`` flag), then ENODATA error code is returned.
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-edid.rst b/Documentation/linux_tv/media/v4l/vidioc-g-edid.rst
index 26bbf060aa51..0bd8f1ba84d2 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-edid.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-edid.rst
@@ -44,8 +44,8 @@ with subdevice nodes (/dev/v4l-subdevX) or with video nodes
When used with video nodes the ``pad`` field represents the input (for
video capture devices) or output (for video output devices) index as is
-returned by :ref:`VIDIOC_ENUMINPUT <VIDIOC_ENUMINPUT>` and
-:ref:`VIDIOC_ENUMOUTPUT <VIDIOC_ENUMOUTPUT>` respectively. When used
+returned by :ref:`VIDIOC_ENUMINPUT` and
+:ref:`VIDIOC_ENUMOUTPUT` respectively. When used
with subdevice nodes the ``pad`` field represents the input or output
pad of the subdevice. If there is no EDID support for the given ``pad``
value, then the EINVAL error code will be returned.
@@ -105,8 +105,8 @@ EDID is no longer available.
- Pad for which to get/set the EDID blocks. When used with a video
device node the pad represents the input or output index as
- returned by :ref:`VIDIOC_ENUMINPUT <VIDIOC_ENUMINPUT>` and
- :ref:`VIDIOC_ENUMOUTPUT <VIDIOC_ENUMOUTPUT>` respectively.
+ returned by :ref:`VIDIOC_ENUMINPUT` and
+ :ref:`VIDIOC_ENUMOUTPUT` respectively.
- .. row 2
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-ext-ctrls.rst b/Documentation/linux_tv/media/v4l/vidioc-g-ext-ctrls.rst
index f800458d9dfe..cebaa6ea1ba9 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-ext-ctrls.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-ext-ctrls.rst
@@ -58,7 +58,7 @@ set ``size`` to a valid value and return an ENOSPC error code. You
should re-allocate the memory to this new size and try again. For the
string type it is possible that the same issue occurs again if the
string has grown in the meantime. It is recommended to call
-:ref:`VIDIOC_QUERYCTRL <VIDIOC_QUERYCTRL>` first and use
+:ref:`VIDIOC_QUERYCTRL` first and use
``maximum``\ +1 as the new ``size`` value. It is guaranteed that that is
sufficient memory.
@@ -367,7 +367,7 @@ still cause this situation.
- The class containing user controls. These controls are described
in :ref:`control`. All controls that can be set using the
:ref:`VIDIOC_S_CTRL <VIDIOC_G_CTRL>` and
- :ref:`VIDIOC_G_CTRL <VIDIOC_G_CTRL>` ioctl belong to this
+ :ref:`VIDIOC_G_CTRL` ioctl belong to this
class.
- .. row 2
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-fbuf.rst b/Documentation/linux_tv/media/v4l/vidioc-g-fbuf.rst
index f4703b3449b3..0d9b6972bc44 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-fbuf.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-fbuf.rst
@@ -39,7 +39,7 @@ to get and set the framebuffer parameters for a
:ref:`Video Overlay <overlay>` or :ref:`Video Output Overlay <osd>`
(OSD). The type of overlay is implied by the device type (capture or
output device) and can be determined with the
-:ref:`VIDIOC_QUERYCAP <VIDIOC_QUERYCAP>` ioctl. One ``/dev/videoN``
+:ref:`VIDIOC_QUERYCAP` ioctl. One ``/dev/videoN``
device must not support both kinds of overlay.
The V4L2 API distinguishes destructive and non-destructive overlays. A
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-input.rst b/Documentation/linux_tv/media/v4l/vidioc-g-input.rst
index 62990976ff9b..d0abf6231b7d 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-input.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-input.rst
@@ -47,7 +47,7 @@ applications must select an input before querying or negotiating any
other parameters.
Information about video inputs is available using the
-:ref:`VIDIOC_ENUMINPUT <VIDIOC_ENUMINPUT>` ioctl.
+:ref:`VIDIOC_ENUMINPUT` ioctl.
Return Value
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-output.rst b/Documentation/linux_tv/media/v4l/vidioc-g-output.rst
index 3b9ea56e3b9e..a38d6a118cf4 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-output.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-output.rst
@@ -48,7 +48,7 @@ effects applications must select an output before querying or
negotiating any other parameters.
Information about video outputs is available using the
-:ref:`VIDIOC_ENUMOUTPUT <VIDIOC_ENUMOUTPUT>` ioctl.
+:ref:`VIDIOC_ENUMOUTPUT` ioctl.
Return Value
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-std.rst b/Documentation/linux_tv/media/v4l/vidioc-g-std.rst
index 9cbf2d2995c6..fa9da29e0657 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-std.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-std.rst
@@ -48,7 +48,7 @@ no flags are given or the current input does not support the requested
standard the driver returns an EINVAL error code. When the standard set
is ambiguous drivers may return EINVAL or choose any of the requested
standards. If the current input or output does not support standard
-video timings (e.g. if :ref:`VIDIOC_ENUMINPUT <VIDIOC_ENUMINPUT>`
+video timings (e.g. if :ref:`VIDIOC_ENUMINPUT`
does not set the ``V4L2_IN_CAP_STD`` flag), then ENODATA error code is
returned.
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-tuner.rst b/Documentation/linux_tv/media/v4l/vidioc-g-tuner.rst
index 1ad5107a0ad5..1e01010fd2e2 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-tuner.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-tuner.rst
@@ -215,7 +215,7 @@ To change the radio frequency the
The selected audio mode, see :ref:`tuner-audmode` for valid
values. The audio mode does not affect audio subprogram detection,
- and like a :ref:`control <control>` it does not automatically
+ and like a :ref:`control` it does not automatically
change unless the requested mode is invalid or unsupported. See
:ref:`tuner-matrix` for possible results when the selected and
received audio programs do not match.
@@ -323,7 +323,7 @@ To change the radio frequency the
determined from the frequency band.) The set of supported video
standards is available from the struct
:ref:`v4l2_input <v4l2-input>` pointing to this tuner, see the
- description of ioctl :ref:`VIDIOC_ENUMINPUT <VIDIOC_ENUMINPUT>`
+ description of ioctl :ref:`VIDIOC_ENUMINPUT`
for details. Only ``V4L2_TUNER_ANALOG_TV`` tuners can have this
capability.
@@ -425,7 +425,7 @@ To change the radio frequency the
- 0x0400
- - The :ref:`VIDIOC_ENUM_FREQ_BANDS <VIDIOC_ENUM_FREQ_BANDS>`
+ - The :ref:`VIDIOC_ENUM_FREQ_BANDS`
ioctl can be used to enumerate the available frequency bands.
- .. row 13
@@ -436,7 +436,7 @@ To change the radio frequency the
- The range to search when using the hardware seek functionality is
programmable, see
- :ref:`VIDIOC_S_HW_FREQ_SEEK <VIDIOC_S_HW_FREQ_SEEK>` for
+ :ref:`VIDIOC_S_HW_FREQ_SEEK` for
details.
- .. row 14
diff --git a/Documentation/linux_tv/media/v4l/vidioc-overlay.rst b/Documentation/linux_tv/media/v4l/vidioc-overlay.rst
index e0373a9d6f14..fe9084147b93 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-overlay.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-overlay.rst
@@ -36,7 +36,7 @@ Applications call ``VIDIOC_OVERLAY`` to start or stop the overlay. It
takes a pointer to an integer which must be set to zero by the
application to stop overlay, to one to start.
-Drivers do not support :ref:`VIDIOC_STREAMON <VIDIOC_STREAMON>` or
+Drivers do not support :ref:`VIDIOC_STREAMON` or
:ref:`VIDIOC_STREAMOFF <VIDIOC_STREAMON>` with
``V4L2_BUF_TYPE_VIDEO_OVERLAY``.
diff --git a/Documentation/linux_tv/media/v4l/vidioc-qbuf.rst b/Documentation/linux_tv/media/v4l/vidioc-qbuf.rst
index 045fa53e0417..57a0bc470f36 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-qbuf.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-qbuf.rst
@@ -42,10 +42,10 @@ previously used with struct :ref:`v4l2_format <v4l2-format>` ``type``
and struct :ref:`v4l2_requestbuffers <v4l2-requestbuffers>` ``type``.
Applications must also set the ``index`` field. Valid index numbers
range from zero to the number of buffers allocated with
-:ref:`VIDIOC_REQBUFS <VIDIOC_REQBUFS>` (struct
+:ref:`VIDIOC_REQBUFS` (struct
:ref:`v4l2_requestbuffers <v4l2-requestbuffers>` ``count``) minus
one. The contents of the struct :c:type:`struct v4l2_buffer` returned
-by a :ref:`VIDIOC_QUERYBUF <VIDIOC_QUERYBUF>` ioctl will do as well.
+by a :ref:`VIDIOC_QUERYBUF` ioctl will do as well.
When the buffer is intended for output (``type`` is
``V4L2_BUF_TYPE_VIDEO_OUTPUT``, ``V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE``,
or ``V4L2_BUF_TYPE_VBI_OUTPUT``) applications must also initialize the
@@ -76,7 +76,7 @@ the driver sets the ``V4L2_BUF_FLAG_QUEUED`` flag and clears the
memory pages of the buffer in physical memory, they cannot be swapped
out to disk. Buffers remain locked until dequeued, until the
:ref:`VIDIOC_STREAMOFF <VIDIOC_STREAMON>` or
-:ref:`VIDIOC_REQBUFS <VIDIOC_REQBUFS>` ioctl is called, or until the
+:ref:`VIDIOC_REQBUFS` ioctl is called, or until the
device is closed.
To enqueue a :ref:`DMABUF <dmabuf>` buffer applications set the
@@ -92,7 +92,7 @@ buffer. Locking a buffer means passing it to a driver for a hardware
access (usually DMA). If an application accesses (reads/writes) a locked
buffer then the result is undefined. Buffers remain locked until
dequeued, until the :ref:`VIDIOC_STREAMOFF <VIDIOC_STREAMON>` or
-:ref:`VIDIOC_REQBUFS <VIDIOC_REQBUFS>` ioctl is called, or until the
+:ref:`VIDIOC_REQBUFS` ioctl is called, or until the
device is closed.
Applications call the ``VIDIOC_DQBUF`` ioctl to dequeue a filled
diff --git a/Documentation/linux_tv/media/v4l/vidioc-query-dv-timings.rst b/Documentation/linux_tv/media/v4l/vidioc-query-dv-timings.rst
index 88aedbd1fcae..ba78f7e5bbe8 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-query-dv-timings.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-query-dv-timings.rst
@@ -56,7 +56,7 @@ the receiver could lock to the signal, but the format is unsupported
(e.g. because the pixelclock is out of range of the hardware
capabilities), then the driver fills in whatever timings it could find
and returns ERANGE. In that case the application can call
-:ref:`VIDIOC_DV_TIMINGS_CAP <VIDIOC_DV_TIMINGS_CAP>` to compare the
+:ref:`VIDIOC_DV_TIMINGS_CAP` to compare the
found timings with the hardware's capabilities in order to give more
precise feedback to the user.
diff --git a/Documentation/linux_tv/media/v4l/vidioc-querybuf.rst b/Documentation/linux_tv/media/v4l/vidioc-querybuf.rst
index baa3ad6591c7..744cd9da45a3 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-querybuf.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-querybuf.rst
@@ -33,7 +33,7 @@ Description
This ioctl is part of the :ref:`streaming <mmap>` I/O method. It can
be used to query the status of a buffer at any time after buffers have
-been allocated with the :ref:`VIDIOC_REQBUFS <VIDIOC_REQBUFS>` ioctl.
+been allocated with the :ref:`VIDIOC_REQBUFS` ioctl.
Applications set the ``type`` field of a struct
:ref:`v4l2_buffer <v4l2-buffer>` to the same buffer type as was
@@ -41,7 +41,7 @@ previously used with struct :ref:`v4l2_format <v4l2-format>` ``type``
and struct :ref:`v4l2_requestbuffers <v4l2-requestbuffers>` ``type``,
and the ``index`` field. Valid index numbers range from zero to the
number of buffers allocated with
-:ref:`VIDIOC_REQBUFS <VIDIOC_REQBUFS>` (struct
+:ref:`VIDIOC_REQBUFS` (struct
:ref:`v4l2_requestbuffers <v4l2-requestbuffers>` ``count``) minus
one. The ``reserved`` and ``reserved2`` fields must be set to 0. When
using the :ref:`multi-planar API <planar-apis>`, the ``m.planes``
diff --git a/Documentation/linux_tv/media/v4l/vidioc-querycap.rst b/Documentation/linux_tv/media/v4l/vidioc-querycap.rst
index 3032a9ee1c6b..74589501b95d 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-querycap.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-querycap.rst
@@ -308,7 +308,7 @@ specification the ioctl returns an EINVAL error code.
- 0x00000400
- The device supports the
- :ref:`VIDIOC_S_HW_FREQ_SEEK <VIDIOC_S_HW_FREQ_SEEK>` ioctl
+ :ref:`VIDIOC_S_HW_FREQ_SEEK` ioctl
for hardware frequency seeking.
- .. row 15
diff --git a/Documentation/linux_tv/media/v4l/vidioc-queryctrl.rst b/Documentation/linux_tv/media/v4l/vidioc-queryctrl.rst
index 7d38a51c4f73..2b11efc3d257 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-queryctrl.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-queryctrl.rst
@@ -569,7 +569,7 @@ See also the examples in :ref:`control`.
:ref:`VIDIOC_S_EXT_CTRLS <VIDIOC_G_EXT_CTRLS>` you need to
set the ``size`` field of struct
:ref:`v4l2_ext_control <v4l2-ext-control>` to 9. For
- :ref:`VIDIOC_G_EXT_CTRLS <VIDIOC_G_EXT_CTRLS>` you can set
+ :ref:`VIDIOC_G_EXT_CTRLS` you can set
the ``size`` field to ``maximum`` + 1. Which character encoding is
used will depend on the string control itself and should be part
of the control documentation.
diff --git a/Documentation/linux_tv/media/v4l/vidioc-s-hw-freq-seek.rst b/Documentation/linux_tv/media/v4l/vidioc-s-hw-freq-seek.rst
index 19c2e0afd7de..cd59ba9ab1b0 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-s-hw-freq-seek.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-s-hw-freq-seek.rst
@@ -43,10 +43,10 @@ to tell the driver to search a specific band. If the struct
:ref:`v4l2_tuner <v4l2-tuner>` ``capability`` field has the
``V4L2_TUNER_CAP_HWSEEK_PROG_LIM`` flag set, these values must fall
within one of the bands returned by
-:ref:`VIDIOC_ENUM_FREQ_BANDS <VIDIOC_ENUM_FREQ_BANDS>`. If the
+:ref:`VIDIOC_ENUM_FREQ_BANDS`. If the
``V4L2_TUNER_CAP_HWSEEK_PROG_LIM`` flag is not set, then these values
must exactly match those of one of the bands returned by
-:ref:`VIDIOC_ENUM_FREQ_BANDS <VIDIOC_ENUM_FREQ_BANDS>`. If the
+:ref:`VIDIOC_ENUM_FREQ_BANDS`. If the
current frequency of the tuner does not fall within the selected band it
will be clamped to fit in the band before the seek is started.
diff --git a/Documentation/linux_tv/media/v4l/vidioc-streamon.rst b/Documentation/linux_tv/media/v4l/vidioc-streamon.rst
index 349204d81334..7663339d30be 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-streamon.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-streamon.rst
@@ -55,14 +55,14 @@ and it removes all buffers from the incoming and outgoing queues. That
means all images captured but not dequeued yet will be lost, likewise
all images enqueued for output but not transmitted yet. I/O returns to
the same state as after calling
-:ref:`VIDIOC_REQBUFS <VIDIOC_REQBUFS>` and can be restarted
+:ref:`VIDIOC_REQBUFS` and can be restarted
accordingly.
-If buffers have been queued with :ref:`VIDIOC_QBUF <VIDIOC_QBUF>` and
+If buffers have been queued with :ref:`VIDIOC_QBUF` and
``VIDIOC_STREAMOFF`` is called without ever having called
``VIDIOC_STREAMON``, then those queued buffers will also be removed from
the incoming queue and all are returned to the same state as after
-calling :ref:`VIDIOC_REQBUFS <VIDIOC_REQBUFS>` and can be restarted
+calling :ref:`VIDIOC_REQBUFS` and can be restarted
accordingly.
Both ioctls take a pointer to an integer, the desired buffer or stream
diff --git a/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-frame-interval.rst b/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-frame-interval.rst
index d9f27e32eb60..ab1368786038 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-frame-interval.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-frame-interval.rst
@@ -52,7 +52,7 @@ one until EINVAL is returned.
Available frame intervals may depend on the current 'try' formats at
other pads of the sub-device, as well as on the current active links.
-See :ref:`VIDIOC_SUBDEV_G_FMT <VIDIOC_SUBDEV_G_FMT>` for more
+See :ref:`VIDIOC_SUBDEV_G_FMT` for more
information about the try formats.
Sub-devices that support the frame interval enumeration ioctl should
diff --git a/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-frame-size.rst b/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-frame-size.rst
index 49be2eefaa57..e08de6040757 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-frame-size.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-frame-size.rst
@@ -34,7 +34,7 @@ Description
This ioctl allows applications to enumerate all frame sizes supported by
a sub-device on the given pad for the given media bus format. Supported
formats can be retrieved with the
-:ref:`VIDIOC_SUBDEV_ENUM_MBUS_CODE <VIDIOC_SUBDEV_ENUM_MBUS_CODE>`
+:ref:`VIDIOC_SUBDEV_ENUM_MBUS_CODE`
ioctl.
To enumerate frame sizes applications initialize the ``pad``, ``which``
@@ -58,7 +58,7 @@ sub-device for an exact supported frame size.
Available frame sizes may depend on the current 'try' formats at other
pads of the sub-device, as well as on the current active links and the
current values of V4L2 controls. See
-:ref:`VIDIOC_SUBDEV_G_FMT <VIDIOC_SUBDEV_G_FMT>` for more
+:ref:`VIDIOC_SUBDEV_G_FMT` for more
information about try formats.
diff --git a/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-mbus-code.rst b/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-mbus-code.rst
index a9b0baba2633..0daf410c1546 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-mbus-code.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-mbus-code.rst
@@ -43,7 +43,7 @@ one until EINVAL is returned.
Available media bus formats may depend on the current 'try' formats at
other pads of the sub-device, as well as on the current active links.
-See :ref:`VIDIOC_SUBDEV_G_FMT <VIDIOC_SUBDEV_G_FMT>` for more
+See :ref:`VIDIOC_SUBDEV_G_FMT` for more
information about the try formats.
diff --git a/Documentation/linux_tv/media/v4l/vidioc-subdev-g-crop.rst b/Documentation/linux_tv/media/v4l/vidioc-subdev-g-crop.rst
index bef416cfe46c..6fb1ea143f9e 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-subdev-g-crop.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-subdev-g-crop.rst
@@ -36,7 +36,7 @@ Description
**Note**
- This is an :ref:`obsolete <obsolete>` interface and may be removed
+ This is an :ref:`obsolete` interface and may be removed
in the future. It is superseded by
:ref:`the selection API <VIDIOC_SUBDEV_G_SELECTION>`.
diff --git a/Documentation/linux_tv/media/v4l/vidioc-subscribe-event.rst b/Documentation/linux_tv/media/v4l/vidioc-subscribe-event.rst
index 8d0e346461e9..182353f544eb 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-subscribe-event.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-subscribe-event.rst
@@ -33,7 +33,7 @@ Description
===========
Subscribe or unsubscribe V4L2 event. Subscribed events are dequeued by
-using the :ref:`VIDIOC_DQEVENT <VIDIOC_DQEVENT>` ioctl.
+using the :ref:`VIDIOC_DQEVENT` ioctl.
.. _v4l2-event-subscription:
--
2.7.4
^ permalink raw reply related [flat|nested] 52+ messages in thread* [PATCH 13/51] Documentation: linux_tv: convert lots of consts to references
2016-07-04 11:46 [PATCH 00/51] First part of documentation fixups Mauro Carvalho Chehab
` (11 preceding siblings ...)
2016-07-04 11:46 ` [PATCH 12/51] Documentation: linux_tv: simplify references Mauro Carvalho Chehab
@ 2016-07-04 11:46 ` Mauro Carvalho Chehab
2016-07-04 11:46 ` [PATCH 14/51] Documentation: linux_tv: don't simplify VIDIOC_G_foo references Mauro Carvalho Chehab
` (37 subsequent siblings)
50 siblings, 0 replies; 52+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-04 11:46 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, Jonathan Corbet,
Markus Heiser, linux-doc
There were lots of consts at the media docbook that should
be, instead, references. Convert the ones that can easily
be done by an automatic script.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
Documentation/linux_tv/media/v4l/dev-capture.rst | 16 ++++++++--------
Documentation/linux_tv/media/v4l/dev-osd.rst | 4 ++--
Documentation/linux_tv/media/v4l/dev-output.rst | 16 ++++++++--------
Documentation/linux_tv/media/v4l/dev-overlay.rst | 12 ++++++------
Documentation/linux_tv/media/v4l/dev-raw-vbi.rst | 10 +++++-----
Documentation/linux_tv/media/v4l/format.rst | 12 ++++++------
Documentation/linux_tv/media/v4l/io.rst | 2 +-
.../linux_tv/media/v4l/selection-api-004.rst | 4 ++--
.../linux_tv/media/v4l/selection-api-005.rst | 2 +-
Documentation/linux_tv/media/v4l/standard.rst | 4 ++--
Documentation/linux_tv/media/v4l/tuner.rst | 6 +++---
.../linux_tv/media/v4l/vidioc-create-bufs.rst | 4 ++--
Documentation/linux_tv/media/v4l/vidioc-cropcap.rst | 2 +-
.../linux_tv/media/v4l/vidioc-dbg-g-chip-info.rst | 4 ++--
Documentation/linux_tv/media/v4l/vidioc-enum-fmt.rst | 2 +-
.../linux_tv/media/v4l/vidioc-enum-freq-bands.rst | 2 +-
.../linux_tv/media/v4l/vidioc-enumaudio.rst | 2 +-
.../linux_tv/media/v4l/vidioc-enuminput.rst | 2 +-
.../linux_tv/media/v4l/vidioc-enumoutput.rst | 2 +-
Documentation/linux_tv/media/v4l/vidioc-enumstd.rst | 4 ++--
Documentation/linux_tv/media/v4l/vidioc-expbuf.rst | 4 ++--
Documentation/linux_tv/media/v4l/vidioc-g-audio.rst | 6 +++---
Documentation/linux_tv/media/v4l/vidioc-g-crop.rst | 10 +++++-----
Documentation/linux_tv/media/v4l/vidioc-g-ctrl.rst | 6 +++---
.../linux_tv/media/v4l/vidioc-g-dv-timings.rst | 6 +++---
Documentation/linux_tv/media/v4l/vidioc-g-edid.rst | 4 ++--
.../linux_tv/media/v4l/vidioc-g-enc-index.rst | 6 +++---
.../linux_tv/media/v4l/vidioc-g-ext-ctrls.rst | 20 ++++++++++----------
Documentation/linux_tv/media/v4l/vidioc-g-fbuf.rst | 16 ++++++++--------
Documentation/linux_tv/media/v4l/vidioc-g-fmt.rst | 18 +++++++++---------
.../linux_tv/media/v4l/vidioc-g-frequency.rst | 6 +++---
Documentation/linux_tv/media/v4l/vidioc-g-input.rst | 4 ++--
.../linux_tv/media/v4l/vidioc-g-modulator.rst | 8 ++++----
Documentation/linux_tv/media/v4l/vidioc-g-output.rst | 4 ++--
Documentation/linux_tv/media/v4l/vidioc-g-parm.rst | 2 +-
.../linux_tv/media/v4l/vidioc-g-priority.rst | 4 ++--
.../linux_tv/media/v4l/vidioc-g-sliced-vbi-cap.rst | 2 +-
Documentation/linux_tv/media/v4l/vidioc-g-std.rst | 10 +++++-----
Documentation/linux_tv/media/v4l/vidioc-overlay.rst | 2 +-
.../linux_tv/media/v4l/vidioc-prepare-buf.rst | 4 ++--
.../linux_tv/media/v4l/vidioc-query-dv-timings.rst | 6 +++---
Documentation/linux_tv/media/v4l/vidioc-querybuf.rst | 2 +-
Documentation/linux_tv/media/v4l/vidioc-querystd.rst | 6 +++---
Documentation/linux_tv/media/v4l/vidioc-reqbufs.rst | 2 +-
.../media/v4l/vidioc-subdev-enum-frame-interval.rst | 2 +-
.../media/v4l/vidioc-subdev-enum-frame-size.rst | 2 +-
.../media/v4l/vidioc-subdev-enum-mbus-code.rst | 2 +-
47 files changed, 138 insertions(+), 138 deletions(-)
diff --git a/Documentation/linux_tv/media/v4l/dev-capture.rst b/Documentation/linux_tv/media/v4l/dev-capture.rst
index eb5c1522905d..c970a1fd1439 100644
--- a/Documentation/linux_tv/media/v4l/dev-capture.rst
+++ b/Documentation/linux_tv/media/v4l/dev-capture.rst
@@ -75,23 +75,23 @@ To request different parameters applications set the ``type`` field of a
struct :ref:`v4l2_format <v4l2-format>` as above and initialize all
fields of the struct :ref:`v4l2_pix_format <v4l2-pix-format>`
``vbi`` member of the ``fmt`` union, or better just modify the results
-of ``VIDIOC_G_FMT``, and call the :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>`
+of :ref:`VIDIOC_G_FMT`, and call the :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>`
ioctl with a pointer to this structure. Drivers may adjust the
-parameters and finally return the actual parameters as ``VIDIOC_G_FMT``
+parameters and finally return the actual parameters as :ref:`VIDIOC_G_FMT`
does.
-Like ``VIDIOC_S_FMT`` the :ref:`VIDIOC_TRY_FMT <VIDIOC_G_FMT>` ioctl
+Like :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` the :ref:`VIDIOC_TRY_FMT <VIDIOC_G_FMT>` ioctl
can be used to learn about hardware limitations without disabling I/O or
possibly time consuming hardware preparations.
The contents of struct :ref:`v4l2_pix_format <v4l2-pix-format>` and
struct :ref:`v4l2_pix_format_mplane <v4l2-pix-format-mplane>` are
discussed in :ref:`pixfmt`. See also the specification of the
-``VIDIOC_G_FMT``, ``VIDIOC_S_FMT`` and ``VIDIOC_TRY_FMT`` ioctls for
-details. Video capture devices must implement both the ``VIDIOC_G_FMT``
-and ``VIDIOC_S_FMT`` ioctl, even if ``VIDIOC_S_FMT`` ignores all
-requests and always returns default parameters as ``VIDIOC_G_FMT`` does.
-``VIDIOC_TRY_FMT`` is optional.
+:ref:`VIDIOC_G_FMT`, :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` and :ref:`VIDIOC_TRY_FMT <VIDIOC_G_FMT>` ioctls for
+details. Video capture devices must implement both the :ref:`VIDIOC_G_FMT`
+and :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl, even if :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ignores all
+requests and always returns default parameters as :ref:`VIDIOC_G_FMT` does.
+:ref:`VIDIOC_TRY_FMT <VIDIOC_G_FMT>` is optional.
Reading Images
diff --git a/Documentation/linux_tv/media/v4l/dev-osd.rst b/Documentation/linux_tv/media/v4l/dev-osd.rst
index 27d2cfbf3d9c..4b668a3544b8 100644
--- a/Documentation/linux_tv/media/v4l/dev-osd.rst
+++ b/Documentation/linux_tv/media/v4l/dev-osd.rst
@@ -124,10 +124,10 @@ struct :ref:`v4l2_format <v4l2-format>` to
``V4L2_BUF_TYPE_VIDEO_OUTPUT_OVERLAY``, initialize the ``win``
substructure and call the :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl.
The driver adjusts the parameters against hardware limits and returns
-the actual parameters as ``VIDIOC_G_FMT`` does. Like ``VIDIOC_S_FMT``,
+the actual parameters as :ref:`VIDIOC_G_FMT` does. Like :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>`,
the :ref:`VIDIOC_TRY_FMT <VIDIOC_G_FMT>` ioctl can be used to learn
about driver capabilities without actually changing driver state. Unlike
-``VIDIOC_S_FMT`` this also works after the overlay has been enabled.
+:ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` this also works after the overlay has been enabled.
A struct :ref:`v4l2_crop <v4l2-crop>` defines the size and position
of the target rectangle. The scaling factor of the overlay is implied by
diff --git a/Documentation/linux_tv/media/v4l/dev-output.rst b/Documentation/linux_tv/media/v4l/dev-output.rst
index 1ca0e5873a86..ee62d1a0fb87 100644
--- a/Documentation/linux_tv/media/v4l/dev-output.rst
+++ b/Documentation/linux_tv/media/v4l/dev-output.rst
@@ -72,23 +72,23 @@ To request different parameters applications set the ``type`` field of a
struct :ref:`v4l2_format <v4l2-format>` as above and initialize all
fields of the struct :ref:`v4l2_pix_format <v4l2-pix-format>`
``vbi`` member of the ``fmt`` union, or better just modify the results
-of ``VIDIOC_G_FMT``, and call the :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>`
+of :ref:`VIDIOC_G_FMT`, and call the :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>`
ioctl with a pointer to this structure. Drivers may adjust the
-parameters and finally return the actual parameters as ``VIDIOC_G_FMT``
+parameters and finally return the actual parameters as :ref:`VIDIOC_G_FMT`
does.
-Like ``VIDIOC_S_FMT`` the :ref:`VIDIOC_TRY_FMT <VIDIOC_G_FMT>` ioctl
+Like :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` the :ref:`VIDIOC_TRY_FMT <VIDIOC_G_FMT>` ioctl
can be used to learn about hardware limitations without disabling I/O or
possibly time consuming hardware preparations.
The contents of struct :ref:`v4l2_pix_format <v4l2-pix-format>` and
struct :ref:`v4l2_pix_format_mplane <v4l2-pix-format-mplane>` are
discussed in :ref:`pixfmt`. See also the specification of the
-``VIDIOC_G_FMT``, ``VIDIOC_S_FMT`` and ``VIDIOC_TRY_FMT`` ioctls for
-details. Video output devices must implement both the ``VIDIOC_G_FMT``
-and ``VIDIOC_S_FMT`` ioctl, even if ``VIDIOC_S_FMT`` ignores all
-requests and always returns default parameters as ``VIDIOC_G_FMT`` does.
-``VIDIOC_TRY_FMT`` is optional.
+:ref:`VIDIOC_G_FMT`, :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` and :ref:`VIDIOC_TRY_FMT <VIDIOC_G_FMT>` ioctls for
+details. Video output devices must implement both the :ref:`VIDIOC_G_FMT`
+and :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl, even if :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ignores all
+requests and always returns default parameters as :ref:`VIDIOC_G_FMT` does.
+:ref:`VIDIOC_TRY_FMT <VIDIOC_G_FMT>` is optional.
Writing Images
diff --git a/Documentation/linux_tv/media/v4l/dev-overlay.rst b/Documentation/linux_tv/media/v4l/dev-overlay.rst
index acbcfb4cbe57..26bd4a15a125 100644
--- a/Documentation/linux_tv/media/v4l/dev-overlay.rst
+++ b/Documentation/linux_tv/media/v4l/dev-overlay.rst
@@ -65,7 +65,7 @@ frame buffer parameters, namely the address and size of the frame buffer
and the image format, for example RGB 5:6:5. The
:ref:`VIDIOC_G_FBUF` and
:ref:`VIDIOC_S_FBUF <VIDIOC_G_FBUF>` ioctls are available to get and
-set these parameters, respectively. The ``VIDIOC_S_FBUF`` ioctl is
+set these parameters, respectively. The :ref:`VIDIOC_S_FBUF <VIDIOC_G_FBUF>` ioctl is
privileged because it allows to set up DMA into physical memory,
bypassing the memory protection mechanisms of the kernel. Only the
superuser can change the frame buffer address and size. Users are not
@@ -76,8 +76,8 @@ system and program the V4L2 driver at the appropriate time.
Some devices add the video overlay to the output signal of the graphics
card. In this case the frame buffer is not modified by the video device,
and the frame buffer address and pixel format are not needed by the
-driver. The ``VIDIOC_S_FBUF`` ioctl is not privileged. An application
-can check for this type of device by calling the ``VIDIOC_G_FBUF``
+driver. The :ref:`VIDIOC_S_FBUF <VIDIOC_G_FBUF>` ioctl is not privileged. An application
+can check for this type of device by calling the :ref:`VIDIOC_G_FBUF`
ioctl.
A driver may support any (or none) of five clipping/blending methods:
@@ -130,10 +130,10 @@ struct :ref:`v4l2_format <v4l2-format>` to
``V4L2_BUF_TYPE_VIDEO_OVERLAY``, initialize the ``win`` substructure and
call the :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl. The driver
adjusts the parameters against hardware limits and returns the actual
-parameters as ``VIDIOC_G_FMT`` does. Like ``VIDIOC_S_FMT``, the
+parameters as :ref:`VIDIOC_G_FMT` does. Like :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>`, the
:ref:`VIDIOC_TRY_FMT <VIDIOC_G_FMT>` ioctl can be used to learn
about driver capabilities without actually changing driver state. Unlike
-``VIDIOC_S_FMT`` this also works after the overlay has been enabled.
+:ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` this also works after the overlay has been enabled.
The scaling factor of the overlaid image is implied by the width and
height given in struct :ref:`v4l2_window <v4l2-window>` and the size
@@ -199,7 +199,7 @@ are undefined.
When the application set the ``clips`` field, this field must
contain the number of clipping rectangles in the list. When clip
lists are not supported the driver ignores this field, its contents
- after calling ``VIDIOC_S_FMT`` are undefined. When clip lists are
+ after calling :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` are undefined. When clip lists are
supported but no clipping is desired this field must be set to zero.
``void * bitmap``
diff --git a/Documentation/linux_tv/media/v4l/dev-raw-vbi.rst b/Documentation/linux_tv/media/v4l/dev-raw-vbi.rst
index ca61dde3ad38..2cd813a5b4e4 100644
--- a/Documentation/linux_tv/media/v4l/dev-raw-vbi.rst
+++ b/Documentation/linux_tv/media/v4l/dev-raw-vbi.rst
@@ -80,7 +80,7 @@ To request different parameters applications set the ``type`` field of a
struct :ref:`v4l2_format <v4l2-format>` as above and initialize all
fields of the struct :ref:`v4l2_vbi_format <v4l2-vbi-format>`
``vbi`` member of the ``fmt`` union, or better just modify the results
-of ``VIDIOC_G_FMT``, and call the :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>`
+of :ref:`VIDIOC_G_FMT`, and call the :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>`
ioctl with a pointer to this structure. Drivers return an EINVAL error
code only when the given parameters are ambiguous, otherwise they modify
the parameters according to the hardware capabilities and return the
@@ -94,10 +94,10 @@ expect other resource allocation points which may return EBUSY, at the
:ref:`VIDIOC_STREAMON` ioctl and the first read(),
write() and select() call.
-VBI devices must implement both the ``VIDIOC_G_FMT`` and
-``VIDIOC_S_FMT`` ioctl, even if ``VIDIOC_S_FMT`` ignores all requests
-and always returns default parameters as ``VIDIOC_G_FMT`` does.
-``VIDIOC_TRY_FMT`` is optional.
+VBI devices must implement both the :ref:`VIDIOC_G_FMT` and
+:ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl, even if :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ignores all requests
+and always returns default parameters as :ref:`VIDIOC_G_FMT` does.
+:ref:`VIDIOC_TRY_FMT <VIDIOC_G_FMT>` is optional.
.. _v4l2-vbi-format:
diff --git a/Documentation/linux_tv/media/v4l/format.rst b/Documentation/linux_tv/media/v4l/format.rst
index 46f740a0092e..0184b5931709 100644
--- a/Documentation/linux_tv/media/v4l/format.rst
+++ b/Documentation/linux_tv/media/v4l/format.rst
@@ -31,10 +31,10 @@ format. The data formats supported by the V4L2 API are covered in the
respective device section in :ref:`devices`. For a closer look at
image formats see :ref:`pixfmt`.
-The ``VIDIOC_S_FMT`` ioctl is a major turning-point in the
+The :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl is a major turning-point in the
initialization sequence. Prior to this point multiple panel applications
can access the same device concurrently to select the current input,
-change controls or modify other properties. The first ``VIDIOC_S_FMT``
+change controls or modify other properties. The first :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>`
assigns a logical stream (video data, VBI data etc.) exclusively to one
file descriptor.
@@ -50,7 +50,7 @@ example video overlay is about to start or already in progress,
simultaneous video capturing may be restricted to the same cropping and
image size.
-When applications omit the ``VIDIOC_S_FMT`` ioctl its locking side
+When applications omit the :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl its locking side
effects are implied by the next step, the selection of an I/O method
with the :ref:`VIDIOC_REQBUFS` ioctl or implicit
with the first :ref:`read() <func-read>` or
@@ -61,11 +61,11 @@ the exception being drivers permitting simultaneous video capturing and
overlay using the same file descriptor for compatibility with V4L and
earlier versions of V4L2. Switching the logical stream or returning into
"panel mode" is possible by closing and reopening the device. Drivers
-*may* support a switch using ``VIDIOC_S_FMT``.
+*may* support a switch using :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>`.
All drivers exchanging data with applications must support the
-``VIDIOC_G_FMT`` and ``VIDIOC_S_FMT`` ioctl. Implementation of the
-``VIDIOC_TRY_FMT`` is highly recommended but optional.
+:ref:`VIDIOC_G_FMT` and :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl. Implementation of the
+:ref:`VIDIOC_TRY_FMT <VIDIOC_G_FMT>` is highly recommended but optional.
Image Format Enumeration
diff --git a/Documentation/linux_tv/media/v4l/io.rst b/Documentation/linux_tv/media/v4l/io.rst
index 651d4530c703..77d13fdd1c28 100644
--- a/Documentation/linux_tv/media/v4l/io.rst
+++ b/Documentation/linux_tv/media/v4l/io.rst
@@ -31,7 +31,7 @@ and drivers permitting simultaneous video capturing and overlay using
the same file descriptor, for compatibility with V4L and earlier
versions of V4L2.
-``VIDIOC_S_FMT`` and ``VIDIOC_REQBUFS`` would permit this to some
+:ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` and :ref:`VIDIOC_REQBUFS` would permit this to some
degree, but for simplicity drivers need not support switching the I/O
method (after first switching away from read/write) other than by
closing and reopening the device.
diff --git a/Documentation/linux_tv/media/v4l/selection-api-004.rst b/Documentation/linux_tv/media/v4l/selection-api-004.rst
index 4890815e268e..1a8f4d09bff1 100644
--- a/Documentation/linux_tv/media/v4l/selection-api-004.rst
+++ b/Documentation/linux_tv/media/v4l/selection-api-004.rst
@@ -50,7 +50,7 @@ The composing targets refer to a memory buffer. The limits of composing
coordinates are obtained using ``V4L2_SEL_TGT_COMPOSE_BOUNDS``. All
coordinates are expressed in pixels. The rectangle's top/left corner
must be located at position ``(0,0)``. The width and height are equal to
-the image size set by ``VIDIOC_S_FMT``.
+the image size set by :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>`.
The part of a buffer into which the image is inserted by the hardware is
controlled by the ``V4L2_SEL_TGT_COMPOSE`` target. The rectangle's
@@ -90,7 +90,7 @@ to be inserted into a video signal or graphical screen. The limits of
cropping coordinates are obtained using ``V4L2_SEL_TGT_CROP_BOUNDS``.
All coordinates are expressed in pixels. The top/left corner is always
point ``(0,0)``. The width and height is equal to the image size
-specified using ``VIDIOC_S_FMT`` ioctl.
+specified using :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl.
The top left corner, width and height of the source rectangle, that is
the area from which image date are processed by the hardware, is given
diff --git a/Documentation/linux_tv/media/v4l/selection-api-005.rst b/Documentation/linux_tv/media/v4l/selection-api-005.rst
index aefab87788db..6fdb0af2b13d 100644
--- a/Documentation/linux_tv/media/v4l/selection-api-005.rst
+++ b/Documentation/linux_tv/media/v4l/selection-api-005.rst
@@ -19,7 +19,7 @@ setting the field struct
:ref:`v4l2_pix_format <v4l2-pix-format>```::bytesperline``.
Introducing an image offsets could be done by modifying field struct
:ref:`v4l2_buffer <v4l2-buffer>```::m_userptr`` before calling
-``VIDIOC_QBUF``. Those operations should be avoided because they are not
+:ref:`VIDIOC_QBUF`. Those operations should be avoided because they are not
portable (endianness), and do not work for macroblock and Bayer formats
and mmap buffers. The selection API deals with configuration of buffer
cropping/composing in a clear, intuitive and portable way. Next, with
diff --git a/Documentation/linux_tv/media/v4l/standard.rst b/Documentation/linux_tv/media/v4l/standard.rst
index 3c0f6cb97f13..ec39b2b39e67 100644
--- a/Documentation/linux_tv/media/v4l/standard.rst
+++ b/Documentation/linux_tv/media/v4l/standard.rst
@@ -56,8 +56,8 @@ output device which is:
Here the driver shall set the ``std`` field of struct
:ref:`v4l2_input <v4l2-input>` and struct
-:ref:`v4l2_output <v4l2-output>` to zero and the ``VIDIOC_G_STD``,
-``VIDIOC_S_STD``, ``VIDIOC_QUERYSTD`` and ``VIDIOC_ENUMSTD`` ioctls
+:ref:`v4l2_output <v4l2-output>` to zero and the :ref:`VIDIOC_G_STD`,
+:ref:`VIDIOC_S_STD <VIDIOC_G_STD>`, :ref:`VIDIOC_QUERYSTD` and :ref:`VIDIOC_ENUMSTD` ioctls
shall return the ENOTTY error code or the EINVAL error code.
Applications can make use of the :ref:`input-capabilities` and
diff --git a/Documentation/linux_tv/media/v4l/tuner.rst b/Documentation/linux_tv/media/v4l/tuner.rst
index b1be27bd297e..67f4e24709b5 100644
--- a/Documentation/linux_tv/media/v4l/tuner.rst
+++ b/Documentation/linux_tv/media/v4l/tuner.rst
@@ -24,9 +24,9 @@ inputs.
To query and change tuner properties applications use the
:ref:`VIDIOC_G_TUNER` and
:ref:`VIDIOC_S_TUNER <VIDIOC_G_TUNER>` ioctls, respectively. The
-struct :ref:`v4l2_tuner <v4l2-tuner>` returned by ``VIDIOC_G_TUNER``
+struct :ref:`v4l2_tuner <v4l2-tuner>` returned by :ref:`VIDIOC_G_TUNER`
also contains signal status information applicable when the tuner of the
-current video or radio input is queried. Note that ``VIDIOC_S_TUNER``
+current video or radio input is queried. Note that :ref:`VIDIOC_S_TUNER <VIDIOC_G_TUNER>`
does not switch the current tuner, when there is more than one at all.
The tuner is solely determined by the current video input. Drivers must
support both ioctls and set the ``V4L2_CAP_TUNER`` flag in the struct
@@ -61,7 +61,7 @@ cannot specify whether the frequency is for a tuner or a modulator.
To query and change modulator properties applications use the
:ref:`VIDIOC_G_MODULATOR` and
:ref:`VIDIOC_S_MODULATOR <VIDIOC_G_MODULATOR>` ioctl. Note that
-``VIDIOC_S_MODULATOR`` does not switch the current modulator, when there
+:ref:`VIDIOC_S_MODULATOR <VIDIOC_G_MODULATOR>` does not switch the current modulator, when there
is more than one at all. The modulator is solely determined by the
current video output. Drivers must support both ioctls and set the
``V4L2_CAP_MODULATOR`` flag in the struct
diff --git a/Documentation/linux_tv/media/v4l/vidioc-create-bufs.rst b/Documentation/linux_tv/media/v4l/vidioc-create-bufs.rst
index 9220bcea1259..d269eab4d2b6 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-create-bufs.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-create-bufs.rst
@@ -94,10 +94,10 @@ than the number requested.
- ``count``
- The number of buffers requested or granted. If count == 0, then
- ``VIDIOC_CREATE_BUFS`` will set ``index`` to the current number of
+ :ref:`VIDIOC_CREATE_BUFS` will set ``index`` to the current number of
created buffers, and it will check the validity of ``memory`` and
``format.type``. If those are invalid -1 is returned and errno is
- set to EINVAL error code, otherwise ``VIDIOC_CREATE_BUFS`` returns
+ set to EINVAL error code, otherwise :ref:`VIDIOC_CREATE_BUFS` returns
0. It will never set errno to EBUSY error code in this particular
case.
diff --git a/Documentation/linux_tv/media/v4l/vidioc-cropcap.rst b/Documentation/linux_tv/media/v4l/vidioc-cropcap.rst
index 22b5efe1d2e4..25ad9b29b160 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-cropcap.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-cropcap.rst
@@ -34,7 +34,7 @@ Description
Applications use this function to query the cropping limits, the pixel
aspect of images and to calculate scale factors. They set the ``type``
field of a v4l2_cropcap structure to the respective buffer (stream)
-type and call the ``VIDIOC_CROPCAP`` ioctl with a pointer to this
+type and call the :ref:`VIDIOC_CROPCAP` ioctl with a pointer to this
structure. Drivers fill the rest of the structure. The results are
constant except when switching the video standard. Remember this switch
can occur implicit when switching the video input or output.
diff --git a/Documentation/linux_tv/media/v4l/vidioc-dbg-g-chip-info.rst b/Documentation/linux_tv/media/v4l/vidioc-dbg-g-chip-info.rst
index 12c2e5df48ac..a1534a326bb3 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-dbg-g-chip-info.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-dbg-g-chip-info.rst
@@ -49,14 +49,14 @@ Additionally the Linux kernel must be compiled with the
To query the driver applications must initialize the ``match.type`` and
``match.addr`` or ``match.name`` fields of a struct
:ref:`v4l2_dbg_chip_info <v4l2-dbg-chip-info>` and call
-``VIDIOC_DBG_G_CHIP_INFO`` with a pointer to this structure. On success
+:ref:`VIDIOC_DBG_G_CHIP_INFO` with a pointer to this structure. On success
the driver stores information about the selected chip in the ``name``
and ``flags`` fields.
When ``match.type`` is ``V4L2_CHIP_MATCH_BRIDGE``, ``match.addr``
selects the nth bridge 'chip' on the TV card. You can enumerate all
chips by starting at zero and incrementing ``match.addr`` by one until
-``VIDIOC_DBG_G_CHIP_INFO`` fails with an EINVAL error code. The number
+:ref:`VIDIOC_DBG_G_CHIP_INFO` fails with an EINVAL error code. The number
zero always selects the bridge chip itself, e. g. the chip connected to
the PCI or USB bus. Non-zero numbers identify specific parts of the
bridge chip such as an AC97 register block.
diff --git a/Documentation/linux_tv/media/v4l/vidioc-enum-fmt.rst b/Documentation/linux_tv/media/v4l/vidioc-enum-fmt.rst
index f4fc2723f01e..c838f3dbb808 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-enum-fmt.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-enum-fmt.rst
@@ -33,7 +33,7 @@ Description
To enumerate image formats applications initialize the ``type`` and
``index`` field of struct :ref:`v4l2_fmtdesc <v4l2-fmtdesc>` and call
-the ``VIDIOC_ENUM_FMT`` ioctl with a pointer to this structure. Drivers
+the :ref:`VIDIOC_ENUM_FMT` ioctl with a pointer to this structure. Drivers
fill the rest of the structure or return an EINVAL error code. All
formats are enumerable by beginning at index zero and incrementing by
one until EINVAL is returned.
diff --git a/Documentation/linux_tv/media/v4l/vidioc-enum-freq-bands.rst b/Documentation/linux_tv/media/v4l/vidioc-enum-freq-bands.rst
index 2f5dbe0583b4..3999c419589a 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-enum-freq-bands.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-enum-freq-bands.rst
@@ -35,7 +35,7 @@ Enumerates the frequency bands that a tuner or modulator supports. To do
this applications initialize the ``tuner``, ``type`` and ``index``
fields, and zero out the ``reserved`` array of a struct
:ref:`v4l2_frequency_band <v4l2-frequency-band>` and call the
-``VIDIOC_ENUM_FREQ_BANDS`` ioctl with a pointer to this structure.
+:ref:`VIDIOC_ENUM_FREQ_BANDS` ioctl with a pointer to this structure.
This ioctl is supported if the ``V4L2_TUNER_CAP_FREQ_BANDS`` capability
of the corresponding tuner/modulator is set.
diff --git a/Documentation/linux_tv/media/v4l/vidioc-enumaudio.rst b/Documentation/linux_tv/media/v4l/vidioc-enumaudio.rst
index dcca0591864e..0fc0c3eeae5f 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-enumaudio.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-enumaudio.rst
@@ -33,7 +33,7 @@ Description
To query the attributes of an audio input applications initialize the
``index`` field and zero out the ``reserved`` array of a struct
-:ref:`v4l2_audio <v4l2-audio>` and call the ``VIDIOC_ENUMAUDIO``
+:ref:`v4l2_audio <v4l2-audio>` and call the :ref:`VIDIOC_ENUMAUDIO`
ioctl with a pointer to this structure. Drivers fill the rest of the
structure or return an EINVAL error code when the index is out of
bounds. To enumerate all audio inputs applications shall begin at index
diff --git a/Documentation/linux_tv/media/v4l/vidioc-enuminput.rst b/Documentation/linux_tv/media/v4l/vidioc-enuminput.rst
index 644d50679aa2..131f331462b1 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-enuminput.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-enuminput.rst
@@ -33,7 +33,7 @@ Description
To query the attributes of a video input applications initialize the
``index`` field of struct :ref:`v4l2_input <v4l2-input>` and call the
-``VIDIOC_ENUMINPUT`` ioctl with a pointer to this structure. Drivers
+:ref:`VIDIOC_ENUMINPUT` ioctl with a pointer to this structure. Drivers
fill the rest of the structure or return an EINVAL error code when the
index is out of bounds. To enumerate all inputs applications shall begin
at index zero, incrementing by one until the driver returns EINVAL.
diff --git a/Documentation/linux_tv/media/v4l/vidioc-enumoutput.rst b/Documentation/linux_tv/media/v4l/vidioc-enumoutput.rst
index 6ccb3d094dc8..cb0107b9c03b 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-enumoutput.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-enumoutput.rst
@@ -33,7 +33,7 @@ Description
To query the attributes of a video outputs applications initialize the
``index`` field of struct :ref:`v4l2_output <v4l2-output>` and call
-the ``VIDIOC_ENUMOUTPUT`` ioctl with a pointer to this structure.
+the :ref:`VIDIOC_ENUMOUTPUT` ioctl with a pointer to this structure.
Drivers fill the rest of the structure or return an EINVAL error code
when the index is out of bounds. To enumerate all outputs applications
shall begin at index zero, incrementing by one until the driver returns
diff --git a/Documentation/linux_tv/media/v4l/vidioc-enumstd.rst b/Documentation/linux_tv/media/v4l/vidioc-enumstd.rst
index d16a9494d03b..e292b7d50cc3 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-enumstd.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-enumstd.rst
@@ -33,7 +33,7 @@ Description
To query the attributes of a video standard, especially a custom (driver
defined) one, applications initialize the ``index`` field of struct
-:ref:`v4l2_standard <v4l2-standard>` and call the ``VIDIOC_ENUMSTD``
+:ref:`v4l2_standard <v4l2-standard>` and call the :ref:`VIDIOC_ENUMSTD`
ioctl with a pointer to this structure. Drivers fill the rest of the
structure or return an EINVAL error code when the index is out of
bounds. To enumerate all standards applications shall begin at index
@@ -401,7 +401,7 @@ ENODATA
.. [1]
The supported standards may overlap and we need an unambiguous set to
- find the current standard returned by ``VIDIOC_G_STD``.
+ find the current standard returned by :ref:`VIDIOC_G_STD`.
.. [2]
Japan uses a standard similar to M/NTSC (V4L2_STD_NTSC_M_JP).
diff --git a/Documentation/linux_tv/media/v4l/vidioc-expbuf.rst b/Documentation/linux_tv/media/v4l/vidioc-expbuf.rst
index e71925f3f13e..2933640e8c4e 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-expbuf.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-expbuf.rst
@@ -53,9 +53,9 @@ Additional flags may be posted in the ``flags`` field. Refer to a manual
for open() for details. Currently only O_CLOEXEC, O_RDONLY, O_WRONLY,
and O_RDWR are supported. All other fields must be set to zero. In the
case of multi-planar API, every plane is exported separately using
-multiple ``VIDIOC_EXPBUF`` calls.
+multiple :ref:`VIDIOC_EXPBUF` calls.
-After calling ``VIDIOC_EXPBUF`` the ``fd`` field will be set by a
+After calling :ref:`VIDIOC_EXPBUF` the ``fd`` field will be set by a
driver. This is a DMABUF file descriptor. The application may pass it to
other DMABUF-aware devices. Refer to :ref:`DMABUF importing <dmabuf>`
for details about importing DMABUF files into V4L2 nodes. It is
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-audio.rst b/Documentation/linux_tv/media/v4l/vidioc-g-audio.rst
index 2a81d01a1c00..be8899d87e33 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-audio.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-audio.rst
@@ -36,14 +36,14 @@ Description
To query the current audio input applications zero out the ``reserved``
array of a struct :ref:`v4l2_audio <v4l2-audio>` and call the
-``VIDIOC_G_AUDIO`` ioctl with a pointer to this structure. Drivers fill
+:ref:`VIDIOC_G_AUDIO` ioctl with a pointer to this structure. Drivers fill
the rest of the structure or return an EINVAL error code when the device
has no audio inputs, or none which combine with the current video input.
Audio inputs have one writable property, the audio mode. To select the
current audio input *and* change the audio mode, applications initialize
the ``index`` and ``mode`` fields, and the ``reserved`` array of a
-:c:type:`struct v4l2_audio` structure and call the ``VIDIOC_S_AUDIO``
+:c:type:`struct v4l2_audio` structure and call the :ref:`VIDIOC_S_AUDIO <VIDIOC_G_AUDIO>`
ioctl. Drivers may switch to a different audio mode if the request
cannot be satisfied. However, this is a write-only ioctl, it does not
return the actual new audio mode.
@@ -90,7 +90,7 @@ return the actual new audio mode.
- ``mode``
- Audio mode flags set by drivers and applications (on
- ``VIDIOC_S_AUDIO`` ioctl), see :ref:`audio-mode`.
+ :ref:`VIDIOC_S_AUDIO <VIDIOC_G_AUDIO>` ioctl), see :ref:`audio-mode`.
- .. row 5
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-crop.rst b/Documentation/linux_tv/media/v4l/vidioc-g-crop.rst
index e66f8c213535..0a9ede92bc9f 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-crop.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-crop.rst
@@ -36,13 +36,13 @@ Description
To query the cropping rectangle size and position applications set the
``type`` field of a :c:type:`struct v4l2_crop` structure to the
-respective buffer (stream) type and call the ``VIDIOC_G_CROP`` ioctl
+respective buffer (stream) type and call the :ref:`VIDIOC_G_CROP` ioctl
with a pointer to this structure. The driver fills the rest of the
structure or returns the EINVAL error code if cropping is not supported.
To change the cropping rectangle applications initialize the ``type``
and struct :ref:`v4l2_rect <v4l2-rect>` substructure named ``c`` of a
-v4l2_crop structure and call the ``VIDIOC_S_CROP`` ioctl with a pointer
+v4l2_crop structure and call the :ref:`VIDIOC_S_CROP <VIDIOC_G_CROP>` ioctl with a pointer
to this structure.
Do not use the multiplanar buffer types. Use
@@ -64,15 +64,15 @@ the closest size possible while maintaining the current horizontal and
vertical scaling factor.
Finally the driver programs the hardware with the actual cropping and
-image parameters. ``VIDIOC_S_CROP`` is a write-only ioctl, it does not
+image parameters. :ref:`VIDIOC_S_CROP <VIDIOC_G_CROP>` is a write-only ioctl, it does not
return the actual parameters. To query them applications must call
-``VIDIOC_G_CROP`` and :ref:`VIDIOC_G_FMT`. When the
+:ref:`VIDIOC_G_CROP` and :ref:`VIDIOC_G_FMT`. When the
parameters are unsuitable the application may modify the cropping or
image parameters and repeat the cycle until satisfactory parameters have
been negotiated.
When cropping is not supported then no parameters are changed and
-``VIDIOC_S_CROP`` returns the EINVAL error code.
+:ref:`VIDIOC_S_CROP <VIDIOC_G_CROP>` returns the EINVAL error code.
.. _v4l2-crop:
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-ctrl.rst b/Documentation/linux_tv/media/v4l/vidioc-g-ctrl.rst
index 2c2677a76462..41561c5e444d 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-ctrl.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-ctrl.rst
@@ -34,15 +34,15 @@ Description
To get the current value of a control applications initialize the ``id``
field of a struct :c:type:`struct v4l2_control` and call the
-``VIDIOC_G_CTRL`` ioctl with a pointer to this structure. To change the
+:ref:`VIDIOC_G_CTRL` ioctl with a pointer to this structure. To change the
value of a control applications initialize the ``id`` and ``value``
fields of a struct :c:type:`struct v4l2_control` and call the
-``VIDIOC_S_CTRL`` ioctl.
+:ref:`VIDIOC_S_CTRL <VIDIOC_G_CTRL>` ioctl.
When the ``id`` is invalid drivers return an EINVAL error code. When the
``value`` is out of bounds drivers can choose to take the closest valid
value or return an ERANGE error code, whatever seems more appropriate.
-However, ``VIDIOC_S_CTRL`` is a write-only ioctl, it does not return the
+However, :ref:`VIDIOC_S_CTRL <VIDIOC_G_CTRL>` is a write-only ioctl, it does not return the
actual new value. If the ``value`` is inappropriate for the control
(e.g. if it refers to an unsupported menu index of a menu control), then
EINVAL error code is returned as well.
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-dv-timings.rst b/Documentation/linux_tv/media/v4l/vidioc-g-dv-timings.rst
index 8a7fa1c0facf..cc7cf06e74ee 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-dv-timings.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-dv-timings.rst
@@ -36,8 +36,8 @@ Description
===========
To set DV timings for the input or output, applications use the
-``VIDIOC_S_DV_TIMINGS`` ioctl and to get the current timings,
-applications use the ``VIDIOC_G_DV_TIMINGS`` ioctl. The detailed timing
+:ref:`VIDIOC_S_DV_TIMINGS <VIDIOC_G_DV_TIMINGS>` ioctl and to get the current timings,
+applications use the :ref:`VIDIOC_G_DV_TIMINGS` ioctl. The detailed timing
information is filled in using the structure struct
:ref:`v4l2_dv_timings <v4l2-dv-timings>`. These ioctls take a
pointer to the struct :ref:`v4l2_dv_timings <v4l2-dv-timings>`
@@ -59,7 +59,7 @@ appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.
EINVAL
- This ioctl is not supported, or the ``VIDIOC_S_DV_TIMINGS``
+ This ioctl is not supported, or the :ref:`VIDIOC_S_DV_TIMINGS <VIDIOC_G_DV_TIMINGS>`
parameter was unsuitable.
ENODATA
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-edid.rst b/Documentation/linux_tv/media/v4l/vidioc-g-edid.rst
index 0bd8f1ba84d2..a1311a52b8fa 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-edid.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-edid.rst
@@ -52,7 +52,7 @@ value, then the EINVAL error code will be returned.
To get the EDID data the application has to fill in the ``pad``,
``start_block``, ``blocks`` and ``edid`` fields, zero the ``reserved``
-array and call ``VIDIOC_G_EDID``. The current EDID from block
+array and call :ref:`VIDIOC_G_EDID`. The current EDID from block
``start_block`` and of size ``blocks`` will be placed in the memory
``edid`` points to. The ``edid`` pointer must point to memory at least
``blocks`` * 128 bytes large (the size of one block is 128 bytes).
@@ -65,7 +65,7 @@ If blocks have to be retrieved from the sink, then this call will block
until they have been read.
If ``start_block`` and ``blocks`` are both set to 0 when
-``VIDIOC_G_EDID`` is called, then the driver will set ``blocks`` to the
+:ref:`VIDIOC_G_EDID` is called, then the driver will set ``blocks`` to the
total number of available EDID blocks and it will return 0 without
copying any data. This is an easy way to discover how many EDID blocks
there are. Note that if there are no EDID blocks available at all, then
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-enc-index.rst b/Documentation/linux_tv/media/v4l/vidioc-g-enc-index.rst
index 68af83d964f6..77c7eff9732d 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-enc-index.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-enc-index.rst
@@ -31,19 +31,19 @@ Arguments
Description
===========
-The ``VIDIOC_G_ENC_INDEX`` ioctl provides meta data about a compressed
+The :ref:`VIDIOC_G_ENC_INDEX` ioctl provides meta data about a compressed
video stream the same or another application currently reads from the
driver, which is useful for random access into the stream without
decoding it.
-To read the data applications must call ``VIDIOC_G_ENC_INDEX`` with a
+To read the data applications must call :ref:`VIDIOC_G_ENC_INDEX` with a
pointer to a struct :ref:`v4l2_enc_idx <v4l2-enc-idx>`. On success
the driver fills the ``entry`` array, stores the number of elements
written in the ``entries`` field, and initializes the ``entries_cap``
field.
Each element of the ``entry`` array contains meta data about one
-picture. A ``VIDIOC_G_ENC_INDEX`` call reads up to
+picture. A :ref:`VIDIOC_G_ENC_INDEX` call reads up to
``V4L2_ENC_IDX_ENTRIES`` entries from a driver buffer, which can hold up
to ``entries_cap`` entries. This number can be lower or higher than
``V4L2_ENC_IDX_ENTRIES``, but not zero. When the application fails to
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-ext-ctrls.rst b/Documentation/linux_tv/media/v4l/vidioc-g-ext-ctrls.rst
index cebaa6ea1ba9..fb62cd0a991c 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-ext-ctrls.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-ext-ctrls.rst
@@ -48,7 +48,7 @@ by the ``controls`` fields.
To get the current value of a set of controls applications initialize
the ``id``, ``size`` and ``reserved2`` fields of each struct
:ref:`v4l2_ext_control <v4l2-ext-control>` and call the
-``VIDIOC_G_EXT_CTRLS`` ioctl. String controls controls must also set the
+:ref:`VIDIOC_G_EXT_CTRLS` ioctl. String controls controls must also set the
``string`` field. Controls of compound types
(``V4L2_CTRL_FLAG_HAS_PAYLOAD`` is set) must set the ``ptr`` field.
@@ -70,14 +70,14 @@ by calling :ref:`VIDIOC_QUERY_EXT_CTRL <VIDIOC_QUERYCTRL>`.
To change the value of a set of controls applications initialize the
``id``, ``size``, ``reserved2`` and ``value/value64/string/ptr`` fields
of each struct :ref:`v4l2_ext_control <v4l2-ext-control>` and call
-the ``VIDIOC_S_EXT_CTRLS`` ioctl. The controls will only be set if *all*
+the :ref:`VIDIOC_S_EXT_CTRLS <VIDIOC_G_EXT_CTRLS>` ioctl. The controls will only be set if *all*
control values are valid.
To check if a set of controls have correct values applications
initialize the ``id``, ``size``, ``reserved2`` and
``value/value64/string/ptr`` fields of each struct
:ref:`v4l2_ext_control <v4l2-ext-control>` and call the
-``VIDIOC_TRY_EXT_CTRLS`` ioctl. It is up to the driver whether wrong
+:ref:`VIDIOC_TRY_EXT_CTRLS <VIDIOC_G_EXT_CTRLS>` ioctl. It is up to the driver whether wrong
values are automatically adjusted to a valid value or if an error is
returned.
@@ -122,7 +122,7 @@ still cause this situation.
- The total size in bytes of the payload of this control. This is
normally 0, but for pointer controls this should be set to the
size of the memory containing the payload, or that will receive
- the payload. If ``VIDIOC_G_EXT_CTRLS`` finds that this value is
+ the payload. If :ref:`VIDIOC_G_EXT_CTRLS` finds that this value is
less than is required to store the payload result, then it is set
to a value large enough to store the payload result and ENOSPC is
returned. Note that for string controls this ``size`` field should
@@ -248,7 +248,7 @@ still cause this situation.
handling controls will also accept a value of 0 here, meaning that
the controls can belong to any control class. Whether drivers
support this can be tested by setting ``ctrl_class`` to 0 and
- calling ``VIDIOC_TRY_EXT_CTRLS`` with a ``count`` of 0. If that
+ calling :ref:`VIDIOC_TRY_EXT_CTRLS <VIDIOC_G_EXT_CTRLS>` with a ``count`` of 0. If that
succeeds, then the driver supports this feature.
- .. row 3
@@ -321,14 +321,14 @@ still cause this situation.
``error_idx-1`` were read or written correctly, and the state of
the remaining controls is undefined.
- Since ``VIDIOC_TRY_EXT_CTRLS`` does not access hardware there is
+ Since :ref:`VIDIOC_TRY_EXT_CTRLS <VIDIOC_G_EXT_CTRLS>` does not access hardware there is
also no need to handle the validation step in this special way, so
``error_idx`` will just be set to the control that failed the
validation step instead of to ``count``. This means that if
- ``VIDIOC_S_EXT_CTRLS`` fails with ``error_idx`` set to ``count``,
- then you can call ``VIDIOC_TRY_EXT_CTRLS`` to try to discover the
+ :ref:`VIDIOC_S_EXT_CTRLS <VIDIOC_G_EXT_CTRLS>` fails with ``error_idx`` set to ``count``,
+ then you can call :ref:`VIDIOC_TRY_EXT_CTRLS <VIDIOC_G_EXT_CTRLS>` to try to discover the
actual control that failed the validation step. Unfortunately,
- there is no ``TRY`` equivalent for ``VIDIOC_G_EXT_CTRLS``.
+ there is no ``TRY`` equivalent for :ref:`VIDIOC_G_EXT_CTRLS`.
- .. row 6
@@ -467,7 +467,7 @@ EINVAL
:ref:`v4l2_ext_control <v4l2-ext-control>` ``value`` was
inappropriate (e.g. the given menu index is not supported by the
driver). This error code is also returned by the
- ``VIDIOC_S_EXT_CTRLS`` and ``VIDIOC_TRY_EXT_CTRLS`` ioctls if two or
+ :ref:`VIDIOC_S_EXT_CTRLS <VIDIOC_G_EXT_CTRLS>` and :ref:`VIDIOC_TRY_EXT_CTRLS <VIDIOC_G_EXT_CTRLS>` ioctls if two or
more control values are in conflict.
ERANGE
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-fbuf.rst b/Documentation/linux_tv/media/v4l/vidioc-g-fbuf.rst
index 0d9b6972bc44..e622e2f2435c 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-fbuf.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-fbuf.rst
@@ -34,7 +34,7 @@ Arguments
Description
===========
-Applications can use the ``VIDIOC_G_FBUF`` and ``VIDIOC_S_FBUF`` ioctl
+Applications can use the :ref:`VIDIOC_G_FBUF` and :ref:`VIDIOC_S_FBUF <VIDIOC_G_FBUF>` ioctl
to get and set the framebuffer parameters for a
:ref:`Video Overlay <overlay>` or :ref:`Video Output Overlay <osd>`
(OSD). The type of overlay is implied by the device type (capture or
@@ -48,7 +48,7 @@ of a graphics card. A non-destructive overlay blends video images into a
VGA signal or graphics into a video signal. *Video Output Overlays* are
always non-destructive.
-To get the current parameters applications call the ``VIDIOC_G_FBUF``
+To get the current parameters applications call the :ref:`VIDIOC_G_FBUF`
ioctl with a pointer to a :c:type:`struct v4l2_framebuffer`
structure. The driver fills all fields of the structure or returns an
EINVAL error code when overlays are not supported.
@@ -57,15 +57,15 @@ To set the parameters for a *Video Output Overlay*, applications must
initialize the ``flags`` field of a struct
:c:type:`struct v4l2_framebuffer`. Since the framebuffer is
implemented on the TV card all other parameters are determined by the
-driver. When an application calls ``VIDIOC_S_FBUF`` with a pointer to
+driver. When an application calls :ref:`VIDIOC_S_FBUF <VIDIOC_G_FBUF>` with a pointer to
this structure, the driver prepares for the overlay and returns the
-framebuffer parameters as ``VIDIOC_G_FBUF`` does, or it returns an error
+framebuffer parameters as :ref:`VIDIOC_G_FBUF` does, or it returns an error
code.
To set the parameters for a *non-destructive Video Overlay*,
applications must initialize the ``flags`` field, the ``fmt``
-substructure, and call ``VIDIOC_S_FBUF``. Again the driver prepares for
-the overlay and returns the framebuffer parameters as ``VIDIOC_G_FBUF``
+substructure, and call :ref:`VIDIOC_S_FBUF <VIDIOC_G_FBUF>`. Again the driver prepares for
+the overlay and returns the framebuffer parameters as :ref:`VIDIOC_G_FBUF`
does, or it returns an error code.
For a *destructive Video Overlay* applications must additionally provide
@@ -486,11 +486,11 @@ appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.
EPERM
- ``VIDIOC_S_FBUF`` can only be called by a privileged user to
+ :ref:`VIDIOC_S_FBUF <VIDIOC_G_FBUF>` can only be called by a privileged user to
negotiate the parameters for a destructive overlay.
EINVAL
- The ``VIDIOC_S_FBUF`` parameters are unsuitable.
+ The :ref:`VIDIOC_S_FBUF <VIDIOC_G_FBUF>` parameters are unsuitable.
.. [1]
A physical base address may not suit all platforms. GK notes in
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-fmt.rst b/Documentation/linux_tv/media/v4l/vidioc-g-fmt.rst
index 1d392e6c538d..8c07fe2454e2 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-fmt.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-fmt.rst
@@ -41,7 +41,7 @@ struct :c:type:`struct v4l2_format` to the respective buffer (stream)
type. For example video capture devices use
``V4L2_BUF_TYPE_VIDEO_CAPTURE`` or
``V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE``. When the application calls the
-``VIDIOC_G_FMT`` ioctl with a pointer to this structure the driver fills
+:ref:`VIDIOC_G_FMT` ioctl with a pointer to this structure the driver fills
the respective member of the ``fmt`` union. In case of video capture
devices that is either the struct
:ref:`v4l2_pix_format <v4l2-pix-format>` ``pix`` or the struct
@@ -54,32 +54,32 @@ To change the current format parameters applications initialize the
For details see the documentation of the various devices types in
:ref:`devices`. Good practice is to query the current parameters
first, and to modify only those parameters not suitable for the
-application. When the application calls the ``VIDIOC_S_FMT`` ioctl with
+application. When the application calls the :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl with
a pointer to a :c:type:`struct v4l2_format` structure the driver
checks and adjusts the parameters against hardware abilities. Drivers
should not return an error code unless the ``type`` field is invalid,
this is a mechanism to fathom device capabilities and to approach
parameters acceptable for both the application and driver. On success
the driver may program the hardware, allocate resources and generally
-prepare for data exchange. Finally the ``VIDIOC_S_FMT`` ioctl returns
-the current format parameters as ``VIDIOC_G_FMT`` does. Very simple,
+prepare for data exchange. Finally the :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl returns
+the current format parameters as :ref:`VIDIOC_G_FMT` does. Very simple,
inflexible devices may even ignore all input and always return the
default parameters. However all V4L2 devices exchanging data with the
-application must implement the ``VIDIOC_G_FMT`` and ``VIDIOC_S_FMT``
+application must implement the :ref:`VIDIOC_G_FMT` and :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>`
ioctl. When the requested buffer type is not supported drivers return an
-EINVAL error code on a ``VIDIOC_S_FMT`` attempt. When I/O is already in
+EINVAL error code on a :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` attempt. When I/O is already in
progress or the resource is not available for other reasons drivers
return the EBUSY error code.
-The ``VIDIOC_TRY_FMT`` ioctl is equivalent to ``VIDIOC_S_FMT`` with one
+The :ref:`VIDIOC_TRY_FMT <VIDIOC_G_FMT>` ioctl is equivalent to :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` with one
exception: it does not change driver state. It can also be called at any
time, never returning EBUSY. This function is provided to negotiate
parameters, to learn about hardware limitations, without disabling I/O
or possibly time consuming hardware preparations. Although strongly
recommended drivers are not required to implement this ioctl.
-The format as returned by ``VIDIOC_TRY_FMT`` must be identical to what
-``VIDIOC_S_FMT`` returns for the same input or output.
+The format as returned by :ref:`VIDIOC_TRY_FMT <VIDIOC_G_FMT>` must be identical to what
+:ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` returns for the same input or output.
.. _v4l2-format:
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-frequency.rst b/Documentation/linux_tv/media/v4l/vidioc-g-frequency.rst
index ce247577c3a0..19a5ae9c4bcd 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-frequency.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-frequency.rst
@@ -39,15 +39,15 @@ the ``tuner`` field of a struct
:ref:`v4l2_frequency <v4l2-frequency>` to the respective tuner or
modulator number (only input devices have tuners, only output devices
have modulators), zero out the ``reserved`` array and call the
-``VIDIOC_G_FREQUENCY`` ioctl with a pointer to this structure. The
+:ref:`VIDIOC_G_FREQUENCY` ioctl with a pointer to this structure. The
driver stores the current frequency in the ``frequency`` field.
To change the current tuner or modulator radio frequency applications
initialize the ``tuner``, ``type`` and ``frequency`` fields, and the
``reserved`` array of a struct :ref:`v4l2_frequency <v4l2-frequency>`
-and call the ``VIDIOC_S_FREQUENCY`` ioctl with a pointer to this
+and call the :ref:`VIDIOC_S_FREQUENCY <VIDIOC_G_FREQUENCY>` ioctl with a pointer to this
structure. When the requested frequency is not possible the driver
-assumes the closest possible value. However ``VIDIOC_S_FREQUENCY`` is a
+assumes the closest possible value. However :ref:`VIDIOC_S_FREQUENCY <VIDIOC_G_FREQUENCY>` is a
write-only ioctl, it does not return the actual new frequency.
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-input.rst b/Documentation/linux_tv/media/v4l/vidioc-g-input.rst
index d0abf6231b7d..2bcaa324aa33 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-input.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-input.rst
@@ -33,13 +33,13 @@ Description
===========
To query the current video input applications call the
-``VIDIOC_G_INPUT`` ioctl with a pointer to an integer where the driver
+:ref:`VIDIOC_G_INPUT` ioctl with a pointer to an integer where the driver
stores the number of the input, as in the struct
:ref:`v4l2_input <v4l2-input>` ``index`` field. This ioctl will fail
only when there are no video inputs, returning EINVAL.
To select a video input applications store the number of the desired
-input in an integer and call the ``VIDIOC_S_INPUT`` ioctl with a pointer
+input in an integer and call the :ref:`VIDIOC_S_INPUT <VIDIOC_G_INPUT>` ioctl with a pointer
to this integer. Side effects are possible. For example inputs may
support different video standards, so the driver may implicitly switch
the current standard. Because of these possible side effects
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-modulator.rst b/Documentation/linux_tv/media/v4l/vidioc-g-modulator.rst
index 4399a13f94c1..83e761eaef2b 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-modulator.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-modulator.rst
@@ -37,7 +37,7 @@ Description
To query the attributes of a modulator applications initialize the
``index`` field and zero out the ``reserved`` array of a struct
:ref:`v4l2_modulator <v4l2-modulator>` and call the
-``VIDIOC_G_MODULATOR`` ioctl with a pointer to this structure. Drivers
+:ref:`VIDIOC_G_MODULATOR` ioctl with a pointer to this structure. Drivers
fill the rest of the structure or return an EINVAL error code when the
index is out of bounds. To enumerate all modulators applications shall
begin at index zero, incrementing by one until the driver returns
@@ -46,7 +46,7 @@ EINVAL.
Modulators have two writable properties, an audio modulation set and the
radio frequency. To change the modulated audio subprograms, applications
initialize the ``index`` and ``txsubchans`` fields and the ``reserved``
-array and call the ``VIDIOC_S_MODULATOR`` ioctl. Drivers may choose a
+array and call the :ref:`VIDIOC_S_MODULATOR <VIDIOC_G_MODULATOR>` ioctl. Drivers may choose a
different audio modulation if the request cannot be satisfied. However
this is a write-only ioctl, it does not return the actual audio
modulation selected.
@@ -198,7 +198,7 @@ To change the radio frequency the
``V4L2_TUNER_SUB_MONO``, ``V4L2_TUNER_SUB_STEREO`` or
``V4L2_TUNER_SUB_SAP``. If the hardware does not support the
respective audio matrix, or the current video standard does not
- permit bilingual audio the ``VIDIOC_S_MODULATOR`` ioctl shall
+ permit bilingual audio the :ref:`VIDIOC_S_MODULATOR <VIDIOC_G_MODULATOR>` ioctl shall
return an EINVAL error code and the driver shall fall back to mono
or stereo mode.
@@ -230,7 +230,7 @@ To change the radio frequency the
``V4L2_TUNER_SUB_MONO`` or ``V4L2_TUNER_SUB_STEREO``. If the
hardware does not support the respective audio matrix, or the
current video standard does not permit SAP the
- ``VIDIOC_S_MODULATOR`` ioctl shall return an EINVAL error code and
+ :ref:`VIDIOC_S_MODULATOR <VIDIOC_G_MODULATOR>` ioctl shall return an EINVAL error code and
driver shall fall back to mono or stereo mode.
- .. row 6
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-output.rst b/Documentation/linux_tv/media/v4l/vidioc-g-output.rst
index a38d6a118cf4..ebed04ae48da 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-output.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-output.rst
@@ -33,14 +33,14 @@ Description
===========
To query the current video output applications call the
-``VIDIOC_G_OUTPUT`` ioctl with a pointer to an integer where the driver
+:ref:`VIDIOC_G_OUTPUT` ioctl with a pointer to an integer where the driver
stores the number of the output, as in the struct
:ref:`v4l2_output <v4l2-output>` ``index`` field. This ioctl will
fail only when there are no video outputs, returning the EINVAL error
code.
To select a video output applications store the number of the desired
-output in an integer and call the ``VIDIOC_S_OUTPUT`` ioctl with a
+output in an integer and call the :ref:`VIDIOC_S_OUTPUT <VIDIOC_G_OUTPUT>` ioctl with a
pointer to this integer. Side effects are possible. For example outputs
may support different video standards, so the driver may implicitly
switch the current standard. standard. Because of these possible side
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-parm.rst b/Documentation/linux_tv/media/v4l/vidioc-g-parm.rst
index 07432d386356..906faaa85bfa 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-parm.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-parm.rst
@@ -44,7 +44,7 @@ internally by a driver in read/write mode. For implications see the
section discussing the :ref:`read() <func-read>` function.
To get and set the streaming parameters applications call the
-``VIDIOC_G_PARM`` and ``VIDIOC_S_PARM`` ioctl, respectively. They take a
+:ref:`VIDIOC_G_PARM` and :ref:`VIDIOC_S_PARM <VIDIOC_G_PARM>` ioctl, respectively. They take a
pointer to a struct :c:type:`struct v4l2_streamparm` which contains a
union holding separate parameters for input and output devices.
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-priority.rst b/Documentation/linux_tv/media/v4l/vidioc-g-priority.rst
index ee80c9e0c7d4..db95647d3a80 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-priority.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-priority.rst
@@ -36,11 +36,11 @@ Description
===========
To query the current access priority applications call the
-``VIDIOC_G_PRIORITY`` ioctl with a pointer to an enum v4l2_priority
+:ref:`VIDIOC_G_PRIORITY` ioctl with a pointer to an enum v4l2_priority
variable where the driver stores the current priority.
To request an access priority applications store the desired priority in
-an enum v4l2_priority variable and call ``VIDIOC_S_PRIORITY`` ioctl
+an enum v4l2_priority variable and call :ref:`VIDIOC_S_PRIORITY <VIDIOC_G_PRIORITY>` ioctl
with a pointer to this variable.
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-sliced-vbi-cap.rst b/Documentation/linux_tv/media/v4l/vidioc-g-sliced-vbi-cap.rst
index 8c86d2b41a5b..635cb9b2c250 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-sliced-vbi-cap.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-sliced-vbi-cap.rst
@@ -34,7 +34,7 @@ Description
To find out which data services are supported by a sliced VBI capture or
output device, applications initialize the ``type`` field of a struct
:ref:`v4l2_sliced_vbi_cap <v4l2-sliced-vbi-cap>`, clear the
-``reserved`` array and call the ``VIDIOC_G_SLICED_VBI_CAP`` ioctl. The
+``reserved`` array and call the :ref:`VIDIOC_G_SLICED_VBI_CAP` ioctl. The
driver fills in the remaining fields or returns an EINVAL error code if
the sliced VBI API is unsupported or ``type`` is invalid.
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-std.rst b/Documentation/linux_tv/media/v4l/vidioc-g-std.rst
index fa9da29e0657..bc8e071401b0 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-std.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-std.rst
@@ -35,15 +35,15 @@ Description
===========
To query and select the current video standard applications use the
-``VIDIOC_G_STD`` and ``VIDIOC_S_STD`` ioctls which take a pointer to a
-:ref:`v4l2_std_id <v4l2-std-id>` type as argument. ``VIDIOC_G_STD``
+:ref:`VIDIOC_G_STD` and :ref:`VIDIOC_S_STD <VIDIOC_G_STD>` ioctls which take a pointer to a
+:ref:`v4l2_std_id <v4l2-std-id>` type as argument. :ref:`VIDIOC_G_STD`
can return a single flag or a set of flags as in struct
:ref:`v4l2_standard <v4l2-standard>` field ``id``. The flags must be
unambiguous such that they appear in only one enumerated
:c:type:`struct v4l2_standard` structure.
-``VIDIOC_S_STD`` accepts one or more flags, being a write-only ioctl it
-does not return the actual new standard as ``VIDIOC_G_STD`` does. When
+:ref:`VIDIOC_S_STD <VIDIOC_G_STD>` accepts one or more flags, being a write-only ioctl it
+does not return the actual new standard as :ref:`VIDIOC_G_STD` does. When
no flags are given or the current input does not support the requested
standard the driver returns an EINVAL error code. When the standard set
is ambiguous drivers may return EINVAL or choose any of the requested
@@ -61,7 +61,7 @@ appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.
EINVAL
- The ``VIDIOC_S_STD`` parameter was unsuitable.
+ The :ref:`VIDIOC_S_STD <VIDIOC_G_STD>` parameter was unsuitable.
ENODATA
Standard video timings are not supported for this input or output.
diff --git a/Documentation/linux_tv/media/v4l/vidioc-overlay.rst b/Documentation/linux_tv/media/v4l/vidioc-overlay.rst
index fe9084147b93..10faf2517392 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-overlay.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-overlay.rst
@@ -32,7 +32,7 @@ Description
===========
This ioctl is part of the :ref:`video overlay <overlay>` I/O method.
-Applications call ``VIDIOC_OVERLAY`` to start or stop the overlay. It
+Applications call :ref:`VIDIOC_OVERLAY` to start or stop the overlay. It
takes a pointer to an integer which must be set to zero by the
application to stop overlay, to one to start.
diff --git a/Documentation/linux_tv/media/v4l/vidioc-prepare-buf.rst b/Documentation/linux_tv/media/v4l/vidioc-prepare-buf.rst
index fb3ac38b3db2..0b51c587701b 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-prepare-buf.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-prepare-buf.rst
@@ -31,9 +31,9 @@ Arguments
Description
===========
-Applications can optionally call the ``VIDIOC_PREPARE_BUF`` ioctl to
+Applications can optionally call the :ref:`VIDIOC_PREPARE_BUF` ioctl to
pass ownership of the buffer to the driver before actually enqueuing it,
-using the ``VIDIOC_QBUF`` ioctl, and to prepare it for future I/O. Such
+using the :ref:`VIDIOC_QBUF` ioctl, and to prepare it for future I/O. Such
preparations may include cache invalidation or cleaning. Performing them
in advance saves time during the actual I/O. In case such cache
operations are not required, the application can use one of
diff --git a/Documentation/linux_tv/media/v4l/vidioc-query-dv-timings.rst b/Documentation/linux_tv/media/v4l/vidioc-query-dv-timings.rst
index ba78f7e5bbe8..0120432de989 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-query-dv-timings.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-query-dv-timings.rst
@@ -34,18 +34,18 @@ Description
The hardware may be able to detect the current DV timings automatically,
similar to sensing the video standard. To do so, applications call
-``VIDIOC_QUERY_DV_TIMINGS`` with a pointer to a struct
+:ref:`VIDIOC_QUERY_DV_TIMINGS` with a pointer to a struct
:ref:`v4l2_dv_timings <v4l2-dv-timings>`. Once the hardware detects
the timings, it will fill in the timings structure.
Please note that drivers shall *not* switch timings automatically if new
timings are detected. Instead, drivers should send the
``V4L2_EVENT_SOURCE_CHANGE`` event (if they support this) and expect
-that userspace will take action by calling ``VIDIOC_QUERY_DV_TIMINGS``.
+that userspace will take action by calling :ref:`VIDIOC_QUERY_DV_TIMINGS`.
The reason is that new timings usually mean different buffer sizes as
well, and you cannot change buffer sizes on the fly. In general,
applications that receive the Source Change event will have to call
-``VIDIOC_QUERY_DV_TIMINGS``, and if the detected timings are valid they
+:ref:`VIDIOC_QUERY_DV_TIMINGS`, and if the detected timings are valid they
will have to stop streaming, set the new timings, allocate new buffers
and start streaming again.
diff --git a/Documentation/linux_tv/media/v4l/vidioc-querybuf.rst b/Documentation/linux_tv/media/v4l/vidioc-querybuf.rst
index 744cd9da45a3..280fb795c0b9 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-querybuf.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-querybuf.rst
@@ -48,7 +48,7 @@ using the :ref:`multi-planar API <planar-apis>`, the ``m.planes``
field must contain a userspace pointer to an array of struct
:ref:`v4l2_plane <v4l2-plane>` and the ``length`` field has to be set
to the number of elements in that array. After calling
-``VIDIOC_QUERYBUF`` with a pointer to this structure drivers return an
+:ref:`VIDIOC_QUERYBUF` with a pointer to this structure drivers return an
error code or fill the rest of the structure.
In the ``flags`` field the ``V4L2_BUF_FLAG_MAPPED``,
diff --git a/Documentation/linux_tv/media/v4l/vidioc-querystd.rst b/Documentation/linux_tv/media/v4l/vidioc-querystd.rst
index 1d825fff9d15..29ce879a708b 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-querystd.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-querystd.rst
@@ -32,7 +32,7 @@ Description
===========
The hardware may be able to detect the current video standard
-automatically. To do so, applications call ``VIDIOC_QUERYSTD`` with a
+automatically. To do so, applications call :ref:`VIDIOC_QUERYSTD` with a
pointer to a :ref:`v4l2_std_id <v4l2-std-id>` type. The driver
stores here a set of candidates, this can be a single flag or a set of
supported standards if for example the hardware can only distinguish
@@ -45,10 +45,10 @@ Please note that drivers shall *not* switch the video standard
automatically if a new video standard is detected. Instead, drivers
should send the ``V4L2_EVENT_SOURCE_CHANGE`` event (if they support
this) and expect that userspace will take action by calling
-``VIDIOC_QUERYSTD``. The reason is that a new video standard can mean
+:ref:`VIDIOC_QUERYSTD`. The reason is that a new video standard can mean
different buffer sizes as well, and you cannot change buffer sizes on
the fly. In general, applications that receive the Source Change event
-will have to call ``VIDIOC_QUERYSTD``, and if the detected video
+will have to call :ref:`VIDIOC_QUERYSTD`, and if the detected video
standard is valid they will have to stop streaming, set the new
standard, allocate new buffers and start streaming again.
diff --git a/Documentation/linux_tv/media/v4l/vidioc-reqbufs.rst b/Documentation/linux_tv/media/v4l/vidioc-reqbufs.rst
index c17d3b0465d6..451cf7b11c3d 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-reqbufs.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-reqbufs.rst
@@ -58,7 +58,7 @@ buffers, one displayed and one filled by the application.
When the I/O method is not supported the ioctl returns an EINVAL error
code.
-Applications can call ``VIDIOC_REQBUFS`` again to change the number of
+Applications can call :ref:`VIDIOC_REQBUFS` again to change the number of
buffers, however this cannot succeed when any buffers are still mapped.
A ``count`` value of zero frees all buffers, after aborting or finishing
any DMA in progress, an implicit
diff --git a/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-frame-interval.rst b/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-frame-interval.rst
index ab1368786038..07ad0a98ead2 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-frame-interval.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-frame-interval.rst
@@ -44,7 +44,7 @@ when enumerating frame intervals.
To enumerate frame intervals applications initialize the ``index``,
``pad``, ``which``, ``code``, ``width`` and ``height`` fields of struct
:ref:`v4l2_subdev_frame_interval_enum <v4l2-subdev-frame-interval-enum>`
-and call the ``VIDIOC_SUBDEV_ENUM_FRAME_INTERVAL`` ioctl with a pointer
+and call the :ref:`VIDIOC_SUBDEV_ENUM_FRAME_INTERVAL` ioctl with a pointer
to this structure. Drivers fill the rest of the structure or return an
EINVAL error code if one of the input fields is invalid. All frame
intervals are enumerable by beginning at index zero and incrementing by
diff --git a/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-frame-size.rst b/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-frame-size.rst
index e08de6040757..39393ef11590 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-frame-size.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-frame-size.rst
@@ -40,7 +40,7 @@ ioctl.
To enumerate frame sizes applications initialize the ``pad``, ``which``
, ``code`` and ``index`` fields of the struct
:ref:`v4l2_subdev_mbus_code_enum <v4l2-subdev-mbus-code-enum>` and
-call the ``VIDIOC_SUBDEV_ENUM_FRAME_SIZE`` ioctl with a pointer to the
+call the :ref:`VIDIOC_SUBDEV_ENUM_FRAME_SIZE` ioctl with a pointer to the
structure. Drivers fill the minimum and maximum frame sizes or return an
EINVAL error code if one of the input parameters is invalid.
diff --git a/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-mbus-code.rst b/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-mbus-code.rst
index 0daf410c1546..f50a1f1c68d5 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-mbus-code.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-mbus-code.rst
@@ -35,7 +35,7 @@ To enumerate media bus formats available at a given sub-device pad
applications initialize the ``pad``, ``which`` and ``index`` fields of
struct
:ref:`v4l2_subdev_mbus_code_enum <v4l2-subdev-mbus-code-enum>` and
-call the ``VIDIOC_SUBDEV_ENUM_MBUS_CODE`` ioctl with a pointer to this
+call the :ref:`VIDIOC_SUBDEV_ENUM_MBUS_CODE` ioctl with a pointer to this
structure. Drivers fill the rest of the structure or return an EINVAL
error code if either the ``pad`` or ``index`` are invalid. All media bus
formats are enumerable by beginning at index zero and incrementing by
--
2.7.4
^ permalink raw reply related [flat|nested] 52+ messages in thread* [PATCH 14/51] Documentation: linux_tv: don't simplify VIDIOC_G_foo references
2016-07-04 11:46 [PATCH 00/51] First part of documentation fixups Mauro Carvalho Chehab
` (12 preceding siblings ...)
2016-07-04 11:46 ` [PATCH 13/51] Documentation: linux_tv: convert lots of consts to references Mauro Carvalho Chehab
@ 2016-07-04 11:46 ` Mauro Carvalho Chehab
2016-07-04 11:46 ` [PATCH 15/51] Documentation: audio.rst: re-add captions for the examples Mauro Carvalho Chehab
` (36 subsequent siblings)
50 siblings, 0 replies; 52+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-04 11:46 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, Jonathan Corbet,
Markus Heiser, linux-doc
As VIDIOC_G_foo is the reference used for VIDIOC_S_foo and
VIDIOC_TRY_foo, we need to explicitly name the reference, as
otherwise, it will mention the three ioctls altogether, with
is not what we want.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
Documentation/linux_tv/media/v4l/app-pri.rst | 2 +-
Documentation/linux_tv/media/v4l/audio.rst | 6 ++---
Documentation/linux_tv/media/v4l/control.rst | 2 +-
Documentation/linux_tv/media/v4l/crop.rst | 4 ++--
Documentation/linux_tv/media/v4l/dev-capture.rst | 12 +++++-----
Documentation/linux_tv/media/v4l/dev-osd.rst | 6 ++---
Documentation/linux_tv/media/v4l/dev-output.rst | 12 +++++-----
Documentation/linux_tv/media/v4l/dev-overlay.rst | 12 +++++-----
Documentation/linux_tv/media/v4l/dev-radio.rst | 4 ++--
Documentation/linux_tv/media/v4l/dev-raw-vbi.rst | 8 +++----
.../linux_tv/media/v4l/dev-sliced-vbi.rst | 6 ++---
Documentation/linux_tv/media/v4l/diff-v4l.rst | 24 +++++++++----------
Documentation/linux_tv/media/v4l/dv-timings.rst | 2 +-
.../linux_tv/media/v4l/extended-controls.rst | 4 ++--
Documentation/linux_tv/media/v4l/format.rst | 4 ++--
Documentation/linux_tv/media/v4l/func-read.rst | 2 +-
Documentation/linux_tv/media/v4l/hist-v4l2.rst | 28 +++++++++++-----------
.../linux_tv/media/v4l/libv4l-introduction.rst | 2 +-
Documentation/linux_tv/media/v4l/pixfmt-013.rst | 2 +-
Documentation/linux_tv/media/v4l/pixfmt.rst | 2 +-
Documentation/linux_tv/media/v4l/planar-apis.rst | 2 +-
Documentation/linux_tv/media/v4l/standard.rst | 4 ++--
Documentation/linux_tv/media/v4l/streaming-par.rst | 2 +-
Documentation/linux_tv/media/v4l/tuner.rst | 8 +++----
Documentation/linux_tv/media/v4l/video.rst | 4 ++--
.../linux_tv/media/v4l/vidioc-create-bufs.rst | 2 +-
.../linux_tv/media/v4l/vidioc-enumaudio.rst | 2 +-
.../linux_tv/media/v4l/vidioc-enumaudioout.rst | 2 +-
.../linux_tv/media/v4l/vidioc-enumstd.rst | 2 +-
.../linux_tv/media/v4l/vidioc-g-audio.rst | 2 +-
Documentation/linux_tv/media/v4l/vidioc-g-crop.rst | 4 ++--
Documentation/linux_tv/media/v4l/vidioc-g-ctrl.rst | 4 ++--
.../linux_tv/media/v4l/vidioc-g-dv-timings.rst | 2 +-
Documentation/linux_tv/media/v4l/vidioc-g-edid.rst | 4 ++--
.../linux_tv/media/v4l/vidioc-g-enc-index.rst | 6 ++---
.../linux_tv/media/v4l/vidioc-g-ext-ctrls.rst | 8 +++----
Documentation/linux_tv/media/v4l/vidioc-g-fbuf.rst | 8 +++----
Documentation/linux_tv/media/v4l/vidioc-g-fmt.rst | 6 ++---
.../linux_tv/media/v4l/vidioc-g-frequency.rst | 2 +-
.../linux_tv/media/v4l/vidioc-g-input.rst | 2 +-
.../linux_tv/media/v4l/vidioc-g-modulator.rst | 2 +-
.../linux_tv/media/v4l/vidioc-g-output.rst | 2 +-
Documentation/linux_tv/media/v4l/vidioc-g-parm.rst | 2 +-
.../linux_tv/media/v4l/vidioc-g-priority.rst | 2 +-
.../linux_tv/media/v4l/vidioc-g-sliced-vbi-cap.rst | 2 +-
Documentation/linux_tv/media/v4l/vidioc-g-std.rst | 6 ++---
.../linux_tv/media/v4l/vidioc-queryctrl.rst | 2 +-
47 files changed, 119 insertions(+), 119 deletions(-)
diff --git a/Documentation/linux_tv/media/v4l/app-pri.rst b/Documentation/linux_tv/media/v4l/app-pri.rst
index 4faf9042f612..7ff6f44eb591 100644
--- a/Documentation/linux_tv/media/v4l/app-pri.rst
+++ b/Documentation/linux_tv/media/v4l/app-pri.rst
@@ -16,7 +16,7 @@ applications and automatically regain control of the device at a later
time.
Since these features cannot be implemented entirely in user space V4L2
-defines the :ref:`VIDIOC_G_PRIORITY` and
+defines the :ref:`VIDIOC_G_PRIORITY <VIDIOC_G_PRIORITY>` and
:ref:`VIDIOC_S_PRIORITY <VIDIOC_G_PRIORITY>` ioctls to request and
query the access priority associate with a file descriptor. Opening a
device assigns a medium priority, compatible with earlier versions of
diff --git a/Documentation/linux_tv/media/v4l/audio.rst b/Documentation/linux_tv/media/v4l/audio.rst
index 21db1b97b83c..8c3314218f75 100644
--- a/Documentation/linux_tv/media/v4l/audio.rst
+++ b/Documentation/linux_tv/media/v4l/audio.rst
@@ -33,11 +33,11 @@ The struct :ref:`v4l2_audio <v4l2-audio>` returned by the
:ref:`VIDIOC_ENUMAUDIO` ioctl also contains signal
:status information applicable when the current audio input is queried.
-The :ref:`VIDIOC_G_AUDIO` and
+The :ref:`VIDIOC_G_AUDIO <VIDIOC_G_AUDIO>` and
:ref:`VIDIOC_G_AUDOUT <VIDIOC_G_AUDIOout>` ioctls report the current
audio input and output, respectively. Note that, unlike
-:ref:`VIDIOC_G_INPUT` and
-:ref:`VIDIOC_G_OUTPUT` these ioctls return a
+:ref:`VIDIOC_G_INPUT <VIDIOC_G_INPUT>` and
+:ref:`VIDIOC_G_OUTPUT <VIDIOC_G_OUTPUT>` these ioctls return a
structure as :ref:`VIDIOC_ENUMAUDIO` and
:ref:`VIDIOC_ENUMAUDOUT <VIDIOC_ENUMAUDIOout>` do, not just an index.
diff --git a/Documentation/linux_tv/media/v4l/control.rst b/Documentation/linux_tv/media/v4l/control.rst
index 02bd455a2616..d6df648767c5 100644
--- a/Documentation/linux_tv/media/v4l/control.rst
+++ b/Documentation/linux_tv/media/v4l/control.rst
@@ -364,7 +364,7 @@ Control IDs
Applications can enumerate the available controls with the
:ref:`VIDIOC_QUERYCTRL` and
:ref:`VIDIOC_QUERYMENU <VIDIOC_QUERYCTRL>` ioctls, get and set a
-control value with the :ref:`VIDIOC_G_CTRL` and
+control value with the :ref:`VIDIOC_G_CTRL <VIDIOC_G_CTRL>` and
:ref:`VIDIOC_S_CTRL <VIDIOC_G_CTRL>` ioctls. Drivers must implement
``VIDIOC_QUERYCTRL``, ``VIDIOC_G_CTRL`` and ``VIDIOC_S_CTRL`` when the
device has one or more controls, ``VIDIOC_QUERYMENU`` when it has one or
diff --git a/Documentation/linux_tv/media/v4l/crop.rst b/Documentation/linux_tv/media/v4l/crop.rst
index 41a5efaaa679..bfb30568df23 100644
--- a/Documentation/linux_tv/media/v4l/crop.rst
+++ b/Documentation/linux_tv/media/v4l/crop.rst
@@ -15,7 +15,7 @@ offset into a video signal.
Applications can use the following API to select an area in the video
signal, query the default area and the hardware limits. *Despite their
name, the :ref:`VIDIOC_CROPCAP`,
-:ref:`VIDIOC_G_CROP` and
+:ref:`VIDIOC_G_CROP <VIDIOC_G_CROP>` and
:ref:`VIDIOC_S_CROP <VIDIOC_G_CROP>` ioctls apply to input as well
as output devices.*
@@ -23,7 +23,7 @@ Scaling requires a source and a target. On a video capture or overlay
device the source is the video signal, and the cropping ioctls determine
the area actually sampled. The target are images read by the application
or overlaid onto the graphics screen. Their size (and position for an
-overlay) is negotiated with the :ref:`VIDIOC_G_FMT`
+overlay) is negotiated with the :ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>`
and :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctls.
On a video output device the source are the images passed in by the
diff --git a/Documentation/linux_tv/media/v4l/dev-capture.rst b/Documentation/linux_tv/media/v4l/dev-capture.rst
index c970a1fd1439..0e62dc026251 100644
--- a/Documentation/linux_tv/media/v4l/dev-capture.rst
+++ b/Documentation/linux_tv/media/v4l/dev-capture.rst
@@ -65,7 +65,7 @@ To query the current image format applications set the ``type`` field of
a struct :ref:`v4l2_format <v4l2-format>` to
``V4L2_BUF_TYPE_VIDEO_CAPTURE`` or
``V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE`` and call the
-:ref:`VIDIOC_G_FMT` ioctl with a pointer to this
+:ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>` ioctl with a pointer to this
structure. Drivers fill the struct
:ref:`v4l2_pix_format <v4l2-pix-format>` ``pix`` or the struct
:ref:`v4l2_pix_format_mplane <v4l2-pix-format-mplane>` ``pix_mp``
@@ -75,9 +75,9 @@ To request different parameters applications set the ``type`` field of a
struct :ref:`v4l2_format <v4l2-format>` as above and initialize all
fields of the struct :ref:`v4l2_pix_format <v4l2-pix-format>`
``vbi`` member of the ``fmt`` union, or better just modify the results
-of :ref:`VIDIOC_G_FMT`, and call the :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>`
+of :ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>`, and call the :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>`
ioctl with a pointer to this structure. Drivers may adjust the
-parameters and finally return the actual parameters as :ref:`VIDIOC_G_FMT`
+parameters and finally return the actual parameters as :ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>`
does.
Like :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` the :ref:`VIDIOC_TRY_FMT <VIDIOC_G_FMT>` ioctl
@@ -87,10 +87,10 @@ possibly time consuming hardware preparations.
The contents of struct :ref:`v4l2_pix_format <v4l2-pix-format>` and
struct :ref:`v4l2_pix_format_mplane <v4l2-pix-format-mplane>` are
discussed in :ref:`pixfmt`. See also the specification of the
-:ref:`VIDIOC_G_FMT`, :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` and :ref:`VIDIOC_TRY_FMT <VIDIOC_G_FMT>` ioctls for
-details. Video capture devices must implement both the :ref:`VIDIOC_G_FMT`
+:ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>`, :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` and :ref:`VIDIOC_TRY_FMT <VIDIOC_G_FMT>` ioctls for
+details. Video capture devices must implement both the :ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>`
and :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl, even if :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ignores all
-requests and always returns default parameters as :ref:`VIDIOC_G_FMT` does.
+requests and always returns default parameters as :ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>` does.
:ref:`VIDIOC_TRY_FMT <VIDIOC_G_FMT>` is optional.
diff --git a/Documentation/linux_tv/media/v4l/dev-osd.rst b/Documentation/linux_tv/media/v4l/dev-osd.rst
index 4b668a3544b8..f9337001f50d 100644
--- a/Documentation/linux_tv/media/v4l/dev-osd.rst
+++ b/Documentation/linux_tv/media/v4l/dev-osd.rst
@@ -36,7 +36,7 @@ Contrary to the *Video Overlay* interface the framebuffer is normally
implemented on the TV card and not the graphics card. On Linux it is
accessible as a framebuffer device (``/dev/fbN``). Given a V4L2 device,
applications can find the corresponding framebuffer device by calling
-the :ref:`VIDIOC_G_FBUF` ioctl. It returns, amongst
+the :ref:`VIDIOC_G_FBUF <VIDIOC_G_FBUF>` ioctl. It returns, amongst
other information, the physical address of the framebuffer in the
``base`` field of struct :ref:`v4l2_framebuffer <v4l2-framebuffer>`.
The framebuffer device ioctl ``FBIOGET_FSCREENINFO`` returns the same
@@ -115,7 +115,7 @@ clipping/blending method to be used for the overlay. To get the current
parameters applications set the ``type`` field of a struct
:ref:`v4l2_format <v4l2-format>` to
``V4L2_BUF_TYPE_VIDEO_OUTPUT_OVERLAY`` and call the
-:ref:`VIDIOC_G_FMT` ioctl. The driver fills the
+:ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>` ioctl. The driver fills the
:c:type:`struct v4l2_window` substructure named ``win``. It is not
possible to retrieve a previously programmed clipping list or bitmap.
@@ -124,7 +124,7 @@ struct :ref:`v4l2_format <v4l2-format>` to
``V4L2_BUF_TYPE_VIDEO_OUTPUT_OVERLAY``, initialize the ``win``
substructure and call the :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl.
The driver adjusts the parameters against hardware limits and returns
-the actual parameters as :ref:`VIDIOC_G_FMT` does. Like :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>`,
+the actual parameters as :ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>` does. Like :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>`,
the :ref:`VIDIOC_TRY_FMT <VIDIOC_G_FMT>` ioctl can be used to learn
about driver capabilities without actually changing driver state. Unlike
:ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` this also works after the overlay has been enabled.
diff --git a/Documentation/linux_tv/media/v4l/dev-output.rst b/Documentation/linux_tv/media/v4l/dev-output.rst
index ee62d1a0fb87..5253498db95a 100644
--- a/Documentation/linux_tv/media/v4l/dev-output.rst
+++ b/Documentation/linux_tv/media/v4l/dev-output.rst
@@ -62,7 +62,7 @@ defaults. An example is given in :ref:`crop`.
To query the current image format applications set the ``type`` field of
a struct :ref:`v4l2_format <v4l2-format>` to
``V4L2_BUF_TYPE_VIDEO_OUTPUT`` or ``V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE``
-and call the :ref:`VIDIOC_G_FMT` ioctl with a pointer
+and call the :ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>` ioctl with a pointer
to this structure. Drivers fill the struct
:ref:`v4l2_pix_format <v4l2-pix-format>` ``pix`` or the struct
:ref:`v4l2_pix_format_mplane <v4l2-pix-format-mplane>` ``pix_mp``
@@ -72,9 +72,9 @@ To request different parameters applications set the ``type`` field of a
struct :ref:`v4l2_format <v4l2-format>` as above and initialize all
fields of the struct :ref:`v4l2_pix_format <v4l2-pix-format>`
``vbi`` member of the ``fmt`` union, or better just modify the results
-of :ref:`VIDIOC_G_FMT`, and call the :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>`
+of :ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>`, and call the :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>`
ioctl with a pointer to this structure. Drivers may adjust the
-parameters and finally return the actual parameters as :ref:`VIDIOC_G_FMT`
+parameters and finally return the actual parameters as :ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>`
does.
Like :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` the :ref:`VIDIOC_TRY_FMT <VIDIOC_G_FMT>` ioctl
@@ -84,10 +84,10 @@ possibly time consuming hardware preparations.
The contents of struct :ref:`v4l2_pix_format <v4l2-pix-format>` and
struct :ref:`v4l2_pix_format_mplane <v4l2-pix-format-mplane>` are
discussed in :ref:`pixfmt`. See also the specification of the
-:ref:`VIDIOC_G_FMT`, :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` and :ref:`VIDIOC_TRY_FMT <VIDIOC_G_FMT>` ioctls for
-details. Video output devices must implement both the :ref:`VIDIOC_G_FMT`
+:ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>`, :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` and :ref:`VIDIOC_TRY_FMT <VIDIOC_G_FMT>` ioctls for
+details. Video output devices must implement both the :ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>`
and :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl, even if :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ignores all
-requests and always returns default parameters as :ref:`VIDIOC_G_FMT` does.
+requests and always returns default parameters as :ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>` does.
:ref:`VIDIOC_TRY_FMT <VIDIOC_G_FMT>` is optional.
diff --git a/Documentation/linux_tv/media/v4l/dev-overlay.rst b/Documentation/linux_tv/media/v4l/dev-overlay.rst
index 26bd4a15a125..083cf07e55c5 100644
--- a/Documentation/linux_tv/media/v4l/dev-overlay.rst
+++ b/Documentation/linux_tv/media/v4l/dev-overlay.rst
@@ -63,7 +63,7 @@ Setup
Before overlay can commence applications must program the driver with
frame buffer parameters, namely the address and size of the frame buffer
and the image format, for example RGB 5:6:5. The
-:ref:`VIDIOC_G_FBUF` and
+:ref:`VIDIOC_G_FBUF <VIDIOC_G_FBUF>` and
:ref:`VIDIOC_S_FBUF <VIDIOC_G_FBUF>` ioctls are available to get and
set these parameters, respectively. The :ref:`VIDIOC_S_FBUF <VIDIOC_G_FBUF>` ioctl is
privileged because it allows to set up DMA into physical memory,
@@ -77,7 +77,7 @@ Some devices add the video overlay to the output signal of the graphics
card. In this case the frame buffer is not modified by the video device,
and the frame buffer address and pixel format are not needed by the
driver. The :ref:`VIDIOC_S_FBUF <VIDIOC_G_FBUF>` ioctl is not privileged. An application
-can check for this type of device by calling the :ref:`VIDIOC_G_FBUF`
+can check for this type of device by calling the :ref:`VIDIOC_G_FBUF <VIDIOC_G_FBUF>`
ioctl.
A driver may support any (or none) of five clipping/blending methods:
@@ -121,7 +121,7 @@ its position over the graphics surface and the clipping to be applied.
To get the current parameters applications set the ``type`` field of a
struct :ref:`v4l2_format <v4l2-format>` to
``V4L2_BUF_TYPE_VIDEO_OVERLAY`` and call the
-:ref:`VIDIOC_G_FMT` ioctl. The driver fills the
+:ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>` ioctl. The driver fills the
:c:type:`struct v4l2_window` substructure named ``win``. It is not
possible to retrieve a previously programmed clipping list or bitmap.
@@ -130,7 +130,7 @@ struct :ref:`v4l2_format <v4l2-format>` to
``V4L2_BUF_TYPE_VIDEO_OVERLAY``, initialize the ``win`` substructure and
call the :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl. The driver
adjusts the parameters against hardware limits and returns the actual
-parameters as :ref:`VIDIOC_G_FMT` does. Like :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>`, the
+parameters as :ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>` does. Like :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>`, the
:ref:`VIDIOC_TRY_FMT <VIDIOC_G_FMT>` ioctl can be used to learn
about driver capabilities without actually changing driver state. Unlike
:ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` this also works after the overlay has been enabled.
@@ -179,7 +179,7 @@ struct v4l2_window
``struct v4l2_clip * clips``
When chroma-keying has *not* been negotiated and
- :ref:`VIDIOC_G_FBUF` indicated this capability,
+ :ref:`VIDIOC_G_FBUF <VIDIOC_G_FBUF>` indicated this capability,
applications can set this field to point to an array of clipping
rectangles.
@@ -204,7 +204,7 @@ are undefined.
``void * bitmap``
When chroma-keying has *not* been negotiated and
- :ref:`VIDIOC_G_FBUF` indicated this capability,
+ :ref:`VIDIOC_G_FBUF <VIDIOC_G_FBUF>` indicated this capability,
applications can set this field to point to a clipping bit mask.
It must be of the same size as the window, ``w.width`` and ``w.height``.
diff --git a/Documentation/linux_tv/media/v4l/dev-radio.rst b/Documentation/linux_tv/media/v4l/dev-radio.rst
index 7a0d25a143a6..55a56fb5d958 100644
--- a/Documentation/linux_tv/media/v4l/dev-radio.rst
+++ b/Documentation/linux_tv/media/v4l/dev-radio.rst
@@ -47,8 +47,8 @@ discussed in :ref:`tuner`) with index number zero to select the radio
frequency and to determine if a monaural or FM stereo program is
received/emitted. Drivers switch automatically between AM and FM
depending on the selected frequency. The
-:ref:`VIDIOC_G_TUNER` or
-:ref:`VIDIOC_G_MODULATOR` ioctl reports the
+:ref:`VIDIOC_G_TUNER <VIDIOC_G_TUNER>` or
+:ref:`VIDIOC_G_MODULATOR <VIDIOC_G_MODULATOR>` ioctl reports the
supported frequency range.
diff --git a/Documentation/linux_tv/media/v4l/dev-raw-vbi.rst b/Documentation/linux_tv/media/v4l/dev-raw-vbi.rst
index 2cd813a5b4e4..596b0a6b2177 100644
--- a/Documentation/linux_tv/media/v4l/dev-raw-vbi.rst
+++ b/Documentation/linux_tv/media/v4l/dev-raw-vbi.rst
@@ -71,7 +71,7 @@ parameters and then checking if the actual parameters are suitable.
To query the current raw VBI capture parameters applications set the
``type`` field of a struct :ref:`v4l2_format <v4l2-format>` to
``V4L2_BUF_TYPE_VBI_CAPTURE`` or ``V4L2_BUF_TYPE_VBI_OUTPUT``, and call
-the :ref:`VIDIOC_G_FMT` ioctl with a pointer to this
+the :ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>` ioctl with a pointer to this
structure. Drivers fill the struct
:ref:`v4l2_vbi_format <v4l2-vbi-format>` ``vbi`` member of the
``fmt`` union.
@@ -80,7 +80,7 @@ To request different parameters applications set the ``type`` field of a
struct :ref:`v4l2_format <v4l2-format>` as above and initialize all
fields of the struct :ref:`v4l2_vbi_format <v4l2-vbi-format>`
``vbi`` member of the ``fmt`` union, or better just modify the results
-of :ref:`VIDIOC_G_FMT`, and call the :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>`
+of :ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>`, and call the :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>`
ioctl with a pointer to this structure. Drivers return an EINVAL error
code only when the given parameters are ambiguous, otherwise they modify
the parameters according to the hardware capabilities and return the
@@ -94,9 +94,9 @@ expect other resource allocation points which may return EBUSY, at the
:ref:`VIDIOC_STREAMON` ioctl and the first read(),
write() and select() call.
-VBI devices must implement both the :ref:`VIDIOC_G_FMT` and
+VBI devices must implement both the :ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>` and
:ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl, even if :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ignores all requests
-and always returns default parameters as :ref:`VIDIOC_G_FMT` does.
+and always returns default parameters as :ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>` does.
:ref:`VIDIOC_TRY_FMT <VIDIOC_G_FMT>` is optional.
diff --git a/Documentation/linux_tv/media/v4l/dev-sliced-vbi.rst b/Documentation/linux_tv/media/v4l/dev-sliced-vbi.rst
index d53353afbedf..3692cdf8e756 100644
--- a/Documentation/linux_tv/media/v4l/dev-sliced-vbi.rst
+++ b/Documentation/linux_tv/media/v4l/dev-sliced-vbi.rst
@@ -57,7 +57,7 @@ Sliced VBI Format Negotiation
To find out which data services are supported by the hardware
applications can call the
-:ref:`VIDIOC_G_SLICED_VBI_CAP` ioctl.
+:ref:`VIDIOC_G_SLICED_VBI_CAP <VIDIOC_G_SLICED_VBI_CAP>` ioctl.
All drivers implementing the sliced VBI interface must support this
ioctl. The results may differ from those of the
:ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl when the number of VBI
@@ -70,7 +70,7 @@ To determine the currently selected services applications set the
``type`` field of struct :ref:`v4l2_format <v4l2-format>` to
``V4L2_BUF_TYPE_SLICED_VBI_CAPTURE`` or
``V4L2_BUF_TYPE_SLICED_VBI_OUTPUT``, and the
-:ref:`VIDIOC_G_FMT` ioctl fills the ``fmt.sliced``
+:ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>` ioctl fills the ``fmt.sliced``
member, a struct
:ref:`v4l2_sliced_vbi_format <v4l2-sliced-vbi-format>`.
@@ -432,7 +432,7 @@ the :ref:`VIDIOC_QBUF` ioctl must return an EINVAL
error code when applications violate this rule. They must also return an
EINVAL error code when applications pass an incorrect field or line
number, or a combination of ``field``, ``line`` and ``id`` which has not
-been negotiated with the :ref:`VIDIOC_G_FMT` or
+been negotiated with the :ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>` or
:ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl. When the line numbers are
unknown the driver must pass the packets in transmitted order. The
driver can insert empty packets with ``id`` set to zero anywhere in the
diff --git a/Documentation/linux_tv/media/v4l/diff-v4l.rst b/Documentation/linux_tv/media/v4l/diff-v4l.rst
index 06fdd877d77d..ee9623b454a4 100644
--- a/Documentation/linux_tv/media/v4l/diff-v4l.rst
+++ b/Documentation/linux_tv/media/v4l/diff-v4l.rst
@@ -204,7 +204,7 @@ introduction.
- ``-``
- - Applications can call the :ref:`VIDIOC_G_CROP`
+ - Applications can call the :ref:`VIDIOC_G_CROP <VIDIOC_G_CROP>`
ioctl to determine if the device supports capturing a subsection
of the full picture ("cropping" in V4L2). If not, the ioctl
returns the EINVAL error code. For more information on cropping
@@ -248,7 +248,7 @@ introduction.
The ``audios`` field was replaced by ``capabilities`` flag
``V4L2_CAP_AUDIO``, indicating *if* the device has any audio inputs or
outputs. To determine their number applications can enumerate audio
-inputs with the :ref:`VIDIOC_G_AUDIO` ioctl. The
+inputs with the :ref:`VIDIOC_G_AUDIO <VIDIOC_G_AUDIO>` ioctl. The
audio ioctls are described in :ref:`audio`.
The ``maxwidth``, ``maxheight``, ``minwidth`` and ``minheight`` fields
@@ -265,7 +265,7 @@ V4L provides the ``VIDIOCGCHAN`` and ``VIDIOCSCHAN`` ioctl using struct
:c:type:`struct video_channel` to enumerate the video inputs of a V4L
device. The equivalent V4L2 ioctls are
:ref:`VIDIOC_ENUMINPUT`,
-:ref:`VIDIOC_G_INPUT` and
+:ref:`VIDIOC_G_INPUT <VIDIOC_G_INPUT>` and
:ref:`VIDIOC_S_INPUT <VIDIOC_G_INPUT>` using struct
:ref:`v4l2_input <v4l2-input>` as discussed in :ref:`video`.
@@ -328,7 +328,7 @@ Tuning
The V4L ``VIDIOCGTUNER`` and ``VIDIOCSTUNER`` ioctl and struct
:c:type:`struct video_tuner` can be used to enumerate the tuners of a
V4L TV or radio device. The equivalent V4L2 ioctls are
-:ref:`VIDIOC_G_TUNER` and
+:ref:`VIDIOC_G_TUNER <VIDIOC_G_TUNER>` and
:ref:`VIDIOC_S_TUNER <VIDIOC_G_TUNER>` using struct
:ref:`v4l2_tuner <v4l2-tuner>`. Tuners are covered in :ref:`tuner`.
@@ -360,7 +360,7 @@ the struct :ref:`v4l2_tuner <v4l2-tuner>` ``capability`` field.
The ``VIDIOCGFREQ`` and ``VIDIOCSFREQ`` ioctl to change the tuner
frequency where renamed to
-:ref:`VIDIOC_G_FREQUENCY` and
+:ref:`VIDIOC_G_FREQUENCY <VIDIOC_G_FREQUENCY>` and
:ref:`VIDIOC_S_FREQUENCY <VIDIOC_G_FREQUENCY>`. They take a pointer
to a struct :ref:`v4l2_frequency <v4l2-frequency>` instead of an
unsigned long integer.
@@ -375,7 +375,7 @@ V4L2 has no equivalent of the ``VIDIOCGPICT`` and ``VIDIOCSPICT`` ioctl
and struct :c:type:`struct video_picture`. The following fields where
replaced by V4L2 controls accessible with the
:ref:`VIDIOC_QUERYCTRL`,
-:ref:`VIDIOC_G_CTRL` and
+:ref:`VIDIOC_G_CTRL <VIDIOC_G_CTRL>` and
:ref:`VIDIOC_S_CTRL <VIDIOC_G_CTRL>` ioctls:
@@ -554,7 +554,7 @@ Audio
The ``VIDIOCGAUDIO`` and ``VIDIOCSAUDIO`` ioctl and struct
:c:type:`struct video_audio` are used to enumerate the audio inputs
of a V4L device. The equivalent V4L2 ioctls are
-:ref:`VIDIOC_G_AUDIO` and
+:ref:`VIDIOC_G_AUDIO <VIDIOC_G_AUDIO>` and
:ref:`VIDIOC_S_AUDIO <VIDIOC_G_AUDIO>` using struct
:ref:`v4l2_audio <v4l2-audio>` as discussed in :ref:`audio`.
@@ -577,7 +577,7 @@ stereo input, regardless if the source is a tuner.
The following fields where replaced by V4L2 controls accessible with the
:ref:`VIDIOC_QUERYCTRL`,
-:ref:`VIDIOC_G_CTRL` and
+:ref:`VIDIOC_G_CTRL <VIDIOC_G_CTRL>` and
:ref:`VIDIOC_S_CTRL <VIDIOC_G_CTRL>` ioctls:
@@ -638,7 +638,7 @@ Frame Buffer Overlay
====================
The V4L2 ioctls equivalent to ``VIDIOCGFBUF`` and ``VIDIOCSFBUF`` are
-:ref:`VIDIOC_G_FBUF` and
+:ref:`VIDIOC_G_FBUF <VIDIOC_G_FBUF>` and
:ref:`VIDIOC_S_FBUF <VIDIOC_G_FBUF>`. The ``base`` field of struct
:c:type:`struct video_buffer` remained unchanged, except V4L2 defines
a flag to indicate non-destructive overlays instead of a ``NULL``
@@ -650,7 +650,7 @@ list of RGB formats and their respective color depths.
Instead of the special ioctls ``VIDIOCGWIN`` and ``VIDIOCSWIN`` V4L2
uses the general-purpose data format negotiation ioctls
-:ref:`VIDIOC_G_FMT` and
+:ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>` and
:ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>`. They take a pointer to a struct
:ref:`v4l2_format <v4l2-format>` as argument. Here the ``win`` member
of the ``fmt`` union is used, a struct
@@ -687,7 +687,7 @@ Cropping
To capture only a subsection of the full picture V4L defines the
``VIDIOCGCAPTURE`` and ``VIDIOCSCAPTURE`` ioctls using struct
:c:type:`struct video_capture`. The equivalent V4L2 ioctls are
-:ref:`VIDIOC_G_CROP` and
+:ref:`VIDIOC_G_CROP <VIDIOC_G_CROP>` and
:ref:`VIDIOC_S_CROP <VIDIOC_G_CROP>` using struct
:ref:`v4l2_crop <v4l2-crop>`, and the related
:ref:`VIDIOC_CROPCAP` ioctl. This is a rather
@@ -726,7 +726,7 @@ functions.
To select an image format and size, V4L provides the ``VIDIOCSPICT`` and
``VIDIOCSWIN`` ioctls. V4L2 uses the general-purpose data format
-negotiation ioctls :ref:`VIDIOC_G_FMT` and
+negotiation ioctls :ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>` and
:ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>`. They take a pointer to a struct
:ref:`v4l2_format <v4l2-format>` as argument, here the struct
:ref:`v4l2_pix_format <v4l2-pix-format>` named ``pix`` of its
diff --git a/Documentation/linux_tv/media/v4l/dv-timings.rst b/Documentation/linux_tv/media/v4l/dv-timings.rst
index 4b22b1b0fccb..cde46bc95c79 100644
--- a/Documentation/linux_tv/media/v4l/dv-timings.rst
+++ b/Documentation/linux_tv/media/v4l/dv-timings.rst
@@ -29,7 +29,7 @@ device applications use the
DV timings for the device applications use the
:ref:`VIDIOC_S_DV_TIMINGS <VIDIOC_G_DV_TIMINGS>` ioctl and to get
current DV timings they use the
-:ref:`VIDIOC_G_DV_TIMINGS` ioctl. To detect
+:ref:`VIDIOC_G_DV_TIMINGS <VIDIOC_G_DV_TIMINGS>` ioctl. To detect
the DV timings as seen by the video receiver applications use the
:ref:`VIDIOC_QUERY_DV_TIMINGS` ioctl.
diff --git a/Documentation/linux_tv/media/v4l/extended-controls.rst b/Documentation/linux_tv/media/v4l/extended-controls.rst
index 9a10edc50fa0..38b85d7b1022 100644
--- a/Documentation/linux_tv/media/v4l/extended-controls.rst
+++ b/Documentation/linux_tv/media/v4l/extended-controls.rst
@@ -39,11 +39,11 @@ The Extended Control API
========================
Three new ioctls are available:
-:ref:`VIDIOC_G_EXT_CTRLS`,
+:ref:`VIDIOC_G_EXT_CTRLS <VIDIOC_G_EXT_CTRLS>`,
:ref:`VIDIOC_S_EXT_CTRLS <VIDIOC_G_EXT_CTRLS>` and
:ref:`VIDIOC_TRY_EXT_CTRLS <VIDIOC_G_EXT_CTRLS>`. These ioctls act
on arrays of controls (as opposed to the
-:ref:`VIDIOC_G_CTRL` and
+:ref:`VIDIOC_G_CTRL <VIDIOC_G_CTRL>` and
:ref:`VIDIOC_S_CTRL <VIDIOC_G_CTRL>` ioctls that act on a single
control). This is needed since it is often required to atomically change
several controls at once.
diff --git a/Documentation/linux_tv/media/v4l/format.rst b/Documentation/linux_tv/media/v4l/format.rst
index 0184b5931709..e9b1201fe316 100644
--- a/Documentation/linux_tv/media/v4l/format.rst
+++ b/Documentation/linux_tv/media/v4l/format.rst
@@ -23,7 +23,7 @@ current selection.
A single mechanism exists to negotiate all data formats using the
aggregate struct :ref:`v4l2_format <v4l2-format>` and the
-:ref:`VIDIOC_G_FMT` and
+:ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>` and
:ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctls. Additionally the
:ref:`VIDIOC_TRY_FMT <VIDIOC_G_FMT>` ioctl can be used to examine
what the hardware *could* do, without actually selecting a new data
@@ -64,7 +64,7 @@ earlier versions of V4L2. Switching the logical stream or returning into
*may* support a switch using :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>`.
All drivers exchanging data with applications must support the
-:ref:`VIDIOC_G_FMT` and :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl. Implementation of the
+:ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>` and :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl. Implementation of the
:ref:`VIDIOC_TRY_FMT <VIDIOC_G_FMT>` is highly recommended but optional.
diff --git a/Documentation/linux_tv/media/v4l/func-read.rst b/Documentation/linux_tv/media/v4l/func-read.rst
index 0eae26288189..497bc9a9dd5a 100644
--- a/Documentation/linux_tv/media/v4l/func-read.rst
+++ b/Documentation/linux_tv/media/v4l/func-read.rst
@@ -85,7 +85,7 @@ enough. Again, the behavior when the driver runs out of free buffers
depends on the discarding policy.
Applications can get and set the number of buffers used internally by
-the driver with the :ref:`VIDIOC_G_PARM` and
+the driver with the :ref:`VIDIOC_G_PARM <VIDIOC_G_PARM>` and
:ref:`VIDIOC_S_PARM <VIDIOC_G_PARM>` ioctls. They are optional,
however. The discarding policy is not reported and cannot be changed.
For minimum requirements see :ref:`devices`.
diff --git a/Documentation/linux_tv/media/v4l/hist-v4l2.rst b/Documentation/linux_tv/media/v4l/hist-v4l2.rst
index 4bd621b3aa03..bb115a0f2427 100644
--- a/Documentation/linux_tv/media/v4l/hist-v4l2.rst
+++ b/Documentation/linux_tv/media/v4l/hist-v4l2.rst
@@ -40,7 +40,7 @@ enumerable.
:c:type:`struct video_standard` and the color subcarrier fields were
renamed. The :ref:`VIDIOC_QUERYSTD` ioctl was
renamed to :ref:`VIDIOC_ENUMSTD`,
-:ref:`VIDIOC_G_INPUT` to
+:ref:`VIDIOC_G_INPUT <VIDIOC_G_INPUT>` to
:ref:`VIDIOC_ENUMINPUT`. A first draft of the
Codec API was released.
@@ -52,7 +52,7 @@ material changes to struct :ref:`v4l2_capability <v4l2-capability>`.
1998-11-14: ``V4L2_PIX_FMT_RGB24`` changed to ``V4L2_PIX_FMT_BGR24``,
and ``V4L2_PIX_FMT_RGB32`` changed to ``V4L2_PIX_FMT_BGR32``. Audio
controls are now accessible with the
-:ref:`VIDIOC_G_CTRL` and
+:ref:`VIDIOC_G_CTRL <VIDIOC_G_CTRL>` and
:ref:`VIDIOC_S_CTRL <VIDIOC_G_CTRL>` ioctls under names starting
with ``V4L2_CID_AUDIO``. The ``V4L2_MAJOR`` define was removed from
``videodev.h`` since it was only used once in the ``videodev`` kernel
@@ -142,7 +142,7 @@ common Linux driver API conventions.
int a = V4L2_XXX; err = ioctl(fd, VIDIOC_XXX, &a);
4. All the different get- and set-format commands were swept into one
- :ref:`VIDIOC_G_FMT` and
+ :ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>` and
:ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl taking a union and a
type field selecting the union member as parameter. Purpose is to
simplify the API by eliminating several ioctls and to allow new and
@@ -246,13 +246,13 @@ correctly through the backward compatibility layer. [Solution?]
2001-04-13: Big endian 16-bit RGB formats were added.
2001-09-17: New YUV formats and the
-:ref:`VIDIOC_G_FREQUENCY` and
+:ref:`VIDIOC_G_FREQUENCY <VIDIOC_G_FREQUENCY>` and
:ref:`VIDIOC_S_FREQUENCY <VIDIOC_G_FREQUENCY>` ioctls were added.
(The old ``VIDIOC_G_FREQ`` and ``VIDIOC_S_FREQ`` ioctls did not take
multiple tuners into account.)
2000-09-18: ``V4L2_BUF_TYPE_VBI`` was added. This may *break
-compatibility* as the :ref:`VIDIOC_G_FMT` and
+compatibility* as the :ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>` and
:ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctls may fail now if the struct
:c:type:`struct v4l2_fmt` ``type`` field does not contain
``V4L2_BUF_TYPE_VBI``. In the documentation of the struct
@@ -401,7 +401,7 @@ This unnamed version was finally merged into Linux 2.5.46.
supported standards with an ioctl applications can now refer to
standards by :ref:`v4l2_std_id <v4l2-std-id>` and symbols
defined in the ``videodev2.h`` header file. For details see
- :ref:`standard`. The :ref:`VIDIOC_G_STD` and
+ :ref:`standard`. The :ref:`VIDIOC_G_STD <VIDIOC_G_STD>` and
:ref:`VIDIOC_S_STD <VIDIOC_G_STD>` now take a pointer to this
type as argument. :ref:`VIDIOC_QUERYSTD` was
added to autodetect the received standard, if the hardware has this
@@ -716,14 +716,14 @@ V4L2 2003-06-19
3. The audio input and output interface was found to be incomplete.
- Previously the :ref:`VIDIOC_G_AUDIO` ioctl would
+ Previously the :ref:`VIDIOC_G_AUDIO <VIDIOC_G_AUDIO>` ioctl would
enumerate the available audio inputs. An ioctl to determine the
current audio input, if more than one combines with the current video
input, did not exist. So ``VIDIOC_G_AUDIO`` was renamed to
``VIDIOC_G_AUDIO_OLD``, this ioctl was removed on Kernel 2.6.39. The
:ref:`VIDIOC_ENUMAUDIO` ioctl was added to
enumerate audio inputs, while
- :ref:`VIDIOC_G_AUDIO` now reports the current
+ :ref:`VIDIOC_G_AUDIO <VIDIOC_G_AUDIO>` now reports the current
audio input.
The same changes were made to
@@ -940,7 +940,7 @@ V4L2 in Linux 2.6.17
2. A new ``V4L2_TUNER_MODE_LANG1_LANG2`` was defined to record both
languages of a bilingual program. The use of
``V4L2_TUNER_MODE_STEREO`` for this purpose is deprecated now. See
- the :ref:`VIDIOC_G_TUNER` section for details.
+ the :ref:`VIDIOC_G_TUNER <VIDIOC_G_TUNER>` section for details.
V4L2 spec erratum 2006-09-23 (Draft 0.15)
@@ -950,13 +950,13 @@ V4L2 spec erratum 2006-09-23 (Draft 0.15)
``V4L2_BUF_TYPE_SLICED_VBI_OUTPUT`` of the sliced VBI interface were
not mentioned along with other buffer types.
-2. In :ref:`VIDIOC_G_AUDIO` it was clarified that the struct
+2. In :ref:`VIDIOC_G_AUDIO <VIDIOC_G_AUDIO>` it was clarified that the struct
:ref:`v4l2_audio <v4l2-audio>` ``mode`` field is a flags field.
3. :ref:`VIDIOC_QUERYCAP` did not mention the sliced VBI and radio
capability flags.
-4. In :ref:`VIDIOC_G_FREQUENCY` it was clarified that applications
+4. In :ref:`VIDIOC_G_FREQUENCY <VIDIOC_G_FREQUENCY>` it was clarified that applications
must initialize the tuner ``type`` field of struct
:ref:`v4l2_frequency <v4l2-frequency>` before calling
:ref:`VIDIOC_S_FREQUENCY <VIDIOC_G_FREQUENCY>`.
@@ -976,7 +976,7 @@ V4L2 spec erratum 2006-09-23 (Draft 0.15)
V4L2 in Linux 2.6.18
====================
-1. New ioctls :ref:`VIDIOC_G_EXT_CTRLS`,
+1. New ioctls :ref:`VIDIOC_G_EXT_CTRLS <VIDIOC_G_EXT_CTRLS>`,
:ref:`VIDIOC_S_EXT_CTRLS <VIDIOC_G_EXT_CTRLS>` and
:ref:`VIDIOC_TRY_EXT_CTRLS <VIDIOC_G_EXT_CTRLS>` were added, a
flag to skip unsupported controls with
@@ -995,7 +995,7 @@ V4L2 in Linux 2.6.19
buffer type field was added replacing a reserved field. Note on
architectures where the size of enum types differs from int types the
size of the structure changed. The
- :ref:`VIDIOC_G_SLICED_VBI_CAP` ioctl
+ :ref:`VIDIOC_G_SLICED_VBI_CAP <VIDIOC_G_SLICED_VBI_CAP>` ioctl
was redefined from being read-only to write-read. Applications must
initialize the type field and clear the reserved fields now. These
changes may *break the compatibility* with older drivers and
@@ -1034,7 +1034,7 @@ V4L2 in Linux 2.6.22
2. Three new clipping/blending methods with a global or straight or
inverted local alpha value were added to the video overlay interface.
- See the description of the :ref:`VIDIOC_G_FBUF`
+ See the description of the :ref:`VIDIOC_G_FBUF <VIDIOC_G_FBUF>`
and :ref:`VIDIOC_S_FBUF <VIDIOC_G_FBUF>` ioctls for details.
A new ``global_alpha`` field was added to
diff --git a/Documentation/linux_tv/media/v4l/libv4l-introduction.rst b/Documentation/linux_tv/media/v4l/libv4l-introduction.rst
index bc3eb48e1d9f..b8d247dc236d 100644
--- a/Documentation/linux_tv/media/v4l/libv4l-introduction.rst
+++ b/Documentation/linux_tv/media/v4l/libv4l-introduction.rst
@@ -92,7 +92,7 @@ and to enhance the image quality.
In most cases, libv4l2 just passes the calls directly through to the
v4l2 driver, intercepting the calls to
:ref:`VIDIOC_TRY_FMT <VIDIOC_G_FMT>`,
-:ref:`VIDIOC_G_FMT`
+:ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>`
:ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>`
:ref:`VIDIOC_ENUM_FRAMESIZES` and
:ref:`VIDIOC_ENUM_FRAMEINTERVALS` in
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-013.rst b/Documentation/linux_tv/media/v4l/pixfmt-013.rst
index 7584cb2e5702..b3cb7c48eb74 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-013.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-013.rst
@@ -27,7 +27,7 @@ Compressed Formats
- 'JPEG'
- - TBD. See also :ref:`VIDIOC_G_JPEGCOMP`,
+ - TBD. See also :ref:`VIDIOC_G_JPEGCOMP <VIDIOC_G_JPEGCOMP>`,
:ref:`VIDIOC_S_JPEGCOMP <VIDIOC_G_JPEGCOMP>`.
- .. _`V4L2-PIX-FMT-MPEG`:
diff --git a/Documentation/linux_tv/media/v4l/pixfmt.rst b/Documentation/linux_tv/media/v4l/pixfmt.rst
index b0e6a95a7205..f2c599aaa502 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt.rst
@@ -13,7 +13,7 @@ single-planar API, while the latter is used with the multi-planar
version (see :ref:`planar-apis`). Image formats are negotiated with
the :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl. (The explanations here
focus on video capturing and output, for overlay frame buffer formats
-see also :ref:`VIDIOC_G_FBUF`.)
+see also :ref:`VIDIOC_G_FBUF <VIDIOC_G_FBUF>`.)
.. toctree::
diff --git a/Documentation/linux_tv/media/v4l/planar-apis.rst b/Documentation/linux_tv/media/v4l/planar-apis.rst
index 0546210f868f..cf078650a0a8 100644
--- a/Documentation/linux_tv/media/v4l/planar-apis.rst
+++ b/Documentation/linux_tv/media/v4l/planar-apis.rst
@@ -44,7 +44,7 @@ Calls that distinguish between single and multi-planar APIs
together with non-multi-planar ones for devices that handle both
single- and multi-planar formats.
-:ref:`VIDIOC_G_FMT`,
+:ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>`,
:ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>`,
:ref:`VIDIOC_TRY_FMT <VIDIOC_G_FMT>`
New structures for describing multi-planar formats are added: struct
diff --git a/Documentation/linux_tv/media/v4l/standard.rst b/Documentation/linux_tv/media/v4l/standard.rst
index ec39b2b39e67..20c0d044a129 100644
--- a/Documentation/linux_tv/media/v4l/standard.rst
+++ b/Documentation/linux_tv/media/v4l/standard.rst
@@ -36,7 +36,7 @@ Composite input may collapse standards, enumerating "PAL-B/G/H/I",
"NTSC-M" and "SECAM-D/K". [1]_
To query and select the standard used by the current video input or
-output applications call the :ref:`VIDIOC_G_STD` and
+output applications call the :ref:`VIDIOC_G_STD <VIDIOC_G_STD>` and
:ref:`VIDIOC_S_STD <VIDIOC_G_STD>` ioctl, respectively. The
*received* standard can be sensed with the
:ref:`VIDIOC_QUERYSTD` ioctl. Note that the
@@ -56,7 +56,7 @@ output device which is:
Here the driver shall set the ``std`` field of struct
:ref:`v4l2_input <v4l2-input>` and struct
-:ref:`v4l2_output <v4l2-output>` to zero and the :ref:`VIDIOC_G_STD`,
+:ref:`v4l2_output <v4l2-output>` to zero and the :ref:`VIDIOC_G_STD <VIDIOC_G_STD>`,
:ref:`VIDIOC_S_STD <VIDIOC_G_STD>`, :ref:`VIDIOC_QUERYSTD` and :ref:`VIDIOC_ENUMSTD` ioctls
shall return the ENOTTY error code or the EINVAL error code.
diff --git a/Documentation/linux_tv/media/v4l/streaming-par.rst b/Documentation/linux_tv/media/v4l/streaming-par.rst
index 10420478a3b0..bb8100b6ef87 100644
--- a/Documentation/linux_tv/media/v4l/streaming-par.rst
+++ b/Documentation/linux_tv/media/v4l/streaming-par.rst
@@ -23,7 +23,7 @@ internally by a driver in read/write mode. For implications see the
section discussing the :ref:`read() <func-read>` function.
To get and set the streaming parameters applications call the
-:ref:`VIDIOC_G_PARM` and
+:ref:`VIDIOC_G_PARM <VIDIOC_G_PARM>` and
:ref:`VIDIOC_S_PARM <VIDIOC_G_PARM>` ioctl, respectively. They take
a pointer to a struct :ref:`v4l2_streamparm <v4l2-streamparm>`, which
contains a union holding separate parameters for input and output
diff --git a/Documentation/linux_tv/media/v4l/tuner.rst b/Documentation/linux_tv/media/v4l/tuner.rst
index 67f4e24709b5..9c98e4f64c85 100644
--- a/Documentation/linux_tv/media/v4l/tuner.rst
+++ b/Documentation/linux_tv/media/v4l/tuner.rst
@@ -22,9 +22,9 @@ Radio input devices have exactly one tuner with index zero, no video
inputs.
To query and change tuner properties applications use the
-:ref:`VIDIOC_G_TUNER` and
+:ref:`VIDIOC_G_TUNER <VIDIOC_G_TUNER>` and
:ref:`VIDIOC_S_TUNER <VIDIOC_G_TUNER>` ioctls, respectively. The
-struct :ref:`v4l2_tuner <v4l2-tuner>` returned by :ref:`VIDIOC_G_TUNER`
+struct :ref:`v4l2_tuner <v4l2-tuner>` returned by :ref:`VIDIOC_G_TUNER <VIDIOC_G_TUNER>`
also contains signal status information applicable when the tuner of the
current video or radio input is queried. Note that :ref:`VIDIOC_S_TUNER <VIDIOC_G_TUNER>`
does not switch the current tuner, when there is more than one at all.
@@ -59,7 +59,7 @@ functionality. The reason is a limitation with the
cannot specify whether the frequency is for a tuner or a modulator.
To query and change modulator properties applications use the
-:ref:`VIDIOC_G_MODULATOR` and
+:ref:`VIDIOC_G_MODULATOR <VIDIOC_G_MODULATOR>` and
:ref:`VIDIOC_S_MODULATOR <VIDIOC_G_MODULATOR>` ioctl. Note that
:ref:`VIDIOC_S_MODULATOR <VIDIOC_G_MODULATOR>` does not switch the current modulator, when there
is more than one at all. The modulator is solely determined by the
@@ -74,7 +74,7 @@ Radio Frequency
===============
To get and set the tuner or modulator radio frequency applications use
-the :ref:`VIDIOC_G_FREQUENCY` and
+the :ref:`VIDIOC_G_FREQUENCY <VIDIOC_G_FREQUENCY>` and
:ref:`VIDIOC_S_FREQUENCY <VIDIOC_G_FREQUENCY>` ioctl which both take
a pointer to a struct :ref:`v4l2_frequency <v4l2-frequency>`. These
ioctls are used for TV and radio devices alike. Drivers must support
diff --git a/Documentation/linux_tv/media/v4l/video.rst b/Documentation/linux_tv/media/v4l/video.rst
index 9f2dc4ee4fcd..8e10ecc27123 100644
--- a/Documentation/linux_tv/media/v4l/video.rst
+++ b/Documentation/linux_tv/media/v4l/video.rst
@@ -20,8 +20,8 @@ struct :ref:`v4l2_input <v4l2-input>` returned by the
:ref:`VIDIOC_ENUMINPUT` ioctl also contains signal
:status information applicable when the current video input is queried.
-The :ref:`VIDIOC_G_INPUT` and
-:ref:`VIDIOC_G_OUTPUT` ioctls return the index of
+The :ref:`VIDIOC_G_INPUT <VIDIOC_G_INPUT>` and
+:ref:`VIDIOC_G_OUTPUT <VIDIOC_G_OUTPUT>` ioctls return the index of
the current video input or output. To select a different input or output
applications call the :ref:`VIDIOC_S_INPUT <VIDIOC_G_INPUT>` and
:ref:`VIDIOC_S_OUTPUT <VIDIOC_G_OUTPUT>` ioctls. Drivers must
diff --git a/Documentation/linux_tv/media/v4l/vidioc-create-bufs.rst b/Documentation/linux_tv/media/v4l/vidioc-create-bufs.rst
index d269eab4d2b6..53db867aa9db 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-create-bufs.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-create-bufs.rst
@@ -48,7 +48,7 @@ The ``format`` field specifies the image format that the buffers must be
able to handle. The application has to fill in this struct
:ref:`v4l2_format <v4l2-format>`. Usually this will be done using the
:ref:`VIDIOC_TRY_FMT <VIDIOC_G_FMT>` or
-:ref:`VIDIOC_G_FMT` ioctls to ensure that the
+:ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>` ioctls to ensure that the
requested format is supported by the driver. Based on the format's
``type`` field the requested buffer size (for single-planar) or plane
sizes (for multi-planar formats) will be used for the allocated buffers.
diff --git a/Documentation/linux_tv/media/v4l/vidioc-enumaudio.rst b/Documentation/linux_tv/media/v4l/vidioc-enumaudio.rst
index 0fc0c3eeae5f..8ae7b8bd9333 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-enumaudio.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-enumaudio.rst
@@ -39,7 +39,7 @@ structure or return an EINVAL error code when the index is out of
bounds. To enumerate all audio inputs applications shall begin at index
zero, incrementing by one until the driver returns EINVAL.
-See :ref:`VIDIOC_G_AUDIO` for a description of struct
+See :ref:`VIDIOC_G_AUDIO <VIDIOC_G_AUDIO>` for a description of struct
:ref:`v4l2_audio <v4l2-audio>`.
diff --git a/Documentation/linux_tv/media/v4l/vidioc-enumaudioout.rst b/Documentation/linux_tv/media/v4l/vidioc-enumaudioout.rst
index 29735eddac5d..0e45f41fa608 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-enumaudioout.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-enumaudioout.rst
@@ -42,7 +42,7 @@ zero, incrementing by one until the driver returns EINVAL.
Note connectors on a TV card to loop back the received audio signal to a
sound card are not audio outputs in this sense.
-See :ref:`VIDIOC_G_AUDIOout` for a description of struct
+See :ref:`VIDIOC_G_AUDIOout <VIDIOC_G_AUDIOout>` for a description of struct
:ref:`v4l2_audioout <v4l2-audioout>`.
diff --git a/Documentation/linux_tv/media/v4l/vidioc-enumstd.rst b/Documentation/linux_tv/media/v4l/vidioc-enumstd.rst
index e292b7d50cc3..03353b92449a 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-enumstd.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-enumstd.rst
@@ -401,7 +401,7 @@ ENODATA
.. [1]
The supported standards may overlap and we need an unambiguous set to
- find the current standard returned by :ref:`VIDIOC_G_STD`.
+ find the current standard returned by :ref:`VIDIOC_G_STD <VIDIOC_G_STD>`.
.. [2]
Japan uses a standard similar to M/NTSC (V4L2_STD_NTSC_M_JP).
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-audio.rst b/Documentation/linux_tv/media/v4l/vidioc-g-audio.rst
index be8899d87e33..4b79523bfbab 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-audio.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-audio.rst
@@ -36,7 +36,7 @@ Description
To query the current audio input applications zero out the ``reserved``
array of a struct :ref:`v4l2_audio <v4l2-audio>` and call the
-:ref:`VIDIOC_G_AUDIO` ioctl with a pointer to this structure. Drivers fill
+:ref:`VIDIOC_G_AUDIO <VIDIOC_G_AUDIO>` ioctl with a pointer to this structure. Drivers fill
the rest of the structure or return an EINVAL error code when the device
has no audio inputs, or none which combine with the current video input.
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-crop.rst b/Documentation/linux_tv/media/v4l/vidioc-g-crop.rst
index 0a9ede92bc9f..b0503710c2dd 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-crop.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-crop.rst
@@ -36,7 +36,7 @@ Description
To query the cropping rectangle size and position applications set the
``type`` field of a :c:type:`struct v4l2_crop` structure to the
-respective buffer (stream) type and call the :ref:`VIDIOC_G_CROP` ioctl
+respective buffer (stream) type and call the :ref:`VIDIOC_G_CROP <VIDIOC_G_CROP>` ioctl
with a pointer to this structure. The driver fills the rest of the
structure or returns the EINVAL error code if cropping is not supported.
@@ -66,7 +66,7 @@ vertical scaling factor.
Finally the driver programs the hardware with the actual cropping and
image parameters. :ref:`VIDIOC_S_CROP <VIDIOC_G_CROP>` is a write-only ioctl, it does not
return the actual parameters. To query them applications must call
-:ref:`VIDIOC_G_CROP` and :ref:`VIDIOC_G_FMT`. When the
+:ref:`VIDIOC_G_CROP <VIDIOC_G_CROP>` and :ref:`VIDIOC_G_FMT`. When the
parameters are unsuitable the application may modify the cropping or
image parameters and repeat the cycle until satisfactory parameters have
been negotiated.
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-ctrl.rst b/Documentation/linux_tv/media/v4l/vidioc-g-ctrl.rst
index 41561c5e444d..55bb8ae9be10 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-ctrl.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-ctrl.rst
@@ -34,7 +34,7 @@ Description
To get the current value of a control applications initialize the ``id``
field of a struct :c:type:`struct v4l2_control` and call the
-:ref:`VIDIOC_G_CTRL` ioctl with a pointer to this structure. To change the
+:ref:`VIDIOC_G_CTRL <VIDIOC_G_CTRL>` ioctl with a pointer to this structure. To change the
value of a control applications initialize the ``id`` and ``value``
fields of a struct :c:type:`struct v4l2_control` and call the
:ref:`VIDIOC_S_CTRL <VIDIOC_G_CTRL>` ioctl.
@@ -48,7 +48,7 @@ actual new value. If the ``value`` is inappropriate for the control
EINVAL error code is returned as well.
These ioctls work only with user controls. For other control classes the
-:ref:`VIDIOC_G_EXT_CTRLS`,
+:ref:`VIDIOC_G_EXT_CTRLS <VIDIOC_G_EXT_CTRLS>`,
:ref:`VIDIOC_S_EXT_CTRLS <VIDIOC_G_EXT_CTRLS>` or
:ref:`VIDIOC_TRY_EXT_CTRLS <VIDIOC_G_EXT_CTRLS>` must be used.
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-dv-timings.rst b/Documentation/linux_tv/media/v4l/vidioc-g-dv-timings.rst
index cc7cf06e74ee..43734bb649c5 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-dv-timings.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-dv-timings.rst
@@ -37,7 +37,7 @@ Description
To set DV timings for the input or output, applications use the
:ref:`VIDIOC_S_DV_TIMINGS <VIDIOC_G_DV_TIMINGS>` ioctl and to get the current timings,
-applications use the :ref:`VIDIOC_G_DV_TIMINGS` ioctl. The detailed timing
+applications use the :ref:`VIDIOC_G_DV_TIMINGS <VIDIOC_G_DV_TIMINGS>` ioctl. The detailed timing
information is filled in using the structure struct
:ref:`v4l2_dv_timings <v4l2-dv-timings>`. These ioctls take a
pointer to the struct :ref:`v4l2_dv_timings <v4l2-dv-timings>`
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-edid.rst b/Documentation/linux_tv/media/v4l/vidioc-g-edid.rst
index a1311a52b8fa..d6ccae92e107 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-edid.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-edid.rst
@@ -52,7 +52,7 @@ value, then the EINVAL error code will be returned.
To get the EDID data the application has to fill in the ``pad``,
``start_block``, ``blocks`` and ``edid`` fields, zero the ``reserved``
-array and call :ref:`VIDIOC_G_EDID`. The current EDID from block
+array and call :ref:`VIDIOC_G_EDID <VIDIOC_G_EDID>`. The current EDID from block
``start_block`` and of size ``blocks`` will be placed in the memory
``edid`` points to. The ``edid`` pointer must point to memory at least
``blocks`` * 128 bytes large (the size of one block is 128 bytes).
@@ -65,7 +65,7 @@ If blocks have to be retrieved from the sink, then this call will block
until they have been read.
If ``start_block`` and ``blocks`` are both set to 0 when
-:ref:`VIDIOC_G_EDID` is called, then the driver will set ``blocks`` to the
+:ref:`VIDIOC_G_EDID <VIDIOC_G_EDID>` is called, then the driver will set ``blocks`` to the
total number of available EDID blocks and it will return 0 without
copying any data. This is an easy way to discover how many EDID blocks
there are. Note that if there are no EDID blocks available at all, then
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-enc-index.rst b/Documentation/linux_tv/media/v4l/vidioc-g-enc-index.rst
index 77c7eff9732d..c22907cddfac 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-enc-index.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-enc-index.rst
@@ -31,19 +31,19 @@ Arguments
Description
===========
-The :ref:`VIDIOC_G_ENC_INDEX` ioctl provides meta data about a compressed
+The :ref:`VIDIOC_G_ENC_INDEX <VIDIOC_G_ENC_INDEX>` ioctl provides meta data about a compressed
video stream the same or another application currently reads from the
driver, which is useful for random access into the stream without
decoding it.
-To read the data applications must call :ref:`VIDIOC_G_ENC_INDEX` with a
+To read the data applications must call :ref:`VIDIOC_G_ENC_INDEX <VIDIOC_G_ENC_INDEX>` with a
pointer to a struct :ref:`v4l2_enc_idx <v4l2-enc-idx>`. On success
the driver fills the ``entry`` array, stores the number of elements
written in the ``entries`` field, and initializes the ``entries_cap``
field.
Each element of the ``entry`` array contains meta data about one
-picture. A :ref:`VIDIOC_G_ENC_INDEX` call reads up to
+picture. A :ref:`VIDIOC_G_ENC_INDEX <VIDIOC_G_ENC_INDEX>` call reads up to
``V4L2_ENC_IDX_ENTRIES`` entries from a driver buffer, which can hold up
to ``entries_cap`` entries. This number can be lower or higher than
``V4L2_ENC_IDX_ENTRIES``, but not zero. When the application fails to
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-ext-ctrls.rst b/Documentation/linux_tv/media/v4l/vidioc-g-ext-ctrls.rst
index fb62cd0a991c..040deef04f7d 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-ext-ctrls.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-ext-ctrls.rst
@@ -48,7 +48,7 @@ by the ``controls`` fields.
To get the current value of a set of controls applications initialize
the ``id``, ``size`` and ``reserved2`` fields of each struct
:ref:`v4l2_ext_control <v4l2-ext-control>` and call the
-:ref:`VIDIOC_G_EXT_CTRLS` ioctl. String controls controls must also set the
+:ref:`VIDIOC_G_EXT_CTRLS <VIDIOC_G_EXT_CTRLS>` ioctl. String controls controls must also set the
``string`` field. Controls of compound types
(``V4L2_CTRL_FLAG_HAS_PAYLOAD`` is set) must set the ``ptr`` field.
@@ -122,7 +122,7 @@ still cause this situation.
- The total size in bytes of the payload of this control. This is
normally 0, but for pointer controls this should be set to the
size of the memory containing the payload, or that will receive
- the payload. If :ref:`VIDIOC_G_EXT_CTRLS` finds that this value is
+ the payload. If :ref:`VIDIOC_G_EXT_CTRLS <VIDIOC_G_EXT_CTRLS>` finds that this value is
less than is required to store the payload result, then it is set
to a value large enough to store the payload result and ENOSPC is
returned. Note that for string controls this ``size`` field should
@@ -328,7 +328,7 @@ still cause this situation.
:ref:`VIDIOC_S_EXT_CTRLS <VIDIOC_G_EXT_CTRLS>` fails with ``error_idx`` set to ``count``,
then you can call :ref:`VIDIOC_TRY_EXT_CTRLS <VIDIOC_G_EXT_CTRLS>` to try to discover the
actual control that failed the validation step. Unfortunately,
- there is no ``TRY`` equivalent for :ref:`VIDIOC_G_EXT_CTRLS`.
+ there is no ``TRY`` equivalent for :ref:`VIDIOC_G_EXT_CTRLS <VIDIOC_G_EXT_CTRLS>`.
- .. row 6
@@ -367,7 +367,7 @@ still cause this situation.
- The class containing user controls. These controls are described
in :ref:`control`. All controls that can be set using the
:ref:`VIDIOC_S_CTRL <VIDIOC_G_CTRL>` and
- :ref:`VIDIOC_G_CTRL` ioctl belong to this
+ :ref:`VIDIOC_G_CTRL <VIDIOC_G_CTRL>` ioctl belong to this
class.
- .. row 2
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-fbuf.rst b/Documentation/linux_tv/media/v4l/vidioc-g-fbuf.rst
index e622e2f2435c..dbc68cfc608a 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-fbuf.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-fbuf.rst
@@ -34,7 +34,7 @@ Arguments
Description
===========
-Applications can use the :ref:`VIDIOC_G_FBUF` and :ref:`VIDIOC_S_FBUF <VIDIOC_G_FBUF>` ioctl
+Applications can use the :ref:`VIDIOC_G_FBUF <VIDIOC_G_FBUF>` and :ref:`VIDIOC_S_FBUF <VIDIOC_G_FBUF>` ioctl
to get and set the framebuffer parameters for a
:ref:`Video Overlay <overlay>` or :ref:`Video Output Overlay <osd>`
(OSD). The type of overlay is implied by the device type (capture or
@@ -48,7 +48,7 @@ of a graphics card. A non-destructive overlay blends video images into a
VGA signal or graphics into a video signal. *Video Output Overlays* are
always non-destructive.
-To get the current parameters applications call the :ref:`VIDIOC_G_FBUF`
+To get the current parameters applications call the :ref:`VIDIOC_G_FBUF <VIDIOC_G_FBUF>`
ioctl with a pointer to a :c:type:`struct v4l2_framebuffer`
structure. The driver fills all fields of the structure or returns an
EINVAL error code when overlays are not supported.
@@ -59,13 +59,13 @@ initialize the ``flags`` field of a struct
implemented on the TV card all other parameters are determined by the
driver. When an application calls :ref:`VIDIOC_S_FBUF <VIDIOC_G_FBUF>` with a pointer to
this structure, the driver prepares for the overlay and returns the
-framebuffer parameters as :ref:`VIDIOC_G_FBUF` does, or it returns an error
+framebuffer parameters as :ref:`VIDIOC_G_FBUF <VIDIOC_G_FBUF>` does, or it returns an error
code.
To set the parameters for a *non-destructive Video Overlay*,
applications must initialize the ``flags`` field, the ``fmt``
substructure, and call :ref:`VIDIOC_S_FBUF <VIDIOC_G_FBUF>`. Again the driver prepares for
-the overlay and returns the framebuffer parameters as :ref:`VIDIOC_G_FBUF`
+the overlay and returns the framebuffer parameters as :ref:`VIDIOC_G_FBUF <VIDIOC_G_FBUF>`
does, or it returns an error code.
For a *destructive Video Overlay* applications must additionally provide
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-fmt.rst b/Documentation/linux_tv/media/v4l/vidioc-g-fmt.rst
index 8c07fe2454e2..3ac4fb764a7e 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-fmt.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-fmt.rst
@@ -41,7 +41,7 @@ struct :c:type:`struct v4l2_format` to the respective buffer (stream)
type. For example video capture devices use
``V4L2_BUF_TYPE_VIDEO_CAPTURE`` or
``V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE``. When the application calls the
-:ref:`VIDIOC_G_FMT` ioctl with a pointer to this structure the driver fills
+:ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>` ioctl with a pointer to this structure the driver fills
the respective member of the ``fmt`` union. In case of video capture
devices that is either the struct
:ref:`v4l2_pix_format <v4l2-pix-format>` ``pix`` or the struct
@@ -62,10 +62,10 @@ this is a mechanism to fathom device capabilities and to approach
parameters acceptable for both the application and driver. On success
the driver may program the hardware, allocate resources and generally
prepare for data exchange. Finally the :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl returns
-the current format parameters as :ref:`VIDIOC_G_FMT` does. Very simple,
+the current format parameters as :ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>` does. Very simple,
inflexible devices may even ignore all input and always return the
default parameters. However all V4L2 devices exchanging data with the
-application must implement the :ref:`VIDIOC_G_FMT` and :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>`
+application must implement the :ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>` and :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>`
ioctl. When the requested buffer type is not supported drivers return an
EINVAL error code on a :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` attempt. When I/O is already in
progress or the resource is not available for other reasons drivers
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-frequency.rst b/Documentation/linux_tv/media/v4l/vidioc-g-frequency.rst
index 19a5ae9c4bcd..b187f1345bb4 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-frequency.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-frequency.rst
@@ -39,7 +39,7 @@ the ``tuner`` field of a struct
:ref:`v4l2_frequency <v4l2-frequency>` to the respective tuner or
modulator number (only input devices have tuners, only output devices
have modulators), zero out the ``reserved`` array and call the
-:ref:`VIDIOC_G_FREQUENCY` ioctl with a pointer to this structure. The
+:ref:`VIDIOC_G_FREQUENCY <VIDIOC_G_FREQUENCY>` ioctl with a pointer to this structure. The
driver stores the current frequency in the ``frequency`` field.
To change the current tuner or modulator radio frequency applications
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-input.rst b/Documentation/linux_tv/media/v4l/vidioc-g-input.rst
index 2bcaa324aa33..bb5944449650 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-input.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-input.rst
@@ -33,7 +33,7 @@ Description
===========
To query the current video input applications call the
-:ref:`VIDIOC_G_INPUT` ioctl with a pointer to an integer where the driver
+:ref:`VIDIOC_G_INPUT <VIDIOC_G_INPUT>` ioctl with a pointer to an integer where the driver
stores the number of the input, as in the struct
:ref:`v4l2_input <v4l2-input>` ``index`` field. This ioctl will fail
only when there are no video inputs, returning EINVAL.
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-modulator.rst b/Documentation/linux_tv/media/v4l/vidioc-g-modulator.rst
index 83e761eaef2b..913b7d96faba 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-modulator.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-modulator.rst
@@ -37,7 +37,7 @@ Description
To query the attributes of a modulator applications initialize the
``index`` field and zero out the ``reserved`` array of a struct
:ref:`v4l2_modulator <v4l2-modulator>` and call the
-:ref:`VIDIOC_G_MODULATOR` ioctl with a pointer to this structure. Drivers
+:ref:`VIDIOC_G_MODULATOR <VIDIOC_G_MODULATOR>` ioctl with a pointer to this structure. Drivers
fill the rest of the structure or return an EINVAL error code when the
index is out of bounds. To enumerate all modulators applications shall
begin at index zero, incrementing by one until the driver returns
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-output.rst b/Documentation/linux_tv/media/v4l/vidioc-g-output.rst
index ebed04ae48da..e48bf39cfa10 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-output.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-output.rst
@@ -33,7 +33,7 @@ Description
===========
To query the current video output applications call the
-:ref:`VIDIOC_G_OUTPUT` ioctl with a pointer to an integer where the driver
+:ref:`VIDIOC_G_OUTPUT <VIDIOC_G_OUTPUT>` ioctl with a pointer to an integer where the driver
stores the number of the output, as in the struct
:ref:`v4l2_output <v4l2-output>` ``index`` field. This ioctl will
fail only when there are no video outputs, returning the EINVAL error
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-parm.rst b/Documentation/linux_tv/media/v4l/vidioc-g-parm.rst
index 906faaa85bfa..0567fce18144 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-parm.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-parm.rst
@@ -44,7 +44,7 @@ internally by a driver in read/write mode. For implications see the
section discussing the :ref:`read() <func-read>` function.
To get and set the streaming parameters applications call the
-:ref:`VIDIOC_G_PARM` and :ref:`VIDIOC_S_PARM <VIDIOC_G_PARM>` ioctl, respectively. They take a
+:ref:`VIDIOC_G_PARM <VIDIOC_G_PARM>` and :ref:`VIDIOC_S_PARM <VIDIOC_G_PARM>` ioctl, respectively. They take a
pointer to a struct :c:type:`struct v4l2_streamparm` which contains a
union holding separate parameters for input and output devices.
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-priority.rst b/Documentation/linux_tv/media/v4l/vidioc-g-priority.rst
index db95647d3a80..b241970c8aee 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-priority.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-priority.rst
@@ -36,7 +36,7 @@ Description
===========
To query the current access priority applications call the
-:ref:`VIDIOC_G_PRIORITY` ioctl with a pointer to an enum v4l2_priority
+:ref:`VIDIOC_G_PRIORITY <VIDIOC_G_PRIORITY>` ioctl with a pointer to an enum v4l2_priority
variable where the driver stores the current priority.
To request an access priority applications store the desired priority in
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-sliced-vbi-cap.rst b/Documentation/linux_tv/media/v4l/vidioc-g-sliced-vbi-cap.rst
index 635cb9b2c250..a051f93252d0 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-sliced-vbi-cap.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-sliced-vbi-cap.rst
@@ -34,7 +34,7 @@ Description
To find out which data services are supported by a sliced VBI capture or
output device, applications initialize the ``type`` field of a struct
:ref:`v4l2_sliced_vbi_cap <v4l2-sliced-vbi-cap>`, clear the
-``reserved`` array and call the :ref:`VIDIOC_G_SLICED_VBI_CAP` ioctl. The
+``reserved`` array and call the :ref:`VIDIOC_G_SLICED_VBI_CAP <VIDIOC_G_SLICED_VBI_CAP>` ioctl. The
driver fills in the remaining fields or returns an EINVAL error code if
the sliced VBI API is unsupported or ``type`` is invalid.
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-std.rst b/Documentation/linux_tv/media/v4l/vidioc-g-std.rst
index bc8e071401b0..a7257f0b38a2 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-std.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-std.rst
@@ -35,15 +35,15 @@ Description
===========
To query and select the current video standard applications use the
-:ref:`VIDIOC_G_STD` and :ref:`VIDIOC_S_STD <VIDIOC_G_STD>` ioctls which take a pointer to a
-:ref:`v4l2_std_id <v4l2-std-id>` type as argument. :ref:`VIDIOC_G_STD`
+:ref:`VIDIOC_G_STD <VIDIOC_G_STD>` and :ref:`VIDIOC_S_STD <VIDIOC_G_STD>` ioctls which take a pointer to a
+:ref:`v4l2_std_id <v4l2-std-id>` type as argument. :ref:`VIDIOC_G_STD <VIDIOC_G_STD>`
can return a single flag or a set of flags as in struct
:ref:`v4l2_standard <v4l2-standard>` field ``id``. The flags must be
unambiguous such that they appear in only one enumerated
:c:type:`struct v4l2_standard` structure.
:ref:`VIDIOC_S_STD <VIDIOC_G_STD>` accepts one or more flags, being a write-only ioctl it
-does not return the actual new standard as :ref:`VIDIOC_G_STD` does. When
+does not return the actual new standard as :ref:`VIDIOC_G_STD <VIDIOC_G_STD>` does. When
no flags are given or the current input does not support the requested
standard the driver returns an EINVAL error code. When the standard set
is ambiguous drivers may return EINVAL or choose any of the requested
diff --git a/Documentation/linux_tv/media/v4l/vidioc-queryctrl.rst b/Documentation/linux_tv/media/v4l/vidioc-queryctrl.rst
index 2b11efc3d257..7d38a51c4f73 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-queryctrl.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-queryctrl.rst
@@ -569,7 +569,7 @@ See also the examples in :ref:`control`.
:ref:`VIDIOC_S_EXT_CTRLS <VIDIOC_G_EXT_CTRLS>` you need to
set the ``size`` field of struct
:ref:`v4l2_ext_control <v4l2-ext-control>` to 9. For
- :ref:`VIDIOC_G_EXT_CTRLS` you can set
+ :ref:`VIDIOC_G_EXT_CTRLS <VIDIOC_G_EXT_CTRLS>` you can set
the ``size`` field to ``maximum`` + 1. Which character encoding is
used will depend on the string control itself and should be part
of the control documentation.
--
2.7.4
^ permalink raw reply related [flat|nested] 52+ messages in thread* [PATCH 15/51] Documentation: audio.rst: re-add captions for the examples
2016-07-04 11:46 [PATCH 00/51] First part of documentation fixups Mauro Carvalho Chehab
` (13 preceding siblings ...)
2016-07-04 11:46 ` [PATCH 14/51] Documentation: linux_tv: don't simplify VIDIOC_G_foo references Mauro Carvalho Chehab
@ 2016-07-04 11:46 ` Mauro Carvalho Chehab
2016-07-04 11:46 ` [PATCH 16/51] Documentation: standard.rst: read the example captions Mauro Carvalho Chehab
` (35 subsequent siblings)
50 siblings, 0 replies; 52+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-04 11:46 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, Jonathan Corbet,
Markus Heiser, linux-doc
The captions were lost during the format conversion.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
Documentation/linux_tv/media/v4l/audio.rst | 2 ++
1 file changed, 2 insertions(+)
diff --git a/Documentation/linux_tv/media/v4l/audio.rst b/Documentation/linux_tv/media/v4l/audio.rst
index 8c3314218f75..e9d99f6a259a 100644
--- a/Documentation/linux_tv/media/v4l/audio.rst
+++ b/Documentation/linux_tv/media/v4l/audio.rst
@@ -55,6 +55,7 @@ the :ref:`VIDIOC_QUERYCAP` ioctl.
.. code-block:: c
+ :caption: Example 3: Information about the current audio input
struct v4l2_audio audio;
@@ -69,6 +70,7 @@ the :ref:`VIDIOC_QUERYCAP` ioctl.
.. code-block:: c
+ :caption: Example 4: Switching to the first audio input
struct v4l2_audio audio;
--
2.7.4
^ permalink raw reply related [flat|nested] 52+ messages in thread* [PATCH 16/51] Documentation: standard.rst: read the example captions
2016-07-04 11:46 [PATCH 00/51] First part of documentation fixups Mauro Carvalho Chehab
` (14 preceding siblings ...)
2016-07-04 11:46 ` [PATCH 15/51] Documentation: audio.rst: re-add captions for the examples Mauro Carvalho Chehab
@ 2016-07-04 11:46 ` Mauro Carvalho Chehab
2016-07-04 11:46 ` [PATCH 17/51] Documentation: linux_tv: remove controls.rst Mauro Carvalho Chehab
` (34 subsequent siblings)
50 siblings, 0 replies; 52+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-04 11:46 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, Jonathan Corbet,
Markus Heiser, linux-doc
Those got lost during format conversion.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
Documentation/linux_tv/media/v4l/standard.rst | 3 +++
1 file changed, 3 insertions(+)
diff --git a/Documentation/linux_tv/media/v4l/standard.rst b/Documentation/linux_tv/media/v4l/standard.rst
index 20c0d044a129..11d1a7183c73 100644
--- a/Documentation/linux_tv/media/v4l/standard.rst
+++ b/Documentation/linux_tv/media/v4l/standard.rst
@@ -66,6 +66,7 @@ standard ioctls can be used with the given input or output.
.. code-block:: c
+ :caption: Example 5: Information about the current video standard
v4l2_std_id std_id;
struct v4l2_standard standard;
@@ -101,6 +102,7 @@ standard ioctls can be used with the given input or output.
.. code-block:: c
+ :caption: Example 6: Listing the video standards supported by the current input
struct v4l2_input input;
struct v4l2_standard standard;
@@ -139,6 +141,7 @@ standard ioctls can be used with the given input or output.
.. code-block:: c
+ :caption: Example 7: Selecting a new video standard
struct v4l2_input input;
v4l2_std_id std_id;
--
2.7.4
^ permalink raw reply related [flat|nested] 52+ messages in thread* [PATCH 17/51] Documentation: linux_tv: remove controls.rst
2016-07-04 11:46 [PATCH 00/51] First part of documentation fixups Mauro Carvalho Chehab
` (15 preceding siblings ...)
2016-07-04 11:46 ` [PATCH 16/51] Documentation: standard.rst: read the example captions Mauro Carvalho Chehab
@ 2016-07-04 11:46 ` Mauro Carvalho Chehab
2016-07-04 11:46 ` [PATCH 18/51] Documentation: control.rst: read the example captions Mauro Carvalho Chehab
` (33 subsequent siblings)
50 siblings, 0 replies; 52+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-04 11:46 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, Jonathan Corbet,
Markus Heiser, linux-doc
This auto-generated file is bogus: it just adds a toc for two
other files. Instead, just move the controls and extended-controls
directly to the common.rst file.
this avoids a blank page, and better organize the document.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
Documentation/linux_tv/media/v4l/common.rst | 3 ++-
Documentation/linux_tv/media/v4l/controls.rst | 18 ------------------
2 files changed, 2 insertions(+), 19 deletions(-)
delete mode 100644 Documentation/linux_tv/media/v4l/controls.rst
diff --git a/Documentation/linux_tv/media/v4l/common.rst b/Documentation/linux_tv/media/v4l/common.rst
index 0e85b46b2efc..40d3feab5ab9 100644
--- a/Documentation/linux_tv/media/v4l/common.rst
+++ b/Documentation/linux_tv/media/v4l/common.rst
@@ -37,7 +37,8 @@ applicable to all devices.
tuner
standard
dv-timings
- controls
+ control
+ extended-controls
format
planar-apis
crop
diff --git a/Documentation/linux_tv/media/v4l/controls.rst b/Documentation/linux_tv/media/v4l/controls.rst
deleted file mode 100644
index fe5bca543699..000000000000
--- a/Documentation/linux_tv/media/v4l/controls.rst
+++ /dev/null
@@ -1,18 +0,0 @@
-.. -*- coding: utf-8; mode: rst -*-
-
-.. toctree::
- :maxdepth: 1
-
- control
- extended-controls
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
--
2.7.4
^ permalink raw reply related [flat|nested] 52+ messages in thread* [PATCH 18/51] Documentation: control.rst: read the example captions
2016-07-04 11:46 [PATCH 00/51] First part of documentation fixups Mauro Carvalho Chehab
` (16 preceding siblings ...)
2016-07-04 11:46 ` [PATCH 17/51] Documentation: linux_tv: remove controls.rst Mauro Carvalho Chehab
@ 2016-07-04 11:46 ` Mauro Carvalho Chehab
2016-07-04 11:46 ` [PATCH 19/51] Documentation: control.rst: Fix missing reference for example 8 Mauro Carvalho Chehab
` (32 subsequent siblings)
50 siblings, 0 replies; 52+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-04 11:46 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, Jonathan Corbet,
Markus Heiser, linux-doc
Those got removed by the doc conversion.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
Documentation/linux_tv/media/v4l/control.rst | 4 ++++
1 file changed, 4 insertions(+)
diff --git a/Documentation/linux_tv/media/v4l/control.rst b/Documentation/linux_tv/media/v4l/control.rst
index d6df648767c5..5defd1995e13 100644
--- a/Documentation/linux_tv/media/v4l/control.rst
+++ b/Documentation/linux_tv/media/v4l/control.rst
@@ -372,6 +372,8 @@ more menu type controls.
.. code-block:: c
+ :caption: Example 8: Enumerating all user controls
+
struct v4l2_queryctrl queryctrl;
struct v4l2_querymenu querymenu;
@@ -435,6 +437,7 @@ more menu type controls.
.. code-block:: c
+ :caption: Example 9: Enumerating all user controls (alternative)
memset(&queryctrl, 0, sizeof(queryctrl));
@@ -459,6 +462,7 @@ more menu type controls.
.. code-block:: c
+ :caption: Example 10: Changing controls
struct v4l2_queryctrl queryctrl;
struct v4l2_control control;
--
2.7.4
^ permalink raw reply related [flat|nested] 52+ messages in thread* [PATCH 19/51] Documentation: control.rst: Fix missing reference for example 8
2016-07-04 11:46 [PATCH 00/51] First part of documentation fixups Mauro Carvalho Chehab
` (17 preceding siblings ...)
2016-07-04 11:46 ` [PATCH 18/51] Documentation: control.rst: read the example captions Mauro Carvalho Chehab
@ 2016-07-04 11:46 ` Mauro Carvalho Chehab
2016-07-04 11:46 ` [PATCH 20/51] Documentation: extended-controls.rst: use reference for VIDIOC_S_CTRL Mauro Carvalho Chehab
` (31 subsequent siblings)
50 siblings, 0 replies; 52+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-04 11:46 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, Jonathan Corbet,
Markus Heiser, linux-doc
The conversion broke references and captions for examples.
Fix the missing reference for control enumeration.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
Documentation/linux_tv/media/v4l/control.rst | 2 ++
1 file changed, 2 insertions(+)
diff --git a/Documentation/linux_tv/media/v4l/control.rst b/Documentation/linux_tv/media/v4l/control.rst
index 5defd1995e13..736d79080229 100644
--- a/Documentation/linux_tv/media/v4l/control.rst
+++ b/Documentation/linux_tv/media/v4l/control.rst
@@ -371,6 +371,8 @@ device has one or more controls, ``VIDIOC_QUERYMENU`` when it has one or
more menu type controls.
+.. _enum_all_controls:
+
.. code-block:: c
:caption: Example 8: Enumerating all user controls
--
2.7.4
^ permalink raw reply related [flat|nested] 52+ messages in thread* [PATCH 20/51] Documentation: extended-controls.rst: use reference for VIDIOC_S_CTRL
2016-07-04 11:46 [PATCH 00/51] First part of documentation fixups Mauro Carvalho Chehab
` (18 preceding siblings ...)
2016-07-04 11:46 ` [PATCH 19/51] Documentation: control.rst: Fix missing reference for example 8 Mauro Carvalho Chehab
@ 2016-07-04 11:46 ` Mauro Carvalho Chehab
2016-07-04 11:46 ` [PATCH 21/51] Documentation: vidioc-queryctl.rst: change the title of this chapter Mauro Carvalho Chehab
` (30 subsequent siblings)
50 siblings, 0 replies; 52+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-04 11:46 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, Jonathan Corbet,
Markus Heiser, linux-doc
Instead of using a constant, use references, just like the
other references for ioctl's.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
Documentation/linux_tv/media/v4l/extended-controls.rst | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/Documentation/linux_tv/media/v4l/extended-controls.rst b/Documentation/linux_tv/media/v4l/extended-controls.rst
index 38b85d7b1022..d5efb5bbf5bf 100644
--- a/Documentation/linux_tv/media/v4l/extended-controls.rst
+++ b/Documentation/linux_tv/media/v4l/extended-controls.rst
@@ -54,9 +54,9 @@ contains a pointer to the control array, a count of the number of
controls in that array and a control class. Control classes are used to
group similar controls into a single class. For example, control class
``V4L2_CTRL_CLASS_USER`` contains all user controls (i. e. all controls
-that can also be set using the old ``VIDIOC_S_CTRL`` ioctl). Control
-class ``V4L2_CTRL_CLASS_MPEG`` contains all controls relating to MPEG
-encoding, etc.
+that can also be set using the old :ref:`VIDIOC_S_CTRL <VIDIOC_G_CTRL>`
+ioctl). Control class ``V4L2_CTRL_CLASS_MPEG`` contains all controls
+relating to MPEG encoding, etc.
All controls in the control array must belong to the specified control
class. An error is returned if this is not the case.
--
2.7.4
^ permalink raw reply related [flat|nested] 52+ messages in thread* [PATCH 21/51] Documentation: vidioc-queryctl.rst: change the title of this chapter
2016-07-04 11:46 [PATCH 00/51] First part of documentation fixups Mauro Carvalho Chehab
` (19 preceding siblings ...)
2016-07-04 11:46 ` [PATCH 20/51] Documentation: extended-controls.rst: use reference for VIDIOC_S_CTRL Mauro Carvalho Chehab
@ 2016-07-04 11:46 ` Mauro Carvalho Chehab
2016-07-04 11:46 ` [PATCH 22/51] Documentation: linux_tv: supress lots of warnings Mauro Carvalho Chehab
` (29 subsequent siblings)
50 siblings, 0 replies; 52+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-04 11:46 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, Jonathan Corbet,
Markus Heiser, linux-doc
This chapter is referenced on several parts of the extended
controls. Change the title to make it nicer where it is
referenced.
Ok, we might, instead, just change the name for the references
to only mention the oldest ioctl, but IMHO, it is better to
keep the name of all ioctls where it is referenced.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
Documentation/linux_tv/media/v4l/vidioc-queryctrl.rst | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/Documentation/linux_tv/media/v4l/vidioc-queryctrl.rst b/Documentation/linux_tv/media/v4l/vidioc-queryctrl.rst
index 7d38a51c4f73..2e93caeafe9e 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-queryctrl.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-queryctrl.rst
@@ -2,9 +2,9 @@
.. _VIDIOC_QUERYCTRL:
-***************************************************************
-ioctl VIDIOC_QUERYCTRL, VIDIOC_QUERY_EXT_CTRL, VIDIOC_QUERYMENU
-***************************************************************
+*******************************************************************
+ioctls VIDIOC_QUERYCTRL, VIDIOC_QUERY_EXT_CTRL and VIDIOC_QUERYMENU
+*******************************************************************
*man VIDIOC_QUERYCTRL(2)*
--
2.7.4
^ permalink raw reply related [flat|nested] 52+ messages in thread* [PATCH 22/51] Documentation: linux_tv: supress lots of warnings
2016-07-04 11:46 [PATCH 00/51] First part of documentation fixups Mauro Carvalho Chehab
` (20 preceding siblings ...)
2016-07-04 11:46 ` [PATCH 21/51] Documentation: vidioc-queryctl.rst: change the title of this chapter Mauro Carvalho Chehab
@ 2016-07-04 11:46 ` Mauro Carvalho Chehab
2016-07-04 11:46 ` [PATCH 23/51] Documentation: planar-apis.rst: fix some conversion troubles Mauro Carvalho Chehab
` (28 subsequent siblings)
50 siblings, 0 replies; 52+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-04 11:46 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, Jonathan Corbet,
Markus Heiser, linux-doc
The c language parser checks if there are duplicated object
definitions. That causes lots of warnings like:
WARNING: duplicate C object description of ioctl
Let's remove those by telling Sphinx that the language for
those objects are c++. The look of the descriptions will
be close, and the warnings will be gone.
Please notice that we had to keep a few of them as C, as
the c++ parser seems to be broken when it finds an enum.
Yet, this reduced from 219 warnings to 143, with is
a good thing.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
Documentation/linux_tv/media/dvb/fe-diseqc-recv-slave-reply.rst | 2 +-
Documentation/linux_tv/media/dvb/fe-diseqc-reset-overload.rst | 2 +-
Documentation/linux_tv/media/dvb/fe-diseqc-send-master-cmd.rst | 2 +-
Documentation/linux_tv/media/dvb/fe-enable-high-lnb-voltage.rst | 2 +-
Documentation/linux_tv/media/dvb/fe-get-info.rst | 2 +-
Documentation/linux_tv/media/dvb/fe-get-property.rst | 2 +-
Documentation/linux_tv/media/dvb/fe-read-status.rst | 2 +-
Documentation/linux_tv/media/dvb/fe-set-frontend-tune-mode.rst | 2 +-
Documentation/linux_tv/media/dvb/frontend_f_close.rst | 2 +-
Documentation/linux_tv/media/dvb/frontend_f_open.rst | 2 +-
Documentation/linux_tv/media/dvb/net.rst | 6 +++---
Documentation/linux_tv/media/v4l/func-close.rst | 2 +-
Documentation/linux_tv/media/v4l/func-ioctl.rst | 2 +-
Documentation/linux_tv/media/v4l/func-mmap.rst | 2 +-
Documentation/linux_tv/media/v4l/func-munmap.rst | 2 +-
Documentation/linux_tv/media/v4l/func-open.rst | 2 +-
Documentation/linux_tv/media/v4l/func-poll.rst | 2 +-
Documentation/linux_tv/media/v4l/func-read.rst | 2 +-
Documentation/linux_tv/media/v4l/func-select.rst | 2 +-
Documentation/linux_tv/media/v4l/func-write.rst | 2 +-
Documentation/linux_tv/media/v4l/media-func-close.rst | 2 +-
Documentation/linux_tv/media/v4l/media-func-ioctl.rst | 2 +-
Documentation/linux_tv/media/v4l/media-func-open.rst | 2 +-
Documentation/linux_tv/media/v4l/media-ioc-device-info.rst | 2 +-
Documentation/linux_tv/media/v4l/media-ioc-enum-entities.rst | 2 +-
Documentation/linux_tv/media/v4l/media-ioc-enum-links.rst | 2 +-
Documentation/linux_tv/media/v4l/media-ioc-g-topology.rst | 2 +-
Documentation/linux_tv/media/v4l/media-ioc-setup-link.rst | 2 +-
Documentation/linux_tv/media/v4l/vidioc-create-bufs.rst | 2 +-
Documentation/linux_tv/media/v4l/vidioc-cropcap.rst | 2 +-
Documentation/linux_tv/media/v4l/vidioc-dbg-g-chip-info.rst | 2 +-
Documentation/linux_tv/media/v4l/vidioc-dbg-g-register.rst | 4 ++--
Documentation/linux_tv/media/v4l/vidioc-decoder-cmd.rst | 2 +-
Documentation/linux_tv/media/v4l/vidioc-dqevent.rst | 2 +-
Documentation/linux_tv/media/v4l/vidioc-dv-timings-cap.rst | 2 +-
Documentation/linux_tv/media/v4l/vidioc-encoder-cmd.rst | 2 +-
Documentation/linux_tv/media/v4l/vidioc-enum-dv-timings.rst | 2 +-
Documentation/linux_tv/media/v4l/vidioc-enum-fmt.rst | 2 +-
Documentation/linux_tv/media/v4l/vidioc-enum-frameintervals.rst | 2 +-
Documentation/linux_tv/media/v4l/vidioc-enum-framesizes.rst | 2 +-
Documentation/linux_tv/media/v4l/vidioc-enum-freq-bands.rst | 2 +-
Documentation/linux_tv/media/v4l/vidioc-enumaudio.rst | 2 +-
Documentation/linux_tv/media/v4l/vidioc-enumaudioout.rst | 2 +-
Documentation/linux_tv/media/v4l/vidioc-enuminput.rst | 2 +-
Documentation/linux_tv/media/v4l/vidioc-enumoutput.rst | 2 +-
Documentation/linux_tv/media/v4l/vidioc-enumstd.rst | 2 +-
Documentation/linux_tv/media/v4l/vidioc-expbuf.rst | 2 +-
Documentation/linux_tv/media/v4l/vidioc-g-audio.rst | 4 ++--
Documentation/linux_tv/media/v4l/vidioc-g-audioout.rst | 4 ++--
Documentation/linux_tv/media/v4l/vidioc-g-crop.rst | 4 ++--
Documentation/linux_tv/media/v4l/vidioc-g-ctrl.rst | 2 +-
Documentation/linux_tv/media/v4l/vidioc-g-dv-timings.rst | 2 +-
Documentation/linux_tv/media/v4l/vidioc-g-edid.rst | 4 ++--
Documentation/linux_tv/media/v4l/vidioc-g-enc-index.rst | 2 +-
Documentation/linux_tv/media/v4l/vidioc-g-ext-ctrls.rst | 2 +-
Documentation/linux_tv/media/v4l/vidioc-g-fbuf.rst | 4 ++--
Documentation/linux_tv/media/v4l/vidioc-g-fmt.rst | 2 +-
Documentation/linux_tv/media/v4l/vidioc-g-frequency.rst | 4 ++--
Documentation/linux_tv/media/v4l/vidioc-g-input.rst | 2 +-
Documentation/linux_tv/media/v4l/vidioc-g-jpegcomp.rst | 4 ++--
Documentation/linux_tv/media/v4l/vidioc-g-modulator.rst | 4 ++--
Documentation/linux_tv/media/v4l/vidioc-g-output.rst | 2 +-
Documentation/linux_tv/media/v4l/vidioc-g-parm.rst | 2 +-
Documentation/linux_tv/media/v4l/vidioc-g-selection.rst | 2 +-
Documentation/linux_tv/media/v4l/vidioc-g-sliced-vbi-cap.rst | 2 +-
Documentation/linux_tv/media/v4l/vidioc-g-std.rst | 4 ++--
Documentation/linux_tv/media/v4l/vidioc-g-tuner.rst | 4 ++--
Documentation/linux_tv/media/v4l/vidioc-log-status.rst | 2 +-
Documentation/linux_tv/media/v4l/vidioc-overlay.rst | 2 +-
Documentation/linux_tv/media/v4l/vidioc-prepare-buf.rst | 2 +-
Documentation/linux_tv/media/v4l/vidioc-qbuf.rst | 2 +-
Documentation/linux_tv/media/v4l/vidioc-query-dv-timings.rst | 2 +-
Documentation/linux_tv/media/v4l/vidioc-querybuf.rst | 2 +-
Documentation/linux_tv/media/v4l/vidioc-querycap.rst | 2 +-
Documentation/linux_tv/media/v4l/vidioc-queryctrl.rst | 6 +++---
Documentation/linux_tv/media/v4l/vidioc-querystd.rst | 2 +-
Documentation/linux_tv/media/v4l/vidioc-reqbufs.rst | 2 +-
Documentation/linux_tv/media/v4l/vidioc-s-hw-freq-seek.rst | 2 +-
Documentation/linux_tv/media/v4l/vidioc-streamon.rst | 2 +-
.../linux_tv/media/v4l/vidioc-subdev-enum-frame-interval.rst | 2 +-
Documentation/linux_tv/media/v4l/vidioc-subdev-enum-frame-size.rst | 2 +-
Documentation/linux_tv/media/v4l/vidioc-subdev-enum-mbus-code.rst | 2 +-
Documentation/linux_tv/media/v4l/vidioc-subdev-g-crop.rst | 4 ++--
Documentation/linux_tv/media/v4l/vidioc-subdev-g-fmt.rst | 2 +-
Documentation/linux_tv/media/v4l/vidioc-subdev-g-frame-interval.rst | 2 +-
Documentation/linux_tv/media/v4l/vidioc-subdev-g-selection.rst | 2 +-
Documentation/linux_tv/media/v4l/vidioc-subscribe-event.rst | 2 +-
scripts/kernel-doc | 2 +-
88 files changed, 104 insertions(+), 104 deletions(-)
mode change 100755 => 100644 scripts/kernel-doc
diff --git a/Documentation/linux_tv/media/dvb/fe-diseqc-recv-slave-reply.rst b/Documentation/linux_tv/media/dvb/fe-diseqc-recv-slave-reply.rst
index 309930f9b3cd..0f01584c8d4e 100644
--- a/Documentation/linux_tv/media/dvb/fe-diseqc-recv-slave-reply.rst
+++ b/Documentation/linux_tv/media/dvb/fe-diseqc-recv-slave-reply.rst
@@ -14,7 +14,7 @@ Receives reply from a DiSEqC 2.0 command
Synopsis
========
-.. c:function:: int ioctl( int fd, int request, struct dvb_diseqc_slave_reply *argp )
+.. cpp:function:: int ioctl( int fd, int request, struct dvb_diseqc_slave_reply *argp )
Arguments
=========
diff --git a/Documentation/linux_tv/media/dvb/fe-diseqc-reset-overload.rst b/Documentation/linux_tv/media/dvb/fe-diseqc-reset-overload.rst
index dc7ae1a02725..50d0d651d270 100644
--- a/Documentation/linux_tv/media/dvb/fe-diseqc-reset-overload.rst
+++ b/Documentation/linux_tv/media/dvb/fe-diseqc-reset-overload.rst
@@ -15,7 +15,7 @@ to power overload.
Synopsis
========
-.. c:function:: int ioctl( int fd, int request, NULL )
+.. cpp:function:: int ioctl( int fd, int request, NULL )
Arguments
=========
diff --git a/Documentation/linux_tv/media/dvb/fe-diseqc-send-master-cmd.rst b/Documentation/linux_tv/media/dvb/fe-diseqc-send-master-cmd.rst
index 974a45f632a6..7a85632e64b4 100644
--- a/Documentation/linux_tv/media/dvb/fe-diseqc-send-master-cmd.rst
+++ b/Documentation/linux_tv/media/dvb/fe-diseqc-send-master-cmd.rst
@@ -14,7 +14,7 @@ Sends a DiSEqC command
Synopsis
========
-.. c:function:: int ioctl( int fd, int request, struct dvb_diseqc_master_cmd *argp )
+.. cpp:function:: int ioctl( int fd, int request, struct dvb_diseqc_master_cmd *argp )
Arguments
=========
diff --git a/Documentation/linux_tv/media/dvb/fe-enable-high-lnb-voltage.rst b/Documentation/linux_tv/media/dvb/fe-enable-high-lnb-voltage.rst
index 207c65a44120..f2705a383d8c 100644
--- a/Documentation/linux_tv/media/dvb/fe-enable-high-lnb-voltage.rst
+++ b/Documentation/linux_tv/media/dvb/fe-enable-high-lnb-voltage.rst
@@ -15,7 +15,7 @@ voltages.
Synopsis
========
-.. c:function:: int ioctl( int fd, int request, unsigned int high )
+.. cpp:function:: int ioctl( int fd, int request, unsigned int high )
Arguments
=========
diff --git a/Documentation/linux_tv/media/dvb/fe-get-info.rst b/Documentation/linux_tv/media/dvb/fe-get-info.rst
index 5ac74c232b12..d7990c80ef87 100644
--- a/Documentation/linux_tv/media/dvb/fe-get-info.rst
+++ b/Documentation/linux_tv/media/dvb/fe-get-info.rst
@@ -15,7 +15,7 @@ front-end. This call only requires read-only access to the device
Synopsis
========
-.. c:function:: int ioctl( int fd, int request, struct dvb_frontend_info *argp )
+.. cpp:function:: int ioctl( int fd, int request, struct dvb_frontend_info *argp )
Arguments
=========
diff --git a/Documentation/linux_tv/media/dvb/fe-get-property.rst b/Documentation/linux_tv/media/dvb/fe-get-property.rst
index 8a6c5de041e8..5b73ee8e790b 100644
--- a/Documentation/linux_tv/media/dvb/fe-get-property.rst
+++ b/Documentation/linux_tv/media/dvb/fe-get-property.rst
@@ -16,7 +16,7 @@ FE_GET_PROPERTY returns one or more frontend properties.
Synopsis
========
-.. c:function:: int ioctl( int fd, int request, struct dtv_properties *argp )
+.. cpp:function:: int ioctl( int fd, int request, struct dtv_properties *argp )
Arguments
=========
diff --git a/Documentation/linux_tv/media/dvb/fe-read-status.rst b/Documentation/linux_tv/media/dvb/fe-read-status.rst
index 41396a8f1c3d..c032cda4e5a6 100644
--- a/Documentation/linux_tv/media/dvb/fe-read-status.rst
+++ b/Documentation/linux_tv/media/dvb/fe-read-status.rst
@@ -15,7 +15,7 @@ read-only access to the device
Synopsis
========
-.. c:function:: int ioctl( int fd, int request, unsigned int *status )
+.. cpp:function:: int ioctl( int fd, int request, unsigned int *status )
Arguments
=========
diff --git a/Documentation/linux_tv/media/dvb/fe-set-frontend-tune-mode.rst b/Documentation/linux_tv/media/dvb/fe-set-frontend-tune-mode.rst
index 1167d22c2382..82665279b840 100644
--- a/Documentation/linux_tv/media/dvb/fe-set-frontend-tune-mode.rst
+++ b/Documentation/linux_tv/media/dvb/fe-set-frontend-tune-mode.rst
@@ -14,7 +14,7 @@ Allow setting tuner mode flags to the frontend.
Synopsis
========
-.. c:function:: int ioctl( int fd, int request, unsigned int flags )
+.. cpp:function:: int ioctl( int fd, int request, unsigned int flags )
Arguments
=========
diff --git a/Documentation/linux_tv/media/dvb/frontend_f_close.rst b/Documentation/linux_tv/media/dvb/frontend_f_close.rst
index cde87322859a..faae1c7381e2 100644
--- a/Documentation/linux_tv/media/dvb/frontend_f_close.rst
+++ b/Documentation/linux_tv/media/dvb/frontend_f_close.rst
@@ -19,7 +19,7 @@ Synopsis
#include <unistd.h>
-.. c:function:: int close( int fd )
+.. cpp:function:: int close( int fd )
Arguments
=========
diff --git a/Documentation/linux_tv/media/dvb/frontend_f_open.rst b/Documentation/linux_tv/media/dvb/frontend_f_open.rst
index 91ac9ef8c356..9ef430abcba4 100644
--- a/Documentation/linux_tv/media/dvb/frontend_f_open.rst
+++ b/Documentation/linux_tv/media/dvb/frontend_f_open.rst
@@ -19,7 +19,7 @@ Synopsis
#include <fcntl.h>
-.. c:function:: int open( const char *device_name, int flags )
+.. cpp:function:: int open( const char *device_name, int flags )
Arguments
=========
diff --git a/Documentation/linux_tv/media/dvb/net.rst b/Documentation/linux_tv/media/dvb/net.rst
index 040ffc70601d..830076fadda2 100644
--- a/Documentation/linux_tv/media/dvb/net.rst
+++ b/Documentation/linux_tv/media/dvb/net.rst
@@ -46,7 +46,7 @@ Creates a new network interface for a given Packet ID.
Synopsis
========
-.. c:function:: int ioctl( int fd, int request, struct dvb_net_if *net_if )
+.. cpp:function:: int ioctl( int fd, int request, struct dvb_net_if *net_if )
Arguments
=========
@@ -135,7 +135,7 @@ Removes a network interface.
Synopsis
========
-.. c:function:: int ioctl( int fd, int request, int ifnum )
+.. cpp:function:: int ioctl( int fd, int request, int ifnum )
Arguments
=========
@@ -178,7 +178,7 @@ Read the configuration data of an interface created via
Synopsis
========
-.. c:function:: int ioctl( int fd, int request, struct dvb_net_if *net_if )
+.. cpp:function:: int ioctl( int fd, int request, struct dvb_net_if *net_if )
Arguments
=========
diff --git a/Documentation/linux_tv/media/v4l/func-close.rst b/Documentation/linux_tv/media/v4l/func-close.rst
index 28fd055bf71b..991a34a163af 100644
--- a/Documentation/linux_tv/media/v4l/func-close.rst
+++ b/Documentation/linux_tv/media/v4l/func-close.rst
@@ -19,7 +19,7 @@ Synopsis
#include <unistd.h>
-.. c:function:: int close( int fd )
+.. cpp:function:: int close( int fd )
Arguments
=========
diff --git a/Documentation/linux_tv/media/v4l/func-ioctl.rst b/Documentation/linux_tv/media/v4l/func-ioctl.rst
index 774ac4cbb6b8..26b072cfe850 100644
--- a/Documentation/linux_tv/media/v4l/func-ioctl.rst
+++ b/Documentation/linux_tv/media/v4l/func-ioctl.rst
@@ -19,7 +19,7 @@ Synopsis
#include <sys/ioctl.h>
-.. c:function:: int ioctl( int fd, int request, void *argp )
+.. cpp:function:: int ioctl( int fd, int request, void *argp )
Arguments
=========
diff --git a/Documentation/linux_tv/media/v4l/func-mmap.rst b/Documentation/linux_tv/media/v4l/func-mmap.rst
index b908c0253c07..51502a906c3c 100644
--- a/Documentation/linux_tv/media/v4l/func-mmap.rst
+++ b/Documentation/linux_tv/media/v4l/func-mmap.rst
@@ -20,7 +20,7 @@ Synopsis
#include <sys/mman.h>
-.. c:function:: void *mmap( void *start, size_t length, int prot, int flags, int fd, off_t offset )
+.. cpp:function:: void *mmap( void *start, size_t length, int prot, int flags, int fd, off_t offset )
Arguments
=========
diff --git a/Documentation/linux_tv/media/v4l/func-munmap.rst b/Documentation/linux_tv/media/v4l/func-munmap.rst
index 46c837457cae..80f9ecd92774 100644
--- a/Documentation/linux_tv/media/v4l/func-munmap.rst
+++ b/Documentation/linux_tv/media/v4l/func-munmap.rst
@@ -20,7 +20,7 @@ Synopsis
#include <sys/mman.h>
-.. c:function:: int munmap( void *start, size_t length )
+.. cpp:function:: int munmap( void *start, size_t length )
Arguments
=========
diff --git a/Documentation/linux_tv/media/v4l/func-open.rst b/Documentation/linux_tv/media/v4l/func-open.rst
index 370a6858d65d..06937b925be3 100644
--- a/Documentation/linux_tv/media/v4l/func-open.rst
+++ b/Documentation/linux_tv/media/v4l/func-open.rst
@@ -19,7 +19,7 @@ Synopsis
#include <fcntl.h>
-.. c:function:: int open( const char *device_name, int flags )
+.. cpp:function:: int open( const char *device_name, int flags )
Arguments
=========
diff --git a/Documentation/linux_tv/media/v4l/func-poll.rst b/Documentation/linux_tv/media/v4l/func-poll.rst
index 782531fe964c..2de7f8a3a971 100644
--- a/Documentation/linux_tv/media/v4l/func-poll.rst
+++ b/Documentation/linux_tv/media/v4l/func-poll.rst
@@ -19,7 +19,7 @@ Synopsis
#include <sys/poll.h>
-.. c:function:: int poll( struct pollfd *ufds, unsigned int nfds, int timeout )
+.. cpp:function:: int poll( struct pollfd *ufds, unsigned int nfds, int timeout )
Description
===========
diff --git a/Documentation/linux_tv/media/v4l/func-read.rst b/Documentation/linux_tv/media/v4l/func-read.rst
index 497bc9a9dd5a..94349fa19215 100644
--- a/Documentation/linux_tv/media/v4l/func-read.rst
+++ b/Documentation/linux_tv/media/v4l/func-read.rst
@@ -19,7 +19,7 @@ Synopsis
#include <unistd.h>
-.. c:function:: ssize_t read( int fd, void *buf, size_t count )
+.. cpp:function:: ssize_t read( int fd, void *buf, size_t count )
Arguments
=========
diff --git a/Documentation/linux_tv/media/v4l/func-select.rst b/Documentation/linux_tv/media/v4l/func-select.rst
index 77302800e6ca..56d01b33e25d 100644
--- a/Documentation/linux_tv/media/v4l/func-select.rst
+++ b/Documentation/linux_tv/media/v4l/func-select.rst
@@ -21,7 +21,7 @@ Synopsis
#include <unistd.h>
-.. c:function:: int select( int nfds, fd_set *readfds, fd_set *writefds, fd_set *exceptfds, struct timeval *timeout )
+.. cpp:function:: int select( int nfds, fd_set *readfds, fd_set *writefds, fd_set *exceptfds, struct timeval *timeout )
Description
===========
diff --git a/Documentation/linux_tv/media/v4l/func-write.rst b/Documentation/linux_tv/media/v4l/func-write.rst
index d2265ba0d92d..402beed3231c 100644
--- a/Documentation/linux_tv/media/v4l/func-write.rst
+++ b/Documentation/linux_tv/media/v4l/func-write.rst
@@ -19,7 +19,7 @@ Synopsis
#include <unistd.h>
-.. c:function:: ssize_t write( int fd, void *buf, size_t count )
+.. cpp:function:: ssize_t write( int fd, void *buf, size_t count )
Arguments
=========
diff --git a/Documentation/linux_tv/media/v4l/media-func-close.rst b/Documentation/linux_tv/media/v4l/media-func-close.rst
index 4049db61ac73..e142ee73d15d 100644
--- a/Documentation/linux_tv/media/v4l/media-func-close.rst
+++ b/Documentation/linux_tv/media/v4l/media-func-close.rst
@@ -19,7 +19,7 @@ Synopsis
#include <unistd.h>
-.. c:function:: int close( int fd )
+.. cpp:function:: int close( int fd )
Arguments
=========
diff --git a/Documentation/linux_tv/media/v4l/media-func-ioctl.rst b/Documentation/linux_tv/media/v4l/media-func-ioctl.rst
index c07f4c05d0bc..7a5c01d6cb4a 100644
--- a/Documentation/linux_tv/media/v4l/media-func-ioctl.rst
+++ b/Documentation/linux_tv/media/v4l/media-func-ioctl.rst
@@ -19,7 +19,7 @@ Synopsis
#include <sys/ioctl.h>
-.. c:function:: int ioctl( int fd, int request, void *argp )
+.. cpp:function:: int ioctl( int fd, int request, void *argp )
Arguments
=========
diff --git a/Documentation/linux_tv/media/v4l/media-func-open.rst b/Documentation/linux_tv/media/v4l/media-func-open.rst
index 59b01c294c9c..573292ac9a94 100644
--- a/Documentation/linux_tv/media/v4l/media-func-open.rst
+++ b/Documentation/linux_tv/media/v4l/media-func-open.rst
@@ -19,7 +19,7 @@ Synopsis
#include <fcntl.h>
-.. c:function:: int open( const char *device_name, int flags )
+.. cpp:function:: int open( const char *device_name, int flags )
Arguments
=========
diff --git a/Documentation/linux_tv/media/v4l/media-ioc-device-info.rst b/Documentation/linux_tv/media/v4l/media-ioc-device-info.rst
index 7c1b3904fbb2..230f9fd9b4fb 100644
--- a/Documentation/linux_tv/media/v4l/media-ioc-device-info.rst
+++ b/Documentation/linux_tv/media/v4l/media-ioc-device-info.rst
@@ -14,7 +14,7 @@ Query device information
Synopsis
========
-.. c:function:: int ioctl( int fd, int request, struct media_device_info *argp )
+.. cpp:function:: int ioctl( int fd, int request, struct media_device_info *argp )
Arguments
=========
diff --git a/Documentation/linux_tv/media/v4l/media-ioc-enum-entities.rst b/Documentation/linux_tv/media/v4l/media-ioc-enum-entities.rst
index 842b05438edb..2549857e681e 100644
--- a/Documentation/linux_tv/media/v4l/media-ioc-enum-entities.rst
+++ b/Documentation/linux_tv/media/v4l/media-ioc-enum-entities.rst
@@ -14,7 +14,7 @@ Enumerate entities and their properties
Synopsis
========
-.. c:function:: int ioctl( int fd, int request, struct media_entity_desc *argp )
+.. cpp:function:: int ioctl( int fd, int request, struct media_entity_desc *argp )
Arguments
=========
diff --git a/Documentation/linux_tv/media/v4l/media-ioc-enum-links.rst b/Documentation/linux_tv/media/v4l/media-ioc-enum-links.rst
index 17aeb6d210f6..f3a4e41b3696 100644
--- a/Documentation/linux_tv/media/v4l/media-ioc-enum-links.rst
+++ b/Documentation/linux_tv/media/v4l/media-ioc-enum-links.rst
@@ -14,7 +14,7 @@ Enumerate all pads and links for a given entity
Synopsis
========
-.. c:function:: int ioctl( int fd, int request, struct media_links_enum *argp )
+.. cpp:function:: int ioctl( int fd, int request, struct media_links_enum *argp )
Arguments
=========
diff --git a/Documentation/linux_tv/media/v4l/media-ioc-g-topology.rst b/Documentation/linux_tv/media/v4l/media-ioc-g-topology.rst
index 65c817312df4..f22310319264 100644
--- a/Documentation/linux_tv/media/v4l/media-ioc-g-topology.rst
+++ b/Documentation/linux_tv/media/v4l/media-ioc-g-topology.rst
@@ -14,7 +14,7 @@ Enumerate the graph topology and graph element properties
Synopsis
========
-.. c:function:: int ioctl( int fd, int request, struct media_v2_topology *argp )
+.. cpp:function:: int ioctl( int fd, int request, struct media_v2_topology *argp )
Arguments
=========
diff --git a/Documentation/linux_tv/media/v4l/media-ioc-setup-link.rst b/Documentation/linux_tv/media/v4l/media-ioc-setup-link.rst
index 969a71c61309..aa6495fe3608 100644
--- a/Documentation/linux_tv/media/v4l/media-ioc-setup-link.rst
+++ b/Documentation/linux_tv/media/v4l/media-ioc-setup-link.rst
@@ -14,7 +14,7 @@ Modify the properties of a link
Synopsis
========
-.. c:function:: int ioctl( int fd, int request, struct media_link_desc *argp )
+.. cpp:function:: int ioctl( int fd, int request, struct media_link_desc *argp )
Arguments
=========
diff --git a/Documentation/linux_tv/media/v4l/vidioc-create-bufs.rst b/Documentation/linux_tv/media/v4l/vidioc-create-bufs.rst
index 53db867aa9db..fc9542e4204c 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-create-bufs.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-create-bufs.rst
@@ -14,7 +14,7 @@ Create buffers for Memory Mapped or User Pointer or DMA Buffer I/O
Synopsis
========
-.. c:function:: int ioctl( int fd, int request, struct v4l2_create_buffers *argp )
+.. cpp:function:: int ioctl( int fd, int request, struct v4l2_create_buffers *argp )
Arguments
=========
diff --git a/Documentation/linux_tv/media/v4l/vidioc-cropcap.rst b/Documentation/linux_tv/media/v4l/vidioc-cropcap.rst
index 25ad9b29b160..22c4268ea54f 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-cropcap.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-cropcap.rst
@@ -14,7 +14,7 @@ Information about the video cropping and scaling abilities
Synopsis
========
-.. c:function:: int ioctl( int fd, int request, struct v4l2_cropcap *argp )
+.. cpp:function:: int ioctl( int fd, int request, struct v4l2_cropcap *argp )
Arguments
=========
diff --git a/Documentation/linux_tv/media/v4l/vidioc-dbg-g-chip-info.rst b/Documentation/linux_tv/media/v4l/vidioc-dbg-g-chip-info.rst
index a1534a326bb3..4baf472b658b 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-dbg-g-chip-info.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-dbg-g-chip-info.rst
@@ -14,7 +14,7 @@ Identify the chips on a TV card
Synopsis
========
-.. c:function:: int ioctl( int fd, int request, struct v4l2_dbg_chip_info *argp )
+.. cpp:function:: int ioctl( int fd, int request, struct v4l2_dbg_chip_info *argp )
Arguments
=========
diff --git a/Documentation/linux_tv/media/v4l/vidioc-dbg-g-register.rst b/Documentation/linux_tv/media/v4l/vidioc-dbg-g-register.rst
index b50c1be72f15..2c5afc9a4012 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-dbg-g-register.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-dbg-g-register.rst
@@ -15,9 +15,9 @@ Read or write hardware registers
Synopsis
========
-.. c:function:: int ioctl( int fd, int request, struct v4l2_dbg_register *argp )
+.. cpp:function:: int ioctl( int fd, int request, struct v4l2_dbg_register *argp )
-.. c:function:: int ioctl( int fd, int request, const struct v4l2_dbg_register *argp )
+.. cpp:function:: int ioctl( int fd, int request, const struct v4l2_dbg_register *argp )
Arguments
=========
diff --git a/Documentation/linux_tv/media/v4l/vidioc-decoder-cmd.rst b/Documentation/linux_tv/media/v4l/vidioc-decoder-cmd.rst
index a56c5fc1ed6f..d3b3c8a2ad08 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-decoder-cmd.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-decoder-cmd.rst
@@ -15,7 +15,7 @@ Execute an decoder command
Synopsis
========
-.. c:function:: int ioctl( int fd, int request, struct v4l2_decoder_cmd *argp )
+.. cpp:function:: int ioctl( int fd, int request, struct v4l2_decoder_cmd *argp )
Arguments
=========
diff --git a/Documentation/linux_tv/media/v4l/vidioc-dqevent.rst b/Documentation/linux_tv/media/v4l/vidioc-dqevent.rst
index 9e41fc818b90..509f0df19746 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-dqevent.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-dqevent.rst
@@ -14,7 +14,7 @@ Dequeue event
Synopsis
========
-.. c:function:: int ioctl( int fd, int request, struct v4l2_event *argp )
+.. cpp:function:: int ioctl( int fd, int request, struct v4l2_event *argp )
Arguments
=========
diff --git a/Documentation/linux_tv/media/v4l/vidioc-dv-timings-cap.rst b/Documentation/linux_tv/media/v4l/vidioc-dv-timings-cap.rst
index b5b8e41dc693..50133087af5b 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-dv-timings-cap.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-dv-timings-cap.rst
@@ -15,7 +15,7 @@ The capabilities of the Digital Video receiver/transmitter
Synopsis
========
-.. c:function:: int ioctl( int fd, int request, struct v4l2_dv_timings_cap *argp )
+.. cpp:function:: int ioctl( int fd, int request, struct v4l2_dv_timings_cap *argp )
Arguments
=========
diff --git a/Documentation/linux_tv/media/v4l/vidioc-encoder-cmd.rst b/Documentation/linux_tv/media/v4l/vidioc-encoder-cmd.rst
index 43c7a3928e7b..7d029498d700 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-encoder-cmd.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-encoder-cmd.rst
@@ -15,7 +15,7 @@ Execute an encoder command
Synopsis
========
-.. c:function:: int ioctl( int fd, int request, struct v4l2_encoder_cmd *argp )
+.. cpp:function:: int ioctl( int fd, int request, struct v4l2_encoder_cmd *argp )
Arguments
=========
diff --git a/Documentation/linux_tv/media/v4l/vidioc-enum-dv-timings.rst b/Documentation/linux_tv/media/v4l/vidioc-enum-dv-timings.rst
index 07462519cbf4..4639d9a9f0a6 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-enum-dv-timings.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-enum-dv-timings.rst
@@ -15,7 +15,7 @@ Enumerate supported Digital Video timings
Synopsis
========
-.. c:function:: int ioctl( int fd, int request, struct v4l2_enum_dv_timings *argp )
+.. cpp:function:: int ioctl( int fd, int request, struct v4l2_enum_dv_timings *argp )
Arguments
=========
diff --git a/Documentation/linux_tv/media/v4l/vidioc-enum-fmt.rst b/Documentation/linux_tv/media/v4l/vidioc-enum-fmt.rst
index c838f3dbb808..a20ed3ae3417 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-enum-fmt.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-enum-fmt.rst
@@ -14,7 +14,7 @@ Enumerate image formats
Synopsis
========
-.. c:function:: int ioctl( int fd, int request, struct v4l2_fmtdesc *argp )
+.. cpp:function:: int ioctl( int fd, int request, struct v4l2_fmtdesc *argp )
Arguments
=========
diff --git a/Documentation/linux_tv/media/v4l/vidioc-enum-frameintervals.rst b/Documentation/linux_tv/media/v4l/vidioc-enum-frameintervals.rst
index a9182898b6dc..24acbd928b9c 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-enum-frameintervals.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-enum-frameintervals.rst
@@ -14,7 +14,7 @@ Enumerate frame intervals
Synopsis
========
-.. c:function:: int ioctl( int fd, int request, struct v4l2_frmivalenum *argp )
+.. cpp:function:: int ioctl( int fd, int request, struct v4l2_frmivalenum *argp )
Arguments
=========
diff --git a/Documentation/linux_tv/media/v4l/vidioc-enum-framesizes.rst b/Documentation/linux_tv/media/v4l/vidioc-enum-framesizes.rst
index 5e171dbc975c..1d2969220857 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-enum-framesizes.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-enum-framesizes.rst
@@ -14,7 +14,7 @@ Enumerate frame sizes
Synopsis
========
-.. c:function:: int ioctl( int fd, int request, struct v4l2_frmsizeenum *argp )
+.. cpp:function:: int ioctl( int fd, int request, struct v4l2_frmsizeenum *argp )
Arguments
=========
diff --git a/Documentation/linux_tv/media/v4l/vidioc-enum-freq-bands.rst b/Documentation/linux_tv/media/v4l/vidioc-enum-freq-bands.rst
index 3999c419589a..bc0826bec1cb 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-enum-freq-bands.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-enum-freq-bands.rst
@@ -14,7 +14,7 @@ Enumerate supported frequency bands
Synopsis
========
-.. c:function:: int ioctl( int fd, int request, struct v4l2_frequency_band *argp )
+.. cpp:function:: int ioctl( int fd, int request, struct v4l2_frequency_band *argp )
Arguments
=========
diff --git a/Documentation/linux_tv/media/v4l/vidioc-enumaudio.rst b/Documentation/linux_tv/media/v4l/vidioc-enumaudio.rst
index 8ae7b8bd9333..32ef1fcb013d 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-enumaudio.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-enumaudio.rst
@@ -14,7 +14,7 @@ Enumerate audio inputs
Synopsis
========
-.. c:function:: int ioctl( int fd, int request, struct v4l2_audio *argp )
+.. cpp:function:: int ioctl( int fd, int request, struct v4l2_audio *argp )
Arguments
=========
diff --git a/Documentation/linux_tv/media/v4l/vidioc-enumaudioout.rst b/Documentation/linux_tv/media/v4l/vidioc-enumaudioout.rst
index 0e45f41fa608..8412f1c0e4cf 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-enumaudioout.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-enumaudioout.rst
@@ -14,7 +14,7 @@ Enumerate audio outputs
Synopsis
========
-.. c:function:: int ioctl( int fd, int request, struct v4l2_audioout *argp )
+.. cpp:function:: int ioctl( int fd, int request, struct v4l2_audioout *argp )
Arguments
=========
diff --git a/Documentation/linux_tv/media/v4l/vidioc-enuminput.rst b/Documentation/linux_tv/media/v4l/vidioc-enuminput.rst
index 131f331462b1..3b0577a307e9 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-enuminput.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-enuminput.rst
@@ -14,7 +14,7 @@ Enumerate video inputs
Synopsis
========
-.. c:function:: int ioctl( int fd, int request, struct v4l2_input *argp )
+.. cpp:function:: int ioctl( int fd, int request, struct v4l2_input *argp )
Arguments
=========
diff --git a/Documentation/linux_tv/media/v4l/vidioc-enumoutput.rst b/Documentation/linux_tv/media/v4l/vidioc-enumoutput.rst
index cb0107b9c03b..1ad68a88e594 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-enumoutput.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-enumoutput.rst
@@ -14,7 +14,7 @@ Enumerate video outputs
Synopsis
========
-.. c:function:: int ioctl( int fd, int request, struct v4l2_output *argp )
+.. cpp:function:: int ioctl( int fd, int request, struct v4l2_output *argp )
Arguments
=========
diff --git a/Documentation/linux_tv/media/v4l/vidioc-enumstd.rst b/Documentation/linux_tv/media/v4l/vidioc-enumstd.rst
index 03353b92449a..6421b37b5ace 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-enumstd.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-enumstd.rst
@@ -14,7 +14,7 @@ Enumerate supported video standards
Synopsis
========
-.. c:function:: int ioctl( int fd, int request, struct v4l2_standard *argp )
+.. cpp:function:: int ioctl( int fd, int request, struct v4l2_standard *argp )
Arguments
=========
diff --git a/Documentation/linux_tv/media/v4l/vidioc-expbuf.rst b/Documentation/linux_tv/media/v4l/vidioc-expbuf.rst
index 2933640e8c4e..04216a0d658e 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-expbuf.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-expbuf.rst
@@ -14,7 +14,7 @@ Export a buffer as a DMABUF file descriptor.
Synopsis
========
-.. c:function:: int ioctl( int fd, int request, struct v4l2_exportbuffer *argp )
+.. cpp:function:: int ioctl( int fd, int request, struct v4l2_exportbuffer *argp )
Arguments
=========
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-audio.rst b/Documentation/linux_tv/media/v4l/vidioc-g-audio.rst
index 4b79523bfbab..66d74f3964f3 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-audio.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-audio.rst
@@ -15,9 +15,9 @@ Query or select the current audio input and its attributes
Synopsis
========
-.. c:function:: int ioctl( int fd, int request, struct v4l2_audio *argp )
+.. cpp:function:: int ioctl( int fd, int request, struct v4l2_audio *argp )
-.. c:function:: int ioctl( int fd, int request, const struct v4l2_audio *argp )
+.. cpp:function:: int ioctl( int fd, int request, const struct v4l2_audio *argp )
Arguments
=========
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-audioout.rst b/Documentation/linux_tv/media/v4l/vidioc-g-audioout.rst
index 1da1e7ad51a6..990f86a20bd2 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-audioout.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-audioout.rst
@@ -15,9 +15,9 @@ Query or select the current audio output
Synopsis
========
-.. c:function:: int ioctl( int fd, int request, struct v4l2_audioout *argp )
+.. cpp:function:: int ioctl( int fd, int request, struct v4l2_audioout *argp )
-.. c:function:: int ioctl( int fd, int request, const struct v4l2_audioout *argp )
+.. cpp:function:: int ioctl( int fd, int request, const struct v4l2_audioout *argp )
Arguments
=========
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-crop.rst b/Documentation/linux_tv/media/v4l/vidioc-g-crop.rst
index b0503710c2dd..e2ffef351edf 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-crop.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-crop.rst
@@ -15,9 +15,9 @@ Get or set the current cropping rectangle
Synopsis
========
-.. c:function:: int ioctl( int fd, int request, struct v4l2_crop *argp )
+.. cpp:function:: int ioctl( int fd, int request, struct v4l2_crop *argp )
-.. c:function:: int ioctl( int fd, int request, const struct v4l2_crop *argp )
+.. cpp:function:: int ioctl( int fd, int request, const struct v4l2_crop *argp )
Arguments
=========
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-ctrl.rst b/Documentation/linux_tv/media/v4l/vidioc-g-ctrl.rst
index 55bb8ae9be10..333eb4fa5099 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-ctrl.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-ctrl.rst
@@ -15,7 +15,7 @@ Get or set the value of a control
Synopsis
========
-.. c:function:: int ioctl( int fd, int request, struct v4l2_control *argp )
+.. cpp:function:: int ioctl( int fd, int request, struct v4l2_control *argp )
Arguments
=========
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-dv-timings.rst b/Documentation/linux_tv/media/v4l/vidioc-g-dv-timings.rst
index 43734bb649c5..c9de292ca1d2 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-dv-timings.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-dv-timings.rst
@@ -17,7 +17,7 @@ Get or set DV timings for input or output
Synopsis
========
-.. c:function:: int ioctl( int fd, int request, struct v4l2_dv_timings *argp )
+.. cpp:function:: int ioctl( int fd, int request, struct v4l2_dv_timings *argp )
Arguments
=========
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-edid.rst b/Documentation/linux_tv/media/v4l/vidioc-g-edid.rst
index d6ccae92e107..54f364bdde8e 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-edid.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-edid.rst
@@ -17,9 +17,9 @@ Get or set the EDID of a video receiver/transmitter
Synopsis
========
-.. c:function:: int ioctl( int fd, int request, struct v4l2_edid *argp )
+.. cpp:function:: int ioctl( int fd, int request, struct v4l2_edid *argp )
-.. c:function:: int ioctl( int fd, int request, struct v4l2_edid *argp )
+.. cpp:function:: int ioctl( int fd, int request, struct v4l2_edid *argp )
Arguments
=========
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-enc-index.rst b/Documentation/linux_tv/media/v4l/vidioc-g-enc-index.rst
index c22907cddfac..35df295e1809 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-enc-index.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-enc-index.rst
@@ -14,7 +14,7 @@ Get meta data about a compressed video stream
Synopsis
========
-.. c:function:: int ioctl( int fd, int request, struct v4l2_enc_idx *argp )
+.. cpp:function:: int ioctl( int fd, int request, struct v4l2_enc_idx *argp )
Arguments
=========
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-ext-ctrls.rst b/Documentation/linux_tv/media/v4l/vidioc-g-ext-ctrls.rst
index 040deef04f7d..91a0b8227423 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-ext-ctrls.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-ext-ctrls.rst
@@ -16,7 +16,7 @@ Get or set the value of several controls, try control values
Synopsis
========
-.. c:function:: int ioctl( int fd, int request, struct v4l2_ext_controls *argp )
+.. cpp:function:: int ioctl( int fd, int request, struct v4l2_ext_controls *argp )
Arguments
=========
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-fbuf.rst b/Documentation/linux_tv/media/v4l/vidioc-g-fbuf.rst
index dbc68cfc608a..abf997fea991 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-fbuf.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-fbuf.rst
@@ -15,9 +15,9 @@ Get or set frame buffer overlay parameters
Synopsis
========
-.. c:function:: int ioctl( int fd, int request, struct v4l2_framebuffer *argp )
+.. cpp:function:: int ioctl( int fd, int request, struct v4l2_framebuffer *argp )
-.. c:function:: int ioctl( int fd, int request, const struct v4l2_framebuffer *argp )
+.. cpp:function:: int ioctl( int fd, int request, const struct v4l2_framebuffer *argp )
Arguments
=========
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-fmt.rst b/Documentation/linux_tv/media/v4l/vidioc-g-fmt.rst
index 3ac4fb764a7e..173e4aca7ee1 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-fmt.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-fmt.rst
@@ -16,7 +16,7 @@ Get or set the data format, try a format
Synopsis
========
-.. c:function:: int ioctl( int fd, int request, struct v4l2_format *argp )
+.. cpp:function:: int ioctl( int fd, int request, struct v4l2_format *argp )
Arguments
=========
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-frequency.rst b/Documentation/linux_tv/media/v4l/vidioc-g-frequency.rst
index b187f1345bb4..40ef31938f79 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-frequency.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-frequency.rst
@@ -15,9 +15,9 @@ Get or set tuner or modulator radio frequency
Synopsis
========
-.. c:function:: int ioctl( int fd, int request, struct v4l2_frequency *argp )
+.. cpp:function:: int ioctl( int fd, int request, struct v4l2_frequency *argp )
-.. c:function:: int ioctl( int fd, int request, const struct v4l2_frequency *argp )
+.. cpp:function:: int ioctl( int fd, int request, const struct v4l2_frequency *argp )
Arguments
=========
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-input.rst b/Documentation/linux_tv/media/v4l/vidioc-g-input.rst
index bb5944449650..6b1fc39c602f 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-input.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-input.rst
@@ -15,7 +15,7 @@ Query or select the current video input
Synopsis
========
-.. c:function:: int ioctl( int fd, int request, int *argp )
+.. cpp:function:: int ioctl( int fd, int request, int *argp )
Arguments
=========
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-jpegcomp.rst b/Documentation/linux_tv/media/v4l/vidioc-g-jpegcomp.rst
index acd05bf0d7b6..b2da34012df6 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-jpegcomp.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-jpegcomp.rst
@@ -13,9 +13,9 @@ VIDIOC_S_JPEGCOMP
Synopsis
========
-.. c:function:: int ioctl( int fd, int request, v4l2_jpegcompression *argp )
+.. cpp:function:: int ioctl( int fd, int request, v4l2_jpegcompression *argp )
-.. c:function:: int ioctl( int fd, int request, const v4l2_jpegcompression *argp )
+.. cpp:function:: int ioctl( int fd, int request, const v4l2_jpegcompression *argp )
Arguments
=========
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-modulator.rst b/Documentation/linux_tv/media/v4l/vidioc-g-modulator.rst
index 913b7d96faba..b41ec0fe6acc 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-modulator.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-modulator.rst
@@ -15,9 +15,9 @@ Get or set modulator attributes
Synopsis
========
-.. c:function:: int ioctl( int fd, int request, struct v4l2_modulator *argp )
+.. cpp:function:: int ioctl( int fd, int request, struct v4l2_modulator *argp )
-.. c:function:: int ioctl( int fd, int request, const struct v4l2_modulator *argp )
+.. cpp:function:: int ioctl( int fd, int request, const struct v4l2_modulator *argp )
Arguments
=========
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-output.rst b/Documentation/linux_tv/media/v4l/vidioc-g-output.rst
index e48bf39cfa10..95d7a9b19166 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-output.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-output.rst
@@ -15,7 +15,7 @@ Query or select the current video output
Synopsis
========
-.. c:function:: int ioctl( int fd, int request, int *argp )
+.. cpp:function:: int ioctl( int fd, int request, int *argp )
Arguments
=========
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-parm.rst b/Documentation/linux_tv/media/v4l/vidioc-g-parm.rst
index 0567fce18144..2fbec8a6adfc 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-parm.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-parm.rst
@@ -15,7 +15,7 @@ Get or set streaming parameters
Synopsis
========
-.. c:function:: int ioctl( int fd, int request, v4l2_streamparm *argp )
+.. cpp:function:: int ioctl( int fd, int request, v4l2_streamparm *argp )
Arguments
=========
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-selection.rst b/Documentation/linux_tv/media/v4l/vidioc-g-selection.rst
index fd07c87a369c..271610e06b2b 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-selection.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-selection.rst
@@ -15,7 +15,7 @@ Get or set one of the selection rectangles
Synopsis
========
-.. c:function:: int ioctl( int fd, int request, struct v4l2_selection *argp )
+.. cpp:function:: int ioctl( int fd, int request, struct v4l2_selection *argp )
Arguments
=========
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-sliced-vbi-cap.rst b/Documentation/linux_tv/media/v4l/vidioc-g-sliced-vbi-cap.rst
index a051f93252d0..00a9b61002de 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-sliced-vbi-cap.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-sliced-vbi-cap.rst
@@ -14,7 +14,7 @@ Query sliced VBI capabilities
Synopsis
========
-.. c:function:: int ioctl( int fd, int request, struct v4l2_sliced_vbi_cap *argp )
+.. cpp:function:: int ioctl( int fd, int request, struct v4l2_sliced_vbi_cap *argp )
Arguments
=========
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-std.rst b/Documentation/linux_tv/media/v4l/vidioc-g-std.rst
index a7257f0b38a2..5644cc670381 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-std.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-std.rst
@@ -15,9 +15,9 @@ Query or select the video standard of the current input
Synopsis
========
-.. c:function:: int ioctl( int fd, int request, v4l2_std_id *argp )
+.. cpp:function:: int ioctl( int fd, int request, v4l2_std_id *argp )
-.. c:function:: int ioctl( int fd, int request, const v4l2_std_id *argp )
+.. cpp:function:: int ioctl( int fd, int request, const v4l2_std_id *argp )
Arguments
=========
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-tuner.rst b/Documentation/linux_tv/media/v4l/vidioc-g-tuner.rst
index 1e01010fd2e2..8e119fa28ccd 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-tuner.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-tuner.rst
@@ -15,9 +15,9 @@ Get or set tuner attributes
Synopsis
========
-.. c:function:: int ioctl( int fd, int request, struct v4l2_tuner *argp )
+.. cpp:function:: int ioctl( int fd, int request, struct v4l2_tuner *argp )
-.. c:function:: int ioctl( int fd, int request, const struct v4l2_tuner *argp )
+.. cpp:function:: int ioctl( int fd, int request, const struct v4l2_tuner *argp )
Arguments
=========
diff --git a/Documentation/linux_tv/media/v4l/vidioc-log-status.rst b/Documentation/linux_tv/media/v4l/vidioc-log-status.rst
index 6df7c2fd5b6c..af89f8f2dca6 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-log-status.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-log-status.rst
@@ -14,7 +14,7 @@ Log driver status information
Synopsis
========
-.. c:function:: int ioctl( int fd, int request )
+.. cpp:function:: int ioctl( int fd, int request )
Description
===========
diff --git a/Documentation/linux_tv/media/v4l/vidioc-overlay.rst b/Documentation/linux_tv/media/v4l/vidioc-overlay.rst
index 10faf2517392..990907643869 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-overlay.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-overlay.rst
@@ -14,7 +14,7 @@ Start or stop video overlay
Synopsis
========
-.. c:function:: int ioctl( int fd, int request, const int *argp )
+.. cpp:function:: int ioctl( int fd, int request, const int *argp )
Arguments
=========
diff --git a/Documentation/linux_tv/media/v4l/vidioc-prepare-buf.rst b/Documentation/linux_tv/media/v4l/vidioc-prepare-buf.rst
index 0b51c587701b..79a6a1009703 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-prepare-buf.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-prepare-buf.rst
@@ -14,7 +14,7 @@ Prepare a buffer for I/O
Synopsis
========
-.. c:function:: int ioctl( int fd, int request, struct v4l2_buffer *argp )
+.. cpp:function:: int ioctl( int fd, int request, struct v4l2_buffer *argp )
Arguments
=========
diff --git a/Documentation/linux_tv/media/v4l/vidioc-qbuf.rst b/Documentation/linux_tv/media/v4l/vidioc-qbuf.rst
index 57a0bc470f36..380970ba9a12 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-qbuf.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-qbuf.rst
@@ -15,7 +15,7 @@ Exchange a buffer with the driver
Synopsis
========
-.. c:function:: int ioctl( int fd, int request, struct v4l2_buffer *argp )
+.. cpp:function:: int ioctl( int fd, int request, struct v4l2_buffer *argp )
Arguments
=========
diff --git a/Documentation/linux_tv/media/v4l/vidioc-query-dv-timings.rst b/Documentation/linux_tv/media/v4l/vidioc-query-dv-timings.rst
index 0120432de989..9f067f587e42 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-query-dv-timings.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-query-dv-timings.rst
@@ -15,7 +15,7 @@ Sense the DV preset received by the current input
Synopsis
========
-.. c:function:: int ioctl( int fd, int request, struct v4l2_dv_timings *argp )
+.. cpp:function:: int ioctl( int fd, int request, struct v4l2_dv_timings *argp )
Arguments
=========
diff --git a/Documentation/linux_tv/media/v4l/vidioc-querybuf.rst b/Documentation/linux_tv/media/v4l/vidioc-querybuf.rst
index 280fb795c0b9..efc8143edc34 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-querybuf.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-querybuf.rst
@@ -14,7 +14,7 @@ Query the status of a buffer
Synopsis
========
-.. c:function:: int ioctl( int fd, int request, struct v4l2_buffer *argp )
+.. cpp:function:: int ioctl( int fd, int request, struct v4l2_buffer *argp )
Arguments
=========
diff --git a/Documentation/linux_tv/media/v4l/vidioc-querycap.rst b/Documentation/linux_tv/media/v4l/vidioc-querycap.rst
index 74589501b95d..91551fe448fc 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-querycap.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-querycap.rst
@@ -14,7 +14,7 @@ Query device capabilities
Synopsis
========
-.. c:function:: int ioctl( int fd, int request, struct v4l2_capability *argp )
+.. cpp:function:: int ioctl( int fd, int request, struct v4l2_capability *argp )
Arguments
=========
diff --git a/Documentation/linux_tv/media/v4l/vidioc-queryctrl.rst b/Documentation/linux_tv/media/v4l/vidioc-queryctrl.rst
index 2e93caeafe9e..a08c68262871 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-queryctrl.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-queryctrl.rst
@@ -16,11 +16,11 @@ Enumerate controls and menu control items
Synopsis
========
-.. c:function:: int ioctl( int fd, int request, struct v4l2_queryctrl *argp )
+.. cpp:function:: int ioctl( int fd, int request, struct v4l2_queryctrl *argp )
-.. c:function:: int ioctl( int fd, int request, struct v4l2_query_ext_ctrl *argp )
+.. cpp:function:: int ioctl( int fd, int request, struct v4l2_query_ext_ctrl *argp )
-.. c:function:: int ioctl( int fd, int request, struct v4l2_querymenu *argp )
+.. cpp:function:: int ioctl( int fd, int request, struct v4l2_querymenu *argp )
Arguments
=========
diff --git a/Documentation/linux_tv/media/v4l/vidioc-querystd.rst b/Documentation/linux_tv/media/v4l/vidioc-querystd.rst
index 29ce879a708b..de2fe176fc6d 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-querystd.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-querystd.rst
@@ -14,7 +14,7 @@ Sense the video standard received by the current input
Synopsis
========
-.. c:function:: int ioctl( int fd, int request, v4l2_std_id *argp )
+.. cpp:function:: int ioctl( int fd, int request, v4l2_std_id *argp )
Arguments
=========
diff --git a/Documentation/linux_tv/media/v4l/vidioc-reqbufs.rst b/Documentation/linux_tv/media/v4l/vidioc-reqbufs.rst
index 451cf7b11c3d..23b2fee646a1 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-reqbufs.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-reqbufs.rst
@@ -14,7 +14,7 @@ Initiate Memory Mapping or User Pointer I/O
Synopsis
========
-.. c:function:: int ioctl( int fd, int request, struct v4l2_requestbuffers *argp )
+.. cpp:function:: int ioctl( int fd, int request, struct v4l2_requestbuffers *argp )
Arguments
=========
diff --git a/Documentation/linux_tv/media/v4l/vidioc-s-hw-freq-seek.rst b/Documentation/linux_tv/media/v4l/vidioc-s-hw-freq-seek.rst
index cd59ba9ab1b0..226440e4bb76 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-s-hw-freq-seek.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-s-hw-freq-seek.rst
@@ -14,7 +14,7 @@ Perform a hardware frequency seek
Synopsis
========
-.. c:function:: int ioctl( int fd, int request, struct v4l2_hw_freq_seek *argp )
+.. cpp:function:: int ioctl( int fd, int request, struct v4l2_hw_freq_seek *argp )
Arguments
=========
diff --git a/Documentation/linux_tv/media/v4l/vidioc-streamon.rst b/Documentation/linux_tv/media/v4l/vidioc-streamon.rst
index 7663339d30be..960c5965c7a6 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-streamon.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-streamon.rst
@@ -15,7 +15,7 @@ Start or stop streaming I/O
Synopsis
========
-.. c:function:: int ioctl( int fd, int request, const int *argp )
+.. cpp:function:: int ioctl( int fd, int request, const int *argp )
Arguments
=========
diff --git a/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-frame-interval.rst b/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-frame-interval.rst
index 07ad0a98ead2..bcf161cd5012 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-frame-interval.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-frame-interval.rst
@@ -14,7 +14,7 @@ Enumerate frame intervals
Synopsis
========
-.. c:function:: int ioctl( int fd, int request, struct v4l2_subdev_frame_interval_enum * argp )
+.. cpp:function:: int ioctl( int fd, int request, struct v4l2_subdev_frame_interval_enum * argp )
Arguments
=========
diff --git a/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-frame-size.rst b/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-frame-size.rst
index 39393ef11590..5ddb766f4a16 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-frame-size.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-frame-size.rst
@@ -14,7 +14,7 @@ Enumerate media bus frame sizes
Synopsis
========
-.. c:function:: int ioctl( int fd, int request, struct v4l2_subdev_frame_size_enum * argp )
+.. cpp:function:: int ioctl( int fd, int request, struct v4l2_subdev_frame_size_enum * argp )
Arguments
=========
diff --git a/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-mbus-code.rst b/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-mbus-code.rst
index f50a1f1c68d5..dbaf866e82fe 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-mbus-code.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-mbus-code.rst
@@ -14,7 +14,7 @@ Enumerate media bus formats
Synopsis
========
-.. c:function:: int ioctl( int fd, int request, struct v4l2_subdev_mbus_code_enum * argp )
+.. cpp:function:: int ioctl( int fd, int request, struct v4l2_subdev_mbus_code_enum * argp )
Arguments
=========
diff --git a/Documentation/linux_tv/media/v4l/vidioc-subdev-g-crop.rst b/Documentation/linux_tv/media/v4l/vidioc-subdev-g-crop.rst
index 6fb1ea143f9e..46776cdfa7b5 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-subdev-g-crop.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-subdev-g-crop.rst
@@ -15,9 +15,9 @@ Get or set the crop rectangle on a subdev pad
Synopsis
========
-.. c:function:: int ioctl( int fd, int request, struct v4l2_subdev_crop *argp )
+.. cpp:function:: int ioctl( int fd, int request, struct v4l2_subdev_crop *argp )
-.. c:function:: int ioctl( int fd, int request, const struct v4l2_subdev_crop *argp )
+.. cpp:function:: int ioctl( int fd, int request, const struct v4l2_subdev_crop *argp )
Arguments
=========
diff --git a/Documentation/linux_tv/media/v4l/vidioc-subdev-g-fmt.rst b/Documentation/linux_tv/media/v4l/vidioc-subdev-g-fmt.rst
index 789277a2647a..b4d109943fd2 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-subdev-g-fmt.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-subdev-g-fmt.rst
@@ -15,7 +15,7 @@ Get or set the data format on a subdev pad
Synopsis
========
-.. c:function:: int ioctl( int fd, int request, struct v4l2_subdev_format *argp )
+.. cpp:function:: int ioctl( int fd, int request, struct v4l2_subdev_format *argp )
Arguments
=========
diff --git a/Documentation/linux_tv/media/v4l/vidioc-subdev-g-frame-interval.rst b/Documentation/linux_tv/media/v4l/vidioc-subdev-g-frame-interval.rst
index bcc54e2e396f..9504e8b5de8a 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-subdev-g-frame-interval.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-subdev-g-frame-interval.rst
@@ -15,7 +15,7 @@ Get or set the frame interval on a subdev pad
Synopsis
========
-.. c:function:: int ioctl( int fd, int request, struct v4l2_subdev_frame_interval *argp )
+.. cpp:function:: int ioctl( int fd, int request, struct v4l2_subdev_frame_interval *argp )
Arguments
=========
diff --git a/Documentation/linux_tv/media/v4l/vidioc-subdev-g-selection.rst b/Documentation/linux_tv/media/v4l/vidioc-subdev-g-selection.rst
index 7b60c9b99aad..d95b5431004c 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-subdev-g-selection.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-subdev-g-selection.rst
@@ -15,7 +15,7 @@ Get or set selection rectangles on a subdev pad
Synopsis
========
-.. c:function:: int ioctl( int fd, int request, struct v4l2_subdev_selection *argp )
+.. cpp:function:: int ioctl( int fd, int request, struct v4l2_subdev_selection *argp )
Arguments
=========
diff --git a/Documentation/linux_tv/media/v4l/vidioc-subscribe-event.rst b/Documentation/linux_tv/media/v4l/vidioc-subscribe-event.rst
index 182353f544eb..a127622d47b8 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-subscribe-event.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-subscribe-event.rst
@@ -15,7 +15,7 @@ Subscribe or unsubscribe event
Synopsis
========
-.. c:function:: int ioctl( int fd, int request, struct v4l2_event_subscription *argp )
+.. cpp:function:: int ioctl( int fd, int request, struct v4l2_event_subscription *argp )
Arguments
=========
diff --git a/scripts/kernel-doc b/scripts/kernel-doc
old mode 100755
new mode 100644
index 932b3f34ff06..41eade332307
--- a/scripts/kernel-doc
+++ b/scripts/kernel-doc
@@ -1833,7 +1833,7 @@ sub output_function_rst(%) {
my $oldprefix = $lineprefix;
my $start;
- print ".. c:function:: ";
+ print ".. cpp:function:: ";
if ($args{'functiontype'} ne "") {
$start = $args{'functiontype'} . " " . $args{'function'} . " (";
} else {
--
2.7.4
^ permalink raw reply related [flat|nested] 52+ messages in thread* [PATCH 23/51] Documentation: planar-apis.rst: fix some conversion troubles
2016-07-04 11:46 [PATCH 00/51] First part of documentation fixups Mauro Carvalho Chehab
` (21 preceding siblings ...)
2016-07-04 11:46 ` [PATCH 22/51] Documentation: linux_tv: supress lots of warnings Mauro Carvalho Chehab
@ 2016-07-04 11:46 ` Mauro Carvalho Chehab
2016-07-04 11:46 ` [PATCH 24/51] Documentation: crop.rst: fix conversion on this file Mauro Carvalho Chehab
` (27 subsequent siblings)
50 siblings, 0 replies; 52+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-04 11:46 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, Jonathan Corbet,
Markus Heiser, linux-doc
There is a missing escape caracter, causing troubles at the
format of one of the paragraphs. Also, the ioctl description
was producing some warnings about wrong identation.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
Documentation/linux_tv/media/v4l/planar-apis.rst | 14 +++++---------
1 file changed, 5 insertions(+), 9 deletions(-)
diff --git a/Documentation/linux_tv/media/v4l/planar-apis.rst b/Documentation/linux_tv/media/v4l/planar-apis.rst
index cf078650a0a8..db1e63bd691e 100644
--- a/Documentation/linux_tv/media/v4l/planar-apis.rst
+++ b/Documentation/linux_tv/media/v4l/planar-apis.rst
@@ -20,7 +20,7 @@ Some of the V4L2 API calls and structures are interpreted differently,
depending on whether single- or multi-planar API is being used. An
application can choose whether to use one or the other by passing a
corresponding buffer type to its ioctl calls. Multi-planar versions of
-buffer types are suffixed with an `_MPLANE' string. For a list of
+buffer types are suffixed with an ``_MPLANE`` string. For a list of
available multi-planar buffer types see enum
:ref:`v4l2_buf_type <v4l2-buf-type>`.
@@ -39,29 +39,25 @@ handle multi-planar formats.
Calls that distinguish between single and multi-planar APIs
===========================================================
-:ref:`VIDIOC_QUERYCAP`
+:ref:`VIDIOC_QUERYCAP <VIDIOC_QUERYCAP>`
Two additional multi-planar capabilities are added. They can be set
together with non-multi-planar ones for devices that handle both
single- and multi-planar formats.
-:ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>`,
-:ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>`,
-:ref:`VIDIOC_TRY_FMT <VIDIOC_G_FMT>`
+:ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>`, :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>`, :ref:`VIDIOC_TRY_FMT <VIDIOC_G_FMT>`
New structures for describing multi-planar formats are added: struct
:ref:`v4l2_pix_format_mplane <v4l2-pix-format-mplane>` and
struct :ref:`v4l2_plane_pix_format <v4l2-plane-pix-format>`.
Drivers may define new multi-planar formats, which have distinct
FourCC codes from the existing single-planar ones.
-:ref:`VIDIOC_QBUF`,
-:ref:`VIDIOC_DQBUF <VIDIOC_QBUF>`,
-:ref:`VIDIOC_QUERYBUF`
+:ref:`VIDIOC_QBUF <VIDIOC_QBUF>`, :ref:`VIDIOC_DQBUF <VIDIOC_QBUF>`, :ref:`VIDIOC_QUERYBUF <VIDIOC_QUERYBUF>`
A new struct :ref:`v4l2_plane <v4l2-plane>` structure for
describing planes is added. Arrays of this structure are passed in
the new ``m.planes`` field of struct
:ref:`v4l2_buffer <v4l2-buffer>`.
-:ref:`VIDIOC_REQBUFS`
+:ref:`VIDIOC_REQBUFS <VIDIOC_REQBUFS>`
Will allocate multi-planar buffers as requested.
--
2.7.4
^ permalink raw reply related [flat|nested] 52+ messages in thread* [PATCH 24/51] Documentation: crop.rst: fix conversion on this file
2016-07-04 11:46 [PATCH 00/51] First part of documentation fixups Mauro Carvalho Chehab
` (22 preceding siblings ...)
2016-07-04 11:46 ` [PATCH 23/51] Documentation: planar-apis.rst: fix some conversion troubles Mauro Carvalho Chehab
@ 2016-07-04 11:46 ` Mauro Carvalho Chehab
2016-07-04 11:46 ` [PATCH 25/51] Documentation: selection-api-005.rst: Fix ReST parsing Mauro Carvalho Chehab
` (26 subsequent siblings)
50 siblings, 0 replies; 52+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-04 11:46 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, Jonathan Corbet,
Markus Heiser, linux-doc
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #1: Type: text/plain; charset=true, Size: 10753 bytes --]
The conversion on this file didn't end too well. fix the found
issues:
1) Sphinix seems to not allow things like *foo :ref:`bar`*. At least
on this document, it did the wrong thing. So, change the logic to
something that will work fine with ReST format;
2) Some ioctl pointers were not looking nice;
3) the captions on the examples got discarded;
4) The notes specific to each example were not converted well.
Again, we'll need to replace it for a simpler design, as Sphinx
is a way more limited than DocBook.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
Documentation/linux_tv/media/v4l/crop.rst | 115 +++++++++++++++---------------
1 file changed, 59 insertions(+), 56 deletions(-)
diff --git a/Documentation/linux_tv/media/v4l/crop.rst b/Documentation/linux_tv/media/v4l/crop.rst
index bfb30568df23..e1214d85b9c7 100644
--- a/Documentation/linux_tv/media/v4l/crop.rst
+++ b/Documentation/linux_tv/media/v4l/crop.rst
@@ -13,11 +13,11 @@ image up or down and insert it at an arbitrary scan line and horizontal
offset into a video signal.
Applications can use the following API to select an area in the video
-signal, query the default area and the hardware limits. *Despite their
-name, the :ref:`VIDIOC_CROPCAP`,
-:ref:`VIDIOC_G_CROP <VIDIOC_G_CROP>` and
-:ref:`VIDIOC_S_CROP <VIDIOC_G_CROP>` ioctls apply to input as well
-as output devices.*
+signal, query the default area and the hardware limits.
+
+**NOTE**: Despite their name, the :ref:`VIDIOC_CROPCAP <VIDIOC_CROPCAP>`,
+:ref:`VIDIOC_G_CROP <VIDIOC_G_CROP>` and :ref:`VIDIOC_S_CROP
+<VIDIOC_G_CROP>` ioctls apply to input as well as output devices.
Scaling requires a source and a target. On a video capture or overlay
device the source is the video signal, and the cropping ioctls determine
@@ -28,15 +28,19 @@ and :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctls.
On a video output device the source are the images passed in by the
application, and their size is again negotiated with the
-``VIDIOC_G/S_FMT`` ioctls, or may be encoded in a compressed video
-stream. The target is the video signal, and the cropping ioctls
-determine the area where the images are inserted.
+:ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>` and :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>`
+ioctls, or may be encoded in a compressed video stream. The target is
+the video signal, and the cropping ioctls determine the area where the
+images are inserted.
Source and target rectangles are defined even if the device does not
-support scaling or the ``VIDIOC_G/S_CROP`` ioctls. Their size (and
-position where applicable) will be fixed in this case. *All capture and
-output device must support the ``VIDIOC_CROPCAP`` ioctl such that
-applications can determine if scaling takes place.*
+support scaling or the :ref:`VIDIOC_G_CROP <VIDIOC_G_CROP>` and
+:ref:`VIDIOC_S_CROP <VIDIOC_G_CROP>` ioctls. Their size (and position
+where applicable) will be fixed in this case.
+
+**NOTE:** All capture and output devices must support the
+:ref:`VIDIOC_CROPCAP <VIDIOC_CROPCAP>` ioctl such that applications can
+determine if scaling takes place.
Cropping Structures
@@ -57,23 +61,24 @@ Cropping Structures
For capture devices the coordinates of the top left corner, width and
height of the area which can be sampled is given by the ``bounds``
-substructure of the struct :ref:`v4l2_cropcap <v4l2-cropcap>`
-returned by the ``VIDIOC_CROPCAP`` ioctl. To support a wide range of
-hardware this specification does not define an origin or units. However
-by convention drivers should horizontally count unscaled samples
+substructure of the struct :ref:`v4l2_cropcap <v4l2-cropcap>` returned
+by the :ref:`VIDIOC_CROPCAP <VIDIOC_CROPCAP>` ioctl. To support a wide
+range of hardware this specification does not define an origin or units.
+However by convention drivers should horizontally count unscaled samples
relative to 0H (the leading edge of the horizontal sync pulse, see
:ref:`vbi-hsync`). Vertically ITU-R line numbers of the first field
-(:ref:`vbi-525`, :ref:`vbi-625`), multiplied by two if the driver
+(see ITU R-525 line numbering for :ref:`525 lines <vbi-525>` and for
+:ref:`625 lines <vbi-625>`), multiplied by two if the driver
can capture both fields.
The top left corner, width and height of the source rectangle, that is
the area actually sampled, is given by struct
:ref:`v4l2_crop <v4l2-crop>` using the same coordinate system as
struct :ref:`v4l2_cropcap <v4l2-cropcap>`. Applications can use the
-``VIDIOC_G_CROP`` and ``VIDIOC_S_CROP`` ioctls to get and set this
-rectangle. It must lie completely within the capture boundaries and the
-driver may further adjust the requested size and/or position according
-to hardware limitations.
+:ref:`VIDIOC_G_CROP <VIDIOC_G_CROP>` and :ref:`VIDIOC_S_CROP <VIDIOC_G_CROP>`
+ioctls to get and set this rectangle. It must lie completely within the
+capture boundaries and the driver may further adjust the requested size
+and/or position according to hardware limitations.
Each capture device has a default source rectangle, given by the
``defrect`` substructure of struct
@@ -121,8 +126,8 @@ The driver sets the image size to the closest possible values 304 × 224,
then chooses the cropping rectangle closest to the requested size, that
is 608 × 224 (224 × 2:1 would exceed the limit 400). The offset 0, 0 is
still valid, thus unmodified. Given the default cropping rectangle
-reported by ``VIDIOC_CROPCAP`` the application can easily propose
-another offset to center the cropping rectangle.
+reported by :ref:`VIDIOC_CROPCAP <VIDIOC_CROPCAP>` the application can
+easily propose another offset to center the cropping rectangle.
Now the application may insist on covering an area using a picture
aspect ratio closer to the original request, so it asks for a cropping
@@ -139,11 +144,11 @@ reopening a device, such that piping data into or out of a device will
work without special preparations. More advanced applications should
ensure the parameters are suitable before starting I/O.
-(A video capture device is assumed; change
-``V4L2_BUF_TYPE_VIDEO_CAPTURE`` for other devices.)
-
+**NOTE:** on the next two examples, a video capture device is assumed;
+change ``V4L2_BUF_TYPE_VIDEO_CAPTURE`` for other types of device.
.. code-block:: c
+ :caption: Example 11: Resetting the cropping parameters
struct v4l2_cropcap cropcap;
struct v4l2_crop crop;
@@ -152,8 +157,8 @@ ensure the parameters are suitable before starting I/O.
cropcap.type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
if (-1 == ioctl (fd, VIDIOC_CROPCAP, &cropcap)) {
- perror ("VIDIOC_CROPCAP");
- exit (EXIT_FAILURE);
+ perror ("VIDIOC_CROPCAP");
+ exit (EXIT_FAILURE);
}
memset (&crop, 0, sizeof (crop));
@@ -163,15 +168,13 @@ ensure the parameters are suitable before starting I/O.
/* Ignore if cropping is not supported (EINVAL). */
if (-1 == ioctl (fd, VIDIOC_S_CROP, &crop)
- && errno != EINVAL) {
- perror ("VIDIOC_S_CROP");
- exit (EXIT_FAILURE);
+ && errno != EINVAL) {
+ perror ("VIDIOC_S_CROP");
+ exit (EXIT_FAILURE);
}
-(A video capture device is assumed.)
-
-
.. code-block:: c
+ :caption: Example 12: Simple downscaling
struct v4l2_cropcap cropcap;
struct v4l2_format format;
@@ -189,15 +192,17 @@ ensure the parameters are suitable before starting I/O.
format.fmt.pix.pixelformat = V4L2_PIX_FMT_YUYV;
if (-1 == ioctl (fd, VIDIOC_S_FMT, &format)) {
- perror ("VIDIOC_S_FORMAT");
- exit (EXIT_FAILURE);
+ perror ("VIDIOC_S_FORMAT");
+ exit (EXIT_FAILURE);
}
/* We could check the actual image size now, the actual scaling factor
or if the driver can scale at all. */
+**NOTE:** This example assumes an output device.
.. code-block:: c
+ :caption: Example 13. Selecting an output area
struct v4l2_cropcap cropcap;
struct v4l2_crop crop;
@@ -206,8 +211,8 @@ ensure the parameters are suitable before starting I/O.
cropcap.type = V4L2_BUF_TYPE_VIDEO_OUTPUT;
if (-1 == ioctl (fd, VIDIOC_CROPCAP;, &cropcap)) {
- perror ("VIDIOC_CROPCAP");
- exit (EXIT_FAILURE);
+ perror ("VIDIOC_CROPCAP");
+ exit (EXIT_FAILURE);
}
memset (&crop, 0, sizeof (crop));
@@ -226,15 +231,15 @@ ensure the parameters are suitable before starting I/O.
/* Ignore if cropping is not supported (EINVAL). */
if (-1 == ioctl (fd, VIDIOC_S_CROP, &crop)
- && errno != EINVAL) {
- perror ("VIDIOC_S_CROP");
- exit (EXIT_FAILURE);
+ && errno != EINVAL) {
+ perror ("VIDIOC_S_CROP");
+ exit (EXIT_FAILURE);
}
-(A video capture device is assumed.)
-
+**NOTE:** This example assumes a video capture device.
.. code-block:: c
+ :caption: Example 14: Current scaling factor and pixel aspect
struct v4l2_cropcap cropcap;
struct v4l2_crop crop;
@@ -247,29 +252,29 @@ ensure the parameters are suitable before starting I/O.
cropcap.type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
if (-1 == ioctl (fd, VIDIOC_CROPCAP, &cropcap)) {
- perror ("VIDIOC_CROPCAP");
- exit (EXIT_FAILURE);
+ perror ("VIDIOC_CROPCAP");
+ exit (EXIT_FAILURE);
}
memset (&crop, 0, sizeof (crop));
crop.type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
if (-1 == ioctl (fd, VIDIOC_G_CROP, &crop)) {
- if (errno != EINVAL) {
- perror ("VIDIOC_G_CROP");
- exit (EXIT_FAILURE);
- }
+ if (errno != EINVAL) {
+ perror ("VIDIOC_G_CROP");
+ exit (EXIT_FAILURE);
+ }
- /* Cropping not supported. */
- crop.c = cropcap.defrect;
+ /* Cropping not supported. */
+ crop.c = cropcap.defrect;
}
memset (&format, 0, sizeof (format));
format.fmt.type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
if (-1 == ioctl (fd, VIDIOC_G_FMT, &format)) {
- perror ("VIDIOC_G_FMT");
- exit (EXIT_FAILURE);
+ perror ("VIDIOC_G_FMT");
+ exit (EXIT_FAILURE);
}
/* The scaling applied by the driver. */
@@ -278,7 +283,7 @@ ensure the parameters are suitable before starting I/O.
vscale = format.fmt.pix.height / (double) crop.c.height;
aspect = cropcap.pixelaspect.numerator /
- (double) cropcap.pixelaspect.denominator;
+ (double) cropcap.pixelaspect.denominator;
aspect = aspect * hscale / vscale;
/* Devices following ITU-R BT.601 do not capture
@@ -289,8 +294,6 @@ ensure the parameters are suitable before starting I/O.
dheight = format.fmt.pix.height;
-
-
.. ------------------------------------------------------------------------------
.. This file was automatically converted from DocBook-XML with the dbxml
.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
--
2.7.4
^ permalink raw reply related [flat|nested] 52+ messages in thread* [PATCH 25/51] Documentation: selection-api-005.rst: Fix ReST parsing
2016-07-04 11:46 [PATCH 00/51] First part of documentation fixups Mauro Carvalho Chehab
` (23 preceding siblings ...)
2016-07-04 11:46 ` [PATCH 24/51] Documentation: crop.rst: fix conversion on this file Mauro Carvalho Chehab
@ 2016-07-04 11:46 ` Mauro Carvalho Chehab
2016-07-04 11:46 ` [PATCH 26/51] Documentation: linux_tv: use Example x.y. instead of a single number Mauro Carvalho Chehab
` (25 subsequent siblings)
50 siblings, 0 replies; 52+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-04 11:46 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, Jonathan Corbet,
Markus Heiser, linux-doc
The ReST markup is limited: it doesn't accept a const just
after a reference. So, change the documentation to avoid such
constraint.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
Documentation/linux_tv/media/v4l/selection-api-005.rst | 9 +++++----
1 file changed, 5 insertions(+), 4 deletions(-)
diff --git a/Documentation/linux_tv/media/v4l/selection-api-005.rst b/Documentation/linux_tv/media/v4l/selection-api-005.rst
index 6fdb0af2b13d..78448023a79a 100644
--- a/Documentation/linux_tv/media/v4l/selection-api-005.rst
+++ b/Documentation/linux_tv/media/v4l/selection-api-005.rst
@@ -15,10 +15,11 @@ appropriate targets. The V4L2 API lacks any support for composing to and
cropping from an image inside a memory buffer. The application could
configure a capture device to fill only a part of an image by abusing
V4L2 API. Cropping a smaller image from a larger one is achieved by
-setting the field struct
-:ref:`v4l2_pix_format <v4l2-pix-format>```::bytesperline``.
-Introducing an image offsets could be done by modifying field struct
-:ref:`v4l2_buffer <v4l2-buffer>```::m_userptr`` before calling
+setting the field ``bytesperline`` at struct
+:ref:`v4l2_pix_format <v4l2-pix-format>`.
+Introducing an image offsets could be done by modifying field ``m_userptr``
+at struct
+:ref:`v4l2_buffer <v4l2-buffer>` before calling
:ref:`VIDIOC_QBUF`. Those operations should be avoided because they are not
portable (endianness), and do not work for macroblock and Bayer formats
and mmap buffers. The selection API deals with configuration of buffer
--
2.7.4
^ permalink raw reply related [flat|nested] 52+ messages in thread* [PATCH 26/51] Documentation: linux_tv: use Example x.y. instead of a single number
2016-07-04 11:46 [PATCH 00/51] First part of documentation fixups Mauro Carvalho Chehab
` (24 preceding siblings ...)
2016-07-04 11:46 ` [PATCH 25/51] Documentation: selection-api-005.rst: Fix ReST parsing Mauro Carvalho Chehab
@ 2016-07-04 11:46 ` Mauro Carvalho Chehab
2016-07-04 11:46 ` [PATCH 27/51] Documentation: selection-api-006.rst: add missing captions Mauro Carvalho Chehab
` (24 subsequent siblings)
50 siblings, 0 replies; 52+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-04 11:46 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, Jonathan Corbet,
Markus Heiser, linux-doc
On the example captions, use always <chapter>.<number>., because:
1) it matches the DocBook;
2) it would mean less changes if we need to add a new example,
as only one chapter will be affected.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
Documentation/linux_tv/media/v4l/audio.rst | 4 ++--
Documentation/linux_tv/media/v4l/control.rst | 6 +++---
Documentation/linux_tv/media/v4l/crop.rst | 8 ++++----
Documentation/linux_tv/media/v4l/standard.rst | 6 +++---
Documentation/linux_tv/media/v4l/video.rst | 4 ++--
5 files changed, 14 insertions(+), 14 deletions(-)
diff --git a/Documentation/linux_tv/media/v4l/audio.rst b/Documentation/linux_tv/media/v4l/audio.rst
index e9d99f6a259a..bc2db0d8f389 100644
--- a/Documentation/linux_tv/media/v4l/audio.rst
+++ b/Documentation/linux_tv/media/v4l/audio.rst
@@ -55,7 +55,7 @@ the :ref:`VIDIOC_QUERYCAP` ioctl.
.. code-block:: c
- :caption: Example 3: Information about the current audio input
+ :caption: Example 1.3. Information about the current audio input
struct v4l2_audio audio;
@@ -70,7 +70,7 @@ the :ref:`VIDIOC_QUERYCAP` ioctl.
.. code-block:: c
- :caption: Example 4: Switching to the first audio input
+ :caption: Example 1.4. Switching to the first audio input
struct v4l2_audio audio;
diff --git a/Documentation/linux_tv/media/v4l/control.rst b/Documentation/linux_tv/media/v4l/control.rst
index 736d79080229..4f64f1db6ec8 100644
--- a/Documentation/linux_tv/media/v4l/control.rst
+++ b/Documentation/linux_tv/media/v4l/control.rst
@@ -374,7 +374,7 @@ more menu type controls.
.. _enum_all_controls:
.. code-block:: c
- :caption: Example 8: Enumerating all user controls
+ :caption: Example 1.8. Enumerating all user controls
struct v4l2_queryctrl queryctrl;
@@ -439,7 +439,7 @@ more menu type controls.
.. code-block:: c
- :caption: Example 9: Enumerating all user controls (alternative)
+ :caption: Example 1.9. Enumerating all user controls (alternative)
memset(&queryctrl, 0, sizeof(queryctrl));
@@ -464,7 +464,7 @@ more menu type controls.
.. code-block:: c
- :caption: Example 10: Changing controls
+ :caption: Example 1.10. Changing controls
struct v4l2_queryctrl queryctrl;
struct v4l2_control control;
diff --git a/Documentation/linux_tv/media/v4l/crop.rst b/Documentation/linux_tv/media/v4l/crop.rst
index e1214d85b9c7..16d0983ff9fb 100644
--- a/Documentation/linux_tv/media/v4l/crop.rst
+++ b/Documentation/linux_tv/media/v4l/crop.rst
@@ -148,7 +148,7 @@ ensure the parameters are suitable before starting I/O.
change ``V4L2_BUF_TYPE_VIDEO_CAPTURE`` for other types of device.
.. code-block:: c
- :caption: Example 11: Resetting the cropping parameters
+ :caption: Example 1.11. Resetting the cropping parameters
struct v4l2_cropcap cropcap;
struct v4l2_crop crop;
@@ -174,7 +174,7 @@ change ``V4L2_BUF_TYPE_VIDEO_CAPTURE`` for other types of device.
}
.. code-block:: c
- :caption: Example 12: Simple downscaling
+ :caption: Example 1.12. Simple downscaling
struct v4l2_cropcap cropcap;
struct v4l2_format format;
@@ -202,7 +202,7 @@ change ``V4L2_BUF_TYPE_VIDEO_CAPTURE`` for other types of device.
**NOTE:** This example assumes an output device.
.. code-block:: c
- :caption: Example 13. Selecting an output area
+ :caption: Example 1.13. Selecting an output area
struct v4l2_cropcap cropcap;
struct v4l2_crop crop;
@@ -239,7 +239,7 @@ change ``V4L2_BUF_TYPE_VIDEO_CAPTURE`` for other types of device.
**NOTE:** This example assumes a video capture device.
.. code-block:: c
- :caption: Example 14: Current scaling factor and pixel aspect
+ :caption: Example 1.14. Current scaling factor and pixel aspect
struct v4l2_cropcap cropcap;
struct v4l2_crop crop;
diff --git a/Documentation/linux_tv/media/v4l/standard.rst b/Documentation/linux_tv/media/v4l/standard.rst
index 11d1a7183c73..4131ca880268 100644
--- a/Documentation/linux_tv/media/v4l/standard.rst
+++ b/Documentation/linux_tv/media/v4l/standard.rst
@@ -66,7 +66,7 @@ standard ioctls can be used with the given input or output.
.. code-block:: c
- :caption: Example 5: Information about the current video standard
+ :caption: Example 1.5. Information about the current video standard
v4l2_std_id std_id;
struct v4l2_standard standard;
@@ -102,7 +102,7 @@ standard ioctls can be used with the given input or output.
.. code-block:: c
- :caption: Example 6: Listing the video standards supported by the current input
+ :caption: Example 1.6. Listing the video standards supported by the current input
struct v4l2_input input;
struct v4l2_standard standard;
@@ -141,7 +141,7 @@ standard ioctls can be used with the given input or output.
.. code-block:: c
- :caption: Example 7: Selecting a new video standard
+ :caption: Example 1.7. Selecting a new video standard
struct v4l2_input input;
v4l2_std_id std_id;
diff --git a/Documentation/linux_tv/media/v4l/video.rst b/Documentation/linux_tv/media/v4l/video.rst
index 8e10ecc27123..b8ecc774719c 100644
--- a/Documentation/linux_tv/media/v4l/video.rst
+++ b/Documentation/linux_tv/media/v4l/video.rst
@@ -29,7 +29,7 @@ implement all the input ioctls when the device has one or more inputs,
all the output ioctls when the device has one or more outputs.
.. code-block:: c
- :caption: Example 1: Information about the current video input
+ :caption: Example 1.1. Information about the current video input
struct v4l2_input input;
int index;
@@ -51,7 +51,7 @@ all the output ioctls when the device has one or more outputs.
.. code-block:: c
- :caption: Example 2: Switching to the first video input
+ :caption: Example 1.2. Switching to the first video input
int index;
--
2.7.4
^ permalink raw reply related [flat|nested] 52+ messages in thread* [PATCH 27/51] Documentation: selection-api-006.rst: add missing captions
2016-07-04 11:46 [PATCH 00/51] First part of documentation fixups Mauro Carvalho Chehab
` (25 preceding siblings ...)
2016-07-04 11:46 ` [PATCH 26/51] Documentation: linux_tv: use Example x.y. instead of a single number Mauro Carvalho Chehab
@ 2016-07-04 11:46 ` Mauro Carvalho Chehab
2016-07-04 11:46 ` [PATCH 28/51] Documentation: linux_tv: Error codes should be const Mauro Carvalho Chehab
` (23 subsequent siblings)
50 siblings, 0 replies; 52+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-04 11:46 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, Jonathan Corbet,
Markus Heiser, linux-doc
The example captions got stripped by the conversion to ReST.
Re-add.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
Documentation/linux_tv/media/v4l/selection-api-006.rst | 3 +++
1 file changed, 3 insertions(+)
diff --git a/Documentation/linux_tv/media/v4l/selection-api-006.rst b/Documentation/linux_tv/media/v4l/selection-api-006.rst
index 61160b6be4f6..a7c04879cb5d 100644
--- a/Documentation/linux_tv/media/v4l/selection-api-006.rst
+++ b/Documentation/linux_tv/media/v4l/selection-api-006.rst
@@ -10,6 +10,7 @@ Examples
.. code-block:: c
+ :caption: Example 1.15. Resetting the cropping parameters
struct v4l2_selection sel = {
.type = V4L2_BUF_TYPE_VIDEO_CAPTURE,
@@ -28,6 +29,7 @@ placed at a center of a display.
.. code-block:: c
+ :caption: Example 1.16. Simple downscaling
struct v4l2_selection sel = {
.type = V4L2_BUF_TYPE_VIDEO_OUTPUT,
@@ -55,6 +57,7 @@ for other devices
.. code-block:: c
+ :caption: Example 1.17. Querying for scaling factors
struct v4l2_selection compose = {
.type = V4L2_BUF_TYPE_VIDEO_OUTPUT,
--
2.7.4
^ permalink raw reply related [flat|nested] 52+ messages in thread* [PATCH 28/51] Documentation: linux_tv: Error codes should be const
2016-07-04 11:46 [PATCH 00/51] First part of documentation fixups Mauro Carvalho Chehab
` (26 preceding siblings ...)
2016-07-04 11:46 ` [PATCH 27/51] Documentation: selection-api-006.rst: add missing captions Mauro Carvalho Chehab
@ 2016-07-04 11:46 ` Mauro Carvalho Chehab
2016-07-04 11:46 ` [PATCH 29/51] Documentation: linux_tv: use references for structures Mauro Carvalho Chehab
` (22 subsequent siblings)
50 siblings, 0 replies; 52+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-04 11:46 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, Jonathan Corbet,
Markus Heiser, linux-doc
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #1: Type: text/plain; charset=true, Size: 89979 bytes --]
All error codes should be const. Most are, but there are
lots of places where we forgot to add <constant> at the DocBook.
Fix those via this small script:
for i in $(git grep -lE "\s+E[A-Z]+\b" Documentation/linux_tv/); do perl -ne 's,([^\`])\b(E[A-Z]+)\b,\1``\2``,g; print $_' <$i >a && mv a $i; done
As there are false positives, we needed to merge only the changes
that make sense, skipping the c blocks and skipping things like
EDID, EN, ETS that were also converted by the above code.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
Documentation/linux_tv/media/dvb/FE_GET_EVENT.rst | 6 ++--
.../linux_tv/media/dvb/FE_GET_FRONTEND.rst | 2 +-
.../linux_tv/media/dvb/FE_SET_FRONTEND.rst | 2 +-
.../linux_tv/media/dvb/audio_function_calls.rst | 22 ++++++------
.../linux_tv/media/dvb/ca_function_calls.rst | 10 +++---
Documentation/linux_tv/media/dvb/dmx_fcalls.rst | 40 ++++++++++-----------
.../linux_tv/media/dvb/frontend_f_open.rst | 2 +-
.../linux_tv/media/dvb/intro_files/dvbstb.png | Bin 22655 -> 22703 bytes
.../linux_tv/media/dvb/video_function_calls.rst | 40 ++++++++++-----------
Documentation/linux_tv/media/v4l/app-pri.rst | 2 +-
Documentation/linux_tv/media/v4l/buffer.rst | 2 +-
Documentation/linux_tv/media/v4l/dev-overlay.rst | 4 +--
Documentation/linux_tv/media/v4l/dev-raw-vbi.rst | 8 ++---
.../linux_tv/media/v4l/dev-sliced-vbi.rst | 10 +++---
Documentation/linux_tv/media/v4l/dev-subdev.rst | 4 +--
Documentation/linux_tv/media/v4l/diff-v4l.rst | 8 ++---
Documentation/linux_tv/media/v4l/dmabuf.rst | 2 +-
.../media/v4l/field-order_files/fieldseq_tb.gif | Bin 25323 -> 25339 bytes
Documentation/linux_tv/media/v4l/func-open.rst | 2 +-
Documentation/linux_tv/media/v4l/func-read.rst | 2 +-
Documentation/linux_tv/media/v4l/gen-errors.rst | 20 +++++------
Documentation/linux_tv/media/v4l/hist-v4l2.rst | 8 ++---
Documentation/linux_tv/media/v4l/lirc_write.rst | 2 +-
.../linux_tv/media/v4l/media-ioc-enum-entities.rst | 2 +-
.../linux_tv/media/v4l/media-ioc-setup-link.rst | 6 ++--
Documentation/linux_tv/media/v4l/mmap.rst | 2 +-
Documentation/linux_tv/media/v4l/open.rst | 2 +-
Documentation/linux_tv/media/v4l/querycap.rst | 2 +-
.../media/v4l/remote_controllers_sysfs_nodes.rst | 4 +--
Documentation/linux_tv/media/v4l/standard.rst | 2 +-
Documentation/linux_tv/media/v4l/streaming-par.rst | 2 +-
Documentation/linux_tv/media/v4l/userp.rst | 2 +-
.../linux_tv/media/v4l/vidioc-create-bufs.rst | 4 +--
.../linux_tv/media/v4l/vidioc-dbg-g-chip-info.rst | 2 +-
.../linux_tv/media/v4l/vidioc-decoder-cmd.rst | 6 ++--
.../linux_tv/media/v4l/vidioc-dv-timings-cap.rst | 2 +-
.../linux_tv/media/v4l/vidioc-encoder-cmd.rst | 6 ++--
.../linux_tv/media/v4l/vidioc-enum-dv-timings.rst | 6 ++--
.../linux_tv/media/v4l/vidioc-enum-fmt.rst | 4 +--
.../linux_tv/media/v4l/vidioc-enumaudio.rst | 4 +--
.../linux_tv/media/v4l/vidioc-enumaudioout.rst | 4 +--
.../linux_tv/media/v4l/vidioc-enuminput.rst | 4 +--
.../linux_tv/media/v4l/vidioc-enumoutput.rst | 2 +-
.../linux_tv/media/v4l/vidioc-enumstd.rst | 4 +--
.../linux_tv/media/v4l/vidioc-g-audio.rst | 2 +-
.../linux_tv/media/v4l/vidioc-g-audioout.rst | 4 +--
Documentation/linux_tv/media/v4l/vidioc-g-crop.rst | 4 +--
Documentation/linux_tv/media/v4l/vidioc-g-ctrl.rst | 4 +--
.../linux_tv/media/v4l/vidioc-g-dv-timings.rst | 4 +--
Documentation/linux_tv/media/v4l/vidioc-g-edid.rst | 12 +++----
.../linux_tv/media/v4l/vidioc-g-ext-ctrls.rst | 10 +++---
Documentation/linux_tv/media/v4l/vidioc-g-fmt.rst | 6 ++--
.../linux_tv/media/v4l/vidioc-g-input.rst | 2 +-
.../linux_tv/media/v4l/vidioc-g-modulator.rst | 6 ++--
.../linux_tv/media/v4l/vidioc-g-output.rst | 2 +-
.../linux_tv/media/v4l/vidioc-g-selection.rst | 2 +-
.../linux_tv/media/v4l/vidioc-g-sliced-vbi-cap.rst | 2 +-
Documentation/linux_tv/media/v4l/vidioc-g-std.rst | 6 ++--
.../linux_tv/media/v4l/vidioc-g-tuner.rst | 4 +--
Documentation/linux_tv/media/v4l/vidioc-qbuf.rst | 2 +-
.../linux_tv/media/v4l/vidioc-query-dv-timings.rst | 4 +--
.../linux_tv/media/v4l/vidioc-querycap.rst | 2 +-
.../linux_tv/media/v4l/vidioc-queryctrl.rst | 32 ++++++++---------
.../linux_tv/media/v4l/vidioc-reqbufs.rst | 2 +-
.../linux_tv/media/v4l/vidioc-s-hw-freq-seek.rst | 2 +-
.../v4l/vidioc-subdev-enum-frame-interval.rst | 2 +-
.../media/v4l/vidioc-subdev-enum-mbus-code.rst | 4 +--
.../linux_tv/media/v4l/vidioc-subdev-g-crop.rst | 2 +-
68 files changed, 196 insertions(+), 196 deletions(-)
diff --git a/Documentation/linux_tv/media/dvb/FE_GET_EVENT.rst b/Documentation/linux_tv/media/dvb/FE_GET_EVENT.rst
index 8d1caedd2f97..1951857cde65 100644
--- a/Documentation/linux_tv/media/dvb/FE_GET_EVENT.rst
+++ b/Documentation/linux_tv/media/dvb/FE_GET_EVENT.rst
@@ -11,7 +11,7 @@ DESCRIPTION
This ioctl call returns a frontend event if available. If an event is
not available, the behavior depends on whether the device is in blocking
or non-blocking mode. In the latter case, the call fails immediately
-with errno set to EWOULDBLOCK. In the former case, the call blocks until
+with errno set to ``EWOULDBLOCK``. In the former case, the call blocks until
an event becomes available.
SYNOPSIS
@@ -67,13 +67,13 @@ appropriately. The generic error codes are described at the
- .. row 1
- - EWOULDBLOCK
+ - ``EWOULDBLOCK``
- There is no event pending, and the device is in non-blocking mode.
- .. row 2
- - EOVERFLOW
+ - ``EOVERFLOW``
- Overflow in event queue - one or more events were lost.
diff --git a/Documentation/linux_tv/media/dvb/FE_GET_FRONTEND.rst b/Documentation/linux_tv/media/dvb/FE_GET_FRONTEND.rst
index 2e60b239d1da..5bf39ff72bd7 100644
--- a/Documentation/linux_tv/media/dvb/FE_GET_FRONTEND.rst
+++ b/Documentation/linux_tv/media/dvb/FE_GET_FRONTEND.rst
@@ -61,7 +61,7 @@ appropriately. The generic error codes are described at the
- .. row 1
- - EINVAL
+ - ``EINVAL``
- Maximum supported symbol rate reached.
diff --git a/Documentation/linux_tv/media/dvb/FE_SET_FRONTEND.rst b/Documentation/linux_tv/media/dvb/FE_SET_FRONTEND.rst
index f18e12cb3dff..4cb393bbc2e1 100644
--- a/Documentation/linux_tv/media/dvb/FE_SET_FRONTEND.rst
+++ b/Documentation/linux_tv/media/dvb/FE_SET_FRONTEND.rst
@@ -68,7 +68,7 @@ appropriately. The generic error codes are described at the
- .. row 1
- - EINVAL
+ - ``EINVAL``
- Maximum supported symbol rate reached.
diff --git a/Documentation/linux_tv/media/dvb/audio_function_calls.rst b/Documentation/linux_tv/media/dvb/audio_function_calls.rst
index a68149e16116..d8abdd0e9417 100644
--- a/Documentation/linux_tv/media/dvb/audio_function_calls.rst
+++ b/Documentation/linux_tv/media/dvb/audio_function_calls.rst
@@ -85,19 +85,19 @@ RETURN VALUE
- .. row 1
- - ENODEV
+ - ``ENODEV``
- Device driver not loaded/available.
- .. row 2
- - EBUSY
+ - ``EBUSY``
- Device or resource busy.
- .. row 3
- - EINVAL
+ - ``EINVAL``
- Invalid argument.
@@ -143,7 +143,7 @@ RETURN VALUE
- .. row 1
- - EBADF
+ - ``EBADF``
- fd is not a valid open file descriptor.
@@ -205,19 +205,19 @@ RETURN VALUE
- .. row 1
- - EPERM
+ - ``EPERM``
- Mode AUDIO_SOURCE_MEMORY not selected.
- .. row 2
- - ENOMEM
+ - ``ENOMEM``
- Attempted to write more data than the internal buffer can hold.
- .. row 3
- - EBADF
+ - ``EBADF``
- fd is not a valid open file descriptor.
@@ -1102,7 +1102,7 @@ appropriately. The generic error codes are described at the
- .. row 1
- - EINVAL
+ - ``EINVAL``
- type is not a valid or supported stream type.
@@ -1165,7 +1165,7 @@ appropriately. The generic error codes are described at the
- .. row 1
- - EINVAL
+ - ``EINVAL``
- id is not a valid id.
@@ -1229,7 +1229,7 @@ appropriately. The generic error codes are described at the
- .. row 1
- - EINVAL
+ - ``EINVAL``
- attr is not a valid or supported attribute setting.
@@ -1292,7 +1292,7 @@ appropriately. The generic error codes are described at the
- .. row 1
- - EINVAL
+ - ``EINVAL``
- karaoke is not a valid or supported karaoke setting.
diff --git a/Documentation/linux_tv/media/dvb/ca_function_calls.rst b/Documentation/linux_tv/media/dvb/ca_function_calls.rst
index 9984b355f48f..83bce0420881 100644
--- a/Documentation/linux_tv/media/dvb/ca_function_calls.rst
+++ b/Documentation/linux_tv/media/dvb/ca_function_calls.rst
@@ -84,25 +84,25 @@ RETURN VALUE
- .. row 1
- - ENODEV
+ - ``ENODEV``
- Device driver not loaded/available.
- .. row 2
- - EINTERNAL
+ - ``EINTERNAL``
- Internal error.
- .. row 3
- - EBUSY
+ - ``EBUSY``
- Device or resource busy.
- .. row 4
- - EINVAL
+ - ``EINVAL``
- Invalid argument.
@@ -148,7 +148,7 @@ RETURN VALUE
- .. row 1
- - EBADF
+ - ``EBADF``
- fd is not a valid open file descriptor.
diff --git a/Documentation/linux_tv/media/dvb/dmx_fcalls.rst b/Documentation/linux_tv/media/dvb/dmx_fcalls.rst
index 5982b57f0a3b..4563c8f2a1b8 100644
--- a/Documentation/linux_tv/media/dvb/dmx_fcalls.rst
+++ b/Documentation/linux_tv/media/dvb/dmx_fcalls.rst
@@ -83,25 +83,25 @@ RETURN VALUE
- .. row 1
- - ENODEV
+ - ``ENODEV``
- Device driver not loaded/available.
- .. row 2
- - EINVAL
+ - ``EINVAL``
- Invalid argument.
- .. row 3
- - EMFILE
+ - ``EMFILE``
- “Too many open files”, i.e. no more filters available.
- .. row 4
- - ENOMEM
+ - ``ENOMEM``
- The driver failed to allocate enough memory.
@@ -148,7 +148,7 @@ RETURN VALUE
- .. row 1
- - EBADF
+ - ``EBADF``
- fd is not a valid open file descriptor.
@@ -209,26 +209,26 @@ RETURN VALUE
- .. row 1
- - EWOULDBLOCK
+ - ``EWOULDBLOCK``
- No data to return and O_NONBLOCK was specified.
- .. row 2
- - EBADF
+ - ``EBADF``
- fd is not a valid open file descriptor.
- .. row 3
- - ECRC
+ - ``ECRC``
- Last section had a CRC error - no data returned. The buffer is
flushed.
- .. row 4
- - EOVERFLOW
+ - ``EOVERFLOW``
-
@@ -240,14 +240,14 @@ RETURN VALUE
- .. row 6
- - ETIMEDOUT
+ - ``ETIMEDOUT``
- The section was not loaded within the stated timeout period. See
ioctl DMX_SET_FILTER for how to set a timeout.
- .. row 7
- - EFAULT
+ - ``EFAULT``
- The driver failed to write to the callers buffer due to an invalid
*buf pointer.
@@ -311,7 +311,7 @@ RETURN VALUE
- .. row 1
- - EWOULDBLOCK
+ - ``EWOULDBLOCK``
- No data was written. This might happen if O_NONBLOCK was
specified and there is no more buffer space available (if
@@ -320,7 +320,7 @@ RETURN VALUE
- .. row 2
- - EBUSY
+ - ``EBUSY``
- This error code indicates that there are conflicting requests. The
corresponding demux device is setup to receive data from the
@@ -329,7 +329,7 @@ RETURN VALUE
- .. row 3
- - EBADF
+ - ``EBADF``
- fd is not a valid open file descriptor.
@@ -386,14 +386,14 @@ appropriately. The generic error codes are described at the
- .. row 1
- - EINVAL
+ - ``EINVAL``
- Invalid argument, i.e. no filtering parameters provided via the
DMX_SET_FILTER or DMX_SET_PES_FILTER functions.
- .. row 2
- - EBUSY
+ - ``EBUSY``
- This error code indicates that there are conflicting requests.
There are active filters filtering data from another input source.
@@ -564,7 +564,7 @@ appropriately. The generic error codes are described at the
- .. row 1
- - EBUSY
+ - ``EBUSY``
- This error code indicates that there are conflicting requests.
There are active filters filtering data from another input source.
@@ -635,7 +635,7 @@ DESCRIPTION
This ioctl call returns an event if available. If an event is not
available, the behavior depends on whether the device is in blocking or
non-blocking mode. In the latter case, the call fails immediately with
-errno set to EWOULDBLOCK. In the former case, the call blocks until an
+errno set to ``EWOULDBLOCK``. In the former case, the call blocks until an
event becomes available.
SYNOPSIS
@@ -686,7 +686,7 @@ appropriately. The generic error codes are described at the
- .. row 1
- - EWOULDBLOCK
+ - ``EWOULDBLOCK``
- There is no event pending, and the device is in non-blocking mode.
@@ -753,7 +753,7 @@ appropriately. The generic error codes are described at the
- .. row 1
- - EINVAL
+ - ``EINVAL``
- Invalid stc number.
diff --git a/Documentation/linux_tv/media/dvb/frontend_f_open.rst b/Documentation/linux_tv/media/dvb/frontend_f_open.rst
index 9ef430abcba4..bdc9a8139444 100644
--- a/Documentation/linux_tv/media/dvb/frontend_f_open.rst
+++ b/Documentation/linux_tv/media/dvb/frontend_f_open.rst
@@ -37,7 +37,7 @@ Arguments
allowed.
When the ``O_NONBLOCK`` flag is given, the system calls may return
- EAGAIN error code when no data is available or when the device
+ ``EAGAIN`` error code when no data is available or when the device
driver is temporarily busy.
Other flags have no effect.
diff --git a/Documentation/linux_tv/media/dvb/intro_files/dvbstb.png b/Documentation/linux_tv/media/dvb/intro_files/dvbstb.png
index 9b8f372e7afd9d016854973ba705dcdfbd1bbf13..5836ea94eba4ec4fd13a83e89ef86b312cc04c02 100644
GIT binary patch
delta 164
zcmeyrfpPst#tjYZ><J03zJUn|o158Ja<c(BVL-N?@L^UCAluE&4aoZ{A<YcpxwyCh
zc_K31j0oOh**boZ5nzQXy2qG6MuY>Ez0rTi#0k+90_5H|`T~{;0<y1~Zea!~3r$Fv
a+-*4t#PkCS%Ue}|jdFDba%Oox<pTgz-8pao
delta 116
zcmZ3#k@5cq#tjYZ%&xwHo7>q}ax=MxZ8j4=%*x{G=H|AUQBs<j#nr{dWwVM*HzS0#
zUAB&&87RBiM)w#KlWX{94uf}0tRO`poBtbq0SX0e{%N{}naMSD@@C6POs;;Ly{#&M
NT3lT>pYnXl2LO%FCVBt>
diff --git a/Documentation/linux_tv/media/dvb/video_function_calls.rst b/Documentation/linux_tv/media/dvb/video_function_calls.rst
index 78917bdf51ed..39eaecd8755a 100644
--- a/Documentation/linux_tv/media/dvb/video_function_calls.rst
+++ b/Documentation/linux_tv/media/dvb/video_function_calls.rst
@@ -87,25 +87,25 @@ RETURN VALUE
- .. row 1
- - ENODEV
+ - ``ENODEV``
- Device driver not loaded/available.
- .. row 2
- - EINTERNAL
+ - ``EINTERNAL``
- Internal error.
- .. row 3
- - EBUSY
+ - ``EBUSY``
- Device or resource busy.
- .. row 4
- - EINVAL
+ - ``EINVAL``
- Invalid argument.
@@ -151,7 +151,7 @@ RETURN VALUE
- .. row 1
- - EBADF
+ - ``EBADF``
- fd is not a valid open file descriptor.
@@ -213,19 +213,19 @@ RETURN VALUE
- .. row 1
- - EPERM
+ - ``EPERM``
- Mode VIDEO_SOURCE_MEMORY not selected.
- .. row 2
- - ENOMEM
+ - ``ENOMEM``
- Attempted to write more data than the internal buffer can hold.
- .. row 3
- - EBADF
+ - ``EBADF``
- fd is not a valid open file descriptor.
@@ -768,7 +768,7 @@ use the V4L2 :ref:`VIDIOC_DQEVENT` ioctl instead.
This ioctl call returns an event of type video_event if available. If
an event is not available, the behavior depends on whether the device is
in blocking or non-blocking mode. In the latter case, the call fails
-immediately with errno set to EWOULDBLOCK. In the former case, the call
+immediately with errno set to ``EWOULDBLOCK``. In the former case, the call
blocks until an event becomes available. The standard Linux poll()
and/or select() system calls can be used with the device file descriptor
to watch for new events. For select(), the file descriptor should be
@@ -823,13 +823,13 @@ appropriately. The generic error codes are described at the
- .. row 1
- - EWOULDBLOCK
+ - ``EWOULDBLOCK``
- There is no event pending, and the device is in non-blocking mode.
- .. row 2
- - EOVERFLOW
+ - ``EOVERFLOW``
- Overflow in event queue - one or more events were lost.
@@ -1154,7 +1154,7 @@ appropriately. The generic error codes are described at the
- .. row 1
- - EPERM
+ - ``EPERM``
- Mode VIDEO_SOURCE_MEMORY not selected.
@@ -1218,7 +1218,7 @@ appropriately. The generic error codes are described at the
- .. row 1
- - EPERM
+ - ``EPERM``
- Mode VIDEO_SOURCE_MEMORY not selected.
@@ -1332,7 +1332,7 @@ appropriately. The generic error codes are described at the
- .. row 1
- - EINVAL
+ - ``EINVAL``
- Invalid sub-stream id.
@@ -1490,7 +1490,7 @@ appropriately. The generic error codes are described at the
- .. row 1
- - EINVAL
+ - ``EINVAL``
- format is not a valid video format.
@@ -1556,7 +1556,7 @@ appropriately. The generic error codes are described at the
- .. row 1
- - EINVAL
+ - ``EINVAL``
- system is not a valid or supported video system.
@@ -1670,7 +1670,7 @@ appropriately. The generic error codes are described at the
- .. row 1
- - EINVAL
+ - ``EINVAL``
- input is not a valid spu setting or driver cannot handle SPU.
@@ -1733,7 +1733,7 @@ appropriately. The generic error codes are described at the
- .. row 1
- - EINVAL
+ - ``EINVAL``
- input is not a valid palette or driver doesn’t handle SPU.
@@ -1798,7 +1798,7 @@ appropriately. The generic error codes are described at the
- .. row 1
- - EFAULT
+ - ``EFAULT``
- driver is not able to return navigational information
@@ -1864,7 +1864,7 @@ appropriately. The generic error codes are described at the
- .. row 1
- - EINVAL
+ - ``EINVAL``
- input is not a valid attribute setting.
diff --git a/Documentation/linux_tv/media/v4l/app-pri.rst b/Documentation/linux_tv/media/v4l/app-pri.rst
index 7ff6f44eb591..8c4624dd50e2 100644
--- a/Documentation/linux_tv/media/v4l/app-pri.rst
+++ b/Documentation/linux_tv/media/v4l/app-pri.rst
@@ -26,7 +26,7 @@ different priority will usually call :ref:`VIDIOC_S_PRIORITY
:ref:`VIDIOC_QUERYCAP` ioctl.
Ioctls changing driver properties, such as
-:ref:`VIDIOC_S_INPUT <VIDIOC_G_INPUT>`, return an EBUSY error code
+:ref:`VIDIOC_S_INPUT <VIDIOC_G_INPUT>`, return an ``EBUSY`` error code
after another application obtained higher priority.
diff --git a/Documentation/linux_tv/media/v4l/buffer.rst b/Documentation/linux_tv/media/v4l/buffer.rst
index 374e9ba6b4bb..b535177724b9 100644
--- a/Documentation/linux_tv/media/v4l/buffer.rst
+++ b/Documentation/linux_tv/media/v4l/buffer.rst
@@ -651,7 +651,7 @@ buffer.
the driver will set the ``bytesused`` field to 0, regardless of
the format. Any Any subsequent call to the
:ref:`VIDIOC_DQBUF <VIDIOC_QBUF>` ioctl will not block anymore,
- but return an EPIPE error code.
+ but return an ``EPIPE`` error code.
- .. row 13
diff --git a/Documentation/linux_tv/media/v4l/dev-overlay.rst b/Documentation/linux_tv/media/v4l/dev-overlay.rst
index 083cf07e55c5..fc71406369a8 100644
--- a/Documentation/linux_tv/media/v4l/dev-overlay.rst
+++ b/Documentation/linux_tv/media/v4l/dev-overlay.rst
@@ -102,7 +102,7 @@ When simultaneous capturing and overlay is supported and the hardware
prohibits different image and frame buffer formats, the format requested
first takes precedence. The attempt to capture
(:ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>`) or overlay
-(:ref:`VIDIOC_S_FBUF <VIDIOC_G_FBUF>`) may fail with an EBUSY error
+(:ref:`VIDIOC_S_FBUF <VIDIOC_G_FBUF>`) may fail with an ``EBUSY`` error
code or return accordingly modified parameters..
@@ -142,7 +142,7 @@ of the cropping rectangle. For more information see :ref:`crop`.
When simultaneous capturing and overlay is supported and the hardware
prohibits different image and window sizes, the size requested first
takes precedence. The attempt to capture or overlay as well
-(:ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>`) may fail with an EBUSY error
+(:ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>`) may fail with an ``EBUSY`` error
code or return accordingly modified parameters.
diff --git a/Documentation/linux_tv/media/v4l/dev-raw-vbi.rst b/Documentation/linux_tv/media/v4l/dev-raw-vbi.rst
index 596b0a6b2177..20942bf9232e 100644
--- a/Documentation/linux_tv/media/v4l/dev-raw-vbi.rst
+++ b/Documentation/linux_tv/media/v4l/dev-raw-vbi.rst
@@ -81,16 +81,16 @@ struct :ref:`v4l2_format <v4l2-format>` as above and initialize all
fields of the struct :ref:`v4l2_vbi_format <v4l2-vbi-format>`
``vbi`` member of the ``fmt`` union, or better just modify the results
of :ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>`, and call the :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>`
-ioctl with a pointer to this structure. Drivers return an EINVAL error
+ioctl with a pointer to this structure. Drivers return an ``EINVAL`` error
code only when the given parameters are ambiguous, otherwise they modify
the parameters according to the hardware capabilities and return the
actual parameters. When the driver allocates resources at this point, it
-may return an EBUSY error code to indicate the returned parameters are
+may return an ``EBUSY`` error code to indicate the returned parameters are
valid but the required resources are currently not available. That may
happen for instance when the video and VBI areas to capture would
overlap, or when the driver supports multiple opens and another process
already requested VBI capturing or output. Anyway, applications must
-expect other resource allocation points which may return EBUSY, at the
+expect other resource allocation points which may return ``EBUSY``, at the
:ref:`VIDIOC_STREAMON` ioctl and the first read(),
write() and select() call.
@@ -341,7 +341,7 @@ using buffer timestamps.
Remember the :ref:`VIDIOC_STREAMON` ioctl and the
first read(), write() and select() call can be resource allocation
-points returning an EBUSY error code if the required hardware resources
+points returning an ``EBUSY`` error code if the required hardware resources
are temporarily unavailable, for example the device is already in use by
another process.
diff --git a/Documentation/linux_tv/media/v4l/dev-sliced-vbi.rst b/Documentation/linux_tv/media/v4l/dev-sliced-vbi.rst
index 3692cdf8e756..b3e89f93d6ad 100644
--- a/Documentation/linux_tv/media/v4l/dev-sliced-vbi.rst
+++ b/Documentation/linux_tv/media/v4l/dev-sliced-vbi.rst
@@ -92,9 +92,9 @@ explicitly.
The :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl modifies the parameters
according to hardware capabilities. When the driver allocates resources
-at this point, it may return an EBUSY error code if the required
+at this point, it may return an ``EBUSY`` error code if the required
resources are temporarily unavailable. Other resource allocation points
-which may return EBUSY can be the
+which may return ``EBUSY`` can be the
:ref:`VIDIOC_STREAMON` ioctl and the first
:ref:`read() <func-read>`, :ref:`write() <func-write>` and
:ref:`select() <func-select>` call.
@@ -336,12 +336,12 @@ which may return EBUSY can be the
- :cspan:`2` Set of services applicable to 625 line systems.
-Drivers may return an EINVAL error code when applications attempt to
+Drivers may return an ``EINVAL`` error code when applications attempt to
read or write data without prior format negotiation, after switching the
video standard (which may invalidate the negotiated VBI parameters) and
after switching the video input (which may change the video standard as
a side effect). The :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl may
-return an EBUSY error code when applications attempt to change the
+return an ``EBUSY`` error code when applications attempt to change the
format while i/o is in progress (between a
:ref:`VIDIOC_STREAMON` and
:ref:`VIDIOC_STREAMOFF <VIDIOC_STREAMON>` call, and after the first
@@ -428,7 +428,7 @@ of one video frame. The ``id`` of unused
Packets are always passed in ascending line number order, without
duplicate line numbers. The :ref:`write() <func-write>` function and
-the :ref:`VIDIOC_QBUF` ioctl must return an EINVAL
+the :ref:`VIDIOC_QBUF` ioctl must return an ``EINVAL``
error code when applications violate this rule. They must also return an
EINVAL error code when applications pass an incorrect field or line
number, or a combination of ``field``, ``line`` and ``id`` which has not
diff --git a/Documentation/linux_tv/media/v4l/dev-subdev.rst b/Documentation/linux_tv/media/v4l/dev-subdev.rst
index 67732da53be5..87a2cec37645 100644
--- a/Documentation/linux_tv/media/v4l/dev-subdev.rst
+++ b/Documentation/linux_tv/media/v4l/dev-subdev.rst
@@ -125,12 +125,12 @@ negotiate formats on a per-pad basis.
Applications are responsible for configuring coherent parameters on the
whole pipeline and making sure that connected pads have compatible
formats. The pipeline is checked for formats mismatch at
-:ref:`VIDIOC_STREAMON` time, and an EPIPE error
+:ref:`VIDIOC_STREAMON` time, and an ``EPIPE`` error
code is then returned if the configuration is invalid.
Pad-level image format configuration support can be tested by calling
the :ref:`VIDIOC_SUBDEV_G_FMT` ioctl on pad
-0. If the driver returns an EINVAL error code pad-level format
+0. If the driver returns an ``EINVAL`` error code pad-level format
configuration is not supported by the sub-device.
diff --git a/Documentation/linux_tv/media/v4l/diff-v4l.rst b/Documentation/linux_tv/media/v4l/diff-v4l.rst
index ee9623b454a4..da4b391116b5 100644
--- a/Documentation/linux_tv/media/v4l/diff-v4l.rst
+++ b/Documentation/linux_tv/media/v4l/diff-v4l.rst
@@ -78,7 +78,7 @@ V4L prohibits (or used to prohibit) multiple opens of a device file.
V4L2 drivers *may* support multiple opens, see :ref:`open` for details
and consequences.
-V4L drivers respond to V4L2 ioctls with an EINVAL error code.
+V4L drivers respond to V4L2 ioctls with an ``EINVAL`` error code.
Querying Capabilities
@@ -207,7 +207,7 @@ introduction.
- Applications can call the :ref:`VIDIOC_G_CROP <VIDIOC_G_CROP>`
ioctl to determine if the device supports capturing a subsection
of the full picture ("cropping" in V4L2). If not, the ioctl
- returns the EINVAL error code. For more information on cropping
+ returns the ``EINVAL`` error code. For more information on cropping
and scaling see :ref:`crop`.
- .. row 12
@@ -791,7 +791,7 @@ differences.
- The ``VIDIOCMCAPTURE`` ioctl prepares a buffer for capturing. It
also determines the image format for this buffer. The ioctl
- returns immediately, eventually with an EAGAIN error code if no
+ returns immediately, eventually with an ``EAGAIN`` error code if no
video signal had been detected. When the driver supports more than
one buffer applications can call the ioctl multiple times and thus
have multiple outstanding capture requests.
@@ -899,7 +899,7 @@ remaining fields are probably equivalent to struct
Apparently only the Zoran (ZR 36120) driver implements these ioctls. The
semantics differ from those specified for V4L2 in two ways. The
parameters are reset on :ref:`open() <func-open>` and
-``VIDIOCSVBIFMT`` always returns an EINVAL error code if the parameters
+``VIDIOCSVBIFMT`` always returns an ``EINVAL`` error code if the parameters
are invalid.
diff --git a/Documentation/linux_tv/media/v4l/dmabuf.rst b/Documentation/linux_tv/media/v4l/dmabuf.rst
index 773d39308fd6..6f4f0f03e91d 100644
--- a/Documentation/linux_tv/media/v4l/dmabuf.rst
+++ b/Documentation/linux_tv/media/v4l/dmabuf.rst
@@ -129,7 +129,7 @@ Two methods exist to suspend execution of the application until one or
more buffers can be dequeued. By default ``VIDIOC_DQBUF`` blocks when no
buffer is in the outgoing queue. When the ``O_NONBLOCK`` flag was given
to the :ref:`open() <func-open>` function, ``VIDIOC_DQBUF`` returns
-immediately with an EAGAIN error code when no buffer is available. The
+immediately with an ``EAGAIN`` error code when no buffer is available. The
:ref:`select() <func-select>` and :ref:`poll() <func-poll>`
functions are always available.
diff --git a/Documentation/linux_tv/media/v4l/field-order_files/fieldseq_tb.gif b/Documentation/linux_tv/media/v4l/field-order_files/fieldseq_tb.gif
index 718492f1cfc703e6553c3b0e2afc4b269258412b..bf1c3f1b50d5ff04b196659ca5c2629ec9deae03 100644
GIT binary patch
delta 57
zcmaETl=1gb#tlL2YzYajAqfeaL)dQ%f!KjSwxLu47l<7IWKULkZwz9G0og4P>0AJI
C85H6G
delta 41
xcmex;l=1aZ#tlL2Os*lDBiL^XF}VhAwv<ZXVsZ`GJYVI#F_UZ9<|z^BTmVl94*CE9
diff --git a/Documentation/linux_tv/media/v4l/func-open.rst b/Documentation/linux_tv/media/v4l/func-open.rst
index 06937b925be3..dcfce511e273 100644
--- a/Documentation/linux_tv/media/v4l/func-open.rst
+++ b/Documentation/linux_tv/media/v4l/func-open.rst
@@ -33,7 +33,7 @@ Arguments
devices only writing.
When the ``O_NONBLOCK`` flag is given, the read() function and the
- :ref:`VIDIOC_DQBUF <VIDIOC_QBUF>` ioctl will return the EAGAIN
+ :ref:`VIDIOC_DQBUF <VIDIOC_QBUF>` ioctl will return the ``EAGAIN``
error code when no data is available or no buffer is in the driver
outgoing queue, otherwise these functions block until data becomes
available. All V4L2 drivers exchanging data with applications must
diff --git a/Documentation/linux_tv/media/v4l/func-read.rst b/Documentation/linux_tv/media/v4l/func-read.rst
index 94349fa19215..4a4f3e86fd13 100644
--- a/Documentation/linux_tv/media/v4l/func-read.rst
+++ b/Documentation/linux_tv/media/v4l/func-read.rst
@@ -45,7 +45,7 @@ worth of data.
By default :c:func:`read()` blocks until data becomes available. When
the ``O_NONBLOCK`` flag was given to the :ref:`open() <func-open>`
-function it returns immediately with an EAGAIN error code when no data
+function it returns immediately with an ``EAGAIN`` error code when no data
is available. The :ref:`select() <func-select>` or
:ref:`poll() <func-poll>` functions can always be used to suspend
execution until data becomes available. All drivers supporting the
diff --git a/Documentation/linux_tv/media/v4l/gen-errors.rst b/Documentation/linux_tv/media/v4l/gen-errors.rst
index 862cdff45f36..ad119579e9ea 100644
--- a/Documentation/linux_tv/media/v4l/gen-errors.rst
+++ b/Documentation/linux_tv/media/v4l/gen-errors.rst
@@ -16,7 +16,7 @@ Generic Error Codes
- .. row 1
- - EAGAIN (aka EWOULDBLOCK)
+ - ``EAGAIN`` (aka ``EWOULDBLOCK``)
- The ioctl can't be handled because the device is in state where it
can't perform it. This could happen for example in case where
@@ -26,13 +26,13 @@ Generic Error Codes
- .. row 2
- - EBADF
+ - ``EBADF``
- The file descriptor is not a valid.
- .. row 3
- - EBUSY
+ - ``EBUSY``
- The ioctl can't be handled because the device is busy. This is
typically return while device is streaming, and an ioctl tried to
@@ -43,14 +43,14 @@ Generic Error Codes
- .. row 4
- - EFAULT
+ - ``EFAULT``
- There was a failure while copying data from/to userspace, probably
caused by an invalid pointer reference.
- .. row 5
- - EINVAL
+ - ``EINVAL``
- One or more of the ioctl parameters are invalid or out of the
allowed range. This is a widely used error code. See the
@@ -58,19 +58,19 @@ Generic Error Codes
- .. row 6
- - ENODEV
+ - ``ENODEV``
- Device not found or was removed.
- .. row 7
- - ENOMEM
+ - ``ENOMEM``
- There's not enough memory to handle the desired operation.
- .. row 8
- - ENOTTY
+ - ``ENOTTY``
- The ioctl is not supported by the driver, actually meaning that
the required functionality is not available, or the file
@@ -78,7 +78,7 @@ Generic Error Codes
- .. row 9
- - ENOSPC
+ - ``ENOSPC``
- On USB devices, the stream ioctl's can return this error, meaning
that this request would overcommit the usb bandwidth reserved for
@@ -86,7 +86,7 @@ Generic Error Codes
- .. row 10
- - EPERM
+ - ``EPERM``
- Permission denied. Can be returned if the device needs write
permission, or some special capabilities is needed (e. g. root)
diff --git a/Documentation/linux_tv/media/v4l/hist-v4l2.rst b/Documentation/linux_tv/media/v4l/hist-v4l2.rst
index bb115a0f2427..664fbe4780af 100644
--- a/Documentation/linux_tv/media/v4l/hist-v4l2.rst
+++ b/Documentation/linux_tv/media/v4l/hist-v4l2.rst
@@ -280,14 +280,14 @@ A number of changes were made to the raw VBI interface.
transmitted only on the first field. The comment that both ``count``
values will usually be equal is misleading and pointless and has been
removed. This change *breaks compatibility* with earlier versions:
- Drivers may return EINVAL, applications may not function correctly.
+ Drivers may return ``EINVAL``, applications may not function correctly.
3. Drivers are again permitted to return negative (unknown) start values
as proposed earlier. Why this feature was dropped is unclear. This
change may *break compatibility* with applications depending on the
start values being positive. The use of ``EBUSY`` and ``EINVAL``
error codes with the :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl was
- clarified. The EBUSY error code was finally documented, and the
+ clarified. The ``EBUSY`` error code was finally documented, and the
``reserved2`` field which was previously mentioned only in the
``videodev.h`` header file.
@@ -324,7 +324,7 @@ This unnamed version was finally merged into Linux 2.5.46.
3. The struct :ref:`v4l2_capability <v4l2-capability>` changed
dramatically. Note that also the size of the structure changed,
which is encoded in the ioctl request code, thus older V4L2 devices
- will respond with an EINVAL error code to the new
+ will respond with an ``EINVAL`` error code to the new
:ref:`VIDIOC_QUERYCAP` ioctl.
There are new fields to identify the driver, a new RDS device
@@ -855,7 +855,7 @@ V4L2 spec erratum 2004-08-01
4. The documentation of the :ref:`VIDIOC_QBUF` and
:ref:`VIDIOC_DQBUF <VIDIOC_QBUF>` ioctls did not mention the
struct :ref:`v4l2_buffer <v4l2-buffer>` ``memory`` field. It was
- also missing from examples. Also on the ``VIDIOC_DQBUF`` page the EIO
+ also missing from examples. Also on the ``VIDIOC_DQBUF`` page the ``EIO``
error code was not documented.
diff --git a/Documentation/linux_tv/media/v4l/lirc_write.rst b/Documentation/linux_tv/media/v4l/lirc_write.rst
index 167d8b5198d8..234c8f43613e 100644
--- a/Documentation/linux_tv/media/v4l/lirc_write.rst
+++ b/Documentation/linux_tv/media/v4l/lirc_write.rst
@@ -11,7 +11,7 @@ values. Pulses and spaces are only marked implicitly by their position.
The data must start and end with a pulse, therefore, the data must
always include an uneven number of samples. The write function must
block until the data has been transmitted by the hardware. If more data
-is provided than the hardware can send, the driver returns EINVAL.
+is provided than the hardware can send, the driver returns ``EINVAL``.
.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/media-ioc-enum-entities.rst b/Documentation/linux_tv/media/v4l/media-ioc-enum-entities.rst
index 2549857e681e..6d2deba8dea8 100644
--- a/Documentation/linux_tv/media/v4l/media-ioc-enum-entities.rst
+++ b/Documentation/linux_tv/media/v4l/media-ioc-enum-entities.rst
@@ -40,7 +40,7 @@ EINVAL error code when the id is invalid.
Entities can be enumerated by or'ing the id with the
``MEDIA_ENT_ID_FLAG_NEXT`` flag. The driver will return information
about the entity with the smallest id strictly larger than the requested
-one ('next entity'), or the EINVAL error code if there is none.
+one ('next entity'), or the ``EINVAL`` error code if there is none.
Entity IDs can be non-contiguous. Applications must *not* try to
enumerate entities by calling MEDIA_IOC_ENUM_ENTITIES with increasing
diff --git a/Documentation/linux_tv/media/v4l/media-ioc-setup-link.rst b/Documentation/linux_tv/media/v4l/media-ioc-setup-link.rst
index aa6495fe3608..5b9c44e4ee77 100644
--- a/Documentation/linux_tv/media/v4l/media-ioc-setup-link.rst
+++ b/Documentation/linux_tv/media/v4l/media-ioc-setup-link.rst
@@ -43,13 +43,13 @@ not be enabled or disabled.
Link configuration has no side effect on other links. If an enabled link
at the sink pad prevents the link from being enabled, the driver returns
-with an EBUSY error code.
+with an ``EBUSY`` error code.
Only links marked with the ``DYNAMIC`` link flag can be enabled/disabled
while streaming media data. Attempting to enable or disable a streaming
-non-dynamic link will return an EBUSY error code.
+non-dynamic link will return an ``EBUSY`` error code.
-If the specified link can't be found the driver returns with an EINVAL
+If the specified link can't be found the driver returns with an ``EINVAL``
error code.
diff --git a/Documentation/linux_tv/media/v4l/mmap.rst b/Documentation/linux_tv/media/v4l/mmap.rst
index 2013e882f0d4..5f7450ff16c2 100644
--- a/Documentation/linux_tv/media/v4l/mmap.rst
+++ b/Documentation/linux_tv/media/v4l/mmap.rst
@@ -235,7 +235,7 @@ suspend execution of the application until one or more buffers can be
dequeued. By default ``VIDIOC_DQBUF`` blocks when no buffer is in the
outgoing queue. When the ``O_NONBLOCK`` flag was given to the
:ref:`open() <func-open>` function, ``VIDIOC_DQBUF`` returns
-immediately with an EAGAIN error code when no buffer is available. The
+immediately with an ``EAGAIN`` error code when no buffer is available. The
:ref:`select() <func-select>` or :ref:`poll() <func-poll>` functions
are always available.
diff --git a/Documentation/linux_tv/media/v4l/open.rst b/Documentation/linux_tv/media/v4l/open.rst
index ec6b456e37f0..963d2923aaa3 100644
--- a/Documentation/linux_tv/media/v4l/open.rst
+++ b/Documentation/linux_tv/media/v4l/open.rst
@@ -146,7 +146,7 @@ sections.
.. [1]
There are still some old and obscure drivers that have not been
updated to allow for multiple opens. This implies that for such
- drivers :ref:`open() <func-open>` can return an EBUSY error code
+ drivers :ref:`open() <func-open>` can return an ``EBUSY`` error code
when the device is already in use.
.. [2]
diff --git a/Documentation/linux_tv/media/v4l/querycap.rst b/Documentation/linux_tv/media/v4l/querycap.rst
index bb905eb82c08..f3fa6cb6befe 100644
--- a/Documentation/linux_tv/media/v4l/querycap.rst
+++ b/Documentation/linux_tv/media/v4l/querycap.rst
@@ -20,7 +20,7 @@ Starting with kernel version 3.1, :ref:`VIDIOC_QUERYCAP`
will return the V4L2 API version used by the driver, with generally
matches the Kernel version. There's no need of using
:ref:`VIDIOC_QUERYCAP` to check if a specific ioctl
-is supported, the V4L2 core now returns ENOTTY if a driver doesn't
+is supported, the V4L2 core now returns ``ENOTTY`` if a driver doesn't
provide support for an ioctl.
Other features can be queried by calling the respective ioctl, for
diff --git a/Documentation/linux_tv/media/v4l/remote_controllers_sysfs_nodes.rst b/Documentation/linux_tv/media/v4l/remote_controllers_sysfs_nodes.rst
index e2fb81144a4d..03d2d422d4c0 100644
--- a/Documentation/linux_tv/media/v4l/remote_controllers_sysfs_nodes.rst
+++ b/Documentation/linux_tv/media/v4l/remote_controllers_sysfs_nodes.rst
@@ -49,7 +49,7 @@ Writing "proto" will enable only "proto".
Writing "none" will disable all protocols.
-Write fails with EINVAL if an invalid protocol combination or unknown
+Write fails with ``EINVAL`` if an invalid protocol combination or unknown
protocol name is used.
@@ -106,7 +106,7 @@ Writing "proto" will use "proto" for wakeup events.
Writing "none" will disable wakeup.
-Write fails with EINVAL if an invalid protocol combination or unknown
+Write fails with ``EINVAL`` if an invalid protocol combination or unknown
protocol name is used, or if wakeup is not supported by the hardware.
diff --git a/Documentation/linux_tv/media/v4l/standard.rst b/Documentation/linux_tv/media/v4l/standard.rst
index 4131ca880268..67e295daa054 100644
--- a/Documentation/linux_tv/media/v4l/standard.rst
+++ b/Documentation/linux_tv/media/v4l/standard.rst
@@ -58,7 +58,7 @@ Here the driver shall set the ``std`` field of struct
:ref:`v4l2_input <v4l2-input>` and struct
:ref:`v4l2_output <v4l2-output>` to zero and the :ref:`VIDIOC_G_STD <VIDIOC_G_STD>`,
:ref:`VIDIOC_S_STD <VIDIOC_G_STD>`, :ref:`VIDIOC_QUERYSTD` and :ref:`VIDIOC_ENUMSTD` ioctls
-shall return the ENOTTY error code or the EINVAL error code.
+shall return the ``ENOTTY`` error code or the ``EINVAL`` error code.
Applications can make use of the :ref:`input-capabilities` and
:ref:`output-capabilities` flags to determine whether the video
diff --git a/Documentation/linux_tv/media/v4l/streaming-par.rst b/Documentation/linux_tv/media/v4l/streaming-par.rst
index bb8100b6ef87..643bad8cfc1a 100644
--- a/Documentation/linux_tv/media/v4l/streaming-par.rst
+++ b/Documentation/linux_tv/media/v4l/streaming-par.rst
@@ -30,7 +30,7 @@ contains a union holding separate parameters for input and output
devices.
These ioctls are optional, drivers need not implement them. If so, they
-return the EINVAL error code.
+return the ``EINVAL`` error code.
.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/userp.rst b/Documentation/linux_tv/media/v4l/userp.rst
index a5426d10ceb8..23ef4b71444d 100644
--- a/Documentation/linux_tv/media/v4l/userp.rst
+++ b/Documentation/linux_tv/media/v4l/userp.rst
@@ -77,7 +77,7 @@ Two methods exist to suspend execution of the application until one or
more buffers can be dequeued. By default ``VIDIOC_DQBUF`` blocks when no
buffer is in the outgoing queue. When the ``O_NONBLOCK`` flag was given
to the :ref:`open() <func-open>` function, ``VIDIOC_DQBUF`` returns
-immediately with an EAGAIN error code when no buffer is available. The
+immediately with an ``EAGAIN`` error code when no buffer is available. The
:ref:`select() <func-select>` or :ref:`poll() <func-poll>` function
are always available.
diff --git a/Documentation/linux_tv/media/v4l/vidioc-create-bufs.rst b/Documentation/linux_tv/media/v4l/vidioc-create-bufs.rst
index fc9542e4204c..9d872e3b9c22 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-create-bufs.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-create-bufs.rst
@@ -97,8 +97,8 @@ than the number requested.
:ref:`VIDIOC_CREATE_BUFS` will set ``index`` to the current number of
created buffers, and it will check the validity of ``memory`` and
``format.type``. If those are invalid -1 is returned and errno is
- set to EINVAL error code, otherwise :ref:`VIDIOC_CREATE_BUFS` returns
- 0. It will never set errno to EBUSY error code in this particular
+ set to ``EINVAL`` error code, otherwise :ref:`VIDIOC_CREATE_BUFS` returns
+ 0. It will never set errno to ``EBUSY`` error code in this particular
case.
- .. row 3
diff --git a/Documentation/linux_tv/media/v4l/vidioc-dbg-g-chip-info.rst b/Documentation/linux_tv/media/v4l/vidioc-dbg-g-chip-info.rst
index 4baf472b658b..7fc1e6b3e892 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-dbg-g-chip-info.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-dbg-g-chip-info.rst
@@ -56,7 +56,7 @@ and ``flags`` fields.
When ``match.type`` is ``V4L2_CHIP_MATCH_BRIDGE``, ``match.addr``
selects the nth bridge 'chip' on the TV card. You can enumerate all
chips by starting at zero and incrementing ``match.addr`` by one until
-:ref:`VIDIOC_DBG_G_CHIP_INFO` fails with an EINVAL error code. The number
+:ref:`VIDIOC_DBG_G_CHIP_INFO` fails with an ``EINVAL`` error code. The number
zero always selects the bridge chip itself, e. g. the chip connected to
the PCI or USB bus. Non-zero numbers identify specific parts of the
bridge chip such as an AC97 register block.
diff --git a/Documentation/linux_tv/media/v4l/vidioc-decoder-cmd.rst b/Documentation/linux_tv/media/v4l/vidioc-decoder-cmd.rst
index d3b3c8a2ad08..3fd1da8c1132 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-decoder-cmd.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-decoder-cmd.rst
@@ -225,7 +225,7 @@ introduced in Linux 3.3.
indicated by the driver setting the ``bytesused`` field to 0. Once
the ``V4L2_BUF_FLAG_LAST`` flag was set, the
:ref:`VIDIOC_DQBUF <VIDIOC_QBUF>` ioctl will not block anymore,
- but return an EPIPE error code. If
+ but return an ``EPIPE`` error code. If
``V4L2_DEC_CMD_STOP_IMMEDIATELY`` is set, then the decoder stops
immediately (ignoring the ``pts`` value), otherwise it will keep
decoding until timestamp >= pts or until the last of the pending
@@ -238,7 +238,7 @@ introduced in Linux 3.3.
- 2
- Pause the decoder. When the decoder has not been started yet, the
- driver will return an EPERM error code. When the decoder is
+ driver will return an ``EPERM`` error code. When the decoder is
already paused, this command does nothing. This command has one
flag: if ``V4L2_DEC_CMD_PAUSE_TO_BLACK`` is set, then set the
decoder output to black when paused.
@@ -250,7 +250,7 @@ introduced in Linux 3.3.
- 3
- Resume decoding after a PAUSE command. When the decoder has not
- been started yet, the driver will return an EPERM error code. When
+ been started yet, the driver will return an ``EPERM`` error code. When
the decoder is already running, this command does nothing. No
flags are defined for this command.
diff --git a/Documentation/linux_tv/media/v4l/vidioc-dv-timings-cap.rst b/Documentation/linux_tv/media/v4l/vidioc-dv-timings-cap.rst
index 50133087af5b..dbfc5e92faf3 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-dv-timings-cap.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-dv-timings-cap.rst
@@ -46,7 +46,7 @@ receivers) or outputs (for DV transmitters), applications must specify
the desired pad number in the struct
:ref:`v4l2_dv_timings_cap <v4l2-dv-timings-cap>` ``pad`` field and
zero the ``reserved`` array. Attempts to query capabilities on a pad
-that doesn't support them will return an EINVAL error code.
+that doesn't support them will return an ``EINVAL`` error code.
.. _v4l2-bt-timings-cap:
diff --git a/Documentation/linux_tv/media/v4l/vidioc-encoder-cmd.rst b/Documentation/linux_tv/media/v4l/vidioc-encoder-cmd.rst
index 7d029498d700..b62b508c83a7 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-encoder-cmd.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-encoder-cmd.rst
@@ -135,7 +135,7 @@ introduced in Linux 2.6.21.
driver setting the ``bytesused`` field to 0. Once the
``V4L2_BUF_FLAG_LAST`` flag was set, the
:ref:`VIDIOC_DQBUF <VIDIOC_QBUF>` ioctl will not block anymore,
- but return an EPIPE error code.
+ but return an ``EPIPE`` error code.
- .. row 3
@@ -144,7 +144,7 @@ introduced in Linux 2.6.21.
- 2
- Pause the encoder. When the encoder has not been started yet, the
- driver will return an EPERM error code. When the encoder is
+ driver will return an ``EPERM`` error code. When the encoder is
already paused, this command does nothing. No flags are defined
for this command.
@@ -155,7 +155,7 @@ introduced in Linux 2.6.21.
- 3
- Resume encoding after a PAUSE command. When the encoder has not
- been started yet, the driver will return an EPERM error code. When
+ been started yet, the driver will return an ``EPERM`` error code. When
the encoder is already running, this command does nothing. No
flags are defined for this command.
diff --git a/Documentation/linux_tv/media/v4l/vidioc-enum-dv-timings.rst b/Documentation/linux_tv/media/v4l/vidioc-enum-dv-timings.rst
index 4639d9a9f0a6..a3deae4844f5 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-enum-dv-timings.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-enum-dv-timings.rst
@@ -43,10 +43,10 @@ To query the available timings, applications initialize the ``index``
field, set the ``pad`` field to 0, zero the reserved array of struct
:ref:`v4l2_enum_dv_timings <v4l2-enum-dv-timings>` and call the
``VIDIOC_ENUM_DV_TIMINGS`` ioctl on a video node with a pointer to this
-structure. Drivers fill the rest of the structure or return an EINVAL
+structure. Drivers fill the rest of the structure or return an ``EINVAL``
error code when the index is out of bounds. To enumerate all supported
DV timings, applications shall begin at index zero, incrementing by one
-until the driver returns EINVAL. Note that drivers may enumerate a
+until the driver returns ``EINVAL``. Note that drivers may enumerate a
different set of DV timings after switching the video input or output.
When implemented by the driver DV timings of subdevices can be queried
@@ -56,7 +56,7 @@ or outputs (for DV transmitters), applications must specify the desired
pad number in the struct
:ref:`v4l2_enum_dv_timings <v4l2-enum-dv-timings>` ``pad`` field.
Attempts to enumerate timings on a pad that doesn't support them will
-return an EINVAL error code.
+return an ``EINVAL`` error code.
.. _v4l2-enum-dv-timings:
diff --git a/Documentation/linux_tv/media/v4l/vidioc-enum-fmt.rst b/Documentation/linux_tv/media/v4l/vidioc-enum-fmt.rst
index a20ed3ae3417..a8b162ed85a0 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-enum-fmt.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-enum-fmt.rst
@@ -34,9 +34,9 @@ Description
To enumerate image formats applications initialize the ``type`` and
``index`` field of struct :ref:`v4l2_fmtdesc <v4l2-fmtdesc>` and call
the :ref:`VIDIOC_ENUM_FMT` ioctl with a pointer to this structure. Drivers
-fill the rest of the structure or return an EINVAL error code. All
+fill the rest of the structure or return an ``EINVAL`` error code. All
formats are enumerable by beginning at index zero and incrementing by
-one until EINVAL is returned.
+one until ``EINVAL`` is returned.
Note that after switching input or output the list of enumerated image
formats may be different.
diff --git a/Documentation/linux_tv/media/v4l/vidioc-enumaudio.rst b/Documentation/linux_tv/media/v4l/vidioc-enumaudio.rst
index 32ef1fcb013d..51d783734107 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-enumaudio.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-enumaudio.rst
@@ -35,9 +35,9 @@ To query the attributes of an audio input applications initialize the
``index`` field and zero out the ``reserved`` array of a struct
:ref:`v4l2_audio <v4l2-audio>` and call the :ref:`VIDIOC_ENUMAUDIO`
ioctl with a pointer to this structure. Drivers fill the rest of the
-structure or return an EINVAL error code when the index is out of
+structure or return an ``EINVAL`` error code when the index is out of
bounds. To enumerate all audio inputs applications shall begin at index
-zero, incrementing by one until the driver returns EINVAL.
+zero, incrementing by one until the driver returns ``EINVAL``.
See :ref:`VIDIOC_G_AUDIO <VIDIOC_G_AUDIO>` for a description of struct
:ref:`v4l2_audio <v4l2-audio>`.
diff --git a/Documentation/linux_tv/media/v4l/vidioc-enumaudioout.rst b/Documentation/linux_tv/media/v4l/vidioc-enumaudioout.rst
index 8412f1c0e4cf..660bcee62fcf 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-enumaudioout.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-enumaudioout.rst
@@ -35,9 +35,9 @@ To query the attributes of an audio output applications initialize the
``index`` field and zero out the ``reserved`` array of a struct
:ref:`v4l2_audioout <v4l2-audioout>` and call the ``VIDIOC_G_AUDOUT``
ioctl with a pointer to this structure. Drivers fill the rest of the
-structure or return an EINVAL error code when the index is out of
+structure or return an ``EINVAL`` error code when the index is out of
bounds. To enumerate all audio outputs applications shall begin at index
-zero, incrementing by one until the driver returns EINVAL.
+zero, incrementing by one until the driver returns ``EINVAL``.
Note connectors on a TV card to loop back the received audio signal to a
sound card are not audio outputs in this sense.
diff --git a/Documentation/linux_tv/media/v4l/vidioc-enuminput.rst b/Documentation/linux_tv/media/v4l/vidioc-enuminput.rst
index 3b0577a307e9..7344777e3514 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-enuminput.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-enuminput.rst
@@ -34,9 +34,9 @@ Description
To query the attributes of a video input applications initialize the
``index`` field of struct :ref:`v4l2_input <v4l2-input>` and call the
:ref:`VIDIOC_ENUMINPUT` ioctl with a pointer to this structure. Drivers
-fill the rest of the structure or return an EINVAL error code when the
+fill the rest of the structure or return an ``EINVAL`` error code when the
index is out of bounds. To enumerate all inputs applications shall begin
-at index zero, incrementing by one until the driver returns EINVAL.
+at index zero, incrementing by one until the driver returns ``EINVAL``.
.. _v4l2-input:
diff --git a/Documentation/linux_tv/media/v4l/vidioc-enumoutput.rst b/Documentation/linux_tv/media/v4l/vidioc-enumoutput.rst
index 1ad68a88e594..de0952353ad0 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-enumoutput.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-enumoutput.rst
@@ -34,7 +34,7 @@ Description
To query the attributes of a video outputs applications initialize the
``index`` field of struct :ref:`v4l2_output <v4l2-output>` and call
the :ref:`VIDIOC_ENUMOUTPUT` ioctl with a pointer to this structure.
-Drivers fill the rest of the structure or return an EINVAL error code
+Drivers fill the rest of the structure or return an ``EINVAL`` error code
when the index is out of bounds. To enumerate all outputs applications
shall begin at index zero, incrementing by one until the driver returns
EINVAL.
diff --git a/Documentation/linux_tv/media/v4l/vidioc-enumstd.rst b/Documentation/linux_tv/media/v4l/vidioc-enumstd.rst
index 6421b37b5ace..f4866719e099 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-enumstd.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-enumstd.rst
@@ -35,9 +35,9 @@ To query the attributes of a video standard, especially a custom (driver
defined) one, applications initialize the ``index`` field of struct
:ref:`v4l2_standard <v4l2-standard>` and call the :ref:`VIDIOC_ENUMSTD`
ioctl with a pointer to this structure. Drivers fill the rest of the
-structure or return an EINVAL error code when the index is out of
+structure or return an ``EINVAL`` error code when the index is out of
bounds. To enumerate all standards applications shall begin at index
-zero, incrementing by one until the driver returns EINVAL. Drivers may
+zero, incrementing by one until the driver returns ``EINVAL``. Drivers may
enumerate a different set of standards after switching the video input
or output. [1]_
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-audio.rst b/Documentation/linux_tv/media/v4l/vidioc-g-audio.rst
index 66d74f3964f3..8430b49b770a 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-audio.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-audio.rst
@@ -37,7 +37,7 @@ Description
To query the current audio input applications zero out the ``reserved``
array of a struct :ref:`v4l2_audio <v4l2-audio>` and call the
:ref:`VIDIOC_G_AUDIO <VIDIOC_G_AUDIO>` ioctl with a pointer to this structure. Drivers fill
-the rest of the structure or return an EINVAL error code when the device
+the rest of the structure or return an ``EINVAL`` error code when the device
has no audio inputs, or none which combine with the current video input.
Audio inputs have one writable property, the audio mode. To select the
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-audioout.rst b/Documentation/linux_tv/media/v4l/vidioc-g-audioout.rst
index 990f86a20bd2..e2ca42cbe9ae 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-audioout.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-audioout.rst
@@ -37,7 +37,7 @@ Description
To query the current audio output applications zero out the ``reserved``
array of a struct :ref:`v4l2_audioout <v4l2-audioout>` and call the
``VIDIOC_G_AUDOUT`` ioctl with a pointer to this structure. Drivers fill
-the rest of the structure or return an EINVAL error code when the device
+the rest of the structure or return an ``EINVAL`` error code when the device
has no audio inputs, or none which combine with the current video
output.
@@ -46,7 +46,7 @@ current audio output applications can initialize the ``index`` field and
``reserved`` array (which in the future may contain writable properties)
of a :c:type:`struct v4l2_audioout` structure and call the
``VIDIOC_S_AUDOUT`` ioctl. Drivers switch to the requested output or
-return the EINVAL error code when the index is out of bounds. This is a
+return the ``EINVAL`` error code when the index is out of bounds. This is a
write-only ioctl, it does not return the current audio output attributes
as ``VIDIOC_G_AUDOUT`` does.
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-crop.rst b/Documentation/linux_tv/media/v4l/vidioc-g-crop.rst
index e2ffef351edf..888ddb045340 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-crop.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-crop.rst
@@ -38,7 +38,7 @@ To query the cropping rectangle size and position applications set the
``type`` field of a :c:type:`struct v4l2_crop` structure to the
respective buffer (stream) type and call the :ref:`VIDIOC_G_CROP <VIDIOC_G_CROP>` ioctl
with a pointer to this structure. The driver fills the rest of the
-structure or returns the EINVAL error code if cropping is not supported.
+structure or returns the ``EINVAL`` error code if cropping is not supported.
To change the cropping rectangle applications initialize the ``type``
and struct :ref:`v4l2_rect <v4l2-rect>` substructure named ``c`` of a
@@ -72,7 +72,7 @@ image parameters and repeat the cycle until satisfactory parameters have
been negotiated.
When cropping is not supported then no parameters are changed and
-:ref:`VIDIOC_S_CROP <VIDIOC_G_CROP>` returns the EINVAL error code.
+:ref:`VIDIOC_S_CROP <VIDIOC_G_CROP>` returns the ``EINVAL`` error code.
.. _v4l2-crop:
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-ctrl.rst b/Documentation/linux_tv/media/v4l/vidioc-g-ctrl.rst
index 333eb4fa5099..07e27e474326 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-ctrl.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-ctrl.rst
@@ -39,9 +39,9 @@ value of a control applications initialize the ``id`` and ``value``
fields of a struct :c:type:`struct v4l2_control` and call the
:ref:`VIDIOC_S_CTRL <VIDIOC_G_CTRL>` ioctl.
-When the ``id`` is invalid drivers return an EINVAL error code. When the
+When the ``id`` is invalid drivers return an ``EINVAL`` error code. When the
``value`` is out of bounds drivers can choose to take the closest valid
-value or return an ERANGE error code, whatever seems more appropriate.
+value or return an ``ERANGE`` error code, whatever seems more appropriate.
However, :ref:`VIDIOC_S_CTRL <VIDIOC_G_CTRL>` is a write-only ioctl, it does not return the
actual new value. If the ``value`` is inappropriate for the control
(e.g. if it refers to an unsupported menu index of a menu control), then
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-dv-timings.rst b/Documentation/linux_tv/media/v4l/vidioc-g-dv-timings.rst
index c9de292ca1d2..2b2e154a2d1f 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-dv-timings.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-dv-timings.rst
@@ -42,13 +42,13 @@ information is filled in using the structure struct
:ref:`v4l2_dv_timings <v4l2-dv-timings>`. These ioctls take a
pointer to the struct :ref:`v4l2_dv_timings <v4l2-dv-timings>`
structure as argument. If the ioctl is not supported or the timing
-values are not correct, the driver returns EINVAL error code.
+values are not correct, the driver returns ``EINVAL`` error code.
The ``linux/v4l2-dv-timings.h`` header can be used to get the timings of
the formats in the :ref:`cea861` and :ref:`vesadmt` standards. If
the current input or output does not support DV timings (e.g. if
:ref:`VIDIOC_ENUMINPUT` does not set the
-``V4L2_IN_CAP_DV_TIMINGS`` flag), then ENODATA error code is returned.
+``V4L2_IN_CAP_DV_TIMINGS`` flag), then ``ENODATA`` error code is returned.
Return Value
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-edid.rst b/Documentation/linux_tv/media/v4l/vidioc-g-edid.rst
index 54f364bdde8e..b7d56ba0032a 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-edid.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-edid.rst
@@ -48,7 +48,7 @@ returned by :ref:`VIDIOC_ENUMINPUT` and
:ref:`VIDIOC_ENUMOUTPUT` respectively. When used
with subdevice nodes the ``pad`` field represents the input or output
pad of the subdevice. If there is no EDID support for the given ``pad``
-value, then the EINVAL error code will be returned.
+value, then the ``EINVAL`` error code will be returned.
To get the EDID data the application has to fill in the ``pad``,
``start_block``, ``blocks`` and ``edid`` fields, zero the ``reserved``
@@ -59,7 +59,7 @@ array and call :ref:`VIDIOC_G_EDID <VIDIOC_G_EDID>`. The current EDID from block
If there are fewer blocks than specified, then the driver will set
``blocks`` to the actual number of blocks. If there are no EDID blocks
-available at all, then the error code ENODATA is set.
+available at all, then the error code ``ENODATA`` is set.
If blocks have to be retrieved from the sink, then this call will block
until they have been read.
@@ -79,9 +79,9 @@ receivers as it makes no sense for a transmitter.
The driver assumes that the full EDID is passed in. If there are more
EDID blocks than the hardware can handle then the EDID is not written,
-but instead the error code E2BIG is set and ``blocks`` is set to the
+but instead the error code ``E2BIG`` is set and ``blocks`` is set to the
maximum that the hardware supports. If ``start_block`` is any value
-other than 0 then the error code EINVAL is set.
+other than 0 then the error code ``EINVAL`` is set.
To disable an EDID you set ``blocks`` to 0. Depending on the hardware
this will drive the hotplug pin low and/or block the source from reading
@@ -155,10 +155,10 @@ On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.
-ENODATA
+``ENODATA``
The EDID data is not available.
-E2BIG
+``E2BIG``
The EDID data you provided is more than the hardware can handle.
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-ext-ctrls.rst b/Documentation/linux_tv/media/v4l/vidioc-g-ext-ctrls.rst
index 91a0b8227423..d12021c6fbb8 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-ext-ctrls.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-ext-ctrls.rst
@@ -54,7 +54,7 @@ the ``id``, ``size`` and ``reserved2`` fields of each struct
If the ``size`` is too small to receive the control result (only
relevant for pointer-type controls like strings), then the driver will
-set ``size`` to a valid value and return an ENOSPC error code. You
+set ``size`` to a valid value and return an ``ENOSPC`` error code. You
should re-allocate the memory to this new size and try again. For the
string type it is possible that the same issue occurs again if the
string has grown in the meantime. It is recommended to call
@@ -81,13 +81,13 @@ initialize the ``id``, ``size``, ``reserved2`` and
values are automatically adjusted to a valid value or if an error is
returned.
-When the ``id`` or ``which`` is invalid drivers return an EINVAL error
+When the ``id`` or ``which`` is invalid drivers return an ``EINVAL`` error
code. When the value is out of bounds drivers can choose to take the
-closest valid value or return an ERANGE error code, whatever seems more
+closest valid value or return an ``ERANGE`` error code, whatever seems more
appropriate. In the first case the new value is set in struct
:ref:`v4l2_ext_control <v4l2-ext-control>`. If the new control value
is inappropriate (e.g. the given menu index is not supported by the menu
-control), then this will also result in an EINVAL error code error.
+control), then this will also result in an ``EINVAL`` error code error.
The driver will only set/get these controls if all control values are
correct. This prevents the situation where only some of the controls
@@ -124,7 +124,7 @@ still cause this situation.
size of the memory containing the payload, or that will receive
the payload. If :ref:`VIDIOC_G_EXT_CTRLS <VIDIOC_G_EXT_CTRLS>` finds that this value is
less than is required to store the payload result, then it is set
- to a value large enough to store the payload result and ENOSPC is
+ to a value large enough to store the payload result and ``ENOSPC`` is
returned. Note that for string controls this ``size`` field should
not be confused with the length of the string. This field refers
to the size of the memory that contains the string. The actual
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-fmt.rst b/Documentation/linux_tv/media/v4l/vidioc-g-fmt.rst
index 173e4aca7ee1..24fac4536196 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-fmt.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-fmt.rst
@@ -47,7 +47,7 @@ devices that is either the struct
:ref:`v4l2_pix_format <v4l2-pix-format>` ``pix`` or the struct
:ref:`v4l2_pix_format_mplane <v4l2-pix-format-mplane>` ``pix_mp``
member. When the requested buffer type is not supported drivers return
-an EINVAL error code.
+an ``EINVAL`` error code.
To change the current format parameters applications initialize the
``type`` field and all fields of the respective ``fmt`` union member.
@@ -69,11 +69,11 @@ application must implement the :ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>` and :ref:`VIDI
ioctl. When the requested buffer type is not supported drivers return an
EINVAL error code on a :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` attempt. When I/O is already in
progress or the resource is not available for other reasons drivers
-return the EBUSY error code.
+return the ``EBUSY`` error code.
The :ref:`VIDIOC_TRY_FMT <VIDIOC_G_FMT>` ioctl is equivalent to :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` with one
exception: it does not change driver state. It can also be called at any
-time, never returning EBUSY. This function is provided to negotiate
+time, never returning ``EBUSY``. This function is provided to negotiate
parameters, to learn about hardware limitations, without disabling I/O
or possibly time consuming hardware preparations. Although strongly
recommended drivers are not required to implement this ioctl.
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-input.rst b/Documentation/linux_tv/media/v4l/vidioc-g-input.rst
index 6b1fc39c602f..1c14f7dcffeb 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-input.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-input.rst
@@ -36,7 +36,7 @@ To query the current video input applications call the
:ref:`VIDIOC_G_INPUT <VIDIOC_G_INPUT>` ioctl with a pointer to an integer where the driver
stores the number of the input, as in the struct
:ref:`v4l2_input <v4l2-input>` ``index`` field. This ioctl will fail
-only when there are no video inputs, returning EINVAL.
+only when there are no video inputs, returning ``EINVAL``.
To select a video input applications store the number of the desired
input in an integer and call the :ref:`VIDIOC_S_INPUT <VIDIOC_G_INPUT>` ioctl with a pointer
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-modulator.rst b/Documentation/linux_tv/media/v4l/vidioc-g-modulator.rst
index b41ec0fe6acc..2342e036850b 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-modulator.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-modulator.rst
@@ -38,7 +38,7 @@ To query the attributes of a modulator applications initialize the
``index`` field and zero out the ``reserved`` array of a struct
:ref:`v4l2_modulator <v4l2-modulator>` and call the
:ref:`VIDIOC_G_MODULATOR <VIDIOC_G_MODULATOR>` ioctl with a pointer to this structure. Drivers
-fill the rest of the structure or return an EINVAL error code when the
+fill the rest of the structure or return an ``EINVAL`` error code when the
index is out of bounds. To enumerate all modulators applications shall
begin at index zero, incrementing by one until the driver returns
EINVAL.
@@ -199,7 +199,7 @@ To change the radio frequency the
``V4L2_TUNER_SUB_SAP``. If the hardware does not support the
respective audio matrix, or the current video standard does not
permit bilingual audio the :ref:`VIDIOC_S_MODULATOR <VIDIOC_G_MODULATOR>` ioctl shall
- return an EINVAL error code and the driver shall fall back to mono
+ return an ``EINVAL`` error code and the driver shall fall back to mono
or stereo mode.
- .. row 4
@@ -230,7 +230,7 @@ To change the radio frequency the
``V4L2_TUNER_SUB_MONO`` or ``V4L2_TUNER_SUB_STEREO``. If the
hardware does not support the respective audio matrix, or the
current video standard does not permit SAP the
- :ref:`VIDIOC_S_MODULATOR <VIDIOC_G_MODULATOR>` ioctl shall return an EINVAL error code and
+ :ref:`VIDIOC_S_MODULATOR <VIDIOC_G_MODULATOR>` ioctl shall return an ``EINVAL`` error code and
driver shall fall back to mono or stereo mode.
- .. row 6
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-output.rst b/Documentation/linux_tv/media/v4l/vidioc-g-output.rst
index 95d7a9b19166..03defa561e5b 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-output.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-output.rst
@@ -36,7 +36,7 @@ To query the current video output applications call the
:ref:`VIDIOC_G_OUTPUT <VIDIOC_G_OUTPUT>` ioctl with a pointer to an integer where the driver
stores the number of the output, as in the struct
:ref:`v4l2_output <v4l2-output>` ``index`` field. This ioctl will
-fail only when there are no video outputs, returning the EINVAL error
+fail only when there are no video outputs, returning the ``EINVAL`` error
code.
To select a video output applications store the number of the desired
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-selection.rst b/Documentation/linux_tv/media/v4l/vidioc-g-selection.rst
index 271610e06b2b..1159b012a0a1 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-selection.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-selection.rst
@@ -113,7 +113,7 @@ On success the struct :ref:`v4l2_rect <v4l2-rect>` ``r`` field
contains the adjusted rectangle. When the parameters are unsuitable the
application may modify the cropping (composing) or image parameters and
repeat the cycle until satisfactory parameters have been negotiated. If
-constraints flags have to be violated at then ERANGE is returned. The
+constraints flags have to be violated at then ``ERANGE`` is returned. The
error indicates that *there exist no rectangle* that satisfies the
constraints.
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-sliced-vbi-cap.rst b/Documentation/linux_tv/media/v4l/vidioc-g-sliced-vbi-cap.rst
index 00a9b61002de..ac08f606fdd8 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-sliced-vbi-cap.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-sliced-vbi-cap.rst
@@ -35,7 +35,7 @@ To find out which data services are supported by a sliced VBI capture or
output device, applications initialize the ``type`` field of a struct
:ref:`v4l2_sliced_vbi_cap <v4l2-sliced-vbi-cap>`, clear the
``reserved`` array and call the :ref:`VIDIOC_G_SLICED_VBI_CAP <VIDIOC_G_SLICED_VBI_CAP>` ioctl. The
-driver fills in the remaining fields or returns an EINVAL error code if
+driver fills in the remaining fields or returns an ``EINVAL`` error code if
the sliced VBI API is unsupported or ``type`` is invalid.
Note the ``type`` field was added, and the ioctl changed from read-only
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-std.rst b/Documentation/linux_tv/media/v4l/vidioc-g-std.rst
index 5644cc670381..67b4d7da6473 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-std.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-std.rst
@@ -45,11 +45,11 @@ unambiguous such that they appear in only one enumerated
:ref:`VIDIOC_S_STD <VIDIOC_G_STD>` accepts one or more flags, being a write-only ioctl it
does not return the actual new standard as :ref:`VIDIOC_G_STD <VIDIOC_G_STD>` does. When
no flags are given or the current input does not support the requested
-standard the driver returns an EINVAL error code. When the standard set
-is ambiguous drivers may return EINVAL or choose any of the requested
+standard the driver returns an ``EINVAL`` error code. When the standard set
+is ambiguous drivers may return ``EINVAL`` or choose any of the requested
standards. If the current input or output does not support standard
video timings (e.g. if :ref:`VIDIOC_ENUMINPUT`
-does not set the ``V4L2_IN_CAP_STD`` flag), then ENODATA error code is
+does not set the ``V4L2_IN_CAP_STD`` flag), then ``ENODATA`` error code is
returned.
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-tuner.rst b/Documentation/linux_tv/media/v4l/vidioc-g-tuner.rst
index 8e119fa28ccd..078fe6db751e 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-tuner.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-tuner.rst
@@ -38,9 +38,9 @@ To query the attributes of a tuner applications initialize the ``index``
field and zero out the ``reserved`` array of a struct
:ref:`v4l2_tuner <v4l2-tuner>` and call the ``VIDIOC_G_TUNER`` ioctl
with a pointer to this structure. Drivers fill the rest of the structure
-or return an EINVAL error code when the index is out of bounds. To
+or return an ``EINVAL`` error code when the index is out of bounds. To
enumerate all tuners applications shall begin at index zero,
-incrementing by one until the driver returns EINVAL.
+incrementing by one until the driver returns ``EINVAL``.
Tuners have two writable properties, the audio mode and the radio
frequency. To change the audio mode, applications initialize the
diff --git a/Documentation/linux_tv/media/v4l/vidioc-qbuf.rst b/Documentation/linux_tv/media/v4l/vidioc-qbuf.rst
index 380970ba9a12..ab567559a0ac 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-qbuf.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-qbuf.rst
@@ -110,7 +110,7 @@ array must be passed in as well.
By default ``VIDIOC_DQBUF`` blocks when no buffer is in the outgoing
queue. When the ``O_NONBLOCK`` flag was given to the
:ref:`open() <func-open>` function, ``VIDIOC_DQBUF`` returns
-immediately with an EAGAIN error code when no buffer is available.
+immediately with an ``EAGAIN`` error code when no buffer is available.
The :c:type:`struct v4l2_buffer` structure is specified in
:ref:`buffer`.
diff --git a/Documentation/linux_tv/media/v4l/vidioc-query-dv-timings.rst b/Documentation/linux_tv/media/v4l/vidioc-query-dv-timings.rst
index 9f067f587e42..0c01ed49065f 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-query-dv-timings.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-query-dv-timings.rst
@@ -51,11 +51,11 @@ and start streaming again.
If the timings could not be detected because there was no signal, then
ENOLINK is returned. If a signal was detected, but it was unstable and
-the receiver could not lock to the signal, then ENOLCK is returned. If
+the receiver could not lock to the signal, then ``ENOLCK`` is returned. If
the receiver could lock to the signal, but the format is unsupported
(e.g. because the pixelclock is out of range of the hardware
capabilities), then the driver fills in whatever timings it could find
-and returns ERANGE. In that case the application can call
+and returns ``ERANGE``. In that case the application can call
:ref:`VIDIOC_DV_TIMINGS_CAP` to compare the
found timings with the hardware's capabilities in order to give more
precise feedback to the user.
diff --git a/Documentation/linux_tv/media/v4l/vidioc-querycap.rst b/Documentation/linux_tv/media/v4l/vidioc-querycap.rst
index 91551fe448fc..0776232be520 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-querycap.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-querycap.rst
@@ -36,7 +36,7 @@ identify kernel devices compatible with this specification and to obtain
information about driver and hardware capabilities. The ioctl takes a
pointer to a struct :ref:`v4l2_capability <v4l2-capability>` which is
filled by the driver. When the driver is not compatible with this
-specification the ioctl returns an EINVAL error code.
+specification the ioctl returns an ``EINVAL`` error code.
.. _v4l2-capability:
diff --git a/Documentation/linux_tv/media/v4l/vidioc-queryctrl.rst b/Documentation/linux_tv/media/v4l/vidioc-queryctrl.rst
index a08c68262871..2c8ef053a1ab 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-queryctrl.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-queryctrl.rst
@@ -40,30 +40,30 @@ Description
To query the attributes of a control applications set the ``id`` field
of a struct :ref:`v4l2_queryctrl <v4l2-queryctrl>` and call the
``VIDIOC_QUERYCTRL`` ioctl with a pointer to this structure. The driver
-fills the rest of the structure or returns an EINVAL error code when the
+fills the rest of the structure or returns an ``EINVAL`` error code when the
``id`` is invalid.
It is possible to enumerate controls by calling ``VIDIOC_QUERYCTRL``
with successive ``id`` values starting from ``V4L2_CID_BASE`` up to and
-exclusive ``V4L2_CID_LASTP1``. Drivers may return EINVAL if a control in
+exclusive ``V4L2_CID_LASTP1``. Drivers may return ``EINVAL`` if a control in
this range is not supported. Further applications can enumerate private
controls, which are not defined in this specification, by starting at
``V4L2_CID_PRIVATE_BASE`` and incrementing ``id`` until the driver
-returns EINVAL.
+returns ``EINVAL``.
In both cases, when the driver sets the ``V4L2_CTRL_FLAG_DISABLED`` flag
in the ``flags`` field this control is permanently disabled and should
be ignored by the application. [1]_
When the application ORs ``id`` with ``V4L2_CTRL_FLAG_NEXT_CTRL`` the
-driver returns the next supported non-compound control, or EINVAL if
+driver returns the next supported non-compound control, or ``EINVAL`` if
there is none. In addition, the ``V4L2_CTRL_FLAG_NEXT_COMPOUND`` flag
can be specified to enumerate all compound controls (i.e. controls with
type ≥ ``V4L2_CTRL_COMPOUND_TYPES`` and/or array control, in other words
controls that contain more than one value). Specify both
``V4L2_CTRL_FLAG_NEXT_CTRL`` and ``V4L2_CTRL_FLAG_NEXT_COMPOUND`` in
order to enumerate all controls, compound or not. Drivers which do not
-support these flags yet always return EINVAL.
+support these flags yet always return ``EINVAL``.
The ``VIDIOC_QUERY_EXT_CTRL`` ioctl was introduced in order to better
support controls that can use compound types, and to expose additional
@@ -78,12 +78,12 @@ Additional information is required for menu controls: the names of the
menu items. To query them applications set the ``id`` and ``index``
fields of struct :ref:`v4l2_querymenu <v4l2-querymenu>` and call the
``VIDIOC_QUERYMENU`` ioctl with a pointer to this structure. The driver
-fills the rest of the structure or returns an EINVAL error code when the
+fills the rest of the structure or returns an ``EINVAL`` error code when the
``id`` or ``index`` is invalid. Menu items are enumerated by calling
``VIDIOC_QUERYMENU`` with successive ``index`` values from struct
:ref:`v4l2_queryctrl <v4l2-queryctrl>` ``minimum`` to ``maximum``,
inclusive. Note that it is possible for ``VIDIOC_QUERYMENU`` to return
-an EINVAL error code for some indices between ``minimum`` and
+an ``EINVAL`` error code for some indices between ``minimum`` and
``maximum``. In that case that particular menu item is not supported by
this driver. Also note that the ``minimum`` value is not necessarily 0.
@@ -108,7 +108,7 @@ See also the examples in :ref:`control`.
:ref:`control-id` for predefined IDs. When the ID is ORed with
V4L2_CTRL_FLAG_NEXT_CTRL the driver clears the flag and
returns the first control with a higher ID. Drivers which do not
- support this flag yet always return an EINVAL error code.
+ support this flag yet always return an ``EINVAL`` error code.
- .. row 2
@@ -533,7 +533,7 @@ See also the examples in :ref:`control`.
- 0
- A control which performs an action when set. Drivers must ignore
- the value passed with ``VIDIOC_S_CTRL`` and return an EINVAL error
+ the value passed with ``VIDIOC_S_CTRL`` and return an ``EINVAL`` error
code on a ``VIDIOC_G_CTRL`` attempt.
- .. row 8
@@ -588,7 +588,7 @@ See also the examples in :ref:`control`.
control ID equal to a control class code (see :ref:`ctrl-class`)
+ 1, the ioctl returns the name of the control class and this
control type. Older drivers which do not support this feature
- return an EINVAL error code.
+ return an ``EINVAL`` error code.
- .. row 11
@@ -647,7 +647,7 @@ See also the examples in :ref:`control`.
- This control is permanently disabled and should be ignored by the
application. Any attempt to change the control will result in an
- EINVAL error code.
+ ``EINVAL`` error code.
- .. row 2
@@ -658,7 +658,7 @@ See also the examples in :ref:`control`.
- This control is temporarily unchangeable, for example because
another application took over control of the respective resource.
Such controls may be displayed specially in a user interface.
- Attempts to change the control may result in an EBUSY error code.
+ Attempts to change the control may result in an ``EBUSY`` error code.
- .. row 3
@@ -667,7 +667,7 @@ See also the examples in :ref:`control`.
- 0x0004
- This control is permanently readable only. Any attempt to change
- the control will result in an EINVAL error code.
+ the control will result in an ``EINVAL`` error code.
- .. row 4
@@ -706,7 +706,7 @@ See also the examples in :ref:`control`.
- 0x0040
- This control is permanently writable only. Any attempt to read the
- control will result in an EACCES error code error code. This flag
+ control will result in an ``EACCES`` error code error code. This flag
is typically present for relative controls or action controls
where writing a value will cause the device to carry out a given
action (e. g. motor control) but no meaningful value can be
@@ -775,9 +775,9 @@ EACCES
.. [1]
``V4L2_CTRL_FLAG_DISABLED`` was intended for two purposes: Drivers
can skip predefined controls not supported by the hardware (although
- returning EINVAL would do as well), or disable predefined and private
+ returning ``EINVAL`` would do as well), or disable predefined and private
controls after hardware detection without the trouble of reordering
- control arrays and indices (EINVAL cannot be used to skip private
+ control arrays and indices (``EINVAL`` cannot be used to skip private
controls because it would prematurely end the enumeration).
diff --git a/Documentation/linux_tv/media/v4l/vidioc-reqbufs.rst b/Documentation/linux_tv/media/v4l/vidioc-reqbufs.rst
index 23b2fee646a1..411b5bf80313 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-reqbufs.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-reqbufs.rst
@@ -55,7 +55,7 @@ number is also possible when the driver requires more buffers to
function correctly. For example video output requires at least two
buffers, one displayed and one filled by the application.
-When the I/O method is not supported the ioctl returns an EINVAL error
+When the I/O method is not supported the ioctl returns an ``EINVAL`` error
code.
Applications can call :ref:`VIDIOC_REQBUFS` again to change the number of
diff --git a/Documentation/linux_tv/media/v4l/vidioc-s-hw-freq-seek.rst b/Documentation/linux_tv/media/v4l/vidioc-s-hw-freq-seek.rst
index 226440e4bb76..68c96236806d 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-s-hw-freq-seek.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-s-hw-freq-seek.rst
@@ -55,7 +55,7 @@ If an error is returned, then the original frequency will be restored.
This ioctl is supported if the ``V4L2_CAP_HW_FREQ_SEEK`` capability is
set.
-If this ioctl is called from a non-blocking filehandle, then EAGAIN
+If this ioctl is called from a non-blocking filehandle, then ``EAGAIN``
error code is returned and no seek takes place.
diff --git a/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-frame-interval.rst b/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-frame-interval.rst
index bcf161cd5012..8c5298175ba5 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-frame-interval.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-frame-interval.rst
@@ -48,7 +48,7 @@ and call the :ref:`VIDIOC_SUBDEV_ENUM_FRAME_INTERVAL` ioctl with a pointer
to this structure. Drivers fill the rest of the structure or return an
EINVAL error code if one of the input fields is invalid. All frame
intervals are enumerable by beginning at index zero and incrementing by
-one until EINVAL is returned.
+one until ``EINVAL`` is returned.
Available frame intervals may depend on the current 'try' formats at
other pads of the sub-device, as well as on the current active links.
diff --git a/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-mbus-code.rst b/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-mbus-code.rst
index dbaf866e82fe..13d466c2a4e1 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-mbus-code.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-mbus-code.rst
@@ -36,10 +36,10 @@ applications initialize the ``pad``, ``which`` and ``index`` fields of
struct
:ref:`v4l2_subdev_mbus_code_enum <v4l2-subdev-mbus-code-enum>` and
call the :ref:`VIDIOC_SUBDEV_ENUM_MBUS_CODE` ioctl with a pointer to this
-structure. Drivers fill the rest of the structure or return an EINVAL
+structure. Drivers fill the rest of the structure or return an ``EINVAL``
error code if either the ``pad`` or ``index`` are invalid. All media bus
formats are enumerable by beginning at index zero and incrementing by
-one until EINVAL is returned.
+one until ``EINVAL`` is returned.
Available media bus formats may depend on the current 'try' formats at
other pads of the sub-device, as well as on the current active links.
diff --git a/Documentation/linux_tv/media/v4l/vidioc-subdev-g-crop.rst b/Documentation/linux_tv/media/v4l/vidioc-subdev-g-crop.rst
index 46776cdfa7b5..88416ba28d86 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-subdev-g-crop.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-subdev-g-crop.rst
@@ -45,7 +45,7 @@ field of a struct :ref:`v4l2_subdev_crop <v4l2-subdev-crop>` to the
desired pad number as reported by the media API and the ``which`` field
to ``V4L2_SUBDEV_FORMAT_ACTIVE``. They then call the
``VIDIOC_SUBDEV_G_CROP`` ioctl with a pointer to this structure. The
-driver fills the members of the ``rect`` field or returns EINVAL error
+driver fills the members of the ``rect`` field or returns ``EINVAL`` error
code if the input arguments are invalid, or if cropping is not supported
on the given pad.
--
2.7.4
^ permalink raw reply related [flat|nested] 52+ messages in thread* [PATCH 29/51] Documentation: linux_tv: use references for structures
2016-07-04 11:46 [PATCH 00/51] First part of documentation fixups Mauro Carvalho Chehab
` (27 preceding siblings ...)
2016-07-04 11:46 ` [PATCH 28/51] Documentation: linux_tv: Error codes should be const Mauro Carvalho Chehab
@ 2016-07-04 11:46 ` Mauro Carvalho Chehab
2016-07-04 11:46 ` [PATCH 30/51] Documentation: linux_tv: Fix remaining undefined references Mauro Carvalho Chehab
` (21 subsequent siblings)
50 siblings, 0 replies; 52+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-04 11:46 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, Jonathan Corbet,
Markus Heiser, linux-doc
On several places, instead of using references, the code was
using some other tag. Not sure if this was due to the conversion,
or if something were already wrong on the DocBook. In any case,
let's fix them.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
Documentation/linux_tv/media/v4l/buffer.rst | 12 ++++++------
Documentation/linux_tv/media/v4l/dev-osd.rst | 2 +-
Documentation/linux_tv/media/v4l/dev-overlay.rst | 2 +-
Documentation/linux_tv/media/v4l/dev-sliced-vbi.rst | 6 +++---
Documentation/linux_tv/media/v4l/extended-controls.rst | 2 +-
Documentation/linux_tv/media/v4l/func-poll.rst | 2 +-
Documentation/linux_tv/media/v4l/func-select.rst | 2 +-
Documentation/linux_tv/media/v4l/pixfmt-002.rst | 4 ++--
Documentation/linux_tv/media/v4l/pixfmt-003.rst | 6 +++---
Documentation/linux_tv/media/v4l/pixfmt.rst | 4 ++--
Documentation/linux_tv/media/v4l/vidioc-create-bufs.rst | 2 +-
Documentation/linux_tv/media/v4l/vidioc-enumstd.rst | 2 +-
Documentation/linux_tv/media/v4l/vidioc-g-audio.rst | 2 +-
Documentation/linux_tv/media/v4l/vidioc-g-audioout.rst | 2 +-
Documentation/linux_tv/media/v4l/vidioc-g-crop.rst | 2 +-
Documentation/linux_tv/media/v4l/vidioc-g-ctrl.rst | 4 ++--
Documentation/linux_tv/media/v4l/vidioc-g-fbuf.rst | 4 ++--
Documentation/linux_tv/media/v4l/vidioc-g-fmt.rst | 4 ++--
Documentation/linux_tv/media/v4l/vidioc-g-parm.rst | 2 +-
Documentation/linux_tv/media/v4l/vidioc-g-std.rst | 2 +-
Documentation/linux_tv/media/v4l/vidioc-g-tuner.rst | 2 +-
Documentation/linux_tv/media/v4l/vidioc-prepare-buf.rst | 2 +-
Documentation/linux_tv/media/v4l/vidioc-qbuf.rst | 4 ++--
Documentation/linux_tv/media/v4l/vidioc-querybuf.rst | 2 +-
Documentation/linux_tv/media/v4l/vidioc-reqbufs.rst | 2 +-
25 files changed, 40 insertions(+), 40 deletions(-)
diff --git a/Documentation/linux_tv/media/v4l/buffer.rst b/Documentation/linux_tv/media/v4l/buffer.rst
index b535177724b9..1c6c96c37155 100644
--- a/Documentation/linux_tv/media/v4l/buffer.rst
+++ b/Documentation/linux_tv/media/v4l/buffer.rst
@@ -11,14 +11,14 @@ the Streaming I/O methods. In the multi-planar API, the data is held in
planes, while the buffer structure acts as a container for the planes.
Only pointers to buffers (planes) are exchanged, the data itself is not
copied. These pointers, together with meta-information like timestamps
-or field parity, are stored in a struct :c:type:`struct v4l2_buffer`,
+or field parity, are stored in a struct :ref:`struct v4l2_buffer <v4l2-buffer>`,
argument to the :ref:`VIDIOC_QUERYBUF`,
:ref:`VIDIOC_QBUF` and
:ref:`VIDIOC_DQBUF <VIDIOC_QBUF>` ioctl. In the multi-planar API,
-some plane-specific members of struct :c:type:`struct v4l2_buffer`,
+some plane-specific members of struct :ref:`struct v4l2_buffer <v4l2-buffer>`,
such as pointers and sizes for each plane, are stored in struct
-:c:type:`struct v4l2_plane` instead. In that case, struct
-:c:type:`struct v4l2_buffer` contains an array of plane structures.
+:ref:`struct v4l2_plane <v4l2-plane>` instead. In that case, struct
+:ref:`struct v4l2_buffer <v4l2-buffer>` contains an array of plane structures.
Dequeued video buffers come with timestamps. The driver decides at which
part of the frame and with which clock the timestamp is taken. Please
@@ -221,7 +221,7 @@ buffer.
- When using the multi-planar API, contains a userspace pointer to
an array of struct :ref:`v4l2_plane <v4l2-plane>`. The size of
the array should be put in the ``length`` field of this
- :c:type:`struct v4l2_buffer` structure.
+ :ref:`struct v4l2_buffer <v4l2-buffer>` structure.
- .. row 15
@@ -780,7 +780,7 @@ buffer.
Timecodes
=========
-The :c:type:`struct v4l2_timecode` structure is designed to hold a
+The :ref:`struct v4l2_timecode <v4l2-timecode>` structure is designed to hold a
:ref:`smpte12m` or similar timecode. (struct
:c:type:`struct timeval` timestamps are stored in struct
:ref:`v4l2_buffer <v4l2-buffer>` field ``timestamp``.)
diff --git a/Documentation/linux_tv/media/v4l/dev-osd.rst b/Documentation/linux_tv/media/v4l/dev-osd.rst
index f9337001f50d..8b05e3f0587d 100644
--- a/Documentation/linux_tv/media/v4l/dev-osd.rst
+++ b/Documentation/linux_tv/media/v4l/dev-osd.rst
@@ -116,7 +116,7 @@ parameters applications set the ``type`` field of a struct
:ref:`v4l2_format <v4l2-format>` to
``V4L2_BUF_TYPE_VIDEO_OUTPUT_OVERLAY`` and call the
:ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>` ioctl. The driver fills the
-:c:type:`struct v4l2_window` substructure named ``win``. It is not
+:ref:`struct v4l2_window <v4l2-window>` substructure named ``win``. It is not
possible to retrieve a previously programmed clipping list or bitmap.
To program the source rectangle applications set the ``type`` field of a
diff --git a/Documentation/linux_tv/media/v4l/dev-overlay.rst b/Documentation/linux_tv/media/v4l/dev-overlay.rst
index fc71406369a8..dd786b6fc936 100644
--- a/Documentation/linux_tv/media/v4l/dev-overlay.rst
+++ b/Documentation/linux_tv/media/v4l/dev-overlay.rst
@@ -122,7 +122,7 @@ To get the current parameters applications set the ``type`` field of a
struct :ref:`v4l2_format <v4l2-format>` to
``V4L2_BUF_TYPE_VIDEO_OVERLAY`` and call the
:ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>` ioctl. The driver fills the
-:c:type:`struct v4l2_window` substructure named ``win``. It is not
+:ref:`struct v4l2_window <v4l2-window>` substructure named ``win``. It is not
possible to retrieve a previously programmed clipping list or bitmap.
To program the overlay window applications set the ``type`` field of a
diff --git a/Documentation/linux_tv/media/v4l/dev-sliced-vbi.rst b/Documentation/linux_tv/media/v4l/dev-sliced-vbi.rst
index b3e89f93d6ad..0b299b51aceb 100644
--- a/Documentation/linux_tv/media/v4l/dev-sliced-vbi.rst
+++ b/Documentation/linux_tv/media/v4l/dev-sliced-vbi.rst
@@ -77,7 +77,7 @@ member, a struct
Applications can request different parameters by initializing or
modifying the ``fmt.sliced`` member and calling the
:ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl with a pointer to the
-:c:type:`struct v4l2_format` structure.
+:ref:`struct v4l2_format <v4l2-format>` structure.
The sliced VBI API is more complicated than the raw VBI API because the
hardware must be told which VBI service to expect on each scan line. Not
@@ -353,11 +353,11 @@ Reading and writing sliced VBI data
A single :ref:`read() <func-read>` or :ref:`write() <func-write>`
call must pass all data belonging to one video frame. That is an array
-of :c:type:`struct v4l2_sliced_vbi_data` structures with one or
+of :ref:`struct v4l2_sliced_vbi_data <v4l2-sliced-vbi-data>` structures with one or
more elements and a total size not exceeding ``io_size`` bytes. Likewise
in streaming I/O mode one buffer of ``io_size`` bytes must contain data
of one video frame. The ``id`` of unused
-:c:type:`struct v4l2_sliced_vbi_data` elements must be zero.
+:ref:`struct v4l2_sliced_vbi_data <v4l2-sliced-vbi-data>` elements must be zero.
.. _v4l2-sliced-vbi-data:
diff --git a/Documentation/linux_tv/media/v4l/extended-controls.rst b/Documentation/linux_tv/media/v4l/extended-controls.rst
index d5efb5bbf5bf..50598b479273 100644
--- a/Documentation/linux_tv/media/v4l/extended-controls.rst
+++ b/Documentation/linux_tv/media/v4l/extended-controls.rst
@@ -66,7 +66,7 @@ whether the specified control class is supported.
The control array is a struct
:ref:`v4l2_ext_control <v4l2-ext-control>` array. The
-:c:type:`struct v4l2_ext_control` structure is very similar to
+:ref:`struct v4l2_ext_control <v4l2-ext-control>` structure is very similar to
struct :ref:`v4l2_control <v4l2-control>`, except for the fact that
it also allows for 64-bit values and pointers to be passed.
diff --git a/Documentation/linux_tv/media/v4l/func-poll.rst b/Documentation/linux_tv/media/v4l/func-poll.rst
index 2de7f8a3a971..3e96d9b0ce38 100644
--- a/Documentation/linux_tv/media/v4l/func-poll.rst
+++ b/Documentation/linux_tv/media/v4l/func-poll.rst
@@ -39,7 +39,7 @@ returns immediately.
On success :c:func:`poll()` returns the number of file descriptors
that have been selected (that is, file descriptors for which the
-``revents`` field of the respective :c:type:`struct pollfd` structure
+``revents`` field of the respective :c:func:`struct pollfd` structure
is non-zero). Capture devices set the ``POLLIN`` and ``POLLRDNORM``
flags in the ``revents`` field, output devices the ``POLLOUT`` and
``POLLWRNORM`` flags. When the function timed out it returns a value of
diff --git a/Documentation/linux_tv/media/v4l/func-select.rst b/Documentation/linux_tv/media/v4l/func-select.rst
index 56d01b33e25d..de5583c4ffb3 100644
--- a/Documentation/linux_tv/media/v4l/func-select.rst
+++ b/Documentation/linux_tv/media/v4l/func-select.rst
@@ -36,7 +36,7 @@ buffer has been filled or displayed and can be dequeued with the
the outgoing queue of the driver the function returns immediately.
On success :c:func:`select()` returns the total number of bits set in
-the :c:type:`struct fd_set`s. When the function timed out it returns
+:c:func:`struct fd_set`. When the function timed out it returns
a value of zero. On failure it returns -1 and the ``errno`` variable is
set appropriately. When the application did not call
:ref:`VIDIOC_QBUF` or
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-002.rst b/Documentation/linux_tv/media/v4l/pixfmt-002.rst
index d72c36552c4e..a0c8c2298bdd 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-002.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-002.rst
@@ -133,7 +133,7 @@ Single-planar format structure
- ``priv``
- This field indicates whether the remaining fields of the
- :c:type:`struct v4l2_pix_format` structure, also called the
+ :ref:`struct v4l2_pix_format <v4l2-pix-format>` structure, also called the
extended fields, are valid. When set to
``V4L2_PIX_FMT_PRIV_MAGIC``, it indicates that the extended fields
have been correctly initialized. When set to any other value it
@@ -149,7 +149,7 @@ Single-planar format structure
To use the extended fields, applications must set the ``priv``
field to ``V4L2_PIX_FMT_PRIV_MAGIC``, initialize all the extended
fields and zero the unused bytes of the
- :c:type:`struct v4l2_format` ``raw_data`` field.
+ :ref:`struct v4l2_format <v4l2-format>` ``raw_data`` field.
When the ``priv`` field isn't set to ``V4L2_PIX_FMT_PRIV_MAGIC``
drivers must act as if all the extended fields were set to zero.
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-003.rst b/Documentation/linux_tv/media/v4l/pixfmt-003.rst
index 6ee05ff1dbb5..cc8ef6137618 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-003.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-003.rst
@@ -4,11 +4,11 @@
Multi-planar format structures
******************************
-The :c:type:`struct v4l2_plane_pix_format` structures define size
+The :ref:`struct v4l2_plane_pix_format <v4l2-plane-pix-format>` structures define size
and layout for each of the planes in a multi-planar format. The
-:c:type:`struct v4l2_pix_format_mplane` structure contains
+:ref:`struct v4l2_pix_format_mplane <v4l2-pix-format-mplane>` structure contains
information common to all planes (such as image width and height) and an
-array of :c:type:`struct v4l2_plane_pix_format` structures,
+array of :ref:`struct v4l2_plane_pix_format <v4l2-plane-pix-format>` structures,
describing all planes of that format.
diff --git a/Documentation/linux_tv/media/v4l/pixfmt.rst b/Documentation/linux_tv/media/v4l/pixfmt.rst
index f2c599aaa502..417796d39f00 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt.rst
@@ -6,8 +6,8 @@
Image Formats
#############
The V4L2 API was primarily designed for devices exchanging image data
-with applications. The :c:type:`struct v4l2_pix_format` and
-:c:type:`struct v4l2_pix_format_mplane` structures define the
+with applications. The :ref:`struct v4l2_pix_format <v4l2-pix-format>` and
+:ref:`struct v4l2_pix_format_mplane <v4l2-pix-format-mplane>` structures define the
format and layout of an image in memory. The former is used with the
single-planar API, while the latter is used with the multi-planar
version (see :ref:`planar-apis`). Image formats are negotiated with
diff --git a/Documentation/linux_tv/media/v4l/vidioc-create-bufs.rst b/Documentation/linux_tv/media/v4l/vidioc-create-bufs.rst
index 9d872e3b9c22..efd9629e099e 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-create-bufs.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-create-bufs.rst
@@ -39,7 +39,7 @@ over buffers is required. This ioctl can be called multiple times to
create buffers of different sizes.
To allocate the device buffers applications must initialize the relevant
-fields of the :c:type:`struct v4l2_create_buffers` structure. The
+fields of the :ref:`struct v4l2_create_buffers <v4l2-create-buffers>` structure. The
``count`` field must be set to the number of requested buffers, the
``memory`` field specifies the requested I/O method and the ``reserved``
array must be zeroed.
diff --git a/Documentation/linux_tv/media/v4l/vidioc-enumstd.rst b/Documentation/linux_tv/media/v4l/vidioc-enumstd.rst
index f4866719e099..0f4433cefc49 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-enumstd.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-enumstd.rst
@@ -69,7 +69,7 @@ or output. [1]_
set as custom standards. Multiple bits can be set if the hardware
does not distinguish between these standards, however separate
indices do not indicate the opposite. The ``id`` must be unique.
- No other enumerated :c:type:`struct v4l2_standard` structure,
+ No other enumerated :ref:`struct v4l2_standard <v4l2-standard>` structure,
for this input or output anyway, can contain the same set of bits.
- .. row 3
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-audio.rst b/Documentation/linux_tv/media/v4l/vidioc-g-audio.rst
index 8430b49b770a..abf441a04673 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-audio.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-audio.rst
@@ -43,7 +43,7 @@ has no audio inputs, or none which combine with the current video input.
Audio inputs have one writable property, the audio mode. To select the
current audio input *and* change the audio mode, applications initialize
the ``index`` and ``mode`` fields, and the ``reserved`` array of a
-:c:type:`struct v4l2_audio` structure and call the :ref:`VIDIOC_S_AUDIO <VIDIOC_G_AUDIO>`
+:ref:`struct v4l2_audio <v4l2-audio>` structure and call the :ref:`VIDIOC_S_AUDIO <VIDIOC_G_AUDIO>`
ioctl. Drivers may switch to a different audio mode if the request
cannot be satisfied. However, this is a write-only ioctl, it does not
return the actual new audio mode.
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-audioout.rst b/Documentation/linux_tv/media/v4l/vidioc-g-audioout.rst
index e2ca42cbe9ae..6bfd5b1d5428 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-audioout.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-audioout.rst
@@ -44,7 +44,7 @@ output.
Audio outputs have no writable properties. Nevertheless, to select the
current audio output applications can initialize the ``index`` field and
``reserved`` array (which in the future may contain writable properties)
-of a :c:type:`struct v4l2_audioout` structure and call the
+of a :ref:`struct v4l2_audioout <v4l2-audioout>` structure and call the
``VIDIOC_S_AUDOUT`` ioctl. Drivers switch to the requested output or
return the ``EINVAL`` error code when the index is out of bounds. This is a
write-only ioctl, it does not return the current audio output attributes
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-crop.rst b/Documentation/linux_tv/media/v4l/vidioc-g-crop.rst
index 888ddb045340..aba0dc9b4390 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-crop.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-crop.rst
@@ -35,7 +35,7 @@ Description
===========
To query the cropping rectangle size and position applications set the
-``type`` field of a :c:type:`struct v4l2_crop` structure to the
+``type`` field of a :ref:`struct v4l2_crop <v4l2-crop>` structure to the
respective buffer (stream) type and call the :ref:`VIDIOC_G_CROP <VIDIOC_G_CROP>` ioctl
with a pointer to this structure. The driver fills the rest of the
structure or returns the ``EINVAL`` error code if cropping is not supported.
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-ctrl.rst b/Documentation/linux_tv/media/v4l/vidioc-g-ctrl.rst
index 07e27e474326..77a5d1aca78a 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-ctrl.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-ctrl.rst
@@ -33,10 +33,10 @@ Description
===========
To get the current value of a control applications initialize the ``id``
-field of a struct :c:type:`struct v4l2_control` and call the
+field of a struct :ref:`struct v4l2_control <v4l2-control>` and call the
:ref:`VIDIOC_G_CTRL <VIDIOC_G_CTRL>` ioctl with a pointer to this structure. To change the
value of a control applications initialize the ``id`` and ``value``
-fields of a struct :c:type:`struct v4l2_control` and call the
+fields of a struct :ref:`struct v4l2_control <v4l2-control>` and call the
:ref:`VIDIOC_S_CTRL <VIDIOC_G_CTRL>` ioctl.
When the ``id`` is invalid drivers return an ``EINVAL`` error code. When the
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-fbuf.rst b/Documentation/linux_tv/media/v4l/vidioc-g-fbuf.rst
index abf997fea991..e52361001bb9 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-fbuf.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-fbuf.rst
@@ -49,13 +49,13 @@ VGA signal or graphics into a video signal. *Video Output Overlays* are
always non-destructive.
To get the current parameters applications call the :ref:`VIDIOC_G_FBUF <VIDIOC_G_FBUF>`
-ioctl with a pointer to a :c:type:`struct v4l2_framebuffer`
+ioctl with a pointer to a :ref:`struct v4l2_framebuffer <v4l2-framebuffer>`
structure. The driver fills all fields of the structure or returns an
EINVAL error code when overlays are not supported.
To set the parameters for a *Video Output Overlay*, applications must
initialize the ``flags`` field of a struct
-:c:type:`struct v4l2_framebuffer`. Since the framebuffer is
+:ref:`struct v4l2_framebuffer <v4l2-framebuffer>`. Since the framebuffer is
implemented on the TV card all other parameters are determined by the
driver. When an application calls :ref:`VIDIOC_S_FBUF <VIDIOC_G_FBUF>` with a pointer to
this structure, the driver prepares for the overlay and returns the
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-fmt.rst b/Documentation/linux_tv/media/v4l/vidioc-g-fmt.rst
index 24fac4536196..869c7cc08035 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-fmt.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-fmt.rst
@@ -37,7 +37,7 @@ These ioctls are used to negotiate the format of data (typically image
format) exchanged between driver and application.
To query the current parameters applications set the ``type`` field of a
-struct :c:type:`struct v4l2_format` to the respective buffer (stream)
+struct :ref:`struct v4l2_format <v4l2-format>` to the respective buffer (stream)
type. For example video capture devices use
``V4L2_BUF_TYPE_VIDEO_CAPTURE`` or
``V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE``. When the application calls the
@@ -55,7 +55,7 @@ For details see the documentation of the various devices types in
:ref:`devices`. Good practice is to query the current parameters
first, and to modify only those parameters not suitable for the
application. When the application calls the :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl with
-a pointer to a :c:type:`struct v4l2_format` structure the driver
+a pointer to a :ref:`struct v4l2_format <v4l2-format>` structure the driver
checks and adjusts the parameters against hardware abilities. Drivers
should not return an error code unless the ``type`` field is invalid,
this is a mechanism to fathom device capabilities and to approach
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-parm.rst b/Documentation/linux_tv/media/v4l/vidioc-g-parm.rst
index 2fbec8a6adfc..73974cd938b8 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-parm.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-parm.rst
@@ -45,7 +45,7 @@ section discussing the :ref:`read() <func-read>` function.
To get and set the streaming parameters applications call the
:ref:`VIDIOC_G_PARM <VIDIOC_G_PARM>` and :ref:`VIDIOC_S_PARM <VIDIOC_G_PARM>` ioctl, respectively. They take a
-pointer to a struct :c:type:`struct v4l2_streamparm` which contains a
+pointer to a struct :ref:`struct v4l2_streamparm <v4l2-streamparm>` which contains a
union holding separate parameters for input and output devices.
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-std.rst b/Documentation/linux_tv/media/v4l/vidioc-g-std.rst
index 67b4d7da6473..8cacecfb8c97 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-std.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-std.rst
@@ -40,7 +40,7 @@ To query and select the current video standard applications use the
can return a single flag or a set of flags as in struct
:ref:`v4l2_standard <v4l2-standard>` field ``id``. The flags must be
unambiguous such that they appear in only one enumerated
-:c:type:`struct v4l2_standard` structure.
+:ref:`struct v4l2_standard <v4l2-standard>` structure.
:ref:`VIDIOC_S_STD <VIDIOC_G_STD>` accepts one or more flags, being a write-only ioctl it
does not return the actual new standard as :ref:`VIDIOC_G_STD <VIDIOC_G_STD>` does. When
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-tuner.rst b/Documentation/linux_tv/media/v4l/vidioc-g-tuner.rst
index 078fe6db751e..c5f947811746 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-tuner.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-tuner.rst
@@ -221,7 +221,7 @@ To change the radio frequency the
received audio programs do not match.
Currently this is the only field of struct
- :c:type:`struct v4l2_tuner` applications can change.
+ :ref:`struct v4l2_tuner <v4l2-tuner>` applications can change.
- .. row 15
diff --git a/Documentation/linux_tv/media/v4l/vidioc-prepare-buf.rst b/Documentation/linux_tv/media/v4l/vidioc-prepare-buf.rst
index 79a6a1009703..bf31aaaf6c76 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-prepare-buf.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-prepare-buf.rst
@@ -40,7 +40,7 @@ operations are not required, the application can use one of
``V4L2_BUF_FLAG_NO_CACHE_INVALIDATE`` and
``V4L2_BUF_FLAG_NO_CACHE_CLEAN`` flags to skip the respective step.
-The :c:type:`struct v4l2_buffer` structure is specified in
+The :ref:`struct v4l2_buffer <v4l2-buffer>` structure is specified in
:ref:`buffer`.
diff --git a/Documentation/linux_tv/media/v4l/vidioc-qbuf.rst b/Documentation/linux_tv/media/v4l/vidioc-qbuf.rst
index ab567559a0ac..b51db1311e9f 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-qbuf.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-qbuf.rst
@@ -44,7 +44,7 @@ Applications must also set the ``index`` field. Valid index numbers
range from zero to the number of buffers allocated with
:ref:`VIDIOC_REQBUFS` (struct
:ref:`v4l2_requestbuffers <v4l2-requestbuffers>` ``count``) minus
-one. The contents of the struct :c:type:`struct v4l2_buffer` returned
+one. The contents of the struct :ref:`struct v4l2_buffer <v4l2-buffer>` returned
by a :ref:`VIDIOC_QUERYBUF` ioctl will do as well.
When the buffer is intended for output (``type`` is
``V4L2_BUF_TYPE_VIDEO_OUTPUT``, ``V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE``,
@@ -112,7 +112,7 @@ queue. When the ``O_NONBLOCK`` flag was given to the
:ref:`open() <func-open>` function, ``VIDIOC_DQBUF`` returns
immediately with an ``EAGAIN`` error code when no buffer is available.
-The :c:type:`struct v4l2_buffer` structure is specified in
+The :ref:`struct v4l2_buffer <v4l2-buffer>` structure is specified in
:ref:`buffer`.
diff --git a/Documentation/linux_tv/media/v4l/vidioc-querybuf.rst b/Documentation/linux_tv/media/v4l/vidioc-querybuf.rst
index efc8143edc34..11c9c59688ae 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-querybuf.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-querybuf.rst
@@ -63,7 +63,7 @@ elements will be used instead and the ``length`` field of struct
array elements. The driver may or may not set the remaining fields and
flags, they are meaningless in this context.
-The :c:type:`struct v4l2_buffer` structure is specified in
+The :ref:`struct v4l2_buffer <v4l2-buffer>` structure is specified in
:ref:`buffer`.
diff --git a/Documentation/linux_tv/media/v4l/vidioc-reqbufs.rst b/Documentation/linux_tv/media/v4l/vidioc-reqbufs.rst
index 411b5bf80313..065ea275c0df 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-reqbufs.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-reqbufs.rst
@@ -43,7 +43,7 @@ configures the driver into DMABUF I/O mode without performing any direct
allocation.
To allocate device buffers applications initialize all fields of the
-:c:type:`struct v4l2_requestbuffers` structure. They set the ``type``
+:ref:`struct v4l2_requestbuffers <v4l2-requestbuffers>` structure. They set the ``type``
field to the respective stream or buffer type, the ``count`` field to
the desired number of buffers, ``memory`` must be set to the requested
I/O method and the ``reserved`` array must be zeroed. When the ioctl is
--
2.7.4
^ permalink raw reply related [flat|nested] 52+ messages in thread* [PATCH 30/51] Documentation: linux_tv: Fix remaining undefined references
2016-07-04 11:46 [PATCH 00/51] First part of documentation fixups Mauro Carvalho Chehab
` (28 preceding siblings ...)
2016-07-04 11:46 ` [PATCH 29/51] Documentation: linux_tv: use references for structures Mauro Carvalho Chehab
@ 2016-07-04 11:46 ` Mauro Carvalho Chehab
2016-07-04 11:46 ` [PATCH 31/51] Documentation: pixfmt-007.rst: Fix formula parsing Mauro Carvalho Chehab
` (20 subsequent siblings)
50 siblings, 0 replies; 52+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-04 11:46 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, Jonathan Corbet,
Markus Heiser, linux-doc
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #1: Type: text/plain; charset=true, Size: 2772 bytes --]
Fix Sphinx those warnings:
WARNING: undefined label: fdl-modified>`as given on the :ref:`title page <fdl-title-page (if the link has no caption the label must precede a section header)
WARNING: undefined label: v4l2-pix-fmt-yuv420 (if the link has no caption the label must precede a section $
WARNING: undefined label: pixfmt-srggb10 (if the link has no caption the label must precede a section heade$
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
Documentation/linux_tv/media/v4l/fdl-appendix.rst | 2 +-
Documentation/linux_tv/media/v4l/pixfmt-srggb10dpcm8.rst | 2 +-
Documentation/linux_tv/media/v4l/pixfmt-yuv420.rst | 1 +
3 files changed, 3 insertions(+), 2 deletions(-)
diff --git a/Documentation/linux_tv/media/v4l/fdl-appendix.rst b/Documentation/linux_tv/media/v4l/fdl-appendix.rst
index 4a7be9b00670..cb0704883744 100644
--- a/Documentation/linux_tv/media/v4l/fdl-appendix.rst
+++ b/Documentation/linux_tv/media/v4l/fdl-appendix.rst
@@ -246,7 +246,7 @@ Modified Version:
Preserve the section entitled “History”, and its title, and add to it
an item stating at least the title, year, new authors, and publisher
- of the :ref:`Modified Version <fdl-modified>`as given on the
+ of the :ref:`Modified Version <fdl-modified>` as given on the
:ref:`Title Page <fdl-title-page>`. If there is no section entitled
“History” in the :ref:`Document <fdl-document>`, create one stating
the title, year, authors, and publisher of the Document as given on
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-srggb10dpcm8.rst b/Documentation/linux_tv/media/v4l/pixfmt-srggb10dpcm8.rst
index 581ab5190246..03a27c43be21 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-srggb10dpcm8.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-srggb10dpcm8.rst
@@ -21,7 +21,7 @@ These four pixel formats are raw sRGB / Bayer formats with 10 bits per
colour compressed to 8 bits each, using DPCM compression. DPCM,
differential pulse-code modulation, is lossy. Each colour component
consumes 8 bits of memory. In other respects this format is similar to
-:ref:`pixfmt-srggb10`.
+:ref:`V4L2-PIX-FMT-SRGGB10`.
.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-yuv420.rst b/Documentation/linux_tv/media/v4l/pixfmt-yuv420.rst
index dcf3a176d1ba..0dd7e4632dd9 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-yuv420.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-yuv420.rst
@@ -1,6 +1,7 @@
.. -*- coding: utf-8; mode: rst -*-
.. _V4L2-PIX-FMT-YVU420:
+.. _V4L2-PIX-FMT-YUV420:
**********************************************************
V4L2_PIX_FMT_YVU420 ('YV12'), V4L2_PIX_FMT_YUV420 ('YU12')
--
2.7.4
^ permalink raw reply related [flat|nested] 52+ messages in thread* [PATCH 31/51] Documentation: pixfmt-007.rst: Fix formula parsing
2016-07-04 11:46 [PATCH 00/51] First part of documentation fixups Mauro Carvalho Chehab
` (29 preceding siblings ...)
2016-07-04 11:46 ` [PATCH 30/51] Documentation: linux_tv: Fix remaining undefined references Mauro Carvalho Chehab
@ 2016-07-04 11:46 ` Mauro Carvalho Chehab
2016-07-04 11:46 ` [PATCH 32/51] Documentation: fdl-appendix: Fix formatting issues Mauro Carvalho Chehab
` (19 subsequent siblings)
50 siblings, 0 replies; 52+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-04 11:46 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, Jonathan Corbet,
Markus Heiser, linux-doc
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #1: Type: text/plain; charset=true, Size: 9963 bytes --]
There are lots of warnings there:
/devel/v4l/patchwork/Documentation/linux_tv/media/v4l/pixfmt-007.rst:74: ERROR: Unexpected indentation.
/devel/v4l/patchwork/Documentation/linux_tv/media/v4l/pixfmt-007.rst:89: ERROR: Unexpected indentation.
/devel/v4l/patchwork/Documentation/linux_tv/media/v4l/pixfmt-007.rst:168: ERROR: Unexpected indentation.
/devel/v4l/patchwork/Documentation/linux_tv/media/v4l/pixfmt-007.rst:183: ERROR: Unexpected indentation.
/devel/v4l/patchwork/Documentation/linux_tv/media/v4l/pixfmt-007.rst:206: ERROR: Unexpected indentation.
/devel/v4l/patchwork/Documentation/linux_tv/media/v4l/pixfmt-007.rst:216: ERROR: Unexpected indentation.
/devel/v4l/patchwork/Documentation/linux_tv/media/v4l/pixfmt-007.rst:292: ERROR: Unexpected indentation.
/devel/v4l/patchwork/Documentation/linux_tv/media/v4l/pixfmt-007.rst:308: ERROR: Unexpected indentation.
/devel/v4l/patchwork/Documentation/linux_tv/media/v4l/pixfmt-007.rst:393: ERROR: Unexpected indentation.
/devel/v4l/patchwork/Documentation/linux_tv/media/v4l/pixfmt-007.rst:478: ERROR: Unexpected indentation.
/devel/v4l/patchwork/Documentation/linux_tv/media/v4l/pixfmt-007.rst:657: ERROR: Unexpected indentation.
/devel/v4l/patchwork/Documentation/linux_tv/media/v4l/pixfmt-007.rst:735: ERROR: Unexpected indentation.
/devel/v4l/patchwork/Documentation/linux_tv/media/v4l/pixfmt-007.rst:746: ERROR: Unexpected indentation.
/devel/v4l/patchwork/Documentation/linux_tv/media/v4l/pixfmt-007.rst:822: ERROR: Unexpected indentation.
/devel/v4l/patchwork/Documentation/linux_tv/media/v4l/pixfmt-007.rst:833: ERROR: Unexpected indentation.
Also, sometimes the :sup: tag was ignored. Fix it.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
Documentation/linux_tv/media/v4l/pixfmt-007.rst | 81 +++++++++++++++++--------
1 file changed, 57 insertions(+), 24 deletions(-)
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-007.rst b/Documentation/linux_tv/media/v4l/pixfmt-007.rst
index 636506cefec1..7caceea855a0 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-007.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-007.rst
@@ -71,21 +71,24 @@ SMPTE C set, so this colorspace is sometimes called SMPTE C as well.
The transfer function defined for SMPTE 170M is the same as the one
defined in Rec. 709.
- L' = -1.099(-L):sup:`0.45` + 0.099 for L ≤ -0.018
+
+ L' = -1.099(-L) :sup:`0.45` + 0.099 for L ≤ -0.018
L' = 4.5L for -0.018 < L < 0.018
- L' = 1.099L\ :sup:`0.45` - 0.099 for L ≥ 0.018
+ L' = 1.099L :sup:`0.45` - 0.099 for L ≥ 0.018
Inverse Transfer function:
- L = -((L' - 0.099) / -1.099):sup:`1/0.45` for L' ≤ -0.081
+
+ L = -((L' - 0.099) / -1.099) :sup:`1/0.45` for L' ≤ -0.081
L = L' / 4.5 for -0.081 < L' < 0.081
- L = ((L' + 0.099) / 1.099)\ :sup:`1/0.45` for L' ≥ 0.081
+ L = ((L' + 0.099) / 1.099) :sup:`1/0.45` for L' ≥ 0.081
The luminance (Y') and color difference (Cb and Cr) are obtained with
the following ``V4L2_YCBCR_ENC_601`` encoding:
+
Y' = 0.299R' + 0.587G' + 0.114B'
Cb = -0.169R' - 0.331G' + 0.5B'
@@ -165,21 +168,24 @@ The full name of this standard is Rec. ITU-R BT.709-5.
Transfer function. Normally L is in the range [0…1], but for the
extended gamut xvYCC encoding values outside that range are allowed.
- L' = -1.099(-L):sup:`0.45` + 0.099 for L ≤ -0.018
+
+ L' = -1.099(-L) :sup:`0.45` + 0.099 for L ≤ -0.018
L' = 4.5L for -0.018 < L < 0.018
- L' = 1.099L\ :sup:`0.45` - 0.099 for L ≥ 0.018
+ L' = 1.099L :sup:`0.45` - 0.099 for L ≥ 0.018
Inverse Transfer function:
- L = -((L' - 0.099) / -1.099):sup:`1/0.45` for L' ≤ -0.081
+
+ L = -((L' - 0.099) / -1.099) :sup:`1/0.45` for L' ≤ -0.081
L = L' / 4.5 for -0.081 < L' < 0.081
- L = ((L' + 0.099) / 1.099)\ :sup:`1/0.45` for L' ≥ 0.081
+ L = ((L' + 0.099) / 1.099) :sup:`1/0.45` for L' ≥ 0.081
The luminance (Y') and color difference (Cb and Cr) are obtained with
the following ``V4L2_YCBCR_ENC_709`` encoding:
+
Y' = 0.2126R' + 0.7152G' + 0.0722B'
Cb = -0.1146R' - 0.3854G' + 0.5B'
@@ -203,6 +209,7 @@ The xvYCC 709 encoding (``V4L2_YCBCR_ENC_XV709``, :ref:`xvycc`) is
similar to the Rec. 709 encoding, but it allows for R', G' and B' values
that are outside the range [0…1]. The resulting Y', Cb and Cr values are
scaled and offset:
+
Y' = (219 / 256) * (0.2126R' + 0.7152G' + 0.0722B') + (16 / 256)
Cb = (224 / 256) * (-0.1146R' - 0.3854G' + 0.5B')
@@ -213,6 +220,7 @@ The xvYCC 601 encoding (``V4L2_YCBCR_ENC_XV601``, :ref:`xvycc`) is
similar to the BT.601 encoding, but it allows for R', G' and B' values
that are outside the range [0…1]. The resulting Y', Cb and Cr values are
scaled and offset:
+
Y' = (219 / 256) * (0.299R' + 0.587G' + 0.114B') + (16 / 256)
Cb = (224 / 256) * (-0.169R' - 0.331G' + 0.5B')
@@ -289,22 +297,25 @@ These chromaticities are identical to the Rec. 709 colorspace.
Transfer function. Note that negative values for L are only used by the
Y'CbCr conversion.
- L' = -1.055(-L):sup:`1/2.4` + 0.055 for L < -0.0031308
+
+ L' = -1.055(-L) :sup:`1/2.4` + 0.055 for L < -0.0031308
L' = 12.92L for -0.0031308 ≤ L ≤ 0.0031308
- L' = 1.055L\ :sup:`1/2.4` - 0.055 for 0.0031308 < L ≤ 1
+ L' = 1.055L :sup:`1/2.4` - 0.055 for 0.0031308 < L ≤ 1
Inverse Transfer function:
- L = -((-L' + 0.055) / 1.055)\ :sup:`2.4` for L' < -0.04045
+
+ L = -((-L' + 0.055) / 1.055) :sup:`2.4` for L' < -0.04045
L = L' / 12.92 for -0.04045 ≤ L' ≤ 0.04045
- L = ((L' + 0.055) / 1.055)\ :sup:`2.4` for L' > 0.04045
+ L = ((L' + 0.055) / 1.055) :sup:`2.4` for L' > 0.04045
The luminance (Y') and color difference (Cb and Cr) are obtained with
the following ``V4L2_YCBCR_ENC_SYCC`` encoding as defined by
:ref:`sycc`:
+
Y' = 0.2990R' + 0.5870G' + 0.1140B'
Cb = -0.1687R' - 0.3313G' + 0.5B'
@@ -383,13 +394,16 @@ are:
Transfer function:
- L' = L\ :sup:`1/2.19921875`
+
+ L' = L :sup:`1/2.19921875`
Inverse Transfer function:
- L = L'\ :sup:`2.19921875`
+
+ L = L' :sup:`2.19921875`
The luminance (Y') and color difference (Cb and Cr) are obtained with
the following ``V4L2_YCBCR_ENC_601`` encoding:
+
Y' = 0.299R' + 0.587G' + 0.114B'
Cb = -0.169R' - 0.331G' + 0.5B'
@@ -464,17 +478,20 @@ of the primary colors and the white reference are:
Transfer function (same as Rec. 709):
+
L' = 4.5L for 0 ≤ L < 0.018
- L' = 1.099L\ :sup:`0.45` - 0.099 for 0.018 ≤ L ≤ 1
+ L' = 1.099L :sup:`0.45` - 0.099 for 0.018 ≤ L ≤ 1
Inverse Transfer function:
+
L = L' / 4.5 for L' < 0.081
- L = ((L' + 0.099) / 1.099)\ :sup:`1/0.45` for L' ≥ 0.081
+ L = ((L' + 0.099) / 1.099) :sup:`1/0.45` for L' ≥ 0.081
The luminance (Y') and color difference (Cb and Cr) are obtained with
the following ``V4L2_YCBCR_ENC_BT2020`` encoding:
+
Y' = 0.2627R' + 0.6780G' + 0.0593B'
Cb = -0.1396R' - 0.3604G' + 0.5B'
@@ -488,18 +505,23 @@ There is also an alternate constant luminance R'G'B' to Yc'CbcCrc
(``V4L2_YCBCR_ENC_BT2020_CONST_LUM``) encoding:
Luma:
+
Yc' = (0.2627R + 0.6780G + 0.0593B)'
B' - Yc' ≤ 0:
+
Cbc = (B' - Yc') / 1.9404
B' - Yc' > 0:
+
Cbc = (B' - Yc') / 1.5816
R' - Yc' ≤ 0:
+
Crc = (R' - Y') / 1.7184
R' - Yc' > 0:
+
Crc = (R' - Y') / 0.9936
Yc' is clamped to the range [0…1] and Cbc and Crc are clamped to the
@@ -571,10 +593,12 @@ primary colors and the white reference are:
Transfer function:
- L' = L\ :sup:`1/2.6`
+
+ L' = L :sup:`1/2.6`
Inverse Transfer function:
- L = L'\ :sup:`2.6`
+
+ L = L' :sup:`2.6`
Y'CbCr encoding is not specified. V4L2 defaults to Rec. 709.
@@ -643,17 +667,20 @@ and the white reference are:
These chromaticities are identical to the SMPTE 170M colorspace.
Transfer function:
+
L' = 4L for 0 ≤ L < 0.0228
- L' = 1.1115L\ :sup:`0.45` - 0.1115 for 0.0228 ≤ L ≤ 1
+ L' = 1.1115L :sup:`0.45` - 0.1115 for 0.0228 ≤ L ≤ 1
Inverse Transfer function:
+
L = L' / 4 for 0 ≤ L' < 0.0913
- L = ((L' + 0.1115) / 1.1115)\ :sup:`1/0.45` for L' ≥ 0.0913
+ L = ((L' + 0.1115) / 1.1115) :sup:`1/0.45` for L' ≥ 0.0913
The luminance (Y') and color difference (Cb and Cr) are obtained with
the following ``V4L2_YCBCR_ENC_SMPTE240M`` encoding:
+
Y' = 0.2122R' + 0.7013G' + 0.0865B'
Cb = -0.1161R' - 0.3839G' + 0.5B'
@@ -732,17 +759,20 @@ the Bradford method.
The transfer function was never properly defined for NTSC 1953. The Rec.
709 transfer function is recommended in the literature:
+
L' = 4.5L for 0 ≤ L < 0.018
- L' = 1.099L\ :sup:`0.45` - 0.099 for 0.018 ≤ L ≤ 1
+ L' = 1.099L :sup:`0.45` - 0.099 for 0.018 ≤ L ≤ 1
Inverse Transfer function:
+
L = L' / 4.5 for L' < 0.081
- L = ((L' + 0.099) / 1.099)\ :sup:`1/0.45` for L' ≥ 0.081
+ L = ((L' + 0.099) / 1.099) :sup:`1/0.45` for L' ≥ 0.081
The luminance (Y') and color difference (Cb and Cr) are obtained with
the following ``V4L2_YCBCR_ENC_601`` encoding:
+
Y' = 0.299R' + 0.587G' + 0.114B'
Cb = -0.169R' - 0.331G' + 0.5B'
@@ -819,17 +849,20 @@ are:
The transfer function was never properly defined for this colorspace.
The Rec. 709 transfer function is recommended in the literature:
+
L' = 4.5L for 0 ≤ L < 0.018
- L' = 1.099L\ :sup:`0.45` - 0.099 for 0.018 ≤ L ≤ 1
+ L' = 1.099L :sup:`0.45` - 0.099 for 0.018 ≤ L ≤ 1
Inverse Transfer function:
+
L = L' / 4.5 for L' < 0.081
- L = ((L' + 0.099) / 1.099)\ :sup:`1/0.45` for L' ≥ 0.081
+ L = ((L' + 0.099) / 1.099) :sup:`1/0.45` for L' ≥ 0.081
The luminance (Y') and color difference (Cb and Cr) are obtained with
the following ``V4L2_YCBCR_ENC_601`` encoding:
+
Y' = 0.299R' + 0.587G' + 0.114B'
Cb = -0.169R' - 0.331G' + 0.5B'
--
2.7.4
^ permalink raw reply related [flat|nested] 52+ messages in thread* [PATCH 32/51] Documentation: fdl-appendix: Fix formatting issues
2016-07-04 11:46 [PATCH 00/51] First part of documentation fixups Mauro Carvalho Chehab
` (30 preceding siblings ...)
2016-07-04 11:46 ` [PATCH 31/51] Documentation: pixfmt-007.rst: Fix formula parsing Mauro Carvalho Chehab
@ 2016-07-04 11:46 ` Mauro Carvalho Chehab
2016-07-04 11:46 ` [PATCH 33/51] Documentation: linux_tv: fix some warnings due to '*' Mauro Carvalho Chehab
` (18 subsequent siblings)
50 siblings, 0 replies; 52+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-04 11:46 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, Jonathan Corbet,
Markus Heiser, linux-doc
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #1: Type: text/plain; charset=true, Size: 6739 bytes --]
The conversion didn't add blank lines where needed, but it
added were it weren't ;)
Fix it, to make it to parse correctly by Sphinx. This also
fixes a bunch or warnings:
/devel/v4l/patchwork/Documentation/linux_tv/media/v4l/fdl-appendix.rst:44: WARNING: Explicit markup ends without a blank line; unexpected unindent.
/devel/v4l/patchwork/Documentation/linux_tv/media/v4l/fdl-appendix.rst:52: WARNING: Explicit markup ends without a blank line; unexpected unindent.
/devel/v4l/patchwork/Documentation/linux_tv/media/v4l/fdl-appendix.rst:58: WARNING: Explicit markup ends without a blank line; unexpected unindent.
/devel/v4l/patchwork/Documentation/linux_tv/media/v4l/fdl-appendix.rst:71: WARNING: Explicit markup ends without a blank line; unexpected unindent.
/devel/v4l/patchwork/Documentation/linux_tv/media/v4l/fdl-appendix.rst:78: WARNING: Explicit markup ends without a blank line; unexpected unindent.
/devel/v4l/patchwork/Documentation/linux_tv/media/v4l/fdl-appendix.rst:84: WARNING: Explicit markup ends without a blank line; unexpected unindent.
/devel/v4l/patchwork/Documentation/linux_tv/media/v4l/fdl-appendix.rst:107: WARNING: Explicit markup ends without a blank line; unexpected unindent.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
Documentation/linux_tv/media/v4l/fdl-appendix.rst | 21 +++++++--------------
1 file changed, 7 insertions(+), 14 deletions(-)
diff --git a/Documentation/linux_tv/media/v4l/fdl-appendix.rst b/Documentation/linux_tv/media/v4l/fdl-appendix.rst
index cb0704883744..9f3a494cf497 100644
--- a/Documentation/linux_tv/media/v4l/fdl-appendix.rst
+++ b/Documentation/linux_tv/media/v4l/fdl-appendix.rst
@@ -41,6 +41,7 @@ works whose purpose is instruction or reference.
.. _fdl-document:
+
This License applies to any manual or other work that contains a notice
placed by the copyright holder saying it can be distributed under the
terms of this License. The “Document”, below, refers to any such manual
@@ -49,12 +50,14 @@ or work. Any member of the public is a licensee, and is addressed as
.. _fdl-modified:
+
A “Modified Version” of the Document means any work containing the
Document or a portion of it, either copied verbatim, or with
modifications and/or translated into another language.
.. _fdl-secondary:
+
A “Secondary Section” is a named appendix or a front-matter section of
the :ref:`Document <fdl-document>` that deals exclusively with the
relationship of the publishers or authors of the Document to the
@@ -68,6 +71,7 @@ regarding them.
.. _fdl-invariant:
+
The “Invariant Sections” are certain
:ref:`Secondary Sections <fdl-secondary>` whose titles are designated,
as being those of Invariant Sections, in the notice that says that the
@@ -75,12 +79,14 @@ as being those of Invariant Sections, in the notice that says that the
.. _fdl-cover-texts:
+
The “Cover Texts” are certain short passages of text that are listed, as
Front-Cover Texts or Back-Cover Texts, in the notice that says that the
:ref:`Document <fdl-document>` is released under this License.
.. _fdl-transparent:
+
A “Transparent” copy of the :ref:`Document <fdl-document>` means a
machine-readable copy, represented in a format whose specification is
available to the general public, whose contents can be viewed and edited
@@ -104,6 +110,7 @@ word processors for output purposes only.
.. _fdl-title-page:
+
The “Title Page” means, for a printed book, the title page itself, plus
such following pages as are needed to hold, legibly, the material this
License requires to appear in the title page. For works in formats which
@@ -191,7 +198,6 @@ possesses a copy of it. In addition, you must do these things in the
Modified Version:
- **A.**
-
Use in the :ref:`Title Page <fdl-title-page>` (and on the covers,
if any) a title distinct from that of the
:ref:`Document <fdl-document>`, and from those of previous versions
@@ -200,7 +206,6 @@ Modified Version:
the original publisher of that version gives permission.
- **B.**
-
List on the :ref:`Title Page <fdl-title-page>`, as authors, one or
more persons or entities responsible for authorship of the
modifications in the :ref:`Modified Version <fdl-modified>`,
@@ -209,41 +214,34 @@ Modified Version:
has less than five).
- **C.**
-
State on the :ref:`Title Page <fdl-title-page>` the name of the
publisher of the :ref:`Modified Version <fdl-modified>`, as the
publisher.
- **D.**
-
Preserve all the copyright notices of the
:ref:`Document <fdl-document>`.
- **E.**
-
Add an appropriate copyright notice for your modifications adjacent
to the other copyright notices.
- **F.**
-
Include, immediately after the copyright notices, a license notice
giving the public permission to use the
:ref:`Modified Version <fdl-modified>` under the terms of this
License, in the form shown in the Addendum below.
- **G.**
-
Preserve in that license notice the full lists of
:ref:`Invariant Sections <fdl-invariant>` and required
:ref:`Cover Texts <fdl-cover-texts>` given in the
:ref:`Document's <fdl-document>` license notice.
- **H.**
-
Include an unaltered copy of this License.
- **I.**
-
Preserve the section entitled “History”, and its title, and add to it
an item stating at least the title, year, new authors, and publisher
of the :ref:`Modified Version <fdl-modified>` as given on the
@@ -254,7 +252,6 @@ Modified Version:
stated in the previous sentence.
- **J.**
-
Preserve the network location, if any, given in the
:ref:`Document <fdl-document>` for public access to a
:ref:`Transparent <fdl-transparent>` copy of the Document, and
@@ -265,26 +262,22 @@ Modified Version:
original publisher of the version it refers to gives permission.
- **K.**
-
In any section entitled “Acknowledgements” or “Dedications”, preserve
the section's title, and preserve in the section all the substance
and tone of each of the contributor acknowledgements and/or
dedications given therein.
- **L.**
-
Preserve all the :ref:`Invariant Sections <fdl-invariant>` of the
:ref:`Document <fdl-document>`, unaltered in their text and in
their titles. Section numbers or the equivalent are not considered
part of the section titles.
- **M.**
-
Delete any section entitled “Endorsements”. Such a section may not be
included in the :ref:`Modified Version <fdl-modified>`.
- **N.**
-
Do not retitle any existing section as “Endorsements” or to conflict
in title with any :ref:`Invariant Section <fdl-invariant>`.
--
2.7.4
^ permalink raw reply related [flat|nested] 52+ messages in thread* [PATCH 33/51] Documentation: linux_tv: fix some warnings due to '*'
2016-07-04 11:46 [PATCH 00/51] First part of documentation fixups Mauro Carvalho Chehab
` (31 preceding siblings ...)
2016-07-04 11:46 ` [PATCH 32/51] Documentation: fdl-appendix: Fix formatting issues Mauro Carvalho Chehab
@ 2016-07-04 11:46 ` Mauro Carvalho Chehab
2016-07-04 11:46 ` [PATCH 34/51] Documentation: fe_property_parameters.rst: improve descriptions Mauro Carvalho Chehab
` (17 subsequent siblings)
50 siblings, 0 replies; 52+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-04 11:46 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, Jonathan Corbet,
Markus Heiser, linux-doc
Unescaped * causes warnings on Sphinx.
Add an escape at hist-v4l2.rst occurrences.
At libv4l-introduction, the best is do declare the function
prototypes as C code.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
Documentation/linux_tv/media/v4l/hist-v4l2.rst | 5 ++---
.../linux_tv/media/v4l/libv4l-introduction.rst | 22 +++++++++++-----------
2 files changed, 13 insertions(+), 14 deletions(-)
diff --git a/Documentation/linux_tv/media/v4l/hist-v4l2.rst b/Documentation/linux_tv/media/v4l/hist-v4l2.rst
index 664fbe4780af..6e9706f791de 100644
--- a/Documentation/linux_tv/media/v4l/hist-v4l2.rst
+++ b/Documentation/linux_tv/media/v4l/hist-v4l2.rst
@@ -187,7 +187,7 @@ common Linux driver API conventions.
until the time in the timestamp field has arrived. I would like to
follow SGI's lead, and adopt a multimedia timestamping system like
their UST (Unadjusted System Time). See
- http://web.archive.org/web/*/http://reality.sgi.com
+ http://web.archive.org/web/\*/http://reality.sgi.com
/cpirazzi_engr/lg/time/intro.html. UST uses timestamps that are
64-bit signed integers (not struct timeval's) and given in nanosecond
units. The UST clock starts at zero when the system is booted and
@@ -1408,13 +1408,12 @@ XFree86 and XOrg, just programming any overlay capable Video4Linux
device it finds. To enable it ``/etc/X11/XF86Config`` must contain these
lines:
-
-
::
Section "Module"
Load "v4l"
EndSection
+
As of XFree86 4.2 this driver still supports only V4L ioctls, however it
should work just fine with all V4L2 devices through the V4L2
backward-compatibility layer. Since V4L2 permits multiple opens it is
diff --git a/Documentation/linux_tv/media/v4l/libv4l-introduction.rst b/Documentation/linux_tv/media/v4l/libv4l-introduction.rst
index b8d247dc236d..d189316dc1da 100644
--- a/Documentation/linux_tv/media/v4l/libv4l-introduction.rst
+++ b/Documentation/linux_tv/media/v4l/libv4l-introduction.rst
@@ -116,42 +116,42 @@ The common file operation methods are provided by libv4l.
Those functions operate just like glibc
open/close/dup/ioctl/read/mmap/munmap:
-- int v4l2_open(const char *file, int oflag, ...) - operates like the
+- :c:type:`int v4l2_open(const char *file, int oflag, ...)` - operates like the
standard :ref:`open() <func-open>` function.
-- int v4l2_close(int fd) - operates like the standard
+- :c:type:`int v4l2_close(int fd)` - operates like the standard
:ref:`close() <func-close>` function.
-- int v4l2_dup(int fd) - operates like the standard dup() function,
+- :c:type:`int v4l2_dup(int fd)` - operates like the standard dup() function,
duplicating a file handler.
-- int v4l2_ioctl (int fd, unsigned long int request, ...) - operates
+- :c:type:`int v4l2_ioctl (int fd, unsigned long int request, ...)` - operates
like the standard :ref:`ioctl() <func-ioctl>` function.
-- int v4l2_read (int fd, void* buffer, size_t n) - operates like the
+- :c:type:`int v4l2_read (int fd, void* buffer, size_t n)` - operates like the
standard :ref:`read() <func-read>` function.
-- void v4l2_mmap(void *start, size_t length, int prot, int flags, int
- fd, int64_t offset); - operates like the standard
+- :c:type:`void v4l2_mmap(void *start, size_t length, int prot, int flags, int
+ fd, int64_t offset);` - operates like the standard
:ref:`mmap() <func-mmap>` function.
-- int v4l2_munmap(void *_start, size_t length); - operates like the
+- :c:type:`int v4l2_munmap(void *_start, size_t length);` - operates like the
standard :ref:`munmap() <func-munmap>` function.
Those functions provide additional control:
-- int v4l2_fd_open(int fd, int v4l2_flags) - opens an already opened
+- :c:type:`int v4l2_fd_open(int fd, int v4l2_flags)` - opens an already opened
fd for further use through v4l2lib and possibly modify libv4l2's
default behavior through the v4l2_flags argument. Currently,
v4l2_flags can be ``V4L2_DISABLE_CONVERSION``, to disable format
conversion.
-- int v4l2_set_control(int fd, int cid, int value) - This function
+- :c:type:`int v4l2_set_control(int fd, int cid, int value)` - This function
takes a value of 0 - 65535, and then scales that range to the actual
range of the given v4l control id, and then if the cid exists and is
not locked sets the cid to the scaled value.
-- int v4l2_get_control(int fd, int cid) - This function returns a
+- :c:type:`int v4l2_get_control(int fd, int cid)` - This function returns a
value of 0 - 65535, scaled to from the actual range of the given v4l
control id. when the cid does not exist, could not be accessed for
some reason, or some error occurred 0 is returned.
--
2.7.4
^ permalink raw reply related [flat|nested] 52+ messages in thread* [PATCH 34/51] Documentation: fe_property_parameters.rst: improve descriptions
2016-07-04 11:46 [PATCH 00/51] First part of documentation fixups Mauro Carvalho Chehab
` (32 preceding siblings ...)
2016-07-04 11:46 ` [PATCH 33/51] Documentation: linux_tv: fix some warnings due to '*' Mauro Carvalho Chehab
@ 2016-07-04 11:46 ` Mauro Carvalho Chehab
2016-07-04 11:46 ` [PATCH 35/51] Documentation: vidioc-g-edid.rst remove a duplicate declaration Mauro Carvalho Chehab
` (16 subsequent siblings)
50 siblings, 0 replies; 52+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-04 11:46 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, Jonathan Corbet,
Markus Heiser, linux-doc
The asterisks cause parsing warnings with Sphinx:
Documentation/linux_tv/media/dvb/fe_property_parameters.rst:954: WARNING: Inline substitution_reference start-string without end-string.
/devel/v4l/patchwork/Documentation/linux_tv/media/dvb/fe_property_parameters.rst:993: WARNING: Inline emphasis start-string without end-string.
On the first warning, the ISDB-T layer enabled description is a
kind of ackward. Improve it.
For the second one, IMHO, it is clearer to use [A-C], as it
shows what are the real possibilities, than using asterisk.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
.../linux_tv/media/dvb/fe_property_parameters.rst | 34 +++++++++++-----------
1 file changed, 17 insertions(+), 17 deletions(-)
diff --git a/Documentation/linux_tv/media/dvb/fe_property_parameters.rst b/Documentation/linux_tv/media/dvb/fe_property_parameters.rst
index cf8514d79a20..788dbfef0061 100644
--- a/Documentation/linux_tv/media/dvb/fe_property_parameters.rst
+++ b/Documentation/linux_tv/media/dvb/fe_property_parameters.rst
@@ -918,8 +918,8 @@ Note: This value cannot be determined by an automatic channel search.
.. _isdb-hierq-layers:
-DTV-ISDBT-LAYER* parameters
-===========================
+DTV-ISDBT-LAYER[A-C] parameters
+===============================
ISDB-T channels can be coded hierarchically. As opposed to DVB-T in
ISDB-T hierarchical layers can be decoded simultaneously. For that
@@ -951,21 +951,21 @@ In ISDB-Tsb only layer A is used, it can be 1 or 3 in ISDB-Tsb according
to ``DTV_ISDBT_PARTIAL_RECEPTION``. ``SEGMENT_COUNT`` must be filled
accordingly.
-Possible values: 0x1, 0x2, 0x4 (|-able)
+Only the values of the first 3 bits are used. Other bits will be silently ignored:
-``DTV_ISDBT_LAYER_ENABLED[0:0]`` - layer A
+``DTV_ISDBT_LAYER_ENABLED`` bit 0: layer A enabled
-``DTV_ISDBT_LAYER_ENABLED[1:1]`` - layer B
+``DTV_ISDBT_LAYER_ENABLED`` bit 1: layer B enabled
-``DTV_ISDBT_LAYER_ENABLED[2:2]`` - layer C
+``DTV_ISDBT_LAYER_ENABLED`` bit 2: layer C enabled
-``DTV_ISDBT_LAYER_ENABLED[31:3]`` unused
+``DTV_ISDBT_LAYER_ENABLED`` bits 3-31: unused
.. _DTV-ISDBT-LAYER-FEC:
-DTV_ISDBT_LAYER*_FEC
---------------------
+DTV_ISDBT_LAYER[A-C]_FEC
+------------------------
Possible values: ``FEC_AUTO``, ``FEC_1_2``, ``FEC_2_3``, ``FEC_3_4``,
``FEC_5_6``, ``FEC_7_8``
@@ -973,8 +973,8 @@ Possible values: ``FEC_AUTO``, ``FEC_1_2``, ``FEC_2_3``, ``FEC_3_4``,
.. _DTV-ISDBT-LAYER-MODULATION:
-DTV_ISDBT_LAYER*_MODULATION
----------------------------
+DTV_ISDBT_LAYER[A-C]_MODULATION
+-------------------------------
Possible values: ``QAM_AUTO``, QP\ ``SK, QAM_16``, ``QAM_64``, ``DQPSK``
@@ -985,13 +985,13 @@ Note: If layer C is ``DQPSK`` layer B has to be ``DQPSK``. If layer B is
.. _DTV-ISDBT-LAYER-SEGMENT-COUNT:
-DTV_ISDBT_LAYER*_SEGMENT_COUNT
-------------------------------
+DTV_ISDBT_LAYER[A-C]_SEGMENT_COUNT
+----------------------------------
Possible values: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, -1 (AUTO)
Note: Truth table for ``DTV_ISDBT_SOUND_BROADCASTING`` and
-``DTV_ISDBT_PARTIAL_RECEPTION`` and ``LAYER`` *_SEGMENT_COUNT
+``DTV_ISDBT_PARTIAL_RECEPTION`` and ``LAYER[A-C]_SEGMENT_COUNT``
.. _isdbt-layer_seg-cnt-table:
@@ -1075,8 +1075,8 @@ Note: Truth table for ``DTV_ISDBT_SOUND_BROADCASTING`` and
.. _DTV-ISDBT-LAYER-TIME-INTERLEAVING:
-DTV_ISDBT_LAYER*_TIME_INTERLEAVING
-----------------------------------
+DTV_ISDBT_LAYER[A-C]_TIME_INTERLEAVING
+--------------------------------------
Valid values: 0, 1, 2, 4, -1 (AUTO)
@@ -1096,7 +1096,7 @@ TMCC-structure, as shown in the table below.
- .. row 1
- - DTV_ISDBT_LAYER*_TIME_INTERLEAVING
+ - ``DTV_ISDBT_LAYER[A-C]_TIME_INTERLEAVING``
- Mode 1 (2K FFT)
--
2.7.4
^ permalink raw reply related [flat|nested] 52+ messages in thread* [PATCH 35/51] Documentation: vidioc-g-edid.rst remove a duplicate declaration
2016-07-04 11:46 [PATCH 00/51] First part of documentation fixups Mauro Carvalho Chehab
` (33 preceding siblings ...)
2016-07-04 11:46 ` [PATCH 34/51] Documentation: fe_property_parameters.rst: improve descriptions Mauro Carvalho Chehab
@ 2016-07-04 11:46 ` Mauro Carvalho Chehab
2016-07-04 11:46 ` [PATCH 36/51] Documentation: open.rst: fix some warnings Mauro Carvalho Chehab
` (15 subsequent siblings)
50 siblings, 0 replies; 52+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-04 11:46 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, Jonathan Corbet,
Markus Heiser, linux-doc
The ioctl is declared twice. This causes the following warning:
/devel/v4l/patchwork/Documentation/linux_tv/media/v4l/vidioc-g-edid.rst:7:
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
Documentation/linux_tv/media/v4l/vidioc-g-edid.rst | 2 --
1 file changed, 2 deletions(-)
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-edid.rst b/Documentation/linux_tv/media/v4l/vidioc-g-edid.rst
index b7d56ba0032a..26332ceb8b94 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-edid.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-edid.rst
@@ -19,8 +19,6 @@ Synopsis
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_edid *argp )
-.. cpp:function:: int ioctl( int fd, int request, struct v4l2_edid *argp )
-
Arguments
=========
--
2.7.4
^ permalink raw reply related [flat|nested] 52+ messages in thread* [PATCH 36/51] Documentation: open.rst: fix some warnings
2016-07-04 11:46 [PATCH 00/51] First part of documentation fixups Mauro Carvalho Chehab
` (34 preceding siblings ...)
2016-07-04 11:46 ` [PATCH 35/51] Documentation: vidioc-g-edid.rst remove a duplicate declaration Mauro Carvalho Chehab
@ 2016-07-04 11:46 ` Mauro Carvalho Chehab
2016-07-04 11:46 ` [PATCH 37/51] Documentation: rw.rst fix a warning Mauro Carvalho Chehab
` (14 subsequent siblings)
50 siblings, 0 replies; 52+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-04 11:46 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, Jonathan Corbet,
Markus Heiser, linux-doc
Fix those warnings:
Documentation/linux_tv/media/v4l/open.rst:38: WARNING: Literal block ends without a blank line; unexpected unindent.
Documentation/linux_tv/media/v4l/open.rst:45: WARNING: Literal block ends without a blank line; unexpected unindent.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
Documentation/linux_tv/media/v4l/open.rst | 8 +++-----
1 file changed, 3 insertions(+), 5 deletions(-)
diff --git a/Documentation/linux_tv/media/v4l/open.rst b/Documentation/linux_tv/media/v4l/open.rst
index 963d2923aaa3..83f406957cf4 100644
--- a/Documentation/linux_tv/media/v4l/open.rst
+++ b/Documentation/linux_tv/media/v4l/open.rst
@@ -30,18 +30,16 @@ of leaving it to chance. When the driver supports multiple devices of
the same type more than one device node number can be assigned,
separated by commas:
+.. code-block:: none
+ # modprobe mydriver video_nr=0,1 radio_nr=0,1
-::
-
- > modprobe mydriver video_nr=0,1 radio_nr=0,1
In ``/etc/modules.conf`` this may be written as:
-
-
::
options mydriver video_nr=0,1 radio_nr=0,1
+
When no device node number is given as module option the driver supplies
a default.
--
2.7.4
^ permalink raw reply related [flat|nested] 52+ messages in thread* [PATCH 37/51] Documentation: rw.rst fix a warning
2016-07-04 11:46 [PATCH 00/51] First part of documentation fixups Mauro Carvalho Chehab
` (35 preceding siblings ...)
2016-07-04 11:46 ` [PATCH 36/51] Documentation: open.rst: fix some warnings Mauro Carvalho Chehab
@ 2016-07-04 11:46 ` Mauro Carvalho Chehab
2016-07-04 11:46 ` [PATCH 38/51] Documentation: extended-controls.rst: "count" is a constant Mauro Carvalho Chehab
` (13 subsequent siblings)
50 siblings, 0 replies; 52+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-04 11:46 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, Jonathan Corbet,
Markus Heiser, linux-doc
Fix this Sphinx warning:
Documentation/linux_tv/media/v4l/rw.rst:31: WARNING: Literal block ends without a blank line; unexpected unindent.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
Documentation/linux_tv/media/v4l/rw.rst | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/Documentation/linux_tv/media/v4l/rw.rst b/Documentation/linux_tv/media/v4l/rw.rst
index c840ee0fd14c..beab37eccb1a 100644
--- a/Documentation/linux_tv/media/v4l/rw.rst
+++ b/Documentation/linux_tv/media/v4l/rw.rst
@@ -23,11 +23,11 @@ setup to exchange data. It permits command line stunts like this (the
vidctrl tool is fictitious):
+.. code-block:: none
-::
+ $ vidctrl /dev/video --input=0 --format=YUYV --size=352x288
+ $ dd if=/dev/video of=myimage.422 bs=202752 count=1
- > vidctrl /dev/video --input=0 --format=YUYV --size=352x288
- > dd if=/dev/video of=myimage.422 bs=202752 count=1
To read from the device applications use the :ref:`read() <func-read>`
function, to write the :ref:`write() <func-write>` function. Drivers
must implement one I/O method if they exchange data with applications,
--
2.7.4
^ permalink raw reply related [flat|nested] 52+ messages in thread* [PATCH 38/51] Documentation: extended-controls.rst: "count" is a constant
2016-07-04 11:46 [PATCH 00/51] First part of documentation fixups Mauro Carvalho Chehab
` (36 preceding siblings ...)
2016-07-04 11:46 ` [PATCH 37/51] Documentation: rw.rst fix a warning Mauro Carvalho Chehab
@ 2016-07-04 11:46 ` Mauro Carvalho Chehab
2016-07-04 11:47 ` [PATCH 39/51] Documentation: pixfmt-004.rst: Add an extra reference Mauro Carvalho Chehab
` (12 subsequent siblings)
50 siblings, 0 replies; 52+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-04 11:46 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, Jonathan Corbet,
Markus Heiser, linux-doc
Constify the string "count" where it means a field.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
Documentation/linux_tv/media/v4l/extended-controls.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/Documentation/linux_tv/media/v4l/extended-controls.rst b/Documentation/linux_tv/media/v4l/extended-controls.rst
index 50598b479273..413f6ca8eb60 100644
--- a/Documentation/linux_tv/media/v4l/extended-controls.rst
+++ b/Documentation/linux_tv/media/v4l/extended-controls.rst
@@ -61,7 +61,7 @@ relating to MPEG encoding, etc.
All controls in the control array must belong to the specified control
class. An error is returned if this is not the case.
-It is also possible to use an empty control array (count == 0) to check
+It is also possible to use an empty control array (``count`` == 0) to check
whether the specified control class is supported.
The control array is a struct
--
2.7.4
^ permalink raw reply related [flat|nested] 52+ messages in thread* [PATCH 39/51] Documentation: pixfmt-004.rst: Add an extra reference
2016-07-04 11:46 [PATCH 00/51] First part of documentation fixups Mauro Carvalho Chehab
` (37 preceding siblings ...)
2016-07-04 11:46 ` [PATCH 38/51] Documentation: extended-controls.rst: "count" is a constant Mauro Carvalho Chehab
@ 2016-07-04 11:47 ` Mauro Carvalho Chehab
2016-07-04 11:47 ` [PATCH 40/51] Documentation: linux_tv: remove trailing comments Mauro Carvalho Chehab
` (11 subsequent siblings)
50 siblings, 0 replies; 52+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-04 11:47 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, Jonathan Corbet,
Markus Heiser, linux-doc
One paragraph mentions the YUV422 formats, but doesn't provide
a cross-ref. Add it.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
Documentation/linux_tv/media/v4l/pixfmt-004.rst | 12 ++++++------
1 file changed, 6 insertions(+), 6 deletions(-)
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-004.rst b/Documentation/linux_tv/media/v4l/pixfmt-004.rst
index a5599b44fd5d..86d4975a95c9 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-004.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-004.rst
@@ -43,12 +43,12 @@ world.
For some formats, data is stored in separate, discontiguous memory
buffers. Those formats are identified by a separate set of FourCC codes
-and are referred to as "multi-planar formats". For example, a YUV422
-frame is normally stored in one memory buffer, but it can also be placed
-in two or three separate buffers, with Y component in one buffer and
-CbCr components in another in the 2-planar version or with each
-component in its own buffer in the 3-planar case. Those sub-buffers are
-referred to as "planes".
+and are referred to as "multi-planar formats". For example, a
+:ref:`YUV422 <V4L2-PIX-FMT-YUV422M>` frame is normally stored in one
+memory buffer, but it can also be placed in two or three separate
+buffers, with Y component in one buffer and CbCr components in another
+in the 2-planar version or with each component in its own buffer in the
+3-planar case. Those sub-buffers are referred to as "*planes*".
.. ------------------------------------------------------------------------------
--
2.7.4
^ permalink raw reply related [flat|nested] 52+ messages in thread* [PATCH 40/51] Documentation: linux_tv: remove trailing comments
2016-07-04 11:46 [PATCH 00/51] First part of documentation fixups Mauro Carvalho Chehab
` (38 preceding siblings ...)
2016-07-04 11:47 ` [PATCH 39/51] Documentation: pixfmt-004.rst: Add an extra reference Mauro Carvalho Chehab
@ 2016-07-04 11:47 ` Mauro Carvalho Chehab
2016-07-04 11:47 ` [PATCH 41/51] Documentation: pixfmt-y12i.rst: correct format conversion Mauro Carvalho Chehab
` (10 subsequent siblings)
50 siblings, 0 replies; 52+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-04 11:47 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, Jonathan Corbet,
Markus Heiser, linux-doc
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #1: Type: text/plain; charset=true, Size: 275980 bytes --]
The conversion script added some comments at the end.
They point to the original DocBook files, with will be
removed after the manual fixes. So, they'll be pointing
to nowere. So, remove those comments.
They'll be forever stored at the Kernel tree. So, if
someone wants the references, it is just a matter of
looking at the backlog.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
Documentation/linux_tv/audio.h.rst | 11 -----------
Documentation/linux_tv/ca.h.rst | 11 -----------
Documentation/linux_tv/dmx.h.rst | 11 -----------
Documentation/linux_tv/frontend.h.rst | 11 -----------
Documentation/linux_tv/index.rst | 12 ------------
.../linux_tv/media/dvb/FE_DISHNETWORK_SEND_LEGACY_CMD.rst | 9 ---------
Documentation/linux_tv/media/dvb/FE_GET_EVENT.rst | 11 -----------
Documentation/linux_tv/media/dvb/FE_GET_FRONTEND.rst | 11 -----------
Documentation/linux_tv/media/dvb/FE_READ_BER.rst | 9 ---------
Documentation/linux_tv/media/dvb/FE_READ_SIGNAL_STRENGTH.rst | 9 ---------
Documentation/linux_tv/media/dvb/FE_READ_SNR.rst | 9 ---------
.../linux_tv/media/dvb/FE_READ_UNCORRECTED_BLOCKS.rst | 9 ---------
Documentation/linux_tv/media/dvb/FE_SET_FRONTEND.rst | 11 -----------
Documentation/linux_tv/media/dvb/audio.rst | 11 -----------
Documentation/linux_tv/media/dvb/audio_data_types.rst | 11 -----------
Documentation/linux_tv/media/dvb/audio_function_calls.rst | 11 -----------
Documentation/linux_tv/media/dvb/audio_h.rst | 11 -----------
Documentation/linux_tv/media/dvb/ca.rst | 11 -----------
Documentation/linux_tv/media/dvb/ca_data_types.rst | 11 -----------
Documentation/linux_tv/media/dvb/ca_function_calls.rst | 9 ---------
Documentation/linux_tv/media/dvb/ca_h.rst | 11 -----------
Documentation/linux_tv/media/dvb/demux.rst | 11 -----------
Documentation/linux_tv/media/dvb/dmx_fcalls.rst | 9 ---------
Documentation/linux_tv/media/dvb/dmx_h.rst | 11 -----------
Documentation/linux_tv/media/dvb/dmx_types.rst | 11 -----------
Documentation/linux_tv/media/dvb/dtv-fe-stats.rst | 11 -----------
Documentation/linux_tv/media/dvb/dtv-properties.rst | 11 -----------
Documentation/linux_tv/media/dvb/dtv-property.rst | 11 -----------
Documentation/linux_tv/media/dvb/dtv-stats.rst | 11 -----------
Documentation/linux_tv/media/dvb/dvb-fe-read-status.rst | 9 ---------
Documentation/linux_tv/media/dvb/dvb-frontend-event.rst | 11 -----------
Documentation/linux_tv/media/dvb/dvb-frontend-parameters.rst | 11 -----------
Documentation/linux_tv/media/dvb/dvbapi.rst | 9 ---------
Documentation/linux_tv/media/dvb/dvbproperty-006.rst | 9 ---------
Documentation/linux_tv/media/dvb/dvbproperty.rst | 11 -----------
Documentation/linux_tv/media/dvb/examples.rst | 11 -----------
Documentation/linux_tv/media/dvb/fe-bandwidth-t.rst | 11 -----------
.../linux_tv/media/dvb/fe-diseqc-recv-slave-reply.rst | 11 -----------
.../linux_tv/media/dvb/fe-diseqc-reset-overload.rst | 9 ---------
Documentation/linux_tv/media/dvb/fe-diseqc-send-burst.rst | 11 -----------
.../linux_tv/media/dvb/fe-diseqc-send-master-cmd.rst | 11 -----------
.../linux_tv/media/dvb/fe-enable-high-lnb-voltage.rst | 9 ---------
Documentation/linux_tv/media/dvb/fe-get-info.rst | 11 -----------
Documentation/linux_tv/media/dvb/fe-get-property.rst | 9 ---------
Documentation/linux_tv/media/dvb/fe-read-status.rst | 11 -----------
.../linux_tv/media/dvb/fe-set-frontend-tune-mode.rst | 9 ---------
Documentation/linux_tv/media/dvb/fe-set-tone.rst | 11 -----------
Documentation/linux_tv/media/dvb/fe-set-voltage.rst | 9 ---------
Documentation/linux_tv/media/dvb/fe-type-t.rst | 9 ---------
Documentation/linux_tv/media/dvb/fe_property_parameters.rst | 9 ---------
.../linux_tv/media/dvb/frontend-property-cable-systems.rst | 9 ---------
.../media/dvb/frontend-property-satellite-systems.rst | 9 ---------
.../media/dvb/frontend-property-terrestrial-systems.rst | 9 ---------
.../linux_tv/media/dvb/frontend-stat-properties.rst | 9 ---------
Documentation/linux_tv/media/dvb/frontend.rst | 11 -----------
Documentation/linux_tv/media/dvb/frontend_f_close.rst | 9 ---------
Documentation/linux_tv/media/dvb/frontend_f_open.rst | 9 ---------
Documentation/linux_tv/media/dvb/frontend_fcalls.rst | 11 -----------
Documentation/linux_tv/media/dvb/frontend_h.rst | 11 -----------
Documentation/linux_tv/media/dvb/frontend_legacy_api.rst | 11 -----------
.../linux_tv/media/dvb/frontend_legacy_dvbv3_api.rst | 11 -----------
Documentation/linux_tv/media/dvb/intro.rst | 9 ---------
Documentation/linux_tv/media/dvb/legacy_dvb_apis.rst | 11 -----------
Documentation/linux_tv/media/dvb/net.rst | 9 ---------
Documentation/linux_tv/media/dvb/net_h.rst | 11 -----------
Documentation/linux_tv/media/dvb/query-dvb-frontend-info.rst | 9 ---------
Documentation/linux_tv/media/dvb/video.rst | 11 -----------
Documentation/linux_tv/media/dvb/video_function_calls.rst | 11 -----------
Documentation/linux_tv/media/dvb/video_h.rst | 11 -----------
Documentation/linux_tv/media/dvb/video_types.rst | 11 -----------
.../linux_tv/media/v4l/Remote_controllers_Intro.rst | 9 ---------
.../linux_tv/media/v4l/Remote_controllers_table_change.rst | 11 -----------
.../linux_tv/media/v4l/Remote_controllers_tables.rst | 11 -----------
Documentation/linux_tv/media/v4l/app-pri.rst | 9 ---------
Documentation/linux_tv/media/v4l/async.rst | 9 ---------
Documentation/linux_tv/media/v4l/audio.rst | 9 ---------
Documentation/linux_tv/media/v4l/biblio.rst | 9 ---------
Documentation/linux_tv/media/v4l/buffer.rst | 11 -----------
Documentation/linux_tv/media/v4l/capture-example.rst | 11 -----------
Documentation/linux_tv/media/v4l/capture.c.rst | 11 -----------
Documentation/linux_tv/media/v4l/colorspaces.rst | 9 ---------
Documentation/linux_tv/media/v4l/common-defs.rst | 11 -----------
Documentation/linux_tv/media/v4l/common.rst | 11 -----------
Documentation/linux_tv/media/v4l/compat.rst | 11 -----------
Documentation/linux_tv/media/v4l/control.rst | 9 ---------
Documentation/linux_tv/media/v4l/crop.rst | 9 ---------
Documentation/linux_tv/media/v4l/depth-formats.rst | 11 -----------
Documentation/linux_tv/media/v4l/dev-capture.rst | 9 ---------
Documentation/linux_tv/media/v4l/dev-codec.rst | 9 ---------
Documentation/linux_tv/media/v4l/dev-effect.rst | 9 ---------
Documentation/linux_tv/media/v4l/dev-event.rst | 9 ---------
Documentation/linux_tv/media/v4l/dev-osd.rst | 9 ---------
Documentation/linux_tv/media/v4l/dev-output.rst | 9 ---------
Documentation/linux_tv/media/v4l/dev-overlay.rst | 9 ---------
Documentation/linux_tv/media/v4l/dev-radio.rst | 9 ---------
Documentation/linux_tv/media/v4l/dev-raw-vbi.rst | 9 ---------
Documentation/linux_tv/media/v4l/dev-rds.rst | 11 -----------
Documentation/linux_tv/media/v4l/dev-sdr.rst | 9 ---------
Documentation/linux_tv/media/v4l/dev-sliced-vbi.rst | 9 ---------
Documentation/linux_tv/media/v4l/dev-subdev.rst | 11 -----------
Documentation/linux_tv/media/v4l/dev-teletext.rst | 9 ---------
Documentation/linux_tv/media/v4l/devices.rst | 11 -----------
Documentation/linux_tv/media/v4l/diff-v4l.rst | 9 ---------
Documentation/linux_tv/media/v4l/dmabuf.rst | 9 ---------
Documentation/linux_tv/media/v4l/driver.rst | 9 ---------
Documentation/linux_tv/media/v4l/dv-timings.rst | 9 ---------
Documentation/linux_tv/media/v4l/extended-controls.rst | 9 ---------
Documentation/linux_tv/media/v4l/fdl-appendix.rst | 9 ---------
Documentation/linux_tv/media/v4l/field-order.rst | 11 -----------
Documentation/linux_tv/media/v4l/format.rst | 9 ---------
Documentation/linux_tv/media/v4l/func-close.rst | 9 ---------
Documentation/linux_tv/media/v4l/func-ioctl.rst | 9 ---------
Documentation/linux_tv/media/v4l/func-mmap.rst | 9 ---------
Documentation/linux_tv/media/v4l/func-munmap.rst | 9 ---------
Documentation/linux_tv/media/v4l/func-open.rst | 9 ---------
Documentation/linux_tv/media/v4l/func-poll.rst | 9 ---------
Documentation/linux_tv/media/v4l/func-read.rst | 9 ---------
Documentation/linux_tv/media/v4l/func-select.rst | 9 ---------
Documentation/linux_tv/media/v4l/func-write.rst | 9 ---------
Documentation/linux_tv/media/v4l/gen-errors.rst | 9 ---------
Documentation/linux_tv/media/v4l/hist-v4l2.rst | 9 ---------
Documentation/linux_tv/media/v4l/io.rst | 11 -----------
Documentation/linux_tv/media/v4l/keytable.c.rst | 11 -----------
Documentation/linux_tv/media/v4l/libv4l-introduction.rst | 9 ---------
Documentation/linux_tv/media/v4l/libv4l.rst | 11 -----------
Documentation/linux_tv/media/v4l/lirc_dev_intro.rst | 9 ---------
Documentation/linux_tv/media/v4l/lirc_device_interface.rst | 11 -----------
Documentation/linux_tv/media/v4l/lirc_ioctl.rst | 9 ---------
Documentation/linux_tv/media/v4l/lirc_read.rst | 9 ---------
Documentation/linux_tv/media/v4l/lirc_write.rst | 9 ---------
Documentation/linux_tv/media/v4l/media-controller-intro.rst | 9 ---------
Documentation/linux_tv/media/v4l/media-controller-model.rst | 9 ---------
Documentation/linux_tv/media/v4l/media-controller.rst | 9 ---------
Documentation/linux_tv/media/v4l/media-func-close.rst | 9 ---------
Documentation/linux_tv/media/v4l/media-func-ioctl.rst | 9 ---------
Documentation/linux_tv/media/v4l/media-func-open.rst | 9 ---------
Documentation/linux_tv/media/v4l/media-ioc-device-info.rst | 9 ---------
Documentation/linux_tv/media/v4l/media-ioc-enum-entities.rst | 9 ---------
Documentation/linux_tv/media/v4l/media-ioc-enum-links.rst | 9 ---------
Documentation/linux_tv/media/v4l/media-ioc-g-topology.rst | 9 ---------
Documentation/linux_tv/media/v4l/media-ioc-setup-link.rst | 9 ---------
Documentation/linux_tv/media/v4l/media-types.rst | 11 -----------
Documentation/linux_tv/media/v4l/mmap.rst | 9 ---------
Documentation/linux_tv/media/v4l/open.rst | 9 ---------
Documentation/linux_tv/media/v4l/pixfmt-002.rst | 11 -----------
Documentation/linux_tv/media/v4l/pixfmt-003.rst | 11 -----------
Documentation/linux_tv/media/v4l/pixfmt-004.rst | 9 ---------
Documentation/linux_tv/media/v4l/pixfmt-006.rst | 11 -----------
Documentation/linux_tv/media/v4l/pixfmt-007.rst | 9 ---------
Documentation/linux_tv/media/v4l/pixfmt-008.rst | 9 ---------
Documentation/linux_tv/media/v4l/pixfmt-013.rst | 11 -----------
Documentation/linux_tv/media/v4l/pixfmt-grey.rst | 11 -----------
Documentation/linux_tv/media/v4l/pixfmt-indexed.rst | 11 -----------
Documentation/linux_tv/media/v4l/pixfmt-m420.rst | 11 -----------
Documentation/linux_tv/media/v4l/pixfmt-nv12.rst | 11 -----------
Documentation/linux_tv/media/v4l/pixfmt-nv12m.rst | 11 -----------
Documentation/linux_tv/media/v4l/pixfmt-nv12mt.rst | 9 ---------
Documentation/linux_tv/media/v4l/pixfmt-nv16.rst | 11 -----------
Documentation/linux_tv/media/v4l/pixfmt-nv16m.rst | 11 -----------
Documentation/linux_tv/media/v4l/pixfmt-nv24.rst | 11 -----------
Documentation/linux_tv/media/v4l/pixfmt-packed-rgb.rst | 9 ---------
Documentation/linux_tv/media/v4l/pixfmt-packed-yuv.rst | 9 ---------
Documentation/linux_tv/media/v4l/pixfmt-reserved.rst | 11 -----------
Documentation/linux_tv/media/v4l/pixfmt-rgb.rst | 11 -----------
Documentation/linux_tv/media/v4l/pixfmt-sbggr16.rst | 11 -----------
Documentation/linux_tv/media/v4l/pixfmt-sbggr8.rst | 11 -----------
Documentation/linux_tv/media/v4l/pixfmt-sdr-cs08.rst | 11 -----------
Documentation/linux_tv/media/v4l/pixfmt-sdr-cs14le.rst | 11 -----------
Documentation/linux_tv/media/v4l/pixfmt-sdr-cu08.rst | 11 -----------
Documentation/linux_tv/media/v4l/pixfmt-sdr-cu16le.rst | 11 -----------
Documentation/linux_tv/media/v4l/pixfmt-sdr-ru12le.rst | 11 -----------
Documentation/linux_tv/media/v4l/pixfmt-sgbrg8.rst | 11 -----------
Documentation/linux_tv/media/v4l/pixfmt-sgrbg8.rst | 11 -----------
Documentation/linux_tv/media/v4l/pixfmt-srggb10.rst | 11 -----------
Documentation/linux_tv/media/v4l/pixfmt-srggb10alaw8.rst | 9 ---------
Documentation/linux_tv/media/v4l/pixfmt-srggb10dpcm8.rst | 9 ---------
Documentation/linux_tv/media/v4l/pixfmt-srggb10p.rst | 11 -----------
Documentation/linux_tv/media/v4l/pixfmt-srggb12.rst | 11 -----------
Documentation/linux_tv/media/v4l/pixfmt-srggb8.rst | 11 -----------
Documentation/linux_tv/media/v4l/pixfmt-uv8.rst | 11 -----------
Documentation/linux_tv/media/v4l/pixfmt-uyvy.rst | 11 -----------
Documentation/linux_tv/media/v4l/pixfmt-vyuy.rst | 11 -----------
Documentation/linux_tv/media/v4l/pixfmt-y10.rst | 11 -----------
Documentation/linux_tv/media/v4l/pixfmt-y10b.rst | 11 -----------
Documentation/linux_tv/media/v4l/pixfmt-y12.rst | 11 -----------
Documentation/linux_tv/media/v4l/pixfmt-y12i.rst | 11 -----------
Documentation/linux_tv/media/v4l/pixfmt-y16-be.rst | 11 -----------
Documentation/linux_tv/media/v4l/pixfmt-y16.rst | 11 -----------
Documentation/linux_tv/media/v4l/pixfmt-y41p.rst | 11 -----------
Documentation/linux_tv/media/v4l/pixfmt-y8i.rst | 11 -----------
Documentation/linux_tv/media/v4l/pixfmt-yuv410.rst | 11 -----------
Documentation/linux_tv/media/v4l/pixfmt-yuv411p.rst | 11 -----------
Documentation/linux_tv/media/v4l/pixfmt-yuv420.rst | 11 -----------
Documentation/linux_tv/media/v4l/pixfmt-yuv420m.rst | 11 -----------
Documentation/linux_tv/media/v4l/pixfmt-yuv422m.rst | 11 -----------
Documentation/linux_tv/media/v4l/pixfmt-yuv422p.rst | 11 -----------
Documentation/linux_tv/media/v4l/pixfmt-yuv444m.rst | 11 -----------
Documentation/linux_tv/media/v4l/pixfmt-yuyv.rst | 11 -----------
Documentation/linux_tv/media/v4l/pixfmt-yvyu.rst | 11 -----------
Documentation/linux_tv/media/v4l/pixfmt-z16.rst | 11 -----------
Documentation/linux_tv/media/v4l/pixfmt.rst | 11 -----------
Documentation/linux_tv/media/v4l/planar-apis.rst | 9 ---------
Documentation/linux_tv/media/v4l/querycap.rst | 9 ---------
Documentation/linux_tv/media/v4l/remote_controllers.rst | 9 ---------
.../linux_tv/media/v4l/remote_controllers_sysfs_nodes.rst | 9 ---------
Documentation/linux_tv/media/v4l/rw.rst | 9 ---------
Documentation/linux_tv/media/v4l/sdr-formats.rst | 11 -----------
Documentation/linux_tv/media/v4l/selection-api-002.rst | 9 ---------
Documentation/linux_tv/media/v4l/selection-api-003.rst | 9 ---------
Documentation/linux_tv/media/v4l/selection-api-004.rst | 9 ---------
Documentation/linux_tv/media/v4l/selection-api-005.rst | 9 ---------
Documentation/linux_tv/media/v4l/selection-api-006.rst | 11 -----------
Documentation/linux_tv/media/v4l/selection-api.rst | 11 -----------
Documentation/linux_tv/media/v4l/selections-common.rst | 11 -----------
Documentation/linux_tv/media/v4l/standard.rst | 9 ---------
Documentation/linux_tv/media/v4l/streaming-par.rst | 9 ---------
Documentation/linux_tv/media/v4l/subdev-formats.rst | 11 -----------
Documentation/linux_tv/media/v4l/tuner.rst | 9 ---------
Documentation/linux_tv/media/v4l/user-func.rst | 11 -----------
Documentation/linux_tv/media/v4l/userp.rst | 9 ---------
Documentation/linux_tv/media/v4l/v4l2-selection-flags.rst | 11 -----------
Documentation/linux_tv/media/v4l/v4l2-selection-targets.rst | 11 -----------
Documentation/linux_tv/media/v4l/v4l2.rst | 9 ---------
Documentation/linux_tv/media/v4l/v4l2grab-example.rst | 11 -----------
Documentation/linux_tv/media/v4l/v4l2grab.c.rst | 11 -----------
Documentation/linux_tv/media/v4l/video.rst | 11 -----------
Documentation/linux_tv/media/v4l/videodev.rst | 11 -----------
Documentation/linux_tv/media/v4l/vidioc-create-bufs.rst | 9 ---------
Documentation/linux_tv/media/v4l/vidioc-cropcap.rst | 9 ---------
Documentation/linux_tv/media/v4l/vidioc-dbg-g-chip-info.rst | 9 ---------
Documentation/linux_tv/media/v4l/vidioc-dbg-g-register.rst | 9 ---------
Documentation/linux_tv/media/v4l/vidioc-decoder-cmd.rst | 9 ---------
Documentation/linux_tv/media/v4l/vidioc-dqevent.rst | 9 ---------
Documentation/linux_tv/media/v4l/vidioc-dv-timings-cap.rst | 9 ---------
Documentation/linux_tv/media/v4l/vidioc-encoder-cmd.rst | 9 ---------
Documentation/linux_tv/media/v4l/vidioc-enum-dv-timings.rst | 9 ---------
Documentation/linux_tv/media/v4l/vidioc-enum-fmt.rst | 9 ---------
.../linux_tv/media/v4l/vidioc-enum-frameintervals.rst | 9 ---------
Documentation/linux_tv/media/v4l/vidioc-enum-framesizes.rst | 9 ---------
Documentation/linux_tv/media/v4l/vidioc-enum-freq-bands.rst | 9 ---------
Documentation/linux_tv/media/v4l/vidioc-enumaudio.rst | 9 ---------
Documentation/linux_tv/media/v4l/vidioc-enumaudioout.rst | 9 ---------
Documentation/linux_tv/media/v4l/vidioc-enuminput.rst | 9 ---------
Documentation/linux_tv/media/v4l/vidioc-enumoutput.rst | 9 ---------
Documentation/linux_tv/media/v4l/vidioc-enumstd.rst | 9 ---------
Documentation/linux_tv/media/v4l/vidioc-expbuf.rst | 9 ---------
Documentation/linux_tv/media/v4l/vidioc-g-audio.rst | 9 ---------
Documentation/linux_tv/media/v4l/vidioc-g-audioout.rst | 9 ---------
Documentation/linux_tv/media/v4l/vidioc-g-crop.rst | 9 ---------
Documentation/linux_tv/media/v4l/vidioc-g-ctrl.rst | 9 ---------
Documentation/linux_tv/media/v4l/vidioc-g-dv-timings.rst | 11 -----------
Documentation/linux_tv/media/v4l/vidioc-g-edid.rst | 9 ---------
Documentation/linux_tv/media/v4l/vidioc-g-enc-index.rst | 9 ---------
Documentation/linux_tv/media/v4l/vidioc-g-ext-ctrls.rst | 9 ---------
Documentation/linux_tv/media/v4l/vidioc-g-fbuf.rst | 9 ---------
Documentation/linux_tv/media/v4l/vidioc-g-fmt.rst | 9 ---------
Documentation/linux_tv/media/v4l/vidioc-g-frequency.rst | 9 ---------
Documentation/linux_tv/media/v4l/vidioc-g-input.rst | 9 ---------
Documentation/linux_tv/media/v4l/vidioc-g-jpegcomp.rst | 9 ---------
Documentation/linux_tv/media/v4l/vidioc-g-modulator.rst | 9 ---------
Documentation/linux_tv/media/v4l/vidioc-g-output.rst | 9 ---------
Documentation/linux_tv/media/v4l/vidioc-g-parm.rst | 9 ---------
Documentation/linux_tv/media/v4l/vidioc-g-priority.rst | 9 ---------
Documentation/linux_tv/media/v4l/vidioc-g-selection.rst | 9 ---------
Documentation/linux_tv/media/v4l/vidioc-g-sliced-vbi-cap.rst | 9 ---------
Documentation/linux_tv/media/v4l/vidioc-g-std.rst | 9 ---------
Documentation/linux_tv/media/v4l/vidioc-g-tuner.rst | 9 ---------
Documentation/linux_tv/media/v4l/vidioc-log-status.rst | 9 ---------
Documentation/linux_tv/media/v4l/vidioc-overlay.rst | 9 ---------
Documentation/linux_tv/media/v4l/vidioc-prepare-buf.rst | 9 ---------
Documentation/linux_tv/media/v4l/vidioc-qbuf.rst | 9 ---------
Documentation/linux_tv/media/v4l/vidioc-query-dv-timings.rst | 9 ---------
Documentation/linux_tv/media/v4l/vidioc-querybuf.rst | 9 ---------
Documentation/linux_tv/media/v4l/vidioc-querycap.rst | 9 ---------
Documentation/linux_tv/media/v4l/vidioc-queryctrl.rst | 9 ---------
Documentation/linux_tv/media/v4l/vidioc-querystd.rst | 9 ---------
Documentation/linux_tv/media/v4l/vidioc-reqbufs.rst | 9 ---------
Documentation/linux_tv/media/v4l/vidioc-s-hw-freq-seek.rst | 9 ---------
Documentation/linux_tv/media/v4l/vidioc-streamon.rst | 9 ---------
.../linux_tv/media/v4l/vidioc-subdev-enum-frame-interval.rst | 9 ---------
.../linux_tv/media/v4l/vidioc-subdev-enum-frame-size.rst | 9 ---------
.../linux_tv/media/v4l/vidioc-subdev-enum-mbus-code.rst | 9 ---------
Documentation/linux_tv/media/v4l/vidioc-subdev-g-crop.rst | 9 ---------
Documentation/linux_tv/media/v4l/vidioc-subdev-g-fmt.rst | 9 ---------
.../linux_tv/media/v4l/vidioc-subdev-g-frame-interval.rst | 9 ---------
.../linux_tv/media/v4l/vidioc-subdev-g-selection.rst | 9 ---------
Documentation/linux_tv/media/v4l/vidioc-subscribe-event.rst | 9 ---------
Documentation/linux_tv/media/v4l/yuv-formats.rst | 11 -----------
Documentation/linux_tv/net.h.rst | 11 -----------
Documentation/linux_tv/video.h.rst | 11 -----------
Documentation/linux_tv/videodev2.h.rst | 11 -----------
scripts/kernel-doc | 0
292 files changed, 2876 deletions(-)
mode change 100644 => 100755 scripts/kernel-doc
diff --git a/Documentation/linux_tv/audio.h.rst b/Documentation/linux_tv/audio.h.rst
index abf29027f8ea..1e76a866c01a 100644
--- a/Documentation/linux_tv/audio.h.rst
+++ b/Documentation/linux_tv/audio.h.rst
@@ -140,14 +140,3 @@ file: audio.h
#define AUDIO_BILINGUAL_CHANNEL_SELECT _IO('o', 20)
#endif /* _DVBAUDIO_H_ */
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/ca.h.rst b/Documentation/linux_tv/ca.h.rst
index b69ce287aa8c..0664c4bdd985 100644
--- a/Documentation/linux_tv/ca.h.rst
+++ b/Documentation/linux_tv/ca.h.rst
@@ -95,14 +95,3 @@ file: ca.h
#define CA_SET_PID _IOW('o', 135, ca_pid_t)
#endif
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/dmx.h.rst b/Documentation/linux_tv/dmx.h.rst
index 9ced07899e57..4791554f82f9 100644
--- a/Documentation/linux_tv/dmx.h.rst
+++ b/Documentation/linux_tv/dmx.h.rst
@@ -160,14 +160,3 @@ file: dmx.h
#define DMX_REMOVE_PID _IOW('o', 52, __u16)
#endif /* _UAPI_DVBDMX_H_ */
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/frontend.h.rst b/Documentation/linux_tv/frontend.h.rst
index 1b65b2037778..5c8f11a77c1e 100644
--- a/Documentation/linux_tv/frontend.h.rst
+++ b/Documentation/linux_tv/frontend.h.rst
@@ -607,14 +607,3 @@ file: frontend.h
#define FE_DISHNETWORK_SEND_LEGACY_CMD _IO('o', 80) /* unsigned int */
#endif /*_DVBFRONTEND_H_*/
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/index.rst b/Documentation/linux_tv/index.rst
index edb7d56e9b8f..821be82dcb23 100644
--- a/Documentation/linux_tv/index.rst
+++ b/Documentation/linux_tv/index.rst
@@ -75,18 +75,6 @@ etc, please mail to:
media/v4l/gen-errors
media/v4l/fdl-appendix
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
-
-
.. only:: html
Retrieval
diff --git a/Documentation/linux_tv/media/dvb/FE_DISHNETWORK_SEND_LEGACY_CMD.rst b/Documentation/linux_tv/media/dvb/FE_DISHNETWORK_SEND_LEGACY_CMD.rst
index a01cafad8d3c..890b5edb0350 100644
--- a/Documentation/linux_tv/media/dvb/FE_DISHNETWORK_SEND_LEGACY_CMD.rst
+++ b/Documentation/linux_tv/media/dvb/FE_DISHNETWORK_SEND_LEGACY_CMD.rst
@@ -44,12 +44,3 @@ RETURN VALUE
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/dvb/FE_GET_EVENT.rst b/Documentation/linux_tv/media/dvb/FE_GET_EVENT.rst
index 1951857cde65..08a090212f96 100644
--- a/Documentation/linux_tv/media/dvb/FE_GET_EVENT.rst
+++ b/Documentation/linux_tv/media/dvb/FE_GET_EVENT.rst
@@ -76,14 +76,3 @@ appropriately. The generic error codes are described at the
- ``EOVERFLOW``
- Overflow in event queue - one or more events were lost.
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/dvb/FE_GET_FRONTEND.rst b/Documentation/linux_tv/media/dvb/FE_GET_FRONTEND.rst
index 5bf39ff72bd7..ee73fb448ef8 100644
--- a/Documentation/linux_tv/media/dvb/FE_GET_FRONTEND.rst
+++ b/Documentation/linux_tv/media/dvb/FE_GET_FRONTEND.rst
@@ -64,14 +64,3 @@ appropriately. The generic error codes are described at the
- ``EINVAL``
- Maximum supported symbol rate reached.
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/dvb/FE_READ_BER.rst b/Documentation/linux_tv/media/dvb/FE_READ_BER.rst
index 935c0e50b0fd..218e2298615b 100644
--- a/Documentation/linux_tv/media/dvb/FE_READ_BER.rst
+++ b/Documentation/linux_tv/media/dvb/FE_READ_BER.rst
@@ -50,12 +50,3 @@ RETURN VALUE
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/dvb/FE_READ_SIGNAL_STRENGTH.rst b/Documentation/linux_tv/media/dvb/FE_READ_SIGNAL_STRENGTH.rst
index 01180e20e4d4..d2dd0fba5363 100644
--- a/Documentation/linux_tv/media/dvb/FE_READ_SIGNAL_STRENGTH.rst
+++ b/Documentation/linux_tv/media/dvb/FE_READ_SIGNAL_STRENGTH.rst
@@ -53,12 +53,3 @@ RETURN VALUE
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/dvb/FE_READ_SNR.rst b/Documentation/linux_tv/media/dvb/FE_READ_SNR.rst
index 0ccc7d71d8a4..2f9759a310f0 100644
--- a/Documentation/linux_tv/media/dvb/FE_READ_SNR.rst
+++ b/Documentation/linux_tv/media/dvb/FE_READ_SNR.rst
@@ -50,12 +50,3 @@ RETURN VALUE
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/dvb/FE_READ_UNCORRECTED_BLOCKS.rst b/Documentation/linux_tv/media/dvb/FE_READ_UNCORRECTED_BLOCKS.rst
index 3827c7b953e1..fa770d25b3de 100644
--- a/Documentation/linux_tv/media/dvb/FE_READ_UNCORRECTED_BLOCKS.rst
+++ b/Documentation/linux_tv/media/dvb/FE_READ_UNCORRECTED_BLOCKS.rst
@@ -55,12 +55,3 @@ RETURN VALUE
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/dvb/FE_SET_FRONTEND.rst b/Documentation/linux_tv/media/dvb/FE_SET_FRONTEND.rst
index 4cb393bbc2e1..794089897845 100644
--- a/Documentation/linux_tv/media/dvb/FE_SET_FRONTEND.rst
+++ b/Documentation/linux_tv/media/dvb/FE_SET_FRONTEND.rst
@@ -71,14 +71,3 @@ appropriately. The generic error codes are described at the
- ``EINVAL``
- Maximum supported symbol rate reached.
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/dvb/audio.rst b/Documentation/linux_tv/media/dvb/audio.rst
index d6b6f9edf3b3..155622185ea4 100644
--- a/Documentation/linux_tv/media/dvb/audio.rst
+++ b/Documentation/linux_tv/media/dvb/audio.rst
@@ -24,14 +24,3 @@ functionality.
audio_data_types
audio_function_calls
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/dvb/audio_data_types.rst b/Documentation/linux_tv/media/dvb/audio_data_types.rst
index b3f5aa0ac6e4..cf9216c91f2d 100644
--- a/Documentation/linux_tv/media/dvb/audio_data_types.rst
+++ b/Documentation/linux_tv/media/dvb/audio_data_types.rst
@@ -174,14 +174,3 @@ The following attributes can be set by a call to AUDIO_SET_ATTRIBUTES:
/* 7- 6 Quantization / DRC (mpeg audio: 1=DRC exists)(lpcm: 0=16bit, */
/* 5- 4 Sample frequency fs (0=48kHz, 1=96kHz) */
/* 2- 0 number of audio channels (n+1 channels) */
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/dvb/audio_function_calls.rst b/Documentation/linux_tv/media/dvb/audio_function_calls.rst
index d8abdd0e9417..b3408b7c4e91 100644
--- a/Documentation/linux_tv/media/dvb/audio_function_calls.rst
+++ b/Documentation/linux_tv/media/dvb/audio_function_calls.rst
@@ -1295,14 +1295,3 @@ appropriately. The generic error codes are described at the
- ``EINVAL``
- karaoke is not a valid or supported karaoke setting.
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/dvb/audio_h.rst b/Documentation/linux_tv/media/dvb/audio_h.rst
index 09a73a54ab00..bdd9a709a125 100644
--- a/Documentation/linux_tv/media/dvb/audio_h.rst
+++ b/Documentation/linux_tv/media/dvb/audio_h.rst
@@ -11,14 +11,3 @@ DVB Audio Header File
:maxdepth: 1
../../audio.h
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/dvb/ca.rst b/Documentation/linux_tv/media/dvb/ca.rst
index bb01d93f0256..14b14abda1ae 100644
--- a/Documentation/linux_tv/media/dvb/ca.rst
+++ b/Documentation/linux_tv/media/dvb/ca.rst
@@ -16,14 +16,3 @@ application.
ca_data_types
ca_function_calls
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/dvb/ca_data_types.rst b/Documentation/linux_tv/media/dvb/ca_data_types.rst
index bb0cdfa7c9a6..ca17e146dac0 100644
--- a/Documentation/linux_tv/media/dvb/ca_data_types.rst
+++ b/Documentation/linux_tv/media/dvb/ca_data_types.rst
@@ -108,14 +108,3 @@ ca-pid
unsigned int pid;
int index; /* -1 == disable*/
} ca_pid_t;
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/dvb/ca_function_calls.rst b/Documentation/linux_tv/media/dvb/ca_function_calls.rst
index 83bce0420881..af110ba6496a 100644
--- a/Documentation/linux_tv/media/dvb/ca_function_calls.rst
+++ b/Documentation/linux_tv/media/dvb/ca_function_calls.rst
@@ -530,12 +530,3 @@ RETURN VALUE
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/dvb/ca_h.rst b/Documentation/linux_tv/media/dvb/ca_h.rst
index 229bfbca045b..a7d22154022b 100644
--- a/Documentation/linux_tv/media/dvb/ca_h.rst
+++ b/Documentation/linux_tv/media/dvb/ca_h.rst
@@ -11,14 +11,3 @@ DVB Conditional Access Header File
:maxdepth: 1
../../ca.h
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/dvb/demux.rst b/Documentation/linux_tv/media/dvb/demux.rst
index 3bcee72c68fb..b12b5a2dac94 100644
--- a/Documentation/linux_tv/media/dvb/demux.rst
+++ b/Documentation/linux_tv/media/dvb/demux.rst
@@ -16,14 +16,3 @@ your application.
dmx_types
dmx_fcalls
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/dvb/dmx_fcalls.rst b/Documentation/linux_tv/media/dvb/dmx_fcalls.rst
index 4563c8f2a1b8..4612364fb2d8 100644
--- a/Documentation/linux_tv/media/dvb/dmx_fcalls.rst
+++ b/Documentation/linux_tv/media/dvb/dmx_fcalls.rst
@@ -1002,12 +1002,3 @@ RETURN VALUE
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/dvb/dmx_h.rst b/Documentation/linux_tv/media/dvb/dmx_h.rst
index 19e2691b7eab..baf129dd078b 100644
--- a/Documentation/linux_tv/media/dvb/dmx_h.rst
+++ b/Documentation/linux_tv/media/dvb/dmx_h.rst
@@ -11,14 +11,3 @@ DVB Demux Header File
:maxdepth: 1
../../dmx.h
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/dvb/dmx_types.rst b/Documentation/linux_tv/media/dvb/dmx_types.rst
index 83859366b73e..05891946b2a7 100644
--- a/Documentation/linux_tv/media/dvb/dmx_types.rst
+++ b/Documentation/linux_tv/media/dvb/dmx_types.rst
@@ -240,14 +240,3 @@ enum dmx_source_t
DMX_SOURCE_DVR2,
DMX_SOURCE_DVR3
} dmx_source_t;
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/dvb/dtv-fe-stats.rst b/Documentation/linux_tv/media/dvb/dtv-fe-stats.rst
index 17b26fa050f5..d169e318cfde 100644
--- a/Documentation/linux_tv/media/dvb/dtv-fe-stats.rst
+++ b/Documentation/linux_tv/media/dvb/dtv-fe-stats.rst
@@ -15,14 +15,3 @@ struct dtv_fe_stats
__u8 len;
struct dtv_stats stat[MAX_DTV_STATS];
} __packed;
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/dvb/dtv-properties.rst b/Documentation/linux_tv/media/dvb/dtv-properties.rst
index b1b28342d09d..002553b7068b 100644
--- a/Documentation/linux_tv/media/dvb/dtv-properties.rst
+++ b/Documentation/linux_tv/media/dvb/dtv-properties.rst
@@ -13,14 +13,3 @@ struct dtv_properties
__u32 num;
struct dtv_property *props;
};
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/dvb/dtv-property.rst b/Documentation/linux_tv/media/dvb/dtv-property.rst
index 4dff00eb610c..9fc8cef5a09b 100644
--- a/Documentation/linux_tv/media/dvb/dtv-property.rst
+++ b/Documentation/linux_tv/media/dvb/dtv-property.rst
@@ -29,14 +29,3 @@ struct dtv_property
/* num of properties cannot exceed DTV_IOCTL_MAX_MSGS per ioctl */
#define DTV_IOCTL_MAX_MSGS 64
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/dvb/dtv-stats.rst b/Documentation/linux_tv/media/dvb/dtv-stats.rst
index e70e5a5283ff..0f73205400ae 100644
--- a/Documentation/linux_tv/media/dvb/dtv-stats.rst
+++ b/Documentation/linux_tv/media/dvb/dtv-stats.rst
@@ -16,14 +16,3 @@ struct dtv_stats
__s64 svalue; /* for 1/1000 dB measures */
};
} __packed;
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/dvb/dvb-fe-read-status.rst b/Documentation/linux_tv/media/dvb/dvb-fe-read-status.rst
index e36cd134007e..1c708c5e6bc0 100644
--- a/Documentation/linux_tv/media/dvb/dvb-fe-read-status.rst
+++ b/Documentation/linux_tv/media/dvb/dvb-fe-read-status.rst
@@ -20,12 +20,3 @@ statistics require the demodulator to be fully locked (e. g. with
FE_HAS_LOCK bit set). See
:ref:`Frontend statistics indicators <frontend-stat-properties>` for
more details.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/dvb/dvb-frontend-event.rst b/Documentation/linux_tv/media/dvb/dvb-frontend-event.rst
index 82965e4d7450..8ff83578b4da 100644
--- a/Documentation/linux_tv/media/dvb/dvb-frontend-event.rst
+++ b/Documentation/linux_tv/media/dvb/dvb-frontend-event.rst
@@ -13,14 +13,3 @@ frontend events
fe_status_t status;
struct dvb_frontend_parameters parameters;
};
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/dvb/dvb-frontend-parameters.rst b/Documentation/linux_tv/media/dvb/dvb-frontend-parameters.rst
index 0a1766f68917..bb125b8c4b3b 100644
--- a/Documentation/linux_tv/media/dvb/dvb-frontend-parameters.rst
+++ b/Documentation/linux_tv/media/dvb/dvb-frontend-parameters.rst
@@ -117,14 +117,3 @@ DVB-T frontends are supported by the ``dvb_ofdm_parameters`` structure:
fe_guard_interval_t guard_interval;
fe_hierarchy_t hierarchy_information;
};
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/dvb/dvbapi.rst b/Documentation/linux_tv/media/dvb/dvbapi.rst
index daeeb4d64917..ad800404ae9f 100644
--- a/Documentation/linux_tv/media/dvb/dvbapi.rst
+++ b/Documentation/linux_tv/media/dvb/dvbapi.rst
@@ -86,12 +86,3 @@ original LaTex version.
:revision: 1.0.0 / 2003-07-24 (*rjkm*)
Initial revision on LaTEX.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/dvb/dvbproperty-006.rst b/Documentation/linux_tv/media/dvb/dvbproperty-006.rst
index 4b89d607358c..3343a0f306fe 100644
--- a/Documentation/linux_tv/media/dvb/dvbproperty-006.rst
+++ b/Documentation/linux_tv/media/dvb/dvbproperty-006.rst
@@ -10,12 +10,3 @@ With one single ioctl, is possible to get/set up to 64 properties. The
actual meaning of each property is described on the next sections.
The available frontend property types are shown on the next section.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/dvb/dvbproperty.rst b/Documentation/linux_tv/media/dvb/dvbproperty.rst
index a68b17808bc2..34187964db38 100644
--- a/Documentation/linux_tv/media/dvb/dvbproperty.rst
+++ b/Documentation/linux_tv/media/dvb/dvbproperty.rst
@@ -109,14 +109,3 @@ read/write channel descriptor files.
frontend-property-terrestrial-systems
frontend-property-cable-systems
frontend-property-satellite-systems
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/dvb/examples.rst b/Documentation/linux_tv/media/dvb/examples.rst
index b3a94dedcd39..0cad02acd1bd 100644
--- a/Documentation/linux_tv/media/dvb/examples.rst
+++ b/Documentation/linux_tv/media/dvb/examples.rst
@@ -378,14 +378,3 @@ recording.
}
return 0;
}
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/dvb/fe-bandwidth-t.rst b/Documentation/linux_tv/media/dvb/fe-bandwidth-t.rst
index c6e56aba012a..f59d60c57bfd 100644
--- a/Documentation/linux_tv/media/dvb/fe-bandwidth-t.rst
+++ b/Documentation/linux_tv/media/dvb/fe-bandwidth-t.rst
@@ -75,14 +75,3 @@ Frontend bandwidth
``BANDWIDTH_10_MHZ``
- 10 MHz
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/dvb/fe-diseqc-recv-slave-reply.rst b/Documentation/linux_tv/media/dvb/fe-diseqc-recv-slave-reply.rst
index 0f01584c8d4e..da860e50fde9 100644
--- a/Documentation/linux_tv/media/dvb/fe-diseqc-recv-slave-reply.rst
+++ b/Documentation/linux_tv/media/dvb/fe-diseqc-recv-slave-reply.rst
@@ -75,14 +75,3 @@ appropriately. The generic error codes are described at the
- Return from ioctl after timeout ms with errorcode when no message
was received
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/dvb/fe-diseqc-reset-overload.rst b/Documentation/linux_tv/media/dvb/fe-diseqc-reset-overload.rst
index 50d0d651d270..2c64eab598b8 100644
--- a/Documentation/linux_tv/media/dvb/fe-diseqc-reset-overload.rst
+++ b/Documentation/linux_tv/media/dvb/fe-diseqc-reset-overload.rst
@@ -40,12 +40,3 @@ RETURN VALUE
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/dvb/fe-diseqc-send-burst.rst b/Documentation/linux_tv/media/dvb/fe-diseqc-send-burst.rst
index 34c787903eb1..f365238e5b78 100644
--- a/Documentation/linux_tv/media/dvb/fe-diseqc-send-burst.rst
+++ b/Documentation/linux_tv/media/dvb/fe-diseqc-send-burst.rst
@@ -80,14 +80,3 @@ enum fe_sec_mini_cmd
``SEC_MINI_B``
- Sends a mini-DiSEqC 22kHz '1' Data Burst to select satellite-B
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/dvb/fe-diseqc-send-master-cmd.rst b/Documentation/linux_tv/media/dvb/fe-diseqc-send-master-cmd.rst
index 7a85632e64b4..04c6cc8ae070 100644
--- a/Documentation/linux_tv/media/dvb/fe-diseqc-send-master-cmd.rst
+++ b/Documentation/linux_tv/media/dvb/fe-diseqc-send-master-cmd.rst
@@ -65,14 +65,3 @@ appropriately. The generic error codes are described at the
- msg_len
- Length of the DiSEqC message. Valid values are 3 to 6
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/dvb/fe-enable-high-lnb-voltage.rst b/Documentation/linux_tv/media/dvb/fe-enable-high-lnb-voltage.rst
index f2705a383d8c..669dbd6e79b8 100644
--- a/Documentation/linux_tv/media/dvb/fe-enable-high-lnb-voltage.rst
+++ b/Documentation/linux_tv/media/dvb/fe-enable-high-lnb-voltage.rst
@@ -47,12 +47,3 @@ RETURN VALUE
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/dvb/fe-get-info.rst b/Documentation/linux_tv/media/dvb/fe-get-info.rst
index d7990c80ef87..0880a11def86 100644
--- a/Documentation/linux_tv/media/dvb/fe-get-info.rst
+++ b/Documentation/linux_tv/media/dvb/fe-get-info.rst
@@ -421,14 +421,3 @@ supported only on some specific frontend types.
``FE_CAN_MUTE_TS``
- The frontend can stop spurious TS data output
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/dvb/fe-get-property.rst b/Documentation/linux_tv/media/dvb/fe-get-property.rst
index 5b73ee8e790b..0edc9291fc70 100644
--- a/Documentation/linux_tv/media/dvb/fe-get-property.rst
+++ b/Documentation/linux_tv/media/dvb/fe-get-property.rst
@@ -64,12 +64,3 @@ RETURN VALUE
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/dvb/fe-read-status.rst b/Documentation/linux_tv/media/dvb/fe-read-status.rst
index c032cda4e5a6..250fabc71c64 100644
--- a/Documentation/linux_tv/media/dvb/fe-read-status.rst
+++ b/Documentation/linux_tv/media/dvb/fe-read-status.rst
@@ -130,14 +130,3 @@ state changes of the frontend hardware. It is produced using the enum
- The frontend was reinitialized, application is recommended to
reset DiSEqC, tone and parameters
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/dvb/fe-set-frontend-tune-mode.rst b/Documentation/linux_tv/media/dvb/fe-set-frontend-tune-mode.rst
index 82665279b840..aeecb947fa70 100644
--- a/Documentation/linux_tv/media/dvb/fe-set-frontend-tune-mode.rst
+++ b/Documentation/linux_tv/media/dvb/fe-set-frontend-tune-mode.rst
@@ -49,12 +49,3 @@ RETURN VALUE
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/dvb/fe-set-tone.rst b/Documentation/linux_tv/media/dvb/fe-set-tone.rst
index f98c4b3b8760..432797211f80 100644
--- a/Documentation/linux_tv/media/dvb/fe-set-tone.rst
+++ b/Documentation/linux_tv/media/dvb/fe-set-tone.rst
@@ -87,14 +87,3 @@ enum fe_sec_tone_mode
- Don't send a 22kHz tone to the antenna (except if the
FE_DISEQC_* ioctls are called)
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/dvb/fe-set-voltage.rst b/Documentation/linux_tv/media/dvb/fe-set-voltage.rst
index eb4ab28b479a..63c5f401e808 100644
--- a/Documentation/linux_tv/media/dvb/fe-set-voltage.rst
+++ b/Documentation/linux_tv/media/dvb/fe-set-voltage.rst
@@ -57,12 +57,3 @@ RETURN VALUE
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/dvb/fe-type-t.rst b/Documentation/linux_tv/media/dvb/fe-type-t.rst
index 49fa8090010b..fcce8ef421ae 100644
--- a/Documentation/linux_tv/media/dvb/fe-type-t.rst
+++ b/Documentation/linux_tv/media/dvb/fe-type-t.rst
@@ -89,12 +89,3 @@ On devices that support multiple delivery systems, struct
filled with the currently standard, as selected by the last call to
:ref:`FE_SET_PROPERTY <FE_GET_PROPERTY>` using the
:ref:`DTV_DELIVERY_SYSTEM <DTV-DELIVERY-SYSTEM>` property.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/dvb/fe_property_parameters.rst b/Documentation/linux_tv/media/dvb/fe_property_parameters.rst
index 788dbfef0061..e30ed6d71335 100644
--- a/Documentation/linux_tv/media/dvb/fe_property_parameters.rst
+++ b/Documentation/linux_tv/media/dvb/fe_property_parameters.rst
@@ -1965,12 +1965,3 @@ Possible values: 0, 1, LNA_AUTO
1, LNA on
use the special macro LNA_AUTO to set LNA auto
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/dvb/frontend-property-cable-systems.rst b/Documentation/linux_tv/media/dvb/frontend-property-cable-systems.rst
index 360966ef50cf..bf2328627af5 100644
--- a/Documentation/linux_tv/media/dvb/frontend-property-cable-systems.rst
+++ b/Documentation/linux_tv/media/dvb/frontend-property-cable-systems.rst
@@ -73,12 +73,3 @@ The following parameters are valid for DVB-C Annex B:
In addition, the :ref:`DTV QoS statistics <frontend-stat-properties>`
are also valid.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/dvb/frontend-property-satellite-systems.rst b/Documentation/linux_tv/media/dvb/frontend-property-satellite-systems.rst
index 1a204ac01afd..1f40399c68ff 100644
--- a/Documentation/linux_tv/media/dvb/frontend-property-satellite-systems.rst
+++ b/Documentation/linux_tv/media/dvb/frontend-property-satellite-systems.rst
@@ -101,12 +101,3 @@ The following parameters are valid for ISDB-S:
- :ref:`DTV_VOLTAGE <DTV-VOLTAGE>`
- :ref:`DTV_STREAM_ID <DTV-STREAM-ID>`
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/dvb/frontend-property-terrestrial-systems.rst b/Documentation/linux_tv/media/dvb/frontend-property-terrestrial-systems.rst
index 78026596f46f..dbc717cad9ee 100644
--- a/Documentation/linux_tv/media/dvb/frontend-property-terrestrial-systems.rst
+++ b/Documentation/linux_tv/media/dvb/frontend-property-terrestrial-systems.rst
@@ -292,12 +292,3 @@ The following parameters are valid for DTMB:
In addition, the :ref:`DTV QoS statistics <frontend-stat-properties>`
are also valid.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/dvb/frontend-stat-properties.rst b/Documentation/linux_tv/media/dvb/frontend-stat-properties.rst
index 7f3999db3e5d..0fc4aaa304ff 100644
--- a/Documentation/linux_tv/media/dvb/frontend-stat-properties.rst
+++ b/Documentation/linux_tv/media/dvb/frontend-stat-properties.rst
@@ -243,12 +243,3 @@ Possible scales for this metric are:
- ``FE_SCALE_COUNTER`` - Number of blocks counted while measuring
:ref:`DTV_STAT_ERROR_BLOCK_COUNT <DTV-STAT-ERROR-BLOCK-COUNT>`.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/dvb/frontend.rst b/Documentation/linux_tv/media/dvb/frontend.rst
index 46be409e76b6..8c7e502bff1f 100644
--- a/Documentation/linux_tv/media/dvb/frontend.rst
+++ b/Documentation/linux_tv/media/dvb/frontend.rst
@@ -49,14 +49,3 @@ Horn (LNBf). It supports the DiSEqC and V-SEC protocols. The DiSEqC
dvbproperty
frontend_fcalls
frontend_legacy_dvbv3_api
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/dvb/frontend_f_close.rst b/Documentation/linux_tv/media/dvb/frontend_f_close.rst
index faae1c7381e2..8ca7f723ffc3 100644
--- a/Documentation/linux_tv/media/dvb/frontend_f_close.rst
+++ b/Documentation/linux_tv/media/dvb/frontend_f_close.rst
@@ -44,12 +44,3 @@ set appropriately. Possible error codes:
EBADF
``fd`` is not a valid open file descriptor.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/dvb/frontend_f_open.rst b/Documentation/linux_tv/media/dvb/frontend_f_open.rst
index bdc9a8139444..ba9fbb17f70d 100644
--- a/Documentation/linux_tv/media/dvb/frontend_f_open.rst
+++ b/Documentation/linux_tv/media/dvb/frontend_f_open.rst
@@ -97,12 +97,3 @@ ENFILE
ENODEV
The device got removed.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/dvb/frontend_fcalls.rst b/Documentation/linux_tv/media/dvb/frontend_fcalls.rst
index 8eae0e9461ab..b03f9cab6d5a 100644
--- a/Documentation/linux_tv/media/dvb/frontend_fcalls.rst
+++ b/Documentation/linux_tv/media/dvb/frontend_fcalls.rst
@@ -22,14 +22,3 @@ Frontend Function Calls
fe-set-voltage
fe-enable-high-lnb-voltage
fe-set-frontend-tune-mode
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/dvb/frontend_h.rst b/Documentation/linux_tv/media/dvb/frontend_h.rst
index 3f616c6bd01d..7101d6ddd916 100644
--- a/Documentation/linux_tv/media/dvb/frontend_h.rst
+++ b/Documentation/linux_tv/media/dvb/frontend_h.rst
@@ -11,14 +11,3 @@ DVB Frontend Header File
:maxdepth: 1
../../frontend.h
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/dvb/frontend_legacy_api.rst b/Documentation/linux_tv/media/dvb/frontend_legacy_api.rst
index dcc62d4a8516..fb17766d887e 100644
--- a/Documentation/linux_tv/media/dvb/frontend_legacy_api.rst
+++ b/Documentation/linux_tv/media/dvb/frontend_legacy_api.rst
@@ -36,14 +36,3 @@ recommended
FE_GET_FRONTEND
FE_GET_EVENT
FE_DISHNETWORK_SEND_LEGACY_CMD
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/dvb/frontend_legacy_dvbv3_api.rst b/Documentation/linux_tv/media/dvb/frontend_legacy_dvbv3_api.rst
index 1dbff41f6a34..7d4a091b7d7f 100644
--- a/Documentation/linux_tv/media/dvb/frontend_legacy_dvbv3_api.rst
+++ b/Documentation/linux_tv/media/dvb/frontend_legacy_dvbv3_api.rst
@@ -16,14 +16,3 @@ applications.
:maxdepth: 1
frontend_legacy_api
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/dvb/intro.rst b/Documentation/linux_tv/media/dvb/intro.rst
index 0508f0d2c9db..338300b11aa4 100644
--- a/Documentation/linux_tv/media/dvb/intro.rst
+++ b/Documentation/linux_tv/media/dvb/intro.rst
@@ -193,12 +193,3 @@ partial path like:
To enable applications to support different API version, an additional
include file ``linux/dvb/version.h`` exists, which defines the constant
``DVB_API_VERSION``. This document describes ``DVB_API_VERSION 5.10``.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/dvb/legacy_dvb_apis.rst b/Documentation/linux_tv/media/dvb/legacy_dvb_apis.rst
index 15e0d88c2866..2957f5a988b0 100644
--- a/Documentation/linux_tv/media/dvb/legacy_dvb_apis.rst
+++ b/Documentation/linux_tv/media/dvb/legacy_dvb_apis.rst
@@ -18,14 +18,3 @@ Controller API
video
audio
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/dvb/net.rst b/Documentation/linux_tv/media/dvb/net.rst
index 830076fadda2..fd2eb6171f42 100644
--- a/Documentation/linux_tv/media/dvb/net.rst
+++ b/Documentation/linux_tv/media/dvb/net.rst
@@ -208,12 +208,3 @@ RETURN VALUE
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/dvb/net_h.rst b/Documentation/linux_tv/media/dvb/net_h.rst
index 357713b4a5ef..09560db4e1c0 100644
--- a/Documentation/linux_tv/media/dvb/net_h.rst
+++ b/Documentation/linux_tv/media/dvb/net_h.rst
@@ -11,14 +11,3 @@ DVB Network Header File
:maxdepth: 1
../../net.h
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/dvb/query-dvb-frontend-info.rst b/Documentation/linux_tv/media/dvb/query-dvb-frontend-info.rst
index a3da1b8376bc..81cd9b92a36c 100644
--- a/Documentation/linux_tv/media/dvb/query-dvb-frontend-info.rst
+++ b/Documentation/linux_tv/media/dvb/query-dvb-frontend-info.rst
@@ -11,12 +11,3 @@ the frontend capabilities. This is done using
:ref:`FE_GET_INFO`. This ioctl will enumerate the
DVB API version and other characteristics about the frontend, and can be
opened either in read only or read/write mode.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/dvb/video.rst b/Documentation/linux_tv/media/dvb/video.rst
index 9783e9f344f6..60d43fb7ce22 100644
--- a/Documentation/linux_tv/media/dvb/video.rst
+++ b/Documentation/linux_tv/media/dvb/video.rst
@@ -33,14 +33,3 @@ functionality.
video_types
video_function_calls
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/dvb/video_function_calls.rst b/Documentation/linux_tv/media/dvb/video_function_calls.rst
index 39eaecd8755a..b8ea77d1f239 100644
--- a/Documentation/linux_tv/media/dvb/video_function_calls.rst
+++ b/Documentation/linux_tv/media/dvb/video_function_calls.rst
@@ -1867,14 +1867,3 @@ appropriately. The generic error codes are described at the
- ``EINVAL``
- input is not a valid attribute setting.
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/dvb/video_h.rst b/Documentation/linux_tv/media/dvb/video_h.rst
index 348d20c3cab7..45c12d295523 100644
--- a/Documentation/linux_tv/media/dvb/video_h.rst
+++ b/Documentation/linux_tv/media/dvb/video_h.rst
@@ -11,14 +11,3 @@ DVB Video Header File
:maxdepth: 1
../../video.h
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/dvb/video_types.rst b/Documentation/linux_tv/media/dvb/video_types.rst
index f57233825e42..1a73751ec080 100644
--- a/Documentation/linux_tv/media/dvb/video_types.rst
+++ b/Documentation/linux_tv/media/dvb/video_types.rst
@@ -377,14 +377,3 @@ The following attributes can be set by a call to VIDEO_SET_ATTRIBUTES:
/* 5- 3 source resolution (0=720x480/576, 1=704x480/576, 2=352x480/57 */
/* 2 source letterboxed (1=yes, 0=no) */
/* 0 film/camera mode (0=camera, 1=film (625/50 only)) */
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/Remote_controllers_Intro.rst b/Documentation/linux_tv/media/v4l/Remote_controllers_Intro.rst
index 5e461ac39947..3707c29d37ed 100644
--- a/Documentation/linux_tv/media/v4l/Remote_controllers_Intro.rst
+++ b/Documentation/linux_tv/media/v4l/Remote_controllers_Intro.rst
@@ -22,12 +22,3 @@ conjunction with a wide variety of different IR remotes.
In order to allow flexibility, the Remote Controller subsystem allows
controlling the RC-specific attributes via
:ref:`the sysfs class nodes <remote_controllers_sysfs_nodes>`.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/Remote_controllers_table_change.rst b/Documentation/linux_tv/media/v4l/Remote_controllers_table_change.rst
index a04cc2cbbbb3..d604896bca87 100644
--- a/Documentation/linux_tv/media/v4l/Remote_controllers_table_change.rst
+++ b/Documentation/linux_tv/media/v4l/Remote_controllers_table_change.rst
@@ -16,14 +16,3 @@ This program demonstrates how to replace the keymap tables.
:maxdepth: 1
keytable.c
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/Remote_controllers_tables.rst b/Documentation/linux_tv/media/v4l/Remote_controllers_tables.rst
index 2243d5b2dcd1..b02ff7706f80 100644
--- a/Documentation/linux_tv/media/v4l/Remote_controllers_tables.rst
+++ b/Documentation/linux_tv/media/v4l/Remote_controllers_tables.rst
@@ -755,14 +755,3 @@ at some cheaper IR's. Due to that, it is recommended to:
- On simpler IR's, without separate volume keys, you need to map
RIGHT as ``KEY_VOLUMEUP``
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/app-pri.rst b/Documentation/linux_tv/media/v4l/app-pri.rst
index 8c4624dd50e2..a8c41a7ec396 100644
--- a/Documentation/linux_tv/media/v4l/app-pri.rst
+++ b/Documentation/linux_tv/media/v4l/app-pri.rst
@@ -28,12 +28,3 @@ different priority will usually call :ref:`VIDIOC_S_PRIORITY
Ioctls changing driver properties, such as
:ref:`VIDIOC_S_INPUT <VIDIOC_G_INPUT>`, return an ``EBUSY`` error code
after another application obtained higher priority.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/async.rst b/Documentation/linux_tv/media/v4l/async.rst
index 82a56e88a54d..5affc0adb95b 100644
--- a/Documentation/linux_tv/media/v4l/async.rst
+++ b/Documentation/linux_tv/media/v4l/async.rst
@@ -7,12 +7,3 @@ Asynchronous I/O
****************
This method is not defined yet.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/audio.rst b/Documentation/linux_tv/media/v4l/audio.rst
index bc2db0d8f389..d7574fa4f2cc 100644
--- a/Documentation/linux_tv/media/v4l/audio.rst
+++ b/Documentation/linux_tv/media/v4l/audio.rst
@@ -88,12 +88,3 @@ the :ref:`VIDIOC_QUERYCAP` ioctl.
``tuner`` field like struct :ref:`v4l2_input <v4l2-input>`, not
only making the API more consistent but also permitting radio devices
with multiple tuners.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/biblio.rst b/Documentation/linux_tv/media/v4l/biblio.rst
index 44dc7deb24b2..e911df972d40 100644
--- a/Documentation/linux_tv/media/v4l/biblio.rst
+++ b/Documentation/linux_tv/media/v4l/biblio.rst
@@ -379,12 +379,3 @@ colimg
:title: Color Imaging: Fundamentals and Applications
:author: Erik Reinhard et al.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/buffer.rst b/Documentation/linux_tv/media/v4l/buffer.rst
index 1c6c96c37155..98bb2a8dcdeb 100644
--- a/Documentation/linux_tv/media/v4l/buffer.rst
+++ b/Documentation/linux_tv/media/v4l/buffer.rst
@@ -953,14 +953,3 @@ The :ref:`struct v4l2_timecode <v4l2-timecode>` structure is designed to hold a
- 0x0008
- 8-bit ISO characters.
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/capture-example.rst b/Documentation/linux_tv/media/v4l/capture-example.rst
index 8d35e379cea7..ac1cd057e25b 100644
--- a/Documentation/linux_tv/media/v4l/capture-example.rst
+++ b/Documentation/linux_tv/media/v4l/capture-example.rst
@@ -11,14 +11,3 @@ Video Capture Example
:maxdepth: 1
capture.c
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/capture.c.rst b/Documentation/linux_tv/media/v4l/capture.c.rst
index 41e96c78a6dd..ff481e783c39 100644
--- a/Documentation/linux_tv/media/v4l/capture.c.rst
+++ b/Documentation/linux_tv/media/v4l/capture.c.rst
@@ -662,14 +662,3 @@ file: media/v4l/capture.c
fprintf(stderr, "\\n");
return 0;
}
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/colorspaces.rst b/Documentation/linux_tv/media/v4l/colorspaces.rst
index 85d0b33b60a3..322eb94c1d44 100644
--- a/Documentation/linux_tv/media/v4l/colorspaces.rst
+++ b/Documentation/linux_tv/media/v4l/colorspaces.rst
@@ -161,12 +161,3 @@ website is an excellent resource, especially with respect to the
mathematics behind colorspace conversions. The wikipedia
`CIE 1931 colorspace <http://en.wikipedia.org/wiki/CIE_1931_color_space#CIE_xy_chromaticity_diagram_and_the_CIE_xyY_color_space>`__
article is also very useful.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/common-defs.rst b/Documentation/linux_tv/media/v4l/common-defs.rst
index 3f90a8c6e28c..39058216b630 100644
--- a/Documentation/linux_tv/media/v4l/common-defs.rst
+++ b/Documentation/linux_tv/media/v4l/common-defs.rst
@@ -11,14 +11,3 @@ Common definitions for V4L2 and V4L2 subdev interfaces
:maxdepth: 1
selections-common
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/common.rst b/Documentation/linux_tv/media/v4l/common.rst
index 40d3feab5ab9..13f2ed3fc5a6 100644
--- a/Documentation/linux_tv/media/v4l/common.rst
+++ b/Documentation/linux_tv/media/v4l/common.rst
@@ -44,14 +44,3 @@ applicable to all devices.
crop
selection-api
streaming-par
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/compat.rst b/Documentation/linux_tv/media/v4l/compat.rst
index 8a6d883ae6af..8b5e1cebd8f4 100644
--- a/Documentation/linux_tv/media/v4l/compat.rst
+++ b/Documentation/linux_tv/media/v4l/compat.rst
@@ -16,14 +16,3 @@ writers to port or update their code.
diff-v4l
hist-v4l2
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/control.rst b/Documentation/linux_tv/media/v4l/control.rst
index 4f64f1db6ec8..92abac784979 100644
--- a/Documentation/linux_tv/media/v4l/control.rst
+++ b/Documentation/linux_tv/media/v4l/control.rst
@@ -531,12 +531,3 @@ more menu type controls.
instead of using :ref:`VIDIOC_QUERYCTRL` with
the ``V4L2_CTRL_FLAG_NEXT_CTRL`` flag to enumerate all IDs, so
support for ``V4L2_CID_PRIVATE_BASE`` is still around.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/crop.rst b/Documentation/linux_tv/media/v4l/crop.rst
index 16d0983ff9fb..ed43b36c51d8 100644
--- a/Documentation/linux_tv/media/v4l/crop.rst
+++ b/Documentation/linux_tv/media/v4l/crop.rst
@@ -292,12 +292,3 @@ change ``V4L2_BUF_TYPE_VIDEO_CAPTURE`` for other types of device.
dwidth = format.fmt.pix.width / aspect;
dheight = format.fmt.pix.height;
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/depth-formats.rst b/Documentation/linux_tv/media/v4l/depth-formats.rst
index c363eaf741f5..82f183870aae 100644
--- a/Documentation/linux_tv/media/v4l/depth-formats.rst
+++ b/Documentation/linux_tv/media/v4l/depth-formats.rst
@@ -13,14 +13,3 @@ Depth data provides distance to points, mapped onto the image plane
:maxdepth: 1
pixfmt-z16
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/dev-capture.rst b/Documentation/linux_tv/media/v4l/dev-capture.rst
index 0e62dc026251..c927b7834b90 100644
--- a/Documentation/linux_tv/media/v4l/dev-capture.rst
+++ b/Documentation/linux_tv/media/v4l/dev-capture.rst
@@ -100,12 +100,3 @@ Reading Images
A video capture device may support the :ref:`read() function <rw>`
and/or streaming (:ref:`memory mapping <mmap>` or
:ref:`user pointer <userp>`) I/O. See :ref:`io` for details.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/dev-codec.rst b/Documentation/linux_tv/media/v4l/dev-codec.rst
index 170954acc049..5e834d51309e 100644
--- a/Documentation/linux_tv/media/v4l/dev-codec.rst
+++ b/Documentation/linux_tv/media/v4l/dev-codec.rst
@@ -30,12 +30,3 @@ the codec and reprogram it whenever another file handler gets access.
This is different from the usual video node behavior where the video
properties are global to the device (i.e. changing something through one
file handle is visible through another file handle).
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/dev-effect.rst b/Documentation/linux_tv/media/v4l/dev-effect.rst
index c0cdfe07ff4d..be4de3b0a025 100644
--- a/Documentation/linux_tv/media/v4l/dev-effect.rst
+++ b/Documentation/linux_tv/media/v4l/dev-effect.rst
@@ -20,12 +20,3 @@ data either with :ref:`read() <func-read>` and
mechanism.
[to do]
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/dev-event.rst b/Documentation/linux_tv/media/v4l/dev-event.rst
index 385a8a342903..a06ec4d65359 100644
--- a/Documentation/linux_tv/media/v4l/dev-event.rst
+++ b/Documentation/linux_tv/media/v4l/dev-event.rst
@@ -45,12 +45,3 @@ events:
is lost, but only an intermediate step leading up to that
information. See the documentation for the event you want to
subscribe to whether this is applicable for that event or not.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/dev-osd.rst b/Documentation/linux_tv/media/v4l/dev-osd.rst
index 8b05e3f0587d..ebc2f77d0e97 100644
--- a/Documentation/linux_tv/media/v4l/dev-osd.rst
+++ b/Documentation/linux_tv/media/v4l/dev-osd.rst
@@ -143,12 +143,3 @@ Enabling Overlay
There is no V4L2 ioctl to enable or disable the overlay, however the
framebuffer interface of the driver may support the ``FBIOBLANK`` ioctl.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/dev-output.rst b/Documentation/linux_tv/media/v4l/dev-output.rst
index 5253498db95a..5063be7d4938 100644
--- a/Documentation/linux_tv/media/v4l/dev-output.rst
+++ b/Documentation/linux_tv/media/v4l/dev-output.rst
@@ -97,12 +97,3 @@ Writing Images
A video output device may support the :ref:`write() function <rw>`
and/or streaming (:ref:`memory mapping <mmap>` or
:ref:`user pointer <userp>`) I/O. See :ref:`io` for details.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/dev-overlay.rst b/Documentation/linux_tv/media/v4l/dev-overlay.rst
index dd786b6fc936..97b41ecb9e78 100644
--- a/Documentation/linux_tv/media/v4l/dev-overlay.rst
+++ b/Documentation/linux_tv/media/v4l/dev-overlay.rst
@@ -317,12 +317,3 @@ To start or stop the frame buffer overlay applications call the
because the application and graphics system are not aware these
regions need to be refreshed. The driver should clip out more pixels
or not write the image at all.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/dev-radio.rst b/Documentation/linux_tv/media/v4l/dev-radio.rst
index 55a56fb5d958..5ff7cded2591 100644
--- a/Documentation/linux_tv/media/v4l/dev-radio.rst
+++ b/Documentation/linux_tv/media/v4l/dev-radio.rst
@@ -50,12 +50,3 @@ depending on the selected frequency. The
:ref:`VIDIOC_G_TUNER <VIDIOC_G_TUNER>` or
:ref:`VIDIOC_G_MODULATOR <VIDIOC_G_MODULATOR>` ioctl reports the
supported frequency range.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/dev-raw-vbi.rst b/Documentation/linux_tv/media/v4l/dev-raw-vbi.rst
index 20942bf9232e..659196499b32 100644
--- a/Documentation/linux_tv/media/v4l/dev-raw-vbi.rst
+++ b/Documentation/linux_tv/media/v4l/dev-raw-vbi.rst
@@ -357,12 +357,3 @@ another process.
Most VBI services transmit on both fields, but some have different
semantics depending on the field number. These cannot be reliable
decoded or encoded when ``V4L2_VBI_UNSYNC`` is set.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/dev-rds.rst b/Documentation/linux_tv/media/v4l/dev-rds.rst
index 223df4971405..87209fd691f5 100644
--- a/Documentation/linux_tv/media/v4l/dev-rds.rst
+++ b/Documentation/linux_tv/media/v4l/dev-rds.rst
@@ -253,14 +253,3 @@ RDS datastructures
- 0x80
- An uncorrectable error occurred.
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/dev-sdr.rst b/Documentation/linux_tv/media/v4l/dev-sdr.rst
index 0cae31c93dd0..834488ab7147 100644
--- a/Documentation/linux_tv/media/v4l/dev-sdr.rst
+++ b/Documentation/linux_tv/media/v4l/dev-sdr.rst
@@ -118,12 +118,3 @@ data transfer, set by the driver in order to inform application.
An SDR device may support :ref:`read/write <rw>` and/or streaming
(:ref:`memory mapping <mmap>` or :ref:`user pointer <userp>`) I/O.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/dev-sliced-vbi.rst b/Documentation/linux_tv/media/v4l/dev-sliced-vbi.rst
index 0b299b51aceb..4c14f39bbc80 100644
--- a/Documentation/linux_tv/media/v4l/dev-sliced-vbi.rst
+++ b/Documentation/linux_tv/media/v4l/dev-sliced-vbi.rst
@@ -793,12 +793,3 @@ number).
.. [1]
According to :ref:`ETS 300 706 <ets300706>` lines 6-22 of the first
field and lines 5-22 of the second field may carry Teletext data.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/dev-subdev.rst b/Documentation/linux_tv/media/v4l/dev-subdev.rst
index 87a2cec37645..f40aa5187ba5 100644
--- a/Documentation/linux_tv/media/v4l/dev-subdev.rst
+++ b/Documentation/linux_tv/media/v4l/dev-subdev.rst
@@ -489,14 +489,3 @@ source pads.
:maxdepth: 1
subdev-formats
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/dev-teletext.rst b/Documentation/linux_tv/media/v4l/dev-teletext.rst
index 501e68077af2..2648f6b37ea3 100644
--- a/Documentation/linux_tv/media/v4l/dev-teletext.rst
+++ b/Documentation/linux_tv/media/v4l/dev-teletext.rst
@@ -32,12 +32,3 @@ Teletext API in kernel 2.6.37.
Modern devices all use the :ref:`raw <raw-vbi>` or
:ref:`sliced` VBI API.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/devices.rst b/Documentation/linux_tv/media/v4l/devices.rst
index dee6d10e2900..aed0ce11d1f8 100644
--- a/Documentation/linux_tv/media/v4l/devices.rst
+++ b/Documentation/linux_tv/media/v4l/devices.rst
@@ -24,14 +24,3 @@ Interfaces
dev-sdr
dev-event
dev-subdev
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/diff-v4l.rst b/Documentation/linux_tv/media/v4l/diff-v4l.rst
index da4b391116b5..301e1475ca70 100644
--- a/Documentation/linux_tv/media/v4l/diff-v4l.rst
+++ b/Documentation/linux_tv/media/v4l/diff-v4l.rst
@@ -952,12 +952,3 @@ devices is documented in :ref:`extended-controls`.
.. [9]
Old driver versions used different values, eventually the custom
``BTTV_VBISIZE`` ioctl was added to query the correct values.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/dmabuf.rst b/Documentation/linux_tv/media/v4l/dmabuf.rst
index 6f4f0f03e91d..cd68f755c0e3 100644
--- a/Documentation/linux_tv/media/v4l/dmabuf.rst
+++ b/Documentation/linux_tv/media/v4l/dmabuf.rst
@@ -147,12 +147,3 @@ Drivers implementing DMABUF importing I/O must support the
``VIDIOC_REQBUFS``, ``VIDIOC_QBUF``, ``VIDIOC_DQBUF``,
``VIDIOC_STREAMON`` and ``VIDIOC_STREAMOFF`` ioctls, and the
:c:func:`select()` and :c:func:`poll()` functions.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/driver.rst b/Documentation/linux_tv/media/v4l/driver.rst
index 7ed48861c6fe..2319b383f0a4 100644
--- a/Documentation/linux_tv/media/v4l/driver.rst
+++ b/Documentation/linux_tv/media/v4l/driver.rst
@@ -7,12 +7,3 @@ V4L2 Driver Programming
***********************
to do
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/dv-timings.rst b/Documentation/linux_tv/media/v4l/dv-timings.rst
index cde46bc95c79..415a0c4e2ccb 100644
--- a/Documentation/linux_tv/media/v4l/dv-timings.rst
+++ b/Documentation/linux_tv/media/v4l/dv-timings.rst
@@ -36,12 +36,3 @@ the DV timings as seen by the video receiver applications use the
Applications can make use of the :ref:`input-capabilities` and
:ref:`output-capabilities` flags to determine whether the digital
video ioctls can be used with the given input or output.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/extended-controls.rst b/Documentation/linux_tv/media/v4l/extended-controls.rst
index 413f6ca8eb60..ed10c9e274f5 100644
--- a/Documentation/linux_tv/media/v4l/extended-controls.rst
+++ b/Documentation/linux_tv/media/v4l/extended-controls.rst
@@ -4522,12 +4522,3 @@ RF_TUNER Control IDs
.. [1]
This control may be changed to a menu control in the future, if more
options are required.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/fdl-appendix.rst b/Documentation/linux_tv/media/v4l/fdl-appendix.rst
index 9f3a494cf497..fd475180fed8 100644
--- a/Documentation/linux_tv/media/v4l/fdl-appendix.rst
+++ b/Documentation/linux_tv/media/v4l/fdl-appendix.rst
@@ -469,12 +469,3 @@ recommend releasing these examples in parallel under your choice of free
software license, such as the
`GNU General Public License <http://www.gnu.org/copyleft/gpl.html>`__,
to permit their use in free software.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/field-order.rst b/Documentation/linux_tv/media/v4l/field-order.rst
index 0ab52df521a8..b9503e230fd9 100644
--- a/Documentation/linux_tv/media/v4l/field-order.rst
+++ b/Documentation/linux_tv/media/v4l/field-order.rst
@@ -197,14 +197,3 @@ should have the value ``V4L2_FIELD_ANY`` (0).
:align: center
Field Order, Bottom Field First Transmitted
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/format.rst b/Documentation/linux_tv/media/v4l/format.rst
index e9b1201fe316..a29dd9466b8f 100644
--- a/Documentation/linux_tv/media/v4l/format.rst
+++ b/Documentation/linux_tv/media/v4l/format.rst
@@ -90,12 +90,3 @@ by all drivers exchanging image data with applications.
(otherwise it could explicitly ask for them and need not enumerate)
seems useless, but there are applications serving as proxy between
drivers and the actual video applications for which this is useful.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/func-close.rst b/Documentation/linux_tv/media/v4l/func-close.rst
index 991a34a163af..fac5ec14a8e6 100644
--- a/Documentation/linux_tv/media/v4l/func-close.rst
+++ b/Documentation/linux_tv/media/v4l/func-close.rst
@@ -45,12 +45,3 @@ set appropriately. Possible error codes:
EBADF
``fd`` is not a valid open file descriptor.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/func-ioctl.rst b/Documentation/linux_tv/media/v4l/func-ioctl.rst
index 26b072cfe850..d442d9b56dfb 100644
--- a/Documentation/linux_tv/media/v4l/func-ioctl.rst
+++ b/Documentation/linux_tv/media/v4l/func-ioctl.rst
@@ -58,12 +58,3 @@ appropriately. The generic error codes are described at the
When an ioctl that takes an output or read/write parameter fails, the
parameter remains unmodified.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/func-mmap.rst b/Documentation/linux_tv/media/v4l/func-mmap.rst
index 51502a906c3c..a0be2d9b5421 100644
--- a/Documentation/linux_tv/media/v4l/func-mmap.rst
+++ b/Documentation/linux_tv/media/v4l/func-mmap.rst
@@ -130,12 +130,3 @@ EINVAL
ENOMEM
Not enough physical or virtual memory was available to complete the
request.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/func-munmap.rst b/Documentation/linux_tv/media/v4l/func-munmap.rst
index 80f9ecd92774..1f9831795db7 100644
--- a/Documentation/linux_tv/media/v4l/func-munmap.rst
+++ b/Documentation/linux_tv/media/v4l/func-munmap.rst
@@ -54,12 +54,3 @@ On success :c:func:`munmap()` returns 0, on failure -1 and the
EINVAL
The ``start`` or ``length`` is incorrect, or no buffers have been
mapped yet.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/func-open.rst b/Documentation/linux_tv/media/v4l/func-open.rst
index dcfce511e273..c021772a9dee 100644
--- a/Documentation/linux_tv/media/v4l/func-open.rst
+++ b/Documentation/linux_tv/media/v4l/func-open.rst
@@ -79,12 +79,3 @@ EMFILE
ENFILE
The limit on the total number of files open on the system has been
reached.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/func-poll.rst b/Documentation/linux_tv/media/v4l/func-poll.rst
index 3e96d9b0ce38..bfbcec2bb0cd 100644
--- a/Documentation/linux_tv/media/v4l/func-poll.rst
+++ b/Documentation/linux_tv/media/v4l/func-poll.rst
@@ -107,12 +107,3 @@ EINTR
EINVAL
The ``nfds`` argument is greater than ``OPEN_MAX``.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/func-read.rst b/Documentation/linux_tv/media/v4l/func-read.rst
index 4a4f3e86fd13..9238ecddec72 100644
--- a/Documentation/linux_tv/media/v4l/func-read.rst
+++ b/Documentation/linux_tv/media/v4l/func-read.rst
@@ -127,12 +127,3 @@ EIO
EINVAL
The :c:func:`read()` function is not supported by this driver, not
on this device, or generally not on this type of device.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/func-select.rst b/Documentation/linux_tv/media/v4l/func-select.rst
index de5583c4ffb3..5f2ff6a5e00c 100644
--- a/Documentation/linux_tv/media/v4l/func-select.rst
+++ b/Documentation/linux_tv/media/v4l/func-select.rst
@@ -97,12 +97,3 @@ EINVAL
The Linux kernel implements :c:func:`select()` like the
:ref:`poll() <func-poll>` function, but :c:func:`select()` cannot
return a ``POLLERR``.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/func-write.rst b/Documentation/linux_tv/media/v4l/func-write.rst
index 402beed3231c..fee5fe004c0a 100644
--- a/Documentation/linux_tv/media/v4l/func-write.rst
+++ b/Documentation/linux_tv/media/v4l/func-write.rst
@@ -78,12 +78,3 @@ EIO
EINVAL
The :c:func:`write()` function is not supported by this driver,
not on this device, or generally not on this type of device.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/gen-errors.rst b/Documentation/linux_tv/media/v4l/gen-errors.rst
index ad119579e9ea..500a2f73ffd9 100644
--- a/Documentation/linux_tv/media/v4l/gen-errors.rst
+++ b/Documentation/linux_tv/media/v4l/gen-errors.rst
@@ -98,12 +98,3 @@ errors.
Note 2: Request-specific error codes are listed in the individual
requests descriptions.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/hist-v4l2.rst b/Documentation/linux_tv/media/v4l/hist-v4l2.rst
index 6e9706f791de..88f813ad38c6 100644
--- a/Documentation/linux_tv/media/v4l/hist-v4l2.rst
+++ b/Documentation/linux_tv/media/v4l/hist-v4l2.rst
@@ -1478,12 +1478,3 @@ should not be implemented in new drivers.
.. [1]
This is not implemented in XFree86.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/io.rst b/Documentation/linux_tv/media/v4l/io.rst
index 77d13fdd1c28..e68342606ed3 100644
--- a/Documentation/linux_tv/media/v4l/io.rst
+++ b/Documentation/linux_tv/media/v4l/io.rst
@@ -49,14 +49,3 @@ The following sections describe the various I/O methods in more detail.
async
buffer
field-order
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/keytable.c.rst b/Documentation/linux_tv/media/v4l/keytable.c.rst
index c69833ca2fb7..f8d9c4b71f06 100644
--- a/Documentation/linux_tv/media/v4l/keytable.c.rst
+++ b/Documentation/linux_tv/media/v4l/keytable.c.rst
@@ -174,14 +174,3 @@ file: media/v4l/keytable.c
}
return 0;
}
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/libv4l-introduction.rst b/Documentation/linux_tv/media/v4l/libv4l-introduction.rst
index d189316dc1da..4b261d95c672 100644
--- a/Documentation/linux_tv/media/v4l/libv4l-introduction.rst
+++ b/Documentation/linux_tv/media/v4l/libv4l-introduction.rst
@@ -167,12 +167,3 @@ API.
It allows usage of binary legacy applications that still don't use
libv4l.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/libv4l.rst b/Documentation/linux_tv/media/v4l/libv4l.rst
index a88c52812f14..332c1d42688b 100644
--- a/Documentation/linux_tv/media/v4l/libv4l.rst
+++ b/Documentation/linux_tv/media/v4l/libv4l.rst
@@ -11,14 +11,3 @@ Libv4l Userspace Library
:maxdepth: 1
libv4l-introduction
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/lirc_dev_intro.rst b/Documentation/linux_tv/media/v4l/lirc_dev_intro.rst
index 10d4d9a96b15..520660114f99 100644
--- a/Documentation/linux_tv/media/v4l/lirc_dev_intro.rst
+++ b/Documentation/linux_tv/media/v4l/lirc_dev_intro.rst
@@ -26,12 +26,3 @@ What you should see for a chardev:
$ ls -l /dev/lirc*
crw-rw---- 1 root root 248, 0 Jul 2 22:20 /dev/lirc0
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/lirc_device_interface.rst b/Documentation/linux_tv/media/v4l/lirc_device_interface.rst
index 7f7bb6815013..a0c27ed5ad73 100644
--- a/Documentation/linux_tv/media/v4l/lirc_device_interface.rst
+++ b/Documentation/linux_tv/media/v4l/lirc_device_interface.rst
@@ -13,14 +13,3 @@ LIRC Device Interface
lirc_read
lirc_write
lirc_ioctl
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/lirc_ioctl.rst b/Documentation/linux_tv/media/v4l/lirc_ioctl.rst
index 947c3bf9ae07..916d064476f1 100644
--- a/Documentation/linux_tv/media/v4l/lirc_ioctl.rst
+++ b/Documentation/linux_tv/media/v4l/lirc_ioctl.rst
@@ -154,12 +154,3 @@ Return Value
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/lirc_read.rst b/Documentation/linux_tv/media/v4l/lirc_read.rst
index eb2387521862..b0b76c3d1d9a 100644
--- a/Documentation/linux_tv/media/v4l/lirc_read.rst
+++ b/Documentation/linux_tv/media/v4l/lirc_read.rst
@@ -17,12 +17,3 @@ chardev.
See also
`http://www.lirc.org/html/technical.html <http://www.lirc.org/html/technical.html>`__
for more info.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/lirc_write.rst b/Documentation/linux_tv/media/v4l/lirc_write.rst
index 234c8f43613e..d19cb486ecc9 100644
--- a/Documentation/linux_tv/media/v4l/lirc_write.rst
+++ b/Documentation/linux_tv/media/v4l/lirc_write.rst
@@ -12,12 +12,3 @@ The data must start and end with a pulse, therefore, the data must
always include an uneven number of samples. The write function must
block until the data has been transmitted by the hardware. If more data
is provided than the hardware can send, the driver returns ``EINVAL``.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/media-controller-intro.rst b/Documentation/linux_tv/media/v4l/media-controller-intro.rst
index e7e0d5cfe9ca..3e776c0d8276 100644
--- a/Documentation/linux_tv/media/v4l/media-controller-intro.rst
+++ b/Documentation/linux_tv/media/v4l/media-controller-intro.rst
@@ -31,12 +31,3 @@ applications really require based on limited information, thereby
implementing policies that belong to userspace.
The media controller API aims at solving those problems.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/media-controller-model.rst b/Documentation/linux_tv/media/v4l/media-controller-model.rst
index c9abb8e14302..7be58aecb882 100644
--- a/Documentation/linux_tv/media/v4l/media-controller-model.rst
+++ b/Documentation/linux_tv/media/v4l/media-controller-model.rst
@@ -33,12 +33,3 @@ are:
- An **interface link** is a point-to-point bidirectional control
connection between a Linux Kernel interface and an entity.m
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/media-controller.rst b/Documentation/linux_tv/media/v4l/media-controller.rst
index 4fd39178ccd7..49fb76cafcab 100644
--- a/Documentation/linux_tv/media/v4l/media-controller.rst
+++ b/Documentation/linux_tv/media/v4l/media-controller.rst
@@ -55,12 +55,3 @@ Revision and Copyright
:revision: 1.0.0 / 2010-11-10 (*lp*)
Initial revision
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/media-func-close.rst b/Documentation/linux_tv/media/v4l/media-func-close.rst
index e142ee73d15d..959bfa0cb6a8 100644
--- a/Documentation/linux_tv/media/v4l/media-func-close.rst
+++ b/Documentation/linux_tv/media/v4l/media-func-close.rst
@@ -43,12 +43,3 @@ Return Value
EBADF
``fd`` is not a valid open file descriptor.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/media-func-ioctl.rst b/Documentation/linux_tv/media/v4l/media-func-ioctl.rst
index 7a5c01d6cb4a..d7a3a01771ec 100644
--- a/Documentation/linux_tv/media/v4l/media-func-ioctl.rst
+++ b/Documentation/linux_tv/media/v4l/media-func-ioctl.rst
@@ -63,12 +63,3 @@ descriptions.
When an ioctl that takes an output or read/write parameter fails, the
parameter remains unmodified.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/media-func-open.rst b/Documentation/linux_tv/media/v4l/media-func-open.rst
index 573292ac9a94..fc731060a726 100644
--- a/Documentation/linux_tv/media/v4l/media-func-open.rst
+++ b/Documentation/linux_tv/media/v4l/media-func-open.rst
@@ -65,12 +65,3 @@ ENOMEM
ENXIO
No device corresponding to this device special file exists.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/media-ioc-device-info.rst b/Documentation/linux_tv/media/v4l/media-ioc-device-info.rst
index 230f9fd9b4fb..aca9c8aa736a 100644
--- a/Documentation/linux_tv/media/v4l/media-ioc-device-info.rst
+++ b/Documentation/linux_tv/media/v4l/media-ioc-device-info.rst
@@ -138,12 +138,3 @@ Return Value
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/media-ioc-enum-entities.rst b/Documentation/linux_tv/media/v4l/media-ioc-enum-entities.rst
index 6d2deba8dea8..8fe1f1966640 100644
--- a/Documentation/linux_tv/media/v4l/media-ioc-enum-entities.rst
+++ b/Documentation/linux_tv/media/v4l/media-ioc-enum-entities.rst
@@ -193,12 +193,3 @@ appropriately. The generic error codes are described at the
EINVAL
The struct :ref:`media_entity_desc <media-entity-desc>` ``id``
references a non-existing entity.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/media-ioc-enum-links.rst b/Documentation/linux_tv/media/v4l/media-ioc-enum-links.rst
index f3a4e41b3696..b0d4a946e151 100644
--- a/Documentation/linux_tv/media/v4l/media-ioc-enum-links.rst
+++ b/Documentation/linux_tv/media/v4l/media-ioc-enum-links.rst
@@ -169,12 +169,3 @@ appropriately. The generic error codes are described at the
EINVAL
The struct :ref:`media_links_enum <media-links-enum>` ``id``
references a non-existing entity.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/media-ioc-g-topology.rst b/Documentation/linux_tv/media/v4l/media-ioc-g-topology.rst
index f22310319264..6d530dc2a92c 100644
--- a/Documentation/linux_tv/media/v4l/media-ioc-g-topology.rst
+++ b/Documentation/linux_tv/media/v4l/media-ioc-g-topology.rst
@@ -425,12 +425,3 @@ ENOSPC
last time this ioctl was called. Userspace should usually free the
area for the pointers, zero the struct elements and call this ioctl
again.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/media-ioc-setup-link.rst b/Documentation/linux_tv/media/v4l/media-ioc-setup-link.rst
index 5b9c44e4ee77..135fa782dcd2 100644
--- a/Documentation/linux_tv/media/v4l/media-ioc-setup-link.rst
+++ b/Documentation/linux_tv/media/v4l/media-ioc-setup-link.rst
@@ -64,12 +64,3 @@ EINVAL
The struct :ref:`media_link_desc <media-link-desc>` references a
non-existing link, or the link is immutable and an attempt to modify
its configuration was made.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/media-types.rst b/Documentation/linux_tv/media/v4l/media-types.rst
index 50dec2b6cb3a..6a2d001babc2 100644
--- a/Documentation/linux_tv/media/v4l/media-types.rst
+++ b/Documentation/linux_tv/media/v4l/media-types.rst
@@ -420,14 +420,3 @@ must be set for every pad.
``MEDIA_LNK_FL_INTERFACE_LINK`` if the link is between an
interface and an entity
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/mmap.rst b/Documentation/linux_tv/media/v4l/mmap.rst
index 5f7450ff16c2..5769ed36872f 100644
--- a/Documentation/linux_tv/media/v4l/mmap.rst
+++ b/Documentation/linux_tv/media/v4l/mmap.rst
@@ -275,12 +275,3 @@ the :c:func:`mmap()`, :c:func:`munmap()`, :c:func:`select()` and
At the driver level :c:func:`select()` and :c:func:`poll()` are
the same, and :c:func:`select()` is too important to be optional.
The rest should be evident.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/open.rst b/Documentation/linux_tv/media/v4l/open.rst
index 83f406957cf4..c349575efc03 100644
--- a/Documentation/linux_tv/media/v4l/open.rst
+++ b/Documentation/linux_tv/media/v4l/open.rst
@@ -155,12 +155,3 @@ sections.
.. [3]
Drivers could recognize the ``O_EXCL`` open flag. Presently this is
not required, so applications cannot know if it really works.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-002.rst b/Documentation/linux_tv/media/v4l/pixfmt-002.rst
index a0c8c2298bdd..1645d07eeedb 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-002.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-002.rst
@@ -194,14 +194,3 @@ Single-planar format structure
- This information supplements the ``colorspace`` and must be set by
the driver for capture streams and by the application for output
streams, see :ref:`colorspaces`.
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-003.rst b/Documentation/linux_tv/media/v4l/pixfmt-003.rst
index cc8ef6137618..5abbfdf23289 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-003.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-003.rst
@@ -164,14 +164,3 @@ describing all planes of that format.
- Reserved for future extensions. Should be zeroed by drivers and
applications.
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-004.rst b/Documentation/linux_tv/media/v4l/pixfmt-004.rst
index 86d4975a95c9..4bc116aa8193 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-004.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-004.rst
@@ -49,12 +49,3 @@ memory buffer, but it can also be placed in two or three separate
buffers, with Y component in one buffer and CbCr components in another
in the 2-planar version or with each component in its own buffer in the
3-planar case. Those sub-buffers are referred to as "*planes*".
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-006.rst b/Documentation/linux_tv/media/v4l/pixfmt-006.rst
index 89a990745111..19e6a85b3400 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-006.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-006.rst
@@ -278,14 +278,3 @@ R'G'B' quantization.
- Use the limited range quantization encoding. I.e. the range [0…1]
is mapped to [16…235]. Cb and Cr are mapped from [-0.5…0.5] to
[16…240].
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-007.rst b/Documentation/linux_tv/media/v4l/pixfmt-007.rst
index 7caceea855a0..5e39cda6147a 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-007.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-007.rst
@@ -892,12 +892,3 @@ will have to set that information explicitly. Effectively
``V4L2_COLORSPACE_JPEG`` can be considered to be an abbreviation for
``V4L2_COLORSPACE_SRGB``, ``V4L2_YCBCR_ENC_601`` and
``V4L2_QUANTIZATION_FULL_RANGE``.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-008.rst b/Documentation/linux_tv/media/v4l/pixfmt-008.rst
index ef3daf1a5487..4bec79784bdd 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-008.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-008.rst
@@ -30,12 +30,3 @@ Transfer function:
Inverse Transfer function:
L = (max(L':sup:`1/m2` - c1, 0) / (c2 - c3 *
L'\ :sup:`1/m2`))\ :sup:`1/m1`
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-013.rst b/Documentation/linux_tv/media/v4l/pixfmt-013.rst
index b3cb7c48eb74..1f27e081a874 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-013.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-013.rst
@@ -127,14 +127,3 @@ Compressed Formats
- 'VP80'
- VP8 video elementary stream.
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-grey.rst b/Documentation/linux_tv/media/v4l/pixfmt-grey.rst
index 7a9bfe0ec53a..e1e19d558d59 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-grey.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-grey.rst
@@ -76,14 +76,3 @@ Each cell is one byte.
- Y'\ :sub:`32`
- Y'\ :sub:`33`
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-indexed.rst b/Documentation/linux_tv/media/v4l/pixfmt-indexed.rst
index a85b9832035e..dccf96b3d9c4 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-indexed.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-indexed.rst
@@ -71,14 +71,3 @@ the palette, this must be done with ioctls of the Linux framebuffer API.
- i\ :sub:`1`
- i\ :sub:`0`
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-m420.rst b/Documentation/linux_tv/media/v4l/pixfmt-m420.rst
index 553618ab62cf..4434ee1b1be9 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-m420.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-m420.rst
@@ -225,14 +225,3 @@ Each cell is one byte.
-
- Y
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-nv12.rst b/Documentation/linux_tv/media/v4l/pixfmt-nv12.rst
index ffbc9390e5bb..df26d495c892 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-nv12.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-nv12.rst
@@ -228,14 +228,3 @@ Each cell is one byte.
-
- Y
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-nv12m.rst b/Documentation/linux_tv/media/v4l/pixfmt-nv12m.rst
index 4a181af07724..c7db4038609a 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-nv12m.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-nv12m.rst
@@ -243,14 +243,3 @@ Each cell is one byte.
-
- Y
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-nv12mt.rst b/Documentation/linux_tv/media/v4l/pixfmt-nv12mt.rst
index 8b0b4d1812a0..6198941bb814 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-nv12mt.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-nv12mt.rst
@@ -60,12 +60,3 @@ interleaved. Height of the buffer is aligned to 32.
Memory layout of macroblocks of ``V4L2_PIX_FMT_NV12MT`` format in most
extreme case.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-nv16.rst b/Documentation/linux_tv/media/v4l/pixfmt-nv16.rst
index 4c3c638dec33..a82f46c77d2d 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-nv16.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-nv16.rst
@@ -277,14 +277,3 @@ Each cell is one byte.
- C
-
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-nv16m.rst b/Documentation/linux_tv/media/v4l/pixfmt-nv16m.rst
index e250f2c0bc7a..f6a82defe492 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-nv16m.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-nv16m.rst
@@ -284,14 +284,3 @@ Each cell is one byte.
- C
-
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-nv24.rst b/Documentation/linux_tv/media/v4l/pixfmt-nv24.rst
index 5b9716079c25..c0a8ddfd6963 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-nv24.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-nv24.rst
@@ -169,14 +169,3 @@ Each cell is one byte.
- Cb\ :sub:`33`
- Cr\ :sub:`33`
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-packed-rgb.rst b/Documentation/linux_tv/media/v4l/pixfmt-packed-rgb.rst
index 2b4a6c725d4c..517a5b42151c 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-packed-rgb.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-packed-rgb.rst
@@ -1468,12 +1468,3 @@ A test utility to determine which RGB formats a driver actually supports
is available from the LinuxTV v4l-dvb repository. See
`https://linuxtv.org/repo/ <https://linuxtv.org/repo/>`__ for access
instructions.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-packed-yuv.rst b/Documentation/linux_tv/media/v4l/pixfmt-packed-yuv.rst
index 095871a50436..70d0ad54bd22 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-packed-yuv.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-packed-yuv.rst
@@ -314,12 +314,3 @@ Bit 7 is the most significant bit. The value of a = alpha bits is
undefined when reading from the driver, ignored when writing to the
driver, except when alpha blending has been negotiated for a
:ref:`Video Overlay <overlay>` or :ref:`Video Output Overlay <osd>`.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-reserved.rst b/Documentation/linux_tv/media/v4l/pixfmt-reserved.rst
index 072f2843c137..73301b512b1a 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-reserved.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-reserved.rst
@@ -358,14 +358,3 @@ please make a proposal on the linux-media mailing list.
by RGBA values (128, 192, 255, 128), the same pixel described with
premultiplied colors would be described by RGBA values (64, 96,
128, 128)
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-rgb.rst b/Documentation/linux_tv/media/v4l/pixfmt-rgb.rst
index aa607332af25..4b3651cc0a96 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-rgb.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-rgb.rst
@@ -21,14 +21,3 @@ RGB Formats
pixfmt-srggb10alaw8
pixfmt-srggb10dpcm8
pixfmt-srggb12
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-sbggr16.rst b/Documentation/linux_tv/media/v4l/pixfmt-sbggr16.rst
index 9c1cf6d76bb6..742816ad4d41 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-sbggr16.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-sbggr16.rst
@@ -112,14 +112,3 @@ Each cell is one byte.
- R\ :sub:`33low`
- R\ :sub:`33high`
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-sbggr8.rst b/Documentation/linux_tv/media/v4l/pixfmt-sbggr8.rst
index 85d6d1f6e6d9..9a8e7d27e660 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-sbggr8.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-sbggr8.rst
@@ -80,14 +80,3 @@ Each cell is one byte.
- G\ :sub:`32`
- R\ :sub:`33`
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-sdr-cs08.rst b/Documentation/linux_tv/media/v4l/pixfmt-sdr-cs08.rst
index e75129d83def..201901d3f4c5 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-sdr-cs08.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-sdr-cs08.rst
@@ -42,14 +42,3 @@ Each cell is one byte.
- start + 1:
- Q'\ :sub:`0`
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-sdr-cs14le.rst b/Documentation/linux_tv/media/v4l/pixfmt-sdr-cs14le.rst
index cc94ffd90444..c7e471fe722f 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-sdr-cs14le.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-sdr-cs14le.rst
@@ -47,14 +47,3 @@ Each cell is one byte.
- Q'\ :sub:`0[7:0]`
- Q'\ :sub:`0[13:8]`
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-sdr-cu08.rst b/Documentation/linux_tv/media/v4l/pixfmt-sdr-cu08.rst
index 95c7b40b2d72..f97559ebcab5 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-sdr-cu08.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-sdr-cu08.rst
@@ -42,14 +42,3 @@ Each cell is one byte.
- start + 1:
- Q'\ :sub:`0`
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-sdr-cu16le.rst b/Documentation/linux_tv/media/v4l/pixfmt-sdr-cu16le.rst
index cc9891dd9c4b..ee73006bdb23 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-sdr-cu16le.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-sdr-cu16le.rst
@@ -46,14 +46,3 @@ Each cell is one byte.
- Q'\ :sub:`0[7:0]`
- Q'\ :sub:`0[15:8]`
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-sdr-ru12le.rst b/Documentation/linux_tv/media/v4l/pixfmt-sdr-ru12le.rst
index 8bcead790b3e..7147e6cfe6d9 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-sdr-ru12le.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-sdr-ru12le.rst
@@ -37,14 +37,3 @@ Each cell is one byte.
- I'\ :sub:`0[7:0]`
- I'\ :sub:`0[11:8]`
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-sgbrg8.rst b/Documentation/linux_tv/media/v4l/pixfmt-sgbrg8.rst
index efcd5269815f..8d783f332eaa 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-sgbrg8.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-sgbrg8.rst
@@ -80,14 +80,3 @@ Each cell is one byte.
- R\ :sub:`32`
- G\ :sub:`33`
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-sgrbg8.rst b/Documentation/linux_tv/media/v4l/pixfmt-sgrbg8.rst
index fd7506f17a2c..04b93d9335a6 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-sgrbg8.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-sgrbg8.rst
@@ -80,14 +80,3 @@ Each cell is one byte.
- B\ :sub:`32`
- G\ :sub:`33`
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-srggb10.rst b/Documentation/linux_tv/media/v4l/pixfmt-srggb10.rst
index b8b2b7c3cd91..2ad8ef04ad32 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-srggb10.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-srggb10.rst
@@ -116,14 +116,3 @@ Each cell is one byte, high 6 bits in high bytes are 0.
- R\ :sub:`33low`
- R\ :sub:`33high`
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-srggb10alaw8.rst b/Documentation/linux_tv/media/v4l/pixfmt-srggb10alaw8.rst
index 045c7a91203a..4e221629bcb3 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-srggb10alaw8.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-srggb10alaw8.rst
@@ -21,12 +21,3 @@ These four pixel formats are raw sRGB / Bayer formats with 10 bits per
color compressed to 8 bits each, using the A-LAW algorithm. Each color
component consumes 8 bits of memory. In other respects this format is
similar to :ref:`V4L2-PIX-FMT-SRGGB8`.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-srggb10dpcm8.rst b/Documentation/linux_tv/media/v4l/pixfmt-srggb10dpcm8.rst
index 03a27c43be21..23e7db7333ba 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-srggb10dpcm8.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-srggb10dpcm8.rst
@@ -22,12 +22,3 @@ colour compressed to 8 bits each, using DPCM compression. DPCM,
differential pulse-code modulation, is lossy. Each colour component
consumes 8 bits of memory. In other respects this format is similar to
:ref:`V4L2-PIX-FMT-SRGGB10`.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-srggb10p.rst b/Documentation/linux_tv/media/v4l/pixfmt-srggb10p.rst
index 503dd3050e02..fe2908e37d06 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-srggb10p.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-srggb10p.rst
@@ -99,14 +99,3 @@ Each cell is one byte.
- G\ :sub:`30low`\ (bits 7--6) R\ :sub:`31low`\ (bits 5--4)
G\ :sub:`32low`\ (bits 3--2) R\ :sub:`33low`\ (bits 1--0)
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-srggb12.rst b/Documentation/linux_tv/media/v4l/pixfmt-srggb12.rst
index fa10223104d7..fa2efa33be66 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-srggb12.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-srggb12.rst
@@ -116,14 +116,3 @@ Each cell is one byte, high 6 bits in high bytes are 0.
- R\ :sub:`33low`
- R\ :sub:`33high`
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-srggb8.rst b/Documentation/linux_tv/media/v4l/pixfmt-srggb8.rst
index b208ea5a2f66..eb3f6b5e39ca 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-srggb8.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-srggb8.rst
@@ -80,14 +80,3 @@ Each cell is one byte.
- G\ :sub:`32`
- B\ :sub:`33`
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-uv8.rst b/Documentation/linux_tv/media/v4l/pixfmt-uv8.rst
index 6e126e905ec8..033cedf85f57 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-uv8.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-uv8.rst
@@ -75,14 +75,3 @@ Each cell is one byte.
- Cb\ :sub:`31`
- Cr\ :sub:`31`
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-uyvy.rst b/Documentation/linux_tv/media/v4l/pixfmt-uyvy.rst
index fcdfb36c58c2..1184dd629d21 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-uyvy.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-uyvy.rst
@@ -203,14 +203,3 @@ Each cell is one byte.
- C
- Y
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-vyuy.rst b/Documentation/linux_tv/media/v4l/pixfmt-vyuy.rst
index b086bed774b2..7e25aee4f968 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-vyuy.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-vyuy.rst
@@ -203,14 +203,3 @@ Each cell is one byte.
- C
- Y
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-y10.rst b/Documentation/linux_tv/media/v4l/pixfmt-y10.rst
index 000dc5536cb4..bb3f3229d8e5 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-y10.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-y10.rst
@@ -109,14 +109,3 @@ Each cell is one byte.
- Y'\ :sub:`33low`
- Y'\ :sub:`33high`
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-y10b.rst b/Documentation/linux_tv/media/v4l/pixfmt-y10b.rst
index 83b7080643d5..5b50cd61e654 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-y10b.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-y10b.rst
@@ -43,14 +43,3 @@ pixels.
- Y'\ :sub:`02[5:0]`\ Y'\ :sub:`03[9:8]`
- Y'\ :sub:`03[7:0]`
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-y12.rst b/Documentation/linux_tv/media/v4l/pixfmt-y12.rst
index 66c16aa8b3d5..24c59c911fee 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-y12.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-y12.rst
@@ -109,14 +109,3 @@ Each cell is one byte.
- Y'\ :sub:`33low`
- Y'\ :sub:`33high`
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-y12i.rst b/Documentation/linux_tv/media/v4l/pixfmt-y12i.rst
index 18fffaef7f31..82a39faaad08 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-y12i.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-y12i.rst
@@ -46,14 +46,3 @@ interleaved pixel.
- Y'\ :sub:`0right[3:0]`\ Y'\ :sub:`0left[11:8]`
- Y'\ :sub:`0right[11:4]`
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-y16-be.rst b/Documentation/linux_tv/media/v4l/pixfmt-y16-be.rst
index 05fef3841ed7..6dcd9251659d 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-y16-be.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-y16-be.rst
@@ -110,14 +110,3 @@ Each cell is one byte.
- Y'\ :sub:`33high`
- Y'\ :sub:`33low`
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-y16.rst b/Documentation/linux_tv/media/v4l/pixfmt-y16.rst
index b3c766feb4c6..cc1565f37db8 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-y16.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-y16.rst
@@ -110,14 +110,3 @@ Each cell is one byte.
- Y'\ :sub:`33low`
- Y'\ :sub:`33high`
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-y41p.rst b/Documentation/linux_tv/media/v4l/pixfmt-y41p.rst
index d050d27e7ea1..bb10de3da994 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-y41p.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-y41p.rst
@@ -300,14 +300,3 @@ Each cell is one byte.
-
- Y
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-y8i.rst b/Documentation/linux_tv/media/v4l/pixfmt-y8i.rst
index 69ec8d7e8a06..3f3dbf18357f 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-y8i.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-y8i.rst
@@ -110,14 +110,3 @@ Each cell is one byte.
- Y'\ :sub:`33left`
- Y'\ :sub:`33right`
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-yuv410.rst b/Documentation/linux_tv/media/v4l/pixfmt-yuv410.rst
index f56902f6faed..642c20a038b6 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-yuv410.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-yuv410.rst
@@ -206,14 +206,3 @@ Each cell is one byte.
-
- Y
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-yuv411p.rst b/Documentation/linux_tv/media/v4l/pixfmt-yuv411p.rst
index bf4fa56b8efb..0fe1cacf7b7a 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-yuv411p.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-yuv411p.rst
@@ -224,14 +224,3 @@ Each cell is one byte.
-
- Y
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-yuv420.rst b/Documentation/linux_tv/media/v4l/pixfmt-yuv420.rst
index 0dd7e4632dd9..106afed50125 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-yuv420.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-yuv420.rst
@@ -238,14 +238,3 @@ Each cell is one byte.
-
- Y
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-yuv420m.rst b/Documentation/linux_tv/media/v4l/pixfmt-yuv420m.rst
index 5f918d0d1498..dc3d395a5731 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-yuv420m.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-yuv420m.rst
@@ -252,14 +252,3 @@ Each cell is one byte.
-
- Y
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-yuv422m.rst b/Documentation/linux_tv/media/v4l/pixfmt-yuv422m.rst
index 625d4ccf73d9..d8e438857e14 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-yuv422m.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-yuv422m.rst
@@ -261,14 +261,3 @@ Each cell is one byte.
- C
- Y
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-yuv422p.rst b/Documentation/linux_tv/media/v4l/pixfmt-yuv422p.rst
index d21794b48496..a7934540f69a 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-yuv422p.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-yuv422p.rst
@@ -244,14 +244,3 @@ Each cell is one byte.
- C
- Y
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-yuv444m.rst b/Documentation/linux_tv/media/v4l/pixfmt-yuv444m.rst
index 3d25c5e0ca00..c70e74631d4d 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-yuv444m.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-yuv444m.rst
@@ -281,14 +281,3 @@ Each cell is one byte.
-
- YC
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-yuyv.rst b/Documentation/linux_tv/media/v4l/pixfmt-yuyv.rst
index 2fed9b3c87c3..9f01ae03bd10 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-yuyv.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-yuyv.rst
@@ -204,14 +204,3 @@ Each cell is one byte.
- C
- Y
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-yvyu.rst b/Documentation/linux_tv/media/v4l/pixfmt-yvyu.rst
index 40eb6eda9fb1..45e3dcd7d222 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-yvyu.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-yvyu.rst
@@ -203,14 +203,3 @@ Each cell is one byte.
- C
- Y
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-z16.rst b/Documentation/linux_tv/media/v4l/pixfmt-z16.rst
index 25badab393ce..8804dd5cc1c0 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-z16.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-z16.rst
@@ -110,14 +110,3 @@ Each cell is one byte.
- Z\ :sub:`33low`
- Z\ :sub:`33high`
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/pixfmt.rst b/Documentation/linux_tv/media/v4l/pixfmt.rst
index 417796d39f00..81222a99f7ce 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt.rst
@@ -33,14 +33,3 @@ see also :ref:`VIDIOC_G_FBUF <VIDIOC_G_FBUF>`.)
pixfmt-013
sdr-formats
pixfmt-reserved
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/planar-apis.rst b/Documentation/linux_tv/media/v4l/planar-apis.rst
index db1e63bd691e..5fe2e1188230 100644
--- a/Documentation/linux_tv/media/v4l/planar-apis.rst
+++ b/Documentation/linux_tv/media/v4l/planar-apis.rst
@@ -59,12 +59,3 @@ Calls that distinguish between single and multi-planar APIs
:ref:`VIDIOC_REQBUFS <VIDIOC_REQBUFS>`
Will allocate multi-planar buffers as requested.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/querycap.rst b/Documentation/linux_tv/media/v4l/querycap.rst
index f3fa6cb6befe..c19cce7a816f 100644
--- a/Documentation/linux_tv/media/v4l/querycap.rst
+++ b/Documentation/linux_tv/media/v4l/querycap.rst
@@ -32,12 +32,3 @@ specific applications to reliably identify the driver.
All V4L2 drivers must support :ref:`VIDIOC_QUERYCAP`.
Applications should always call this ioctl after opening the device.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/remote_controllers.rst b/Documentation/linux_tv/media/v4l/remote_controllers.rst
index 07add9452be2..4b36e992f59a 100644
--- a/Documentation/linux_tv/media/v4l/remote_controllers.rst
+++ b/Documentation/linux_tv/media/v4l/remote_controllers.rst
@@ -42,12 +42,3 @@ Added the interface description and the RC sysfs class description.
:revision: 1.0 / 2009-09-06 (*mcc*)
Initial revision
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/remote_controllers_sysfs_nodes.rst b/Documentation/linux_tv/media/v4l/remote_controllers_sysfs_nodes.rst
index 03d2d422d4c0..6fb944fe21fd 100644
--- a/Documentation/linux_tv/media/v4l/remote_controllers_sysfs_nodes.rst
+++ b/Documentation/linux_tv/media/v4l/remote_controllers_sysfs_nodes.rst
@@ -141,12 +141,3 @@ scancodes which match the filter will wake the system from e.g. suspend
to RAM or power off. Otherwise the write will fail with an error.
This value may be reset to 0 if the wakeup protocol is altered.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/rw.rst b/Documentation/linux_tv/media/v4l/rw.rst
index beab37eccb1a..9dc58651ef02 100644
--- a/Documentation/linux_tv/media/v4l/rw.rst
+++ b/Documentation/linux_tv/media/v4l/rw.rst
@@ -45,12 +45,3 @@ driver must also support the :ref:`select() <func-select>` and
.. [2]
At the driver level :c:func:`select()` and :c:func:`poll()` are
the same, and :c:func:`select()` is too important to be optional.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/sdr-formats.rst b/Documentation/linux_tv/media/v4l/sdr-formats.rst
index 78c373c5b678..f863c08f1add 100644
--- a/Documentation/linux_tv/media/v4l/sdr-formats.rst
+++ b/Documentation/linux_tv/media/v4l/sdr-formats.rst
@@ -17,14 +17,3 @@ These formats are used for :ref:`SDR <sdr>` interface only.
pixfmt-sdr-cs08
pixfmt-sdr-cs14le
pixfmt-sdr-ru12le
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/selection-api-002.rst b/Documentation/linux_tv/media/v4l/selection-api-002.rst
index d1b2bc3d22e5..09ca93f91bf7 100644
--- a/Documentation/linux_tv/media/v4l/selection-api-002.rst
+++ b/Documentation/linux_tv/media/v4l/selection-api-002.rst
@@ -26,12 +26,3 @@ Rectangles for all cropping and composing targets are defined even if
the device does supports neither cropping nor composing. Their size and
position will be fixed in such a case. If the device does not support
scaling then the cropping and composing rectangles have the same size.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/selection-api-003.rst b/Documentation/linux_tv/media/v4l/selection-api-003.rst
index 9769d87407aa..15cb3b79f12c 100644
--- a/Documentation/linux_tv/media/v4l/selection-api-003.rst
+++ b/Documentation/linux_tv/media/v4l/selection-api-003.rst
@@ -18,12 +18,3 @@ Selection targets
See :ref:`v4l2-selection-targets` for more information.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/selection-api-004.rst b/Documentation/linux_tv/media/v4l/selection-api-004.rst
index 1a8f4d09bff1..d782cd5b2117 100644
--- a/Documentation/linux_tv/media/v4l/selection-api-004.rst
+++ b/Documentation/linux_tv/media/v4l/selection-api-004.rst
@@ -135,12 +135,3 @@ and the height of rectangles obtained using ``V4L2_SEL_TGT_CROP`` and
``V4L2_SEL_TGT_COMPOSE`` targets. If these are not equal then the
scaling is applied. The application can compute the scaling ratios using
these values.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/selection-api-005.rst b/Documentation/linux_tv/media/v4l/selection-api-005.rst
index 78448023a79a..94731a13efdb 100644
--- a/Documentation/linux_tv/media/v4l/selection-api-005.rst
+++ b/Documentation/linux_tv/media/v4l/selection-api-005.rst
@@ -32,12 +32,3 @@ struct :ref:`v4l2_selection <v4l2-selection>` provides a lot of place
for future extensions. Driver developers are encouraged to implement
only selection API. The former cropping API would be simulated using the
new one.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/selection-api-006.rst b/Documentation/linux_tv/media/v4l/selection-api-006.rst
index a7c04879cb5d..54b769e2fd73 100644
--- a/Documentation/linux_tv/media/v4l/selection-api-006.rst
+++ b/Documentation/linux_tv/media/v4l/selection-api-006.rst
@@ -79,14 +79,3 @@ for other devices
/* computing scaling factors */
hscale = (double)compose.r.width / crop.r.width;
vscale = (double)compose.r.height / crop.r.height;
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/selection-api.rst b/Documentation/linux_tv/media/v4l/selection-api.rst
index 1cc3b41b8435..81ea52d785b9 100644
--- a/Documentation/linux_tv/media/v4l/selection-api.rst
+++ b/Documentation/linux_tv/media/v4l/selection-api.rst
@@ -14,14 +14,3 @@ API for cropping, composing and scaling
selection-api-004
selection-api-005
selection-api-006
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/selections-common.rst b/Documentation/linux_tv/media/v4l/selections-common.rst
index 93efdc398fa9..69dbce4e6e47 100644
--- a/Documentation/linux_tv/media/v4l/selections-common.rst
+++ b/Documentation/linux_tv/media/v4l/selections-common.rst
@@ -21,14 +21,3 @@ on the two APIs.
v4l2-selection-targets
v4l2-selection-flags
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/standard.rst b/Documentation/linux_tv/media/v4l/standard.rst
index 67e295daa054..49135e260acc 100644
--- a/Documentation/linux_tv/media/v4l/standard.rst
+++ b/Documentation/linux_tv/media/v4l/standard.rst
@@ -177,12 +177,3 @@ standard ioctls can be used with the given input or output.
Some users are already confused by technical terms PAL, NTSC and
SECAM. There is no point asking them to distinguish between B, G, D,
or K when the software or hardware can do that automatically.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/streaming-par.rst b/Documentation/linux_tv/media/v4l/streaming-par.rst
index 643bad8cfc1a..b07b0f0b35d4 100644
--- a/Documentation/linux_tv/media/v4l/streaming-par.rst
+++ b/Documentation/linux_tv/media/v4l/streaming-par.rst
@@ -31,12 +31,3 @@ devices.
These ioctls are optional, drivers need not implement them. If so, they
return the ``EINVAL`` error code.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/subdev-formats.rst b/Documentation/linux_tv/media/v4l/subdev-formats.rst
index a13c0cba3df0..02a4b20fb1e8 100644
--- a/Documentation/linux_tv/media/v4l/subdev-formats.rst
+++ b/Documentation/linux_tv/media/v4l/subdev-formats.rst
@@ -11688,14 +11688,3 @@ formats.
- Interleaved raw UYVY and JPEG image format with embedded meta-data
used by Samsung S3C73MX camera sensors.
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/tuner.rst b/Documentation/linux_tv/media/v4l/tuner.rst
index 9c98e4f64c85..23d0e00aefdd 100644
--- a/Documentation/linux_tv/media/v4l/tuner.rst
+++ b/Documentation/linux_tv/media/v4l/tuner.rst
@@ -80,12 +80,3 @@ a pointer to a struct :ref:`v4l2_frequency <v4l2-frequency>`. These
ioctls are used for TV and radio devices alike. Drivers must support
both ioctls when the tuner or modulator ioctls are supported, or when
the device is a radio device.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/user-func.rst b/Documentation/linux_tv/media/v4l/user-func.rst
index daa6fd465d30..3e0413b83a33 100644
--- a/Documentation/linux_tv/media/v4l/user-func.rst
+++ b/Documentation/linux_tv/media/v4l/user-func.rst
@@ -79,14 +79,3 @@ Function Reference
func-read
func-select
func-write
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/userp.rst b/Documentation/linux_tv/media/v4l/userp.rst
index 23ef4b71444d..3f4df1fd984d 100644
--- a/Documentation/linux_tv/media/v4l/userp.rst
+++ b/Documentation/linux_tv/media/v4l/userp.rst
@@ -112,12 +112,3 @@ Drivers implementing user pointer I/O must support the
At the driver level :c:func:`select()` and :c:func:`poll()` are
the same, and :c:func:`select()` is too important to be optional.
The rest should be evident.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/v4l2-selection-flags.rst b/Documentation/linux_tv/media/v4l/v4l2-selection-flags.rst
index d72d3fb0d057..6c3531fd0017 100644
--- a/Documentation/linux_tv/media/v4l/v4l2-selection-flags.rst
+++ b/Documentation/linux_tv/media/v4l/v4l2-selection-flags.rst
@@ -69,14 +69,3 @@ Selection flags
- No
- Yes
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/v4l2-selection-targets.rst b/Documentation/linux_tv/media/v4l/v4l2-selection-targets.rst
index 781c4c713394..e9dcff094c77 100644
--- a/Documentation/linux_tv/media/v4l/v4l2-selection-targets.rst
+++ b/Documentation/linux_tv/media/v4l/v4l2-selection-targets.rst
@@ -133,14 +133,3 @@ of the two interfaces they are used.
- Yes
- No
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/v4l2.rst b/Documentation/linux_tv/media/v4l/v4l2.rst
index c9ba2859ebe5..9284446e3cfa 100644
--- a/Documentation/linux_tv/media/v4l/v4l2.rst
+++ b/Documentation/linux_tv/media/v4l/v4l2.rst
@@ -391,12 +391,3 @@ Second draft, with corrections pointed out by Gerd Knorr.
First draft, based on documentation by Bill Dirks and discussions on the
V4L mailing list.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/v4l2grab-example.rst b/Documentation/linux_tv/media/v4l/v4l2grab-example.rst
index 8b933d7a341a..c240f0513bee 100644
--- a/Documentation/linux_tv/media/v4l/v4l2grab-example.rst
+++ b/Documentation/linux_tv/media/v4l/v4l2grab-example.rst
@@ -15,14 +15,3 @@ with any V4L2 driver.
:maxdepth: 1
v4l2grab.c
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/v4l2grab.c.rst b/Documentation/linux_tv/media/v4l/v4l2grab.c.rst
index 6934294e61d9..817cad406c6f 100644
--- a/Documentation/linux_tv/media/v4l/v4l2grab.c.rst
+++ b/Documentation/linux_tv/media/v4l/v4l2grab.c.rst
@@ -167,14 +167,3 @@ file: media/v4l/v4l2grab.c
return 0;
}
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/video.rst b/Documentation/linux_tv/media/v4l/video.rst
index b8ecc774719c..b3c2b1d59f24 100644
--- a/Documentation/linux_tv/media/v4l/video.rst
+++ b/Documentation/linux_tv/media/v4l/video.rst
@@ -61,14 +61,3 @@ all the output ioctls when the device has one or more outputs.
perror("VIDIOC_S_INPUT");
exit(EXIT_FAILURE);
}
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/videodev.rst b/Documentation/linux_tv/media/v4l/videodev.rst
index 4d1f26a90a68..4826416b2ab4 100644
--- a/Documentation/linux_tv/media/v4l/videodev.rst
+++ b/Documentation/linux_tv/media/v4l/videodev.rst
@@ -11,14 +11,3 @@ Video For Linux Two Header File
:maxdepth: 1
../../videodev2.h
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/vidioc-create-bufs.rst b/Documentation/linux_tv/media/v4l/vidioc-create-bufs.rst
index efd9629e099e..0535758fec14 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-create-bufs.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-create-bufs.rst
@@ -143,12 +143,3 @@ ENOMEM
EINVAL
The buffer type (``format.type`` field), requested I/O method
(``memory``) or format (``format`` field) is not valid.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/vidioc-cropcap.rst b/Documentation/linux_tv/media/v4l/vidioc-cropcap.rst
index 22c4268ea54f..8391fc19126f 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-cropcap.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-cropcap.rst
@@ -164,12 +164,3 @@ appropriately. The generic error codes are described at the
EINVAL
The struct :ref:`v4l2_cropcap <v4l2-cropcap>` ``type`` is
invalid.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/vidioc-dbg-g-chip-info.rst b/Documentation/linux_tv/media/v4l/vidioc-dbg-g-chip-info.rst
index 7fc1e6b3e892..da8bd46288dc 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-dbg-g-chip-info.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-dbg-g-chip-info.rst
@@ -201,12 +201,3 @@ appropriately. The generic error codes are described at the
EINVAL
The ``match_type`` is invalid or no device could be matched.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/vidioc-dbg-g-register.rst b/Documentation/linux_tv/media/v4l/vidioc-dbg-g-register.rst
index 2c5afc9a4012..c1b21f3f73f0 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-dbg-g-register.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-dbg-g-register.rst
@@ -207,12 +207,3 @@ appropriately. The generic error codes are described at the
EPERM
Insufficient permissions. Root privileges are required to execute
these ioctls.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/vidioc-decoder-cmd.rst b/Documentation/linux_tv/media/v4l/vidioc-decoder-cmd.rst
index 3fd1da8c1132..5f7be4ee8a51 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-decoder-cmd.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-decoder-cmd.rst
@@ -269,12 +269,3 @@ EINVAL
EPERM
The application sent a PAUSE or RESUME command when the decoder was
not running.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/vidioc-dqevent.rst b/Documentation/linux_tv/media/v4l/vidioc-dqevent.rst
index 509f0df19746..ed37e07bbdc8 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-dqevent.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-dqevent.rst
@@ -570,12 +570,3 @@ Return Value
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/vidioc-dv-timings-cap.rst b/Documentation/linux_tv/media/v4l/vidioc-dv-timings-cap.rst
index dbfc5e92faf3..e852b6194f4a 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-dv-timings-cap.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-dv-timings-cap.rst
@@ -248,12 +248,3 @@ Return Value
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/vidioc-encoder-cmd.rst b/Documentation/linux_tv/media/v4l/vidioc-encoder-cmd.rst
index b62b508c83a7..cd7cc4bfd756 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-encoder-cmd.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-encoder-cmd.rst
@@ -193,12 +193,3 @@ EINVAL
EPERM
The application sent a PAUSE or RESUME command when the encoder was
not running.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/vidioc-enum-dv-timings.rst b/Documentation/linux_tv/media/v4l/vidioc-enum-dv-timings.rst
index a3deae4844f5..1ff64c497ff1 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-enum-dv-timings.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-enum-dv-timings.rst
@@ -117,12 +117,3 @@ EINVAL
ENODATA
Digital video presets are not supported for this input or output.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/vidioc-enum-fmt.rst b/Documentation/linux_tv/media/v4l/vidioc-enum-fmt.rst
index a8b162ed85a0..79162755ea75 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-enum-fmt.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-enum-fmt.rst
@@ -161,12 +161,3 @@ appropriately. The generic error codes are described at the
EINVAL
The struct :ref:`v4l2_fmtdesc <v4l2-fmtdesc>` ``type`` is not
supported or the ``index`` is out of bounds.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/vidioc-enum-frameintervals.rst b/Documentation/linux_tv/media/v4l/vidioc-enum-frameintervals.rst
index 24acbd928b9c..f7e41225e6b6 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-enum-frameintervals.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-enum-frameintervals.rst
@@ -271,12 +271,3 @@ Return Value
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/vidioc-enum-framesizes.rst b/Documentation/linux_tv/media/v4l/vidioc-enum-framesizes.rst
index 1d2969220857..ef9bcdee0635 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-enum-framesizes.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-enum-framesizes.rst
@@ -288,12 +288,3 @@ Return Value
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/vidioc-enum-freq-bands.rst b/Documentation/linux_tv/media/v4l/vidioc-enum-freq-bands.rst
index bc0826bec1cb..5e4a6d4a8640 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-enum-freq-bands.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-enum-freq-bands.rst
@@ -187,12 +187,3 @@ appropriately. The generic error codes are described at the
EINVAL
The ``tuner`` or ``index`` is out of bounds or the ``type`` field is
wrong.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/vidioc-enumaudio.rst b/Documentation/linux_tv/media/v4l/vidioc-enumaudio.rst
index 51d783734107..9573e54271fc 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-enumaudio.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-enumaudio.rst
@@ -52,12 +52,3 @@ appropriately. The generic error codes are described at the
EINVAL
The number of the audio input is out of bounds.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/vidioc-enumaudioout.rst b/Documentation/linux_tv/media/v4l/vidioc-enumaudioout.rst
index 660bcee62fcf..82ffb3194ed3 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-enumaudioout.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-enumaudioout.rst
@@ -55,12 +55,3 @@ appropriately. The generic error codes are described at the
EINVAL
The number of the audio output is out of bounds.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/vidioc-enuminput.rst b/Documentation/linux_tv/media/v4l/vidioc-enuminput.rst
index 7344777e3514..b67cae1bcafd 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-enuminput.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-enuminput.rst
@@ -364,12 +364,3 @@ appropriately. The generic error codes are described at the
EINVAL
The struct :ref:`v4l2_input <v4l2-input>` ``index`` is out of
bounds.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/vidioc-enumoutput.rst b/Documentation/linux_tv/media/v4l/vidioc-enumoutput.rst
index de0952353ad0..8dc5f8ee2eb5 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-enumoutput.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-enumoutput.rst
@@ -219,12 +219,3 @@ appropriately. The generic error codes are described at the
EINVAL
The struct :ref:`v4l2_output <v4l2-output>` ``index`` is out of
bounds.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/vidioc-enumstd.rst b/Documentation/linux_tv/media/v4l/vidioc-enumstd.rst
index 0f4433cefc49..098251b8be30 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-enumstd.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-enumstd.rst
@@ -439,12 +439,3 @@ ENODATA
may be used in addition to the main sound carrier. It is modulated in
differentially encoded QPSK with a 728 kbit/s sound and data
multiplexer capable of carrying two sound channels. (NICAM system)
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/vidioc-expbuf.rst b/Documentation/linux_tv/media/v4l/vidioc-expbuf.rst
index 04216a0d658e..a1f62a33739f 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-expbuf.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-expbuf.rst
@@ -194,12 +194,3 @@ appropriately. The generic error codes are described at the
EINVAL
A queue is not in MMAP mode or DMABUF exporting is not supported or
``flags`` or ``type`` or ``index`` or ``plane`` fields are invalid.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-audio.rst b/Documentation/linux_tv/media/v4l/vidioc-g-audio.rst
index abf441a04673..5ec052165642 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-audio.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-audio.rst
@@ -160,12 +160,3 @@ appropriately. The generic error codes are described at the
EINVAL
No audio inputs combine with the current video input, or the number
of the selected audio input is out of bounds or it does not combine.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-audioout.rst b/Documentation/linux_tv/media/v4l/vidioc-g-audioout.rst
index 6bfd5b1d5428..a2a492fccaed 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-audioout.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-audioout.rst
@@ -120,12 +120,3 @@ EINVAL
No audio outputs combine with the current video output, or the
number of the selected audio output is out of bounds or it does not
combine.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-crop.rst b/Documentation/linux_tv/media/v4l/vidioc-g-crop.rst
index aba0dc9b4390..1610c3fc1d93 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-crop.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-crop.rst
@@ -111,12 +111,3 @@ Return Value
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-ctrl.rst b/Documentation/linux_tv/media/v4l/vidioc-g-ctrl.rst
index 77a5d1aca78a..db1e7b252147 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-ctrl.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-ctrl.rst
@@ -103,12 +103,3 @@ EBUSY
EACCES
Attempt to set a read-only control or to get a write-only control.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-dv-timings.rst b/Documentation/linux_tv/media/v4l/vidioc-g-dv-timings.rst
index 2b2e154a2d1f..bd3d898acd53 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-dv-timings.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-dv-timings.rst
@@ -416,14 +416,3 @@ EBUSY
R'G'B' values use limited range (i.e. 16-235) as opposed to full
range (i.e. 0-255). All formats defined in CEA-861 except for the
640x480p59.94 format are CE formats.
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-edid.rst b/Documentation/linux_tv/media/v4l/vidioc-g-edid.rst
index 26332ceb8b94..5a72bed87cbb 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-edid.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-edid.rst
@@ -158,12 +158,3 @@ appropriately. The generic error codes are described at the
``E2BIG``
The EDID data you provided is more than the hardware can handle.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-enc-index.rst b/Documentation/linux_tv/media/v4l/vidioc-g-enc-index.rst
index 35df295e1809..864a347e6b1a 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-enc-index.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-enc-index.rst
@@ -207,12 +207,3 @@ Return Value
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-ext-ctrls.rst b/Documentation/linux_tv/media/v4l/vidioc-g-ext-ctrls.rst
index d12021c6fbb8..a85778172265 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-ext-ctrls.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-ext-ctrls.rst
@@ -487,12 +487,3 @@ ENOSPC
EACCES
Attempt to try or set a read-only control or to get a write-only
control.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-fbuf.rst b/Documentation/linux_tv/media/v4l/vidioc-g-fbuf.rst
index e52361001bb9..32ce2738d598 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-fbuf.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-fbuf.rst
@@ -498,12 +498,3 @@ EINVAL
offset instead. If you encounter problems please discuss on the
linux-media mailing list:
`https://linuxtv.org/lists.php <https://linuxtv.org/lists.php>`__.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-fmt.rst b/Documentation/linux_tv/media/v4l/vidioc-g-fmt.rst
index 869c7cc08035..684793a47267 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-fmt.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-fmt.rst
@@ -187,12 +187,3 @@ appropriately. The generic error codes are described at the
EINVAL
The struct :ref:`v4l2_format <v4l2-format>` ``type`` field is
invalid or the requested buffer type not supported.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-frequency.rst b/Documentation/linux_tv/media/v4l/vidioc-g-frequency.rst
index 40ef31938f79..c5f6846b498c 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-frequency.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-frequency.rst
@@ -121,12 +121,3 @@ EINVAL
EBUSY
A hardware seek is in progress.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-input.rst b/Documentation/linux_tv/media/v4l/vidioc-g-input.rst
index 1c14f7dcffeb..aae135ea2a77 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-input.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-input.rst
@@ -59,12 +59,3 @@ appropriately. The generic error codes are described at the
EINVAL
The number of the video input is out of bounds.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-jpegcomp.rst b/Documentation/linux_tv/media/v4l/vidioc-g-jpegcomp.rst
index b2da34012df6..0adc8b2e2aac 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-jpegcomp.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-jpegcomp.rst
@@ -180,12 +180,3 @@ Return Value
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-modulator.rst b/Documentation/linux_tv/media/v4l/vidioc-g-modulator.rst
index 2342e036850b..8b213e858b39 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-modulator.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-modulator.rst
@@ -253,12 +253,3 @@ appropriately. The generic error codes are described at the
EINVAL
The struct :ref:`v4l2_modulator <v4l2-modulator>` ``index`` is
out of bounds.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-output.rst b/Documentation/linux_tv/media/v4l/vidioc-g-output.rst
index 03defa561e5b..cd0646eb7539 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-output.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-output.rst
@@ -61,12 +61,3 @@ appropriately. The generic error codes are described at the
EINVAL
The number of the video output is out of bounds, or there are no
video outputs at all.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-parm.rst b/Documentation/linux_tv/media/v4l/vidioc-g-parm.rst
index 73974cd938b8..0f96b95ebc0e 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-parm.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-parm.rst
@@ -347,12 +347,3 @@ Return Value
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-priority.rst b/Documentation/linux_tv/media/v4l/vidioc-g-priority.rst
index b241970c8aee..f3fedd201c6d 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-priority.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-priority.rst
@@ -115,12 +115,3 @@ EINVAL
EBUSY
Another application already requested higher priority.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-selection.rst b/Documentation/linux_tv/media/v4l/vidioc-g-selection.rst
index 1159b012a0a1..337ad78d9a7c 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-selection.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-selection.rst
@@ -207,12 +207,3 @@ ERANGE
EBUSY
It is not possible to apply change of the selection rectangle at the
moment. Usually because streaming is in progress.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-sliced-vbi-cap.rst b/Documentation/linux_tv/media/v4l/vidioc-g-sliced-vbi-cap.rst
index ac08f606fdd8..f5052093a77a 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-sliced-vbi-cap.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-sliced-vbi-cap.rst
@@ -273,12 +273,3 @@ appropriately. The generic error codes are described at the
EINVAL
The value in the ``type`` field is wrong.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-std.rst b/Documentation/linux_tv/media/v4l/vidioc-g-std.rst
index 8cacecfb8c97..e1e3bb7fa726 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-std.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-std.rst
@@ -65,12 +65,3 @@ EINVAL
ENODATA
Standard video timings are not supported for this input or output.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-tuner.rst b/Documentation/linux_tv/media/v4l/vidioc-g-tuner.rst
index c5f947811746..57a14811773c 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-tuner.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-tuner.rst
@@ -713,12 +713,3 @@ EINVAL
future drivers should produce only the primary language in this mode.
Applications should request ``MODE_LANG1_LANG2`` to record both
languages or a stereo signal.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/vidioc-log-status.rst b/Documentation/linux_tv/media/v4l/vidioc-log-status.rst
index af89f8f2dca6..afff82efe392 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-log-status.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-log-status.rst
@@ -37,12 +37,3 @@ Return Value
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/vidioc-overlay.rst b/Documentation/linux_tv/media/v4l/vidioc-overlay.rst
index 990907643869..41ddeea5537f 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-overlay.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-overlay.rst
@@ -51,12 +51,3 @@ appropriately. The generic error codes are described at the
EINVAL
The overlay parameters have not been set up. See :ref:`overlay`
for the necessary steps.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/vidioc-prepare-buf.rst b/Documentation/linux_tv/media/v4l/vidioc-prepare-buf.rst
index bf31aaaf6c76..2c88d3cedecf 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-prepare-buf.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-prepare-buf.rst
@@ -58,12 +58,3 @@ EINVAL
The buffer ``type`` is not supported, or the ``index`` is out of
bounds, or no buffers have been allocated yet, or the ``userptr`` or
``length`` are invalid.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/vidioc-qbuf.rst b/Documentation/linux_tv/media/v4l/vidioc-qbuf.rst
index b51db1311e9f..88179f8019fa 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-qbuf.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-qbuf.rst
@@ -147,12 +147,3 @@ EPIPE
``VIDIOC_DQBUF`` returns this on an empty capture queue for mem2mem
codecs if a buffer with the ``V4L2_BUF_FLAG_LAST`` was already
dequeued and no new buffers are expected to become available.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/vidioc-query-dv-timings.rst b/Documentation/linux_tv/media/v4l/vidioc-query-dv-timings.rst
index 0c01ed49065f..6a37b6503399 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-query-dv-timings.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-query-dv-timings.rst
@@ -80,12 +80,3 @@ ENOLCK
ERANGE
Timings were found, but they are out of range of the hardware
capabilities.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/vidioc-querybuf.rst b/Documentation/linux_tv/media/v4l/vidioc-querybuf.rst
index 11c9c59688ae..2fae7021b511 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-querybuf.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-querybuf.rst
@@ -77,12 +77,3 @@ appropriately. The generic error codes are described at the
EINVAL
The buffer ``type`` is not supported, or the ``index`` is out of
bounds.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/vidioc-querycap.rst b/Documentation/linux_tv/media/v4l/vidioc-querycap.rst
index 0776232be520..a4091b482d75 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-querycap.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-querycap.rst
@@ -431,12 +431,3 @@ appropriately. The generic error codes are described at the
The struct :ref:`v4l2_framebuffer <v4l2-framebuffer>` lacks an
enum :ref:`v4l2_buf_type <v4l2-buf-type>` field, therefore the
type of overlay is implied by the driver capabilities.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/vidioc-queryctrl.rst b/Documentation/linux_tv/media/v4l/vidioc-queryctrl.rst
index 2c8ef053a1ab..7869ca7a04c3 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-queryctrl.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-queryctrl.rst
@@ -779,12 +779,3 @@ EACCES
controls after hardware detection without the trouble of reordering
control arrays and indices (``EINVAL`` cannot be used to skip private
controls because it would prematurely end the enumeration).
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/vidioc-querystd.rst b/Documentation/linux_tv/media/v4l/vidioc-querystd.rst
index de2fe176fc6d..8d6769f2b5c6 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-querystd.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-querystd.rst
@@ -62,12 +62,3 @@ appropriately. The generic error codes are described at the
ENODATA
Standard video timings are not supported for this input or output.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/vidioc-reqbufs.rst b/Documentation/linux_tv/media/v4l/vidioc-reqbufs.rst
index 065ea275c0df..b5a470935ce6 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-reqbufs.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-reqbufs.rst
@@ -122,12 +122,3 @@ appropriately. The generic error codes are described at the
EINVAL
The buffer type (``type`` field) or the requested I/O method
(``memory``) is not supported.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/vidioc-s-hw-freq-seek.rst b/Documentation/linux_tv/media/v4l/vidioc-s-hw-freq-seek.rst
index 68c96236806d..4789c5b74a0a 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-s-hw-freq-seek.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-s-hw-freq-seek.rst
@@ -176,12 +176,3 @@ ENODATA
EBUSY
Another hardware seek is already in progress.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/vidioc-streamon.rst b/Documentation/linux_tv/media/v4l/vidioc-streamon.rst
index 960c5965c7a6..c3ea38c6cb5b 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-streamon.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-streamon.rst
@@ -100,12 +100,3 @@ EPIPE
ENOLINK
The driver implements Media Controller interface and the pipeline
link configuration is invalid.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-frame-interval.rst b/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-frame-interval.rst
index 8c5298175ba5..d332897b30e8 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-frame-interval.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-frame-interval.rst
@@ -150,12 +150,3 @@ EINVAL
``pad`` references a non-existing pad, one of the ``code``,
``width`` or ``height`` fields are invalid for the given pad or the
``index`` field is out of bounds.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-frame-size.rst b/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-frame-size.rst
index 5ddb766f4a16..0f901d815ca5 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-frame-size.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-frame-size.rst
@@ -159,12 +159,3 @@ EINVAL
:ref:`v4l2_subdev_frame_size_enum <v4l2-subdev-frame-size-enum>`
``pad`` references a non-existing pad, the ``code`` is invalid for
the given pad or the ``index`` field is out of bounds.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-mbus-code.rst b/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-mbus-code.rst
index 13d466c2a4e1..bc8e07912d81 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-mbus-code.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-mbus-code.rst
@@ -112,12 +112,3 @@ EINVAL
:ref:`v4l2_subdev_mbus_code_enum <v4l2-subdev-mbus-code-enum>`
``pad`` references a non-existing pad, or the ``index`` field is out
of bounds.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/vidioc-subdev-g-crop.rst b/Documentation/linux_tv/media/v4l/vidioc-subdev-g-crop.rst
index 88416ba28d86..a4cc5f8ebf5b 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-subdev-g-crop.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-subdev-g-crop.rst
@@ -134,12 +134,3 @@ EINVAL
references a non-existing pad, the ``which`` field references a
non-existing format, or cropping is not supported on the given
subdev pad.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/vidioc-subdev-g-fmt.rst b/Documentation/linux_tv/media/v4l/vidioc-subdev-g-fmt.rst
index b4d109943fd2..6afa4fccb9ba 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-subdev-g-fmt.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-subdev-g-fmt.rst
@@ -170,12 +170,3 @@ Return Value
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/vidioc-subdev-g-frame-interval.rst b/Documentation/linux_tv/media/v4l/vidioc-subdev-g-frame-interval.rst
index 9504e8b5de8a..3c45d4b28f43 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-subdev-g-frame-interval.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-subdev-g-frame-interval.rst
@@ -120,12 +120,3 @@ EINVAL
:ref:`v4l2_subdev_frame_interval <v4l2-subdev-frame-interval>`
``pad`` references a non-existing pad, or the pad doesn't support
frame intervals.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/vidioc-subdev-g-selection.rst b/Documentation/linux_tv/media/v4l/vidioc-subdev-g-selection.rst
index d95b5431004c..738131619a4d 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-subdev-g-selection.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-subdev-g-selection.rst
@@ -142,12 +142,3 @@ EINVAL
``pad`` references a non-existing pad, the ``which`` field
references a non-existing format, or the selection target is not
supported on the given subdev pad.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/vidioc-subscribe-event.rst b/Documentation/linux_tv/media/v4l/vidioc-subscribe-event.rst
index a127622d47b8..8323386c93f8 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-subscribe-event.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-subscribe-event.rst
@@ -133,12 +133,3 @@ Return Value
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/media/v4l/yuv-formats.rst b/Documentation/linux_tv/media/v4l/yuv-formats.rst
index 2592d5b8527d..3334ea445657 100644
--- a/Documentation/linux_tv/media/v4l/yuv-formats.rst
+++ b/Documentation/linux_tv/media/v4l/yuv-formats.rst
@@ -53,14 +53,3 @@ to brightness information.
pixfmt-nv16m
pixfmt-nv24
pixfmt-m420
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/net.h.rst b/Documentation/linux_tv/net.h.rst
index c0a0e9310333..4b01cefdb0b7 100644
--- a/Documentation/linux_tv/net.h.rst
+++ b/Documentation/linux_tv/net.h.rst
@@ -57,14 +57,3 @@ file: net.h
#endif /*_DVBNET_H_*/
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/video.h.rst b/Documentation/linux_tv/video.h.rst
index b332a02b8fd6..4be16680ba01 100644
--- a/Documentation/linux_tv/video.h.rst
+++ b/Documentation/linux_tv/video.h.rst
@@ -278,14 +278,3 @@ file: video.h
#define VIDEO_TRY_COMMAND _IOWR('o', 60, struct video_command)
#endif /* _UAPI_DVBVIDEO_H_ */
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/Documentation/linux_tv/videodev2.h.rst b/Documentation/linux_tv/videodev2.h.rst
index 78f19aff04a7..bd433ab201cc 100644
--- a/Documentation/linux_tv/videodev2.h.rst
+++ b/Documentation/linux_tv/videodev2.h.rst
@@ -2298,14 +2298,3 @@ file: videodev2.h
#define BASE_VIDIOC_PRIVATE 192 /* 192-255 are private */
#endif /* _UAPI__LINUX_VIDEODEV2_H */
-
-
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
diff --git a/scripts/kernel-doc b/scripts/kernel-doc
old mode 100644
new mode 100755
--
2.7.4
^ permalink raw reply related [flat|nested] 52+ messages in thread* [PATCH 41/51] Documentation: pixfmt-y12i.rst: correct format conversion
2016-07-04 11:46 [PATCH 00/51] First part of documentation fixups Mauro Carvalho Chehab
` (39 preceding siblings ...)
2016-07-04 11:47 ` [PATCH 40/51] Documentation: linux_tv: remove trailing comments Mauro Carvalho Chehab
@ 2016-07-04 11:47 ` Mauro Carvalho Chehab
2016-07-04 11:47 ` [PATCH 42/51] Documentation: pixfmt-uyvy.rst: remove an empty column Mauro Carvalho Chehab
` (9 subsequent siblings)
50 siblings, 0 replies; 52+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-04 11:47 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, Jonathan Corbet,
Markus Heiser, linux-doc
The format conversion broke one paragraph into two. Fix it.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
Documentation/linux_tv/media/v4l/pixfmt-y12i.rst | 4 ----
1 file changed, 4 deletions(-)
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-y12i.rst b/Documentation/linux_tv/media/v4l/pixfmt-y12i.rst
index 82a39faaad08..8967e8c33b47 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-y12i.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-y12i.rst
@@ -19,7 +19,6 @@ pixels from 2 sources interleaved and bit-packed. Each pixel is stored
in a 24-bit word in the little-endian order. On a little-endian machine
these pixels can be deinterlaced using
-
.. code-block:: c
__u8 *buf;
@@ -27,12 +26,9 @@ these pixels can be deinterlaced using
right0 = *(__u16 *)(buf + 1) >> 4;
**Bit-packed representation.**
-
pixels cross the byte boundary and have a ratio of 3 bytes for each
interleaved pixel.
-
-
.. flat-table::
:header-rows: 0
:stub-columns: 0
--
2.7.4
^ permalink raw reply related [flat|nested] 52+ messages in thread* [PATCH 42/51] Documentation: pixfmt-uyvy.rst: remove an empty column
2016-07-04 11:46 [PATCH 00/51] First part of documentation fixups Mauro Carvalho Chehab
` (40 preceding siblings ...)
2016-07-04 11:47 ` [PATCH 41/51] Documentation: pixfmt-y12i.rst: correct format conversion Mauro Carvalho Chehab
@ 2016-07-04 11:47 ` Mauro Carvalho Chehab
2016-07-04 11:47 ` [PATCH 43/51] Documentation: pixfmt-yvyu.rst: " Mauro Carvalho Chehab
` (8 subsequent siblings)
50 siblings, 0 replies; 52+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-04 11:47 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, Jonathan Corbet,
Markus Heiser, linux-doc
The conversion added an empty column (probably, it was used on
DocBook just to increase spacing.
Remove it.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
Documentation/linux_tv/media/v4l/pixfmt-uyvy.rst | 7 -------
1 file changed, 7 deletions(-)
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-uyvy.rst b/Documentation/linux_tv/media/v4l/pixfmt-uyvy.rst
index 1184dd629d21..8eaacd3af3df 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-uyvy.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-uyvy.rst
@@ -24,8 +24,6 @@ half the horizontal resolution of the Y component.
Each cell is one byte.
-
-
.. flat-table::
:header-rows: 0
:stub-columns: 0
@@ -130,7 +128,6 @@ Each cell is one byte.
-
- 1
- -
- 2
-
@@ -146,7 +143,6 @@ Each cell is one byte.
- Y
- -
- Y
- C
@@ -163,7 +159,6 @@ Each cell is one byte.
- Y
- -
- Y
- C
@@ -180,7 +175,6 @@ Each cell is one byte.
- Y
- -
- Y
- C
@@ -197,7 +191,6 @@ Each cell is one byte.
- Y
- -
- Y
- C
--
2.7.4
^ permalink raw reply related [flat|nested] 52+ messages in thread* [PATCH 43/51] Documentation: pixfmt-yvyu.rst: remove an empty column
2016-07-04 11:46 [PATCH 00/51] First part of documentation fixups Mauro Carvalho Chehab
` (41 preceding siblings ...)
2016-07-04 11:47 ` [PATCH 42/51] Documentation: pixfmt-uyvy.rst: remove an empty column Mauro Carvalho Chehab
@ 2016-07-04 11:47 ` Mauro Carvalho Chehab
2016-07-04 11:47 ` [PATCH 44/51] Documentation: pixfmt-vyuy.rst: " Mauro Carvalho Chehab
` (7 subsequent siblings)
50 siblings, 0 replies; 52+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-04 11:47 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, Jonathan Corbet,
Markus Heiser, linux-doc
The conversion added an empty column (probably, it was used on
DocBook just to increase spacing.
Remove it.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
Documentation/linux_tv/media/v4l/pixfmt-yvyu.rst | 9 ---------
1 file changed, 9 deletions(-)
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-yvyu.rst b/Documentation/linux_tv/media/v4l/pixfmt-yvyu.rst
index 45e3dcd7d222..576af343b81b 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-yvyu.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-yvyu.rst
@@ -24,8 +24,6 @@ half the horizontal resolution of the Y component.
Each cell is one byte.
-
-
.. flat-table::
:header-rows: 0
:stub-columns: 0
@@ -115,8 +113,6 @@ Each cell is one byte.
**Color Sample Location..**
-
-
.. flat-table::
:header-rows: 0
:stub-columns: 0
@@ -130,7 +126,6 @@ Each cell is one byte.
-
- 1
- -
- 2
-
@@ -146,7 +141,6 @@ Each cell is one byte.
- Y
- -
- Y
- C
@@ -163,7 +157,6 @@ Each cell is one byte.
- Y
- -
- Y
- C
@@ -180,7 +173,6 @@ Each cell is one byte.
- Y
- -
- Y
- C
@@ -197,7 +189,6 @@ Each cell is one byte.
- Y
- -
- Y
- C
--
2.7.4
^ permalink raw reply related [flat|nested] 52+ messages in thread* [PATCH 44/51] Documentation: pixfmt-vyuy.rst: remove an empty column
2016-07-04 11:46 [PATCH 00/51] First part of documentation fixups Mauro Carvalho Chehab
` (42 preceding siblings ...)
2016-07-04 11:47 ` [PATCH 43/51] Documentation: pixfmt-yvyu.rst: " Mauro Carvalho Chehab
@ 2016-07-04 11:47 ` Mauro Carvalho Chehab
2016-07-04 11:47 ` [PATCH 45/51] Documentation: pixfmt-41p.rst: remove empty columns Mauro Carvalho Chehab
` (6 subsequent siblings)
50 siblings, 0 replies; 52+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-04 11:47 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, Jonathan Corbet,
Markus Heiser, linux-doc
The conversion added an empty column (probably, it was used on
DocBook just to increase spacing.
Remove it.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
Documentation/linux_tv/media/v4l/pixfmt-vyuy.rst | 9 ---------
1 file changed, 9 deletions(-)
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-vyuy.rst b/Documentation/linux_tv/media/v4l/pixfmt-vyuy.rst
index 7e25aee4f968..9ce531834d9a 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-vyuy.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-vyuy.rst
@@ -24,8 +24,6 @@ half the horizontal resolution of the Y component.
Each cell is one byte.
-
-
.. flat-table::
:header-rows: 0
:stub-columns: 0
@@ -115,8 +113,6 @@ Each cell is one byte.
**Color Sample Location..**
-
-
.. flat-table::
:header-rows: 0
:stub-columns: 0
@@ -133,7 +129,6 @@ Each cell is one byte.
-
- 2
- -
- 3
- .. row 2
@@ -146,7 +141,6 @@ Each cell is one byte.
- Y
- -
- Y
- C
@@ -163,7 +157,6 @@ Each cell is one byte.
- Y
- -
- Y
- C
@@ -180,7 +173,6 @@ Each cell is one byte.
- Y
- -
- Y
- C
@@ -197,7 +189,6 @@ Each cell is one byte.
- Y
- -
- Y
- C
--
2.7.4
^ permalink raw reply related [flat|nested] 52+ messages in thread* [PATCH 45/51] Documentation: pixfmt-41p.rst: remove empty columns
2016-07-04 11:46 [PATCH 00/51] First part of documentation fixups Mauro Carvalho Chehab
` (43 preceding siblings ...)
2016-07-04 11:47 ` [PATCH 44/51] Documentation: pixfmt-vyuy.rst: " Mauro Carvalho Chehab
@ 2016-07-04 11:47 ` Mauro Carvalho Chehab
2016-07-04 11:47 ` [PATCH 46/51] Documentation: pixfmt-yuv422m.rst: remove an empty column Mauro Carvalho Chehab
` (5 subsequent siblings)
50 siblings, 0 replies; 52+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-04 11:47 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, Jonathan Corbet,
Markus Heiser, linux-doc
The conversion added empty columns (probably, it was used on
DocBook just to increase spacing.
Remove them.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
Documentation/linux_tv/media/v4l/pixfmt-y41p.rst | 27 ------------------------
1 file changed, 27 deletions(-)
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-y41p.rst b/Documentation/linux_tv/media/v4l/pixfmt-y41p.rst
index bb10de3da994..1f8fe468001d 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-y41p.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-y41p.rst
@@ -152,8 +152,6 @@ Each cell is one byte.
**Color Sample Location..**
-
-
.. flat-table::
:header-rows: 0
:stub-columns: 0
@@ -164,25 +162,20 @@ Each cell is one byte.
-
- 0
- -
- 1
-
- 2
- -
- 3
- -
- 4
- -
- 5
-
- 6
- -
- 7
- .. row 2
@@ -191,27 +184,22 @@ Each cell is one byte.
- Y
- -
- Y
- C
- Y
- -
- Y
- -
- Y
- -
- Y
- C
- Y
- -
- Y
- .. row 3
@@ -220,27 +208,22 @@ Each cell is one byte.
- Y
- -
- Y
- C
- Y
- -
- Y
- -
- Y
- -
- Y
- C
- Y
- -
- Y
- .. row 4
@@ -249,27 +232,22 @@ Each cell is one byte.
- Y
- -
- Y
- C
- Y
- -
- Y
- -
- Y
- -
- Y
- C
- Y
- -
- Y
- .. row 5
@@ -278,25 +256,20 @@ Each cell is one byte.
- Y
- -
- Y
- C
- Y
- -
- Y
- -
- Y
- -
- Y
- C
- Y
- -
- Y
--
2.7.4
^ permalink raw reply related [flat|nested] 52+ messages in thread* [PATCH 46/51] Documentation: pixfmt-yuv422m.rst: remove an empty column
2016-07-04 11:46 [PATCH 00/51] First part of documentation fixups Mauro Carvalho Chehab
` (44 preceding siblings ...)
2016-07-04 11:47 ` [PATCH 45/51] Documentation: pixfmt-41p.rst: remove empty columns Mauro Carvalho Chehab
@ 2016-07-04 11:47 ` Mauro Carvalho Chehab
2016-07-04 11:47 ` [PATCH 47/51] Documentation: pixfmt-yuv444m.rst: remove empty columns Mauro Carvalho Chehab
` (4 subsequent siblings)
50 siblings, 0 replies; 52+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-04 11:47 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, Jonathan Corbet,
Markus Heiser, linux-doc
The conversion added an empty column (probably, it was used on
DocBook just to increase spacing.
Remove it.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
Documentation/linux_tv/media/v4l/pixfmt-yuv422m.rst | 5 -----
1 file changed, 5 deletions(-)
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-yuv422m.rst b/Documentation/linux_tv/media/v4l/pixfmt-yuv422m.rst
index d8e438857e14..0057bc85fd24 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-yuv422m.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-yuv422m.rst
@@ -188,7 +188,6 @@ Each cell is one byte.
-
- 1
- -
- 2
-
@@ -204,7 +203,6 @@ Each cell is one byte.
- Y
- -
- Y
- C
@@ -221,7 +219,6 @@ Each cell is one byte.
- Y
- -
- Y
- C
@@ -238,7 +235,6 @@ Each cell is one byte.
- Y
- -
- Y
- C
@@ -255,7 +251,6 @@ Each cell is one byte.
- Y
- -
- Y
- C
--
2.7.4
^ permalink raw reply related [flat|nested] 52+ messages in thread* [PATCH 47/51] Documentation: pixfmt-yuv444m.rst: remove empty columns
2016-07-04 11:46 [PATCH 00/51] First part of documentation fixups Mauro Carvalho Chehab
` (45 preceding siblings ...)
2016-07-04 11:47 ` [PATCH 46/51] Documentation: pixfmt-yuv422m.rst: remove an empty column Mauro Carvalho Chehab
@ 2016-07-04 11:47 ` Mauro Carvalho Chehab
2016-07-04 11:47 ` [PATCH 48/51] Documentation: pixfmt-yuv422p.rst: remove an empty column Mauro Carvalho Chehab
` (3 subsequent siblings)
50 siblings, 0 replies; 52+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-04 11:47 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, Jonathan Corbet,
Markus Heiser, linux-doc
The conversion added empty columns (probably, it was used on
DocBook just to increase spacing.
Remove them.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
Documentation/linux_tv/media/v4l/pixfmt-yuv444m.rst | 17 -----------------
1 file changed, 17 deletions(-)
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-yuv444m.rst b/Documentation/linux_tv/media/v4l/pixfmt-yuv444m.rst
index c70e74631d4d..556c37c34d67 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-yuv444m.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-yuv444m.rst
@@ -38,8 +38,6 @@ described in :ref:`planar-apis`.
Each cell is one byte.
-
-
.. flat-table::
:header-rows: 0
:stub-columns: 0
@@ -213,13 +211,10 @@ Each cell is one byte.
-
- 0
- -
- 1
- -
- 2
- -
- 3
- .. row 2
@@ -228,13 +223,10 @@ Each cell is one byte.
- YC
- -
- YC
- -
- YC
- -
- YC
- .. row 3
@@ -243,13 +235,10 @@ Each cell is one byte.
- YC
- -
- YC
- -
- YC
- -
- YC
- .. row 4
@@ -258,13 +247,10 @@ Each cell is one byte.
- YC
- -
- YC
- -
- YC
- -
- YC
- .. row 5
@@ -273,11 +259,8 @@ Each cell is one byte.
- YC
- -
- YC
- -
- YC
- -
- YC
--
2.7.4
^ permalink raw reply related [flat|nested] 52+ messages in thread* [PATCH 48/51] Documentation: pixfmt-yuv422p.rst: remove an empty column
2016-07-04 11:46 [PATCH 00/51] First part of documentation fixups Mauro Carvalho Chehab
` (46 preceding siblings ...)
2016-07-04 11:47 ` [PATCH 47/51] Documentation: pixfmt-yuv444m.rst: remove empty columns Mauro Carvalho Chehab
@ 2016-07-04 11:47 ` Mauro Carvalho Chehab
2016-07-04 11:47 ` [PATCH 49/51] Documentation: pixfmt-yuv411p.rst: " Mauro Carvalho Chehab
` (2 subsequent siblings)
50 siblings, 0 replies; 52+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-04 11:47 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, Jonathan Corbet,
Markus Heiser, linux-doc
The conversion added an empty column (probably, it was used on
DocBook just to increase spacing.
Remove it.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
Documentation/linux_tv/media/v4l/pixfmt-yuv422p.rst | 5 -----
1 file changed, 5 deletions(-)
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-yuv422p.rst b/Documentation/linux_tv/media/v4l/pixfmt-yuv422p.rst
index a7934540f69a..c5efeadc0e9c 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-yuv422p.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-yuv422p.rst
@@ -171,7 +171,6 @@ Each cell is one byte.
-
- 1
- -
- 2
-
@@ -187,7 +186,6 @@ Each cell is one byte.
- Y
- -
- Y
- C
@@ -204,7 +202,6 @@ Each cell is one byte.
- Y
- -
- Y
- C
@@ -221,7 +218,6 @@ Each cell is one byte.
- Y
- -
- Y
- C
@@ -238,7 +234,6 @@ Each cell is one byte.
- Y
- -
- Y
- C
--
2.7.4
^ permalink raw reply related [flat|nested] 52+ messages in thread* [PATCH 49/51] Documentation: pixfmt-yuv411p.rst: remove an empty column
2016-07-04 11:46 [PATCH 00/51] First part of documentation fixups Mauro Carvalho Chehab
` (47 preceding siblings ...)
2016-07-04 11:47 ` [PATCH 48/51] Documentation: pixfmt-yuv422p.rst: remove an empty column Mauro Carvalho Chehab
@ 2016-07-04 11:47 ` Mauro Carvalho Chehab
2016-07-04 11:47 ` [PATCH 50/51] Documentation: pixfmt-nv12.rst: remove empty columns Mauro Carvalho Chehab
2016-07-04 11:47 ` [PATCH 51/51] Documentation: pixfmt-nv12m.rst: fix conversion issues Mauro Carvalho Chehab
50 siblings, 0 replies; 52+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-04 11:47 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, Jonathan Corbet,
Markus Heiser, linux-doc
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #1: Type: text/plain; charset=true, Size: 1752 bytes --]
The conversion added an empty column (probably, it was used on
DocBook just to increase spacing.
It also added an extra line on one of the texts, breaking
the original paragraph into two ones.
Remove them.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
Documentation/linux_tv/media/v4l/pixfmt-yuv411p.rst | 12 ------------
1 file changed, 12 deletions(-)
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-yuv411p.rst b/Documentation/linux_tv/media/v4l/pixfmt-yuv411p.rst
index 0fe1cacf7b7a..9521c4431c78 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-yuv411p.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-yuv411p.rst
@@ -30,11 +30,9 @@ have ¼ as many pad bytes after their rows. In other words, four C x rows
(including padding) is exactly as long as one Y row (including padding).
**Byte Order..**
-
Each cell is one byte.
-
.. flat-table::
:header-rows: 0
:stub-columns: 0
@@ -152,13 +150,11 @@ Each cell is one byte.
-
- 0
- -
- 1
-
- 2
- -
- 3
- .. row 2
@@ -167,14 +163,12 @@ Each cell is one byte.
- Y
- -
- Y
- C
- Y
- -
- Y
- .. row 3
@@ -183,14 +177,12 @@ Each cell is one byte.
- Y
- -
- Y
- C
- Y
- -
- Y
- .. row 4
@@ -199,14 +191,12 @@ Each cell is one byte.
- Y
- -
- Y
- C
- Y
- -
- Y
- .. row 5
@@ -215,12 +205,10 @@ Each cell is one byte.
- Y
- -
- Y
- C
- Y
- -
- Y
--
2.7.4
^ permalink raw reply related [flat|nested] 52+ messages in thread* [PATCH 50/51] Documentation: pixfmt-nv12.rst: remove empty columns
2016-07-04 11:46 [PATCH 00/51] First part of documentation fixups Mauro Carvalho Chehab
` (48 preceding siblings ...)
2016-07-04 11:47 ` [PATCH 49/51] Documentation: pixfmt-yuv411p.rst: " Mauro Carvalho Chehab
@ 2016-07-04 11:47 ` Mauro Carvalho Chehab
2016-07-04 11:47 ` [PATCH 51/51] Documentation: pixfmt-nv12m.rst: fix conversion issues Mauro Carvalho Chehab
50 siblings, 0 replies; 52+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-04 11:47 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, Jonathan Corbet,
Markus Heiser, linux-doc
The conversion added empty columns (probably, it was used on
DocBook just to increase spacing.
Remove them.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
Documentation/linux_tv/media/v4l/pixfmt-nv12.rst | 13 ++-----------
1 file changed, 2 insertions(+), 11 deletions(-)
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-nv12.rst b/Documentation/linux_tv/media/v4l/pixfmt-nv12.rst
index df26d495c892..363e9484aef4 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-nv12.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-nv12.rst
@@ -118,8 +118,6 @@ Each cell is one byte.
**Color Sample Location..**
-
-
.. flat-table::
:header-rows: 0
:stub-columns: 0
@@ -133,7 +131,6 @@ Each cell is one byte.
-
- 1
- -
- 2
-
@@ -148,7 +145,6 @@ Each cell is one byte.
-
- Y
- -
- Y
-
@@ -162,7 +158,6 @@ Each cell is one byte.
-
-
- -
- C
-
@@ -172,11 +167,10 @@ Each cell is one byte.
- 1
- Y
-
-
+
- Y
- -
- Y
-
@@ -191,11 +185,10 @@ Each cell is one byte.
- 2
- Y
-
-
+
- Y
- -
- Y
-
@@ -209,7 +202,6 @@ Each cell is one byte.
-
-
- -
- C
-
@@ -223,7 +215,6 @@ Each cell is one byte.
-
- Y
- -
- Y
-
--
2.7.4
^ permalink raw reply related [flat|nested] 52+ messages in thread* [PATCH 51/51] Documentation: pixfmt-nv12m.rst: fix conversion issues
2016-07-04 11:46 [PATCH 00/51] First part of documentation fixups Mauro Carvalho Chehab
` (49 preceding siblings ...)
2016-07-04 11:47 ` [PATCH 50/51] Documentation: pixfmt-nv12.rst: remove empty columns Mauro Carvalho Chehab
@ 2016-07-04 11:47 ` Mauro Carvalho Chehab
50 siblings, 0 replies; 52+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-04 11:47 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, Jonathan Corbet,
Markus Heiser, linux-doc
The conversion added an empty column (probably, it was used on
DocBook just to increase spacing.
It also added an extra line on one of the texts, breaking
the original paragraph into two ones.
Remove them.
Finally, a space is required before :sub:, as otherwise it
won't display it right. Add it.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
Documentation/linux_tv/media/v4l/pixfmt-nv12m.rst | 13 ++-----------
1 file changed, 2 insertions(+), 11 deletions(-)
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-nv12m.rst b/Documentation/linux_tv/media/v4l/pixfmt-nv12m.rst
index c7db4038609a..a769808aab9b 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-nv12m.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-nv12m.rst
@@ -26,8 +26,8 @@ occupies the first plane. The Y plane has one byte per pixel. In the
second plane there is a chrominance data with alternating chroma
samples. The CbCr plane is the same width, in bytes, as the Y plane (and
of the image), but is half as tall in pixels. Each CbCr pair belongs to
-four pixels. For example, Cb\ :sub:`0`/Cr:sub:`0` belongs to
-Y'\ :sub:`00`, Y'\ :sub:`01`, Y'\ :sub:`10`, Y'\ :sub:`11`.
+four pixels. For example, Cb :sub:`0`/Cr :sub:`0` belongs to
+Y' :sub:`00`, Y' :sub:`01`, Y' :sub:`10`, Y' :sub:`11`.
``V4L2_PIX_FMT_NV12MT_16X16`` is the tiled version of
``V4L2_PIX_FMT_NV12M`` with 16x16 macroblock tiles. Here pixels are
arranged in 16x16 2D tiles and tiles are arranged in linear order in
@@ -43,11 +43,8 @@ If the Y plane has pad bytes after each row, then the CbCr plane has as
many pad bytes after its rows.
**Byte Order..**
-
Each cell is one byte.
-
-
.. flat-table::
:header-rows: 0
:stub-columns: 0
@@ -148,7 +145,6 @@ Each cell is one byte.
-
- 1
- -
- 2
-
@@ -163,7 +159,6 @@ Each cell is one byte.
-
- Y
- -
- Y
-
@@ -177,7 +172,6 @@ Each cell is one byte.
-
-
- -
- C
-
@@ -191,7 +185,6 @@ Each cell is one byte.
-
- Y
- -
- Y
-
@@ -210,7 +203,6 @@ Each cell is one byte.
-
- Y
- -
- Y
-
@@ -238,7 +230,6 @@ Each cell is one byte.
-
- Y
- -
- Y
-
--
2.7.4
^ permalink raw reply related [flat|nested] 52+ messages in thread