From patchwork Tue Oct 6 14:03:11 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Mauro Carvalho Chehab X-Patchwork-Id: 286370 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-13.8 required=3.0 tests=BAYES_00,DKIMWL_WL_HIGH, DKIM_SIGNED, DKIM_VALID, DKIM_VALID_AU, INCLUDES_PATCH, MAILING_LIST_MULTI, SIGNED_OFF_BY,SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED,USER_AGENT_GIT autolearn=unavailable autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 19C2BC4727D for ; Tue, 6 Oct 2020 14:04:20 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 6559C20782 for ; Tue, 6 Oct 2020 14:04:19 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=default; t=1601993059; bh=Cg0fn1knnH+cc6EvV9Oxe+RNtocav5ih/BZWz6jKluc=; h=From:To:Cc:Subject:Date:In-Reply-To:References:List-ID:From; b=Du5zh8pRrBuETe5ws1ShOdc/PNXliYI1NGZWpQ93dudvqt3kQNSvRFt0l96Ok6kXe WW4hNIFXoN5D/wlLxM+5Hzszvur76pHWIS535TqlERDTdK4orJNkbjs9iV9WgyKkRP MrSypWdGGNy+th4LxexbD3/vJHtczvdS1ljqtCHg= Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1726658AbgJFOEP (ORCPT ); Tue, 6 Oct 2020 10:04:15 -0400 Received: from mail.kernel.org ([198.145.29.99]:33620 "EHLO mail.kernel.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726559AbgJFOEF (ORCPT ); Tue, 6 Oct 2020 10:04:05 -0400 Received: from mail.kernel.org (ip5f5ad5bd.dynamic.kabel-deutschland.de [95.90.213.189]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPSA id 57F2C21D46; Tue, 6 Oct 2020 14:03:54 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=default; t=1601993035; bh=Cg0fn1knnH+cc6EvV9Oxe+RNtocav5ih/BZWz6jKluc=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=cgZrvZVp36YpNPCTAYk/7/lLVmmE5sE1ojj8ER/FafHcNRgkFaCmHacPeUZzSnhHz Z8DRbZk9URBdJzpCHhGC70LSOyFZvVb80E0HgMF/B5frtWKEx0PUz724FLzzCjBLwl dwDEdwLc5xWXmB8+omuw7Zm1zmLOqts6x/LVnvFw= Received: from mchehab by mail.kernel.org with local (Exim 4.94) (envelope-from ) id 1kPnZH-0019F6-Gj; Tue, 06 Oct 2020 16:03:51 +0200 From: Mauro Carvalho Chehab To: Linux Doc Mailing List , Jonathan Corbet Cc: Mauro Carvalho Chehab , =?utf-8?q?Niklas_S?= =?utf-8?b?w7ZkZXJsdW5k?= , Alexandre Courbot , Boris Brezillon , Dafna Hirschfeld , Ezequiel Garcia , Hans Verkuil , Helen Koike , Jacopo Mondi , Jernej Skrabec , Jian-Jia Su , Laurent Pinchart , Mauro Carvalho Chehab , Michael Tretter , Paul Kocialkowski , Philipp Zabel , Randy Dunlap , Ricardo Ribalda , Sakari Ailus , Sergey Senozhatsky , Tomasz Figa , linux-kernel@vger.kernel.org, linux-media@vger.kernel.org Subject: [PATCH v5 14/52] media: docs: make V4L documents more compatible with Sphinx 3.1+ Date: Tue, 6 Oct 2020 16:03:11 +0200 Message-Id: <68bb2b77afcb4f5122632ed6644c1450029d0d86.1601992016.git.mchehab+huawei@kernel.org> X-Mailer: git-send-email 2.26.2 In-Reply-To: References: MIME-Version: 1.0 Sender: Mauro Carvalho Chehab Precedence: bulk List-ID: X-Mailing-List: linux-media@vger.kernel.org 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 --- .../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 ++--- .../userspace-api/media/v4l/dev-rds.rst | 12 +--- .../media/v4l/dev-sliced-vbi.rst | 31 ++------ .../userspace-api/media/v4l/diff-v4l.rst | 39 ++--------- .../userspace-api/media/v4l/dmabuf.rst | 8 +-- .../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 ++++---- .../userspace-api/media/v4l/mmap.rst | 26 +++---- .../userspace-api/media/v4l/open.rst | 15 ++-- Documentation/userspace-api/media/v4l/rw.rst | 18 ++--- .../userspace-api/media/v4l/streaming-par.rst | 5 +- .../userspace-api/media/v4l/userp.rst | 11 +-- .../media/v4l/vidioc-create-bufs.rst | 11 ++- .../media/v4l/vidioc-cropcap.rst | 11 ++- .../media/v4l/vidioc-dbg-g-chip-info.rst | 13 ++-- .../media/v4l/vidioc-dbg-g-register.rst | 18 ++--- .../media/v4l/vidioc-decoder-cmd.rst | 19 +++-- .../media/v4l/vidioc-dqevent.rst | 19 ++--- .../media/v4l/vidioc-dv-timings-cap.rst | 17 ++--- .../media/v4l/vidioc-encoder-cmd.rst | 25 +++---- .../media/v4l/vidioc-enum-dv-timings.rst | 16 ++--- .../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 ++-- .../media/v4l/vidioc-enumaudio.rst | 10 ++- .../media/v4l/vidioc-enumaudioout.rst | 10 ++- .../media/v4l/vidioc-enuminput.rst | 14 ++-- .../media/v4l/vidioc-enumoutput.rst | 13 ++-- .../media/v4l/vidioc-enumstd.rst | 23 ++---- .../userspace-api/media/v4l/vidioc-expbuf.rst | 14 ++-- .../media/v4l/vidioc-g-audio.rst | 18 ++--- .../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 ++++--- .../media/v4l/vidioc-g-enc-index.rst | 13 ++-- .../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 +++--- .../media/v4l/vidioc-g-frequency.rst | 16 ++--- .../media/v4l/vidioc-g-input.rst | 15 ++-- .../media/v4l/vidioc-g-jpegcomp.rst | 17 ++--- .../media/v4l/vidioc-g-modulator.rst | 17 ++--- .../media/v4l/vidioc-g-output.rst | 15 ++-- .../userspace-api/media/v4l/vidioc-g-parm.rst | 30 ++++---- .../media/v4l/vidioc-g-priority.rst | 16 ++--- .../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 ++++--- .../media/v4l/vidioc-g-tuner.rst | 19 ++--- .../media/v4l/vidioc-log-status.rst | 10 ++- .../media/v4l/vidioc-overlay.rst | 10 ++- .../media/v4l/vidioc-prepare-buf.rst | 10 ++- .../userspace-api/media/v4l/vidioc-qbuf.rst | 17 +++-- .../media/v4l/vidioc-query-dv-timings.rst | 15 ++-- .../media/v4l/vidioc-querybuf.rst | 10 ++- .../media/v4l/vidioc-querycap.rst | 16 ++--- .../media/v4l/vidioc-queryctrl.rst | 22 +++--- .../media/v4l/vidioc-querystd.rst | 15 ++-- .../media/v4l/vidioc-reqbufs.rst | 10 ++- .../media/v4l/vidioc-s-hw-freq-seek.rst | 11 ++- .../media/v4l/vidioc-streamon.rst | 14 ++-- .../v4l/vidioc-subdev-enum-frame-interval.rst | 10 ++- .../v4l/vidioc-subdev-enum-frame-size.rst | 11 ++- .../v4l/vidioc-subdev-enum-mbus-code.rst | 10 ++- .../media/v4l/vidioc-subdev-g-crop.rst | 16 ++--- .../media/v4l/vidioc-subdev-g-fmt.rst | 17 ++--- .../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(-) diff --git a/Documentation/userspace-api/media/v4l/buffer.rst b/Documentation/userspace-api/media/v4l/buffer.rst index da7366e0e317..7dbdfbb4a0a9 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 @@ -706,7 +702,6 @@ enum v4l2_memory - The buffer is used for :ref:`DMA shared buffer ` I/O. - Timecodes ========= @@ -715,7 +710,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 @@ -752,7 +746,6 @@ struct v4l2_timecode - The "user group" bits from the timecode. - .. _timecode-type: Timecode Types @@ -782,7 +775,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