From patchwork Mon Jul 4 11:46:33 2016 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Mauro Carvalho Chehab X-Patchwork-Id: 9212369 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork.web.codeaurora.org (Postfix) with ESMTP id 3283C60572 for ; Mon, 4 Jul 2016 11:48:51 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 16229286DE for ; Mon, 4 Jul 2016 11:48:51 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 097F9286E4; Mon, 4 Jul 2016 11:48:51 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-6.9 required=2.0 tests=BAYES_00,RCVD_IN_DNSWL_HI autolearn=ham version=3.3.1 Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 586C8286DE for ; Mon, 4 Jul 2016 11:48:44 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S932362AbcGDLsi (ORCPT ); Mon, 4 Jul 2016 07:48:38 -0400 Received: from bombadil.infradead.org ([198.137.202.9]:44855 "EHLO bombadil.infradead.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1753593AbcGDLrZ (ORCPT ); Mon, 4 Jul 2016 07:47:25 -0400 Received: from 201.86.133.99.dynamic.adsl.gvt.net.br ([201.86.133.99] helo=smtp.w2.samsung.com) by bombadil.infradead.org with esmtpsa (Exim 4.85_2 #1 (Red Hat Linux)) id 1bK2LS-0005Jh-9A; Mon, 04 Jul 2016 11:47:24 +0000 Received: from mchehab by smtp.w2.samsung.com with local (Exim 4.87) (envelope-from ) id 1bK2LL-0007jj-2a; Mon, 04 Jul 2016 08:47:15 -0300 From: Mauro Carvalho Chehab To: Linux Media Mailing List Cc: Mauro Carvalho Chehab , Mauro Carvalho Chehab , Jonathan Corbet , Markus Heiser , linux-doc@vger.kernel.org Subject: [PATCH 12/51] Documentation: linux_tv: simplify references Date: Mon, 4 Jul 2016 08:46:33 -0300 Message-Id: <54570090c3f23c597a35910232387a009b5c1218.1467629489.git.mchehab@s-opensource.com> X-Mailer: git-send-email 2.7.4 In-Reply-To: References: In-Reply-To: References: Sender: linux-media-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-media@vger.kernel.org X-Virus-Scanned: ClamAV using ClamSMTP There are lots of internal references in the form: :ref:`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 --- .../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 `, +: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 ` 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 `, struct +:ref:`FE_GET_FRONTEND`, struct dvb_frontend_parameters *p); PARAMETERS @@ -36,7 +36,7 @@ PARAMETERS - int request - - Equals :ref:`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 `, +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 ` 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 `, +:ref:`FE_READ_SIGNAL_STRENGTH`, uint16_t *strength); PARAMETERS @@ -38,7 +38,7 @@ PARAMETERS - int request - Equals - :ref:`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 `, +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 ` 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 `, +:ref:`FE_READ_UNCORRECTED_BLOCKS`, uint32_t *ublocks); PARAMETERS @@ -40,7 +40,7 @@ PARAMETERS - int request - Equals - :ref:`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 ` and -FrontendEvent.) If a new :ref:`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 `, struct +:ref:`FE_SET_FRONTEND`, struct dvb_frontend_parameters *p); PARAMETERS @@ -43,7 +43,7 @@ PARAMETERS - int request - - Equals :ref:`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 ` 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 `. +using :ref:`FE_READ_STATUS`. Signal statistics are provided via -:ref:`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 ` 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 ` by -:ref:`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 `. +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 `. 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 ` 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 ` 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 ` 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 ` 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 ` 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 ` 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 ` 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 ` and +defines the :ref:`VIDIOC_G_PRIORITY` and :ref:`VIDIOC_S_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 ` after verifying the device with the -:ref:`VIDIOC_QUERYCAP ` ioctl. +:ref:`VIDIOC_QUERYCAP` ioctl. Ioctls changing driver properties, such as :ref:`VIDIOC_S_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 ` and +:ref:`VIDIOC_ENUMAUDIO` and :ref:`VIDIOC_ENUMAUDOUT ` ioctl, respectively. The struct :ref:`v4l2_audio ` returned by the -:ref:`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 ` and +The :ref:`VIDIOC_G_AUDIO` and :ref:`VIDIOC_G_AUDOUT ` 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 -structure as :ref:`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 ` 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 ` returned by -the :ref:`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 `, -:ref:`VIDIOC_QBUF ` and +argument to the :ref:`VIDIOC_QUERYBUF`, +:ref:`VIDIOC_QBUF` and :ref:`VIDIOC_DQBUF ` 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 `, then it is set by the driver. This field can range from zero to the number of buffers - allocated with the :ref:`VIDIOC_REQBUFS ` ioctl + allocated with the :ref:`VIDIOC_REQBUFS` ioctl (struct :ref:`v4l2_requestbuffers ` ``count``), plus any buffers allocated with - :ref:`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 ` and/or - :ref:`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 ` and/or - :ref:`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 `, - :ref:`VIDIOC_QBUF ` or + :ref:`VIDIOC_QUERYBUF`, + :ref:`VIDIOC_QBUF` or :ref:`VIDIOC_DQBUF ` 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 `, + :ref:`VIDIOC_QUERYBUF`, :ref:`VIDIOC_PREPARE_BUF `, - :ref:`VIDIOC_QBUF ` or + :ref:`VIDIOC_QBUF` or :ref:`VIDIOC_DQBUF ` 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 ` or + :ref:`VIDIOC_QUERYBUF` or :ref:`VIDIOC_DQBUF ` 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 `, 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 ` and +:ref:`VIDIOC_QUERYCTRL` and :ref:`VIDIOC_QUERYMENU ` ioctls, get and set a -control value with the :ref:`VIDIOC_G_CTRL ` and +control value with the :ref:`VIDIOC_G_CTRL` and :ref:`VIDIOC_S_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 ` 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 `, -:ref:`VIDIOC_G_CROP ` and +name, the :ref:`VIDIOC_CROPCAP`, +:ref:`VIDIOC_G_CROP` and :ref:`VIDIOC_S_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` and :ref:`VIDIOC_S_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 ` returned by the -:ref:`VIDIOC_QUERYCAP ` ioctl. As secondary device +:ref:`VIDIOC_QUERYCAP` ioctl. As secondary device functions they may also support the :ref:`video overlay ` (``V4L2_CAP_VIDEO_OVERLAY``) and the :ref:`raw VBI capture ` (``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