Commit 2e9a2ec5 authored by Sean Young's avatar Sean Young Committed by Mauro Carvalho Chehab
Browse files

media: v4l uapi docs: few minor corrections and typos 



Do a series of minor corrections at the V4L2 uAPI documentation.

Signed-off-by: default avatarSean Young <sean@mess.org>
Signed-off-by: default avatarHans Verkuil <hans.verkuil@cisco.com>
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab+samsung@kernel.org>
parent 32804fcb

Documentation/media/uapi/v4l/app-pri.rst

+1 −1
Original line number Diff line number Diff line
@@ -8,7 +8,7 @@ Application Priority 


When multiple applications share a device it may be desirable to assign

them different priorities. Contrary to the traditional "rm -rf /" school

of thought a video recording application could for example block other

of thought, a video recording application could for example block other

applications from changing video controls or switching the current TV

channel. Another objective is to permit low priority applications

working in background, which can be preempted by user controlled

Documentation/media/uapi/v4l/audio.rst

+1 −1
Original line number Diff line number Diff line
@@ -31,7 +31,7 @@ outputs applications can enumerate them with the 
:ref:`VIDIOC_ENUMAUDOUT <VIDIOC_ENUMAUDOUT>` ioctl, respectively.

The struct :c:type:`v4l2_audio` returned by the

:ref:`VIDIOC_ENUMAUDIO` ioctl also contains signal

:status information applicable when the current audio input is queried.

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_AUDOUT>` ioctls report the current

Documentation/media/uapi/v4l/dev-capture.rst

+1 −1
Original line number Diff line number Diff line
@@ -99,6 +99,6 @@ requests and always returns default parameters as :ref:`VIDIOC_G_FMT <VIDIOC_G_F 
Reading Images

==============



A video capture device may support the ::ref:`read() function <func-read>`

A video capture device may support the :ref:`read() function <func-read>`

and/or streaming (:ref:`memory mapping <func-mmap>` or

:ref:`user pointer <userp>`) I/O. See :ref:`io` for details.

Documentation/media/uapi/v4l/dev-teletext.rst

+1 −1
Original line number Diff line number Diff line
@@ -10,7 +10,7 @@ This interface was aimed at devices receiving and demodulating Teletext 
data [:ref:`ets300706`, :ref:`itu653`], evaluating the Teletext

packages and storing formatted pages in cache memory. Such devices are

usually implemented as microcontrollers with serial interface

(I:sup:`2`\ C) and could be found on old TV cards, dedicated Teletext

(I\ :sup:`2`\ C) and could be found on old TV cards, dedicated Teletext

decoding cards and home-brew devices connected to the PC parallel port.



The Teletext API was designed by Martin Buck. It was defined in the

Documentation/media/uapi/v4l/format.rst

+1 −1
Original line number Diff line number Diff line
@@ -12,7 +12,7 @@ Data Format Negotiation 


Different devices exchange different kinds of data with applications,

for example video images, raw or sliced VBI data, RDS datagrams. Even

within one kind many different formats are possible, in particular an

within one kind many different formats are possible, in particular there is an

abundance of image formats. Although drivers must provide a default and

the selection persists across closing and reopening a device,

applications should always negotiate a data format before engaging in