From 407e84cd1e9a802df1955e281d8956439abc499b Mon Sep 17 00:00:00 2001 From: Mauro Carvalho Chehab Date: Thu, 24 Sep 2020 14:04:26 +0200 Subject: media: docs: make V4L documents more compatible with Sphinx 3.1+ Sphinx 3.x broke support for the cdomain.py extension, as the c domain code was rewritten. Due to that, the c tags need to be re-written, in order to use the new c domain notation. Signed-off-by: Mauro Carvalho Chehab --- Documentation/userspace-api/media/v4l/buffer.rst | 14 +---- .../userspace-api/media/v4l/dev-capture.rst | 7 +-- .../userspace-api/media/v4l/dev-output.rst | 7 +-- .../userspace-api/media/v4l/dev-raw-vbi.rst | 19 ++---- Documentation/userspace-api/media/v4l/dev-rds.rst | 12 +--- .../userspace-api/media/v4l/dev-sliced-vbi.rst | 31 +++------- Documentation/userspace-api/media/v4l/diff-v4l.rst | 39 ++---------- Documentation/userspace-api/media/v4l/dmabuf.rst | 8 +-- Documentation/userspace-api/media/v4l/format.rst | 7 +-- .../userspace-api/media/v4l/func-close.rst | 8 +-- .../userspace-api/media/v4l/func-ioctl.rst | 10 +--- .../userspace-api/media/v4l/func-mmap.rst | 18 +++--- .../userspace-api/media/v4l/func-munmap.rst | 14 ++--- .../userspace-api/media/v4l/func-open.rst | 14 ++--- .../userspace-api/media/v4l/func-poll.rst | 40 ++++++------- .../userspace-api/media/v4l/func-read.rst | 39 ++++++------ .../userspace-api/media/v4l/func-select.rst | 42 ++++++------- .../userspace-api/media/v4l/func-write.rst | 13 ++-- .../userspace-api/media/v4l/hist-v4l2.rst | 70 ++-------------------- Documentation/userspace-api/media/v4l/io.rst | 6 +- .../media/v4l/libv4l-introduction.rst | 30 ++++------ Documentation/userspace-api/media/v4l/mmap.rst | 26 ++++---- Documentation/userspace-api/media/v4l/open.rst | 15 ++--- Documentation/userspace-api/media/v4l/rw.rst | 18 +++--- .../userspace-api/media/v4l/streaming-par.rst | 5 +- Documentation/userspace-api/media/v4l/userp.rst | 11 ++-- .../userspace-api/media/v4l/vidioc-create-bufs.rst | 11 ++-- .../userspace-api/media/v4l/vidioc-cropcap.rst | 11 ++-- .../media/v4l/vidioc-dbg-g-chip-info.rst | 13 ++-- .../media/v4l/vidioc-dbg-g-register.rst | 18 +++--- .../userspace-api/media/v4l/vidioc-decoder-cmd.rst | 19 +++--- .../userspace-api/media/v4l/vidioc-dqevent.rst | 19 ++---- .../media/v4l/vidioc-dv-timings-cap.rst | 17 +++--- .../userspace-api/media/v4l/vidioc-encoder-cmd.rst | 25 ++++---- .../media/v4l/vidioc-enum-dv-timings.rst | 16 +++-- .../userspace-api/media/v4l/vidioc-enum-fmt.rst | 12 ++-- .../media/v4l/vidioc-enum-frameintervals.rst | 15 ++--- .../media/v4l/vidioc-enum-framesizes.rst | 16 ++--- .../media/v4l/vidioc-enum-freq-bands.rst | 12 ++-- .../userspace-api/media/v4l/vidioc-enumaudio.rst | 10 ++-- .../media/v4l/vidioc-enumaudioout.rst | 10 ++-- .../userspace-api/media/v4l/vidioc-enuminput.rst | 14 ++--- .../userspace-api/media/v4l/vidioc-enumoutput.rst | 13 ++-- .../userspace-api/media/v4l/vidioc-enumstd.rst | 23 +++---- .../userspace-api/media/v4l/vidioc-expbuf.rst | 14 ++--- .../userspace-api/media/v4l/vidioc-g-audio.rst | 18 +++--- .../userspace-api/media/v4l/vidioc-g-audioout.rst | 16 +++-- .../userspace-api/media/v4l/vidioc-g-crop.rst | 16 +++-- .../userspace-api/media/v4l/vidioc-g-ctrl.rst | 16 +++-- .../media/v4l/vidioc-g-dv-timings.rst | 26 ++++---- .../userspace-api/media/v4l/vidioc-g-edid.rst | 25 ++++---- .../userspace-api/media/v4l/vidioc-g-enc-index.rst | 13 ++-- .../userspace-api/media/v4l/vidioc-g-ext-ctrls.rst | 21 +++---- .../userspace-api/media/v4l/vidioc-g-fbuf.rst | 18 +++--- .../userspace-api/media/v4l/vidioc-g-fmt.rst | 22 +++---- .../userspace-api/media/v4l/vidioc-g-frequency.rst | 16 +++-- .../userspace-api/media/v4l/vidioc-g-input.rst | 15 +++-- .../userspace-api/media/v4l/vidioc-g-jpegcomp.rst | 17 +++--- .../userspace-api/media/v4l/vidioc-g-modulator.rst | 17 +++--- .../userspace-api/media/v4l/vidioc-g-output.rst | 15 +++-- .../userspace-api/media/v4l/vidioc-g-parm.rst | 30 ++++------ .../userspace-api/media/v4l/vidioc-g-priority.rst | 16 +++-- .../userspace-api/media/v4l/vidioc-g-selection.rst | 15 ++--- .../media/v4l/vidioc-g-sliced-vbi-cap.rst | 12 ++-- .../userspace-api/media/v4l/vidioc-g-std.rst | 24 ++++---- .../userspace-api/media/v4l/vidioc-g-tuner.rst | 19 +++--- .../userspace-api/media/v4l/vidioc-log-status.rst | 10 ++-- .../userspace-api/media/v4l/vidioc-overlay.rst | 10 ++-- .../userspace-api/media/v4l/vidioc-prepare-buf.rst | 10 ++-- .../userspace-api/media/v4l/vidioc-qbuf.rst | 17 +++--- .../media/v4l/vidioc-query-dv-timings.rst | 15 +++-- .../userspace-api/media/v4l/vidioc-querybuf.rst | 10 ++-- .../userspace-api/media/v4l/vidioc-querycap.rst | 16 ++--- .../userspace-api/media/v4l/vidioc-queryctrl.rst | 22 +++---- .../userspace-api/media/v4l/vidioc-querystd.rst | 15 +++-- .../userspace-api/media/v4l/vidioc-reqbufs.rst | 10 ++-- .../media/v4l/vidioc-s-hw-freq-seek.rst | 11 ++-- .../userspace-api/media/v4l/vidioc-streamon.rst | 14 ++--- .../v4l/vidioc-subdev-enum-frame-interval.rst | 10 ++-- .../media/v4l/vidioc-subdev-enum-frame-size.rst | 11 ++-- .../media/v4l/vidioc-subdev-enum-mbus-code.rst | 10 ++-- .../media/v4l/vidioc-subdev-g-crop.rst | 16 +++-- .../media/v4l/vidioc-subdev-g-fmt.rst | 17 +++--- .../media/v4l/vidioc-subdev-g-frame-interval.rst | 16 +++-- .../media/v4l/vidioc-subdev-g-selection.rst | 17 +++--- .../media/v4l/vidioc-subdev-querycap.rst | 9 ++- .../media/v4l/vidioc-subscribe-event.rst | 17 +++--- 87 files changed, 559 insertions(+), 922 deletions(-) (limited to 'Documentation/userspace-api') diff --git a/Documentation/userspace-api/media/v4l/buffer.rst b/Documentation/userspace-api/media/v4l/buffer.rst index 4f95496adc5b..8be62dcffbb2 100644 --- a/Documentation/userspace-api/media/v4l/buffer.rst +++ b/Documentation/userspace-api/media/v4l/buffer.rst @@ -1,4 +1,5 @@ .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later +.. c:namespace:: V4L .. _buffer: @@ -33,7 +34,6 @@ 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 buffer. - Interactions between formats, controls and buffers ================================================== @@ -152,7 +152,6 @@ based on the queried sizes (for instance by allocating a set of buffers large enough for all the desired formats and controls, or by allocating separate set of appropriately sized buffers for each use case). - .. c:type:: v4l2_buffer struct v4l2_buffer @@ -257,7 +256,7 @@ struct v4l2_buffer ``V4L2_MEMORY_MMAP`` this is the offset of the buffer from the start of the device memory. The value is returned by the driver and apart of serving as parameter to the - :ref:`mmap() ` function not useful for applications. + :c:func:`mmap()` function not useful for applications. See :ref:`mmap` for details * - unsigned long - ``userptr`` @@ -310,7 +309,6 @@ struct v4l2_buffer given, then ``EINVAL`` will be returned. - .. c:type:: v4l2_plane struct v4l2_plane @@ -350,7 +348,7 @@ struct v4l2_plane - ``mem_offset`` - When the memory type in the containing struct :c:type:`v4l2_buffer` is ``V4L2_MEMORY_MMAP``, this - is the value that should be passed to :ref:`mmap() `, + is the value that should be passed to :c:func:`mmap()`, similar to the ``offset`` field in struct :c:type:`v4l2_buffer`. * - unsigned long @@ -384,7 +382,6 @@ struct v4l2_plane applications. - .. c:type:: v4l2_buf_type enum v4l2_buf_type @@ -448,7 +445,6 @@ enum v4l2_buf_type - Buffer for metadata output, see :ref:`metadata`. - .. _buffer-flags: Buffer Flags @@ -720,7 +716,6 @@ enum v4l2_memory - The buffer is used for :ref:`DMA shared buffer ` I/O. - Timecodes ========= @@ -729,7 +724,6 @@ The :c:type:`v4l2_buffer_timecode` structure is designed to hold a (struct :c:type:`timeval` timestamps are stored in the struct :c:type:`v4l2_buffer` ``timestamp`` field.) - .. c:type:: v4l2_timecode struct v4l2_timecode @@ -766,7 +760,6 @@ struct v4l2_timecode - The "user group" bits from the timecode. - .. _timecode-type: Timecode Types @@ -796,7 +789,6 @@ Timecode Types - - .. _timecode-flags: Timecode Flags diff --git a/Documentation/userspace-api/media/v4l/dev-capture.rst b/Documentation/userspace-api/media/v4l/dev-capture.rst index 5ea1ffe71fa6..fe58fd450e2f 100644 --- a/Documentation/userspace-api/media/v4l/dev-capture.rst +++ b/Documentation/userspace-api/media/v4l/dev-capture.rst @@ -1,4 +1,5 @@ .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later +.. c:namespace:: V4L .. _capture: @@ -19,7 +20,6 @@ device. .. note:: The same device file names are used for video output devices. - Querying Capabilities ===================== @@ -34,7 +34,6 @@ functions they may also support the :ref:`video overlay ` streaming I/O methods must be supported. Tuners and audio inputs are optional. - Supplemental Functions ====================== @@ -45,7 +44,6 @@ Video capture devices shall support :ref:`audio input