Minki/linux
1
0
Fork 1
mirror of https://github.com/torvalds/linux.git synced 2024-12-19 09:32:32 +00:00
Code Issues Packages Projects Releases Wiki Activity

[media] DocBook/media: fix bad spacing in VIDIOC_EXPBUF

Browse Source 
The VIDIOC_EXPBUF documentation had spurious spaces that made it irritating
to read. Fix this.

Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
This commit is contained in:
Hans Verkuil 2015-06-15 08:33:41 -03:00 committed by Mauro Carvalho Chehab
parent 4c34cc5e0f
commit c046707ff9
1 changed files with 19 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
Documentation/DocBook/media/v4l/vidioc-expbuf.xml
View File

@ -62,28 +62,28 @@ buffer as a DMABUF file at any time after buffers have been allocated with the
&VIDIOC-REQBUFS; ioctl.</para> &VIDIOC-REQBUFS; ioctl.</para>
<para> To export a buffer, applications fill &v4l2-exportbuffer;. The <para> To export a buffer, applications fill &v4l2-exportbuffer;. The
<structfield> type </structfield> field is set to the same buffer type as was <structfield>type</structfield> field is set to the same buffer type as was
previously used with &v4l2-requestbuffers;<structfield> type </structfield>. previously used with &v4l2-requestbuffers; <structfield>type</structfield>.
Applications must also set the <structfield> index </structfield> field. Valid Applications must also set the <structfield>index</structfield> field. Valid
index numbers range from zero to the number of buffers allocated with index numbers range from zero to the number of buffers allocated with
&VIDIOC-REQBUFS; (&v4l2-requestbuffers;<structfield> count </structfield>) &VIDIOC-REQBUFS; (&v4l2-requestbuffers; <structfield>count</structfield>)
minus one. For the multi-planar API, applications set the <structfield> plane minus one. For the multi-planar API, applications set the <structfield>plane</structfield>
</structfield> field to the index of the plane to be exported. Valid planes field to the index of the plane to be exported. Valid planes
range from zero to the maximal number of valid planes for the currently active range from zero to the maximal number of valid planes for the currently active
format. For the single-planar API, applications must set <structfield> plane format. For the single-planar API, applications must set <structfield>plane</structfield>
</structfield> to zero. Additional flags may be posted in the <structfield> to zero. Additional flags may be posted in the <structfield>flags</structfield>
flags </structfield> field. Refer to a manual for open() for details. field. Refer to a manual for open() for details.
Currently only O_CLOEXEC, O_RDONLY, O_WRONLY, and O_RDWR are supported. All Currently only O_CLOEXEC, O_RDONLY, O_WRONLY, and O_RDWR are supported. All
other fields must be set to zero. other fields must be set to zero.
In the case of multi-planar API, every plane is exported separately using In the case of multi-planar API, every plane is exported separately using
multiple <constant> VIDIOC_EXPBUF </constant> calls. </para> multiple <constant>VIDIOC_EXPBUF</constant> calls.</para>
<para> After calling <constant>VIDIOC_EXPBUF</constant> the <structfield> fd <para>After calling <constant>VIDIOC_EXPBUF</constant> the <structfield>fd</structfield>
</structfield> field will be set by a driver. This is a DMABUF file 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 descriptor. The application may pass it to other DMABUF-aware devices. Refer to
<link linkend="dmabuf">DMABUF importing</link> for details about importing <link linkend="dmabuf">DMABUF importing</link> for details about importing
DMABUF files into V4L2 nodes. It is recommended to close a DMABUF file when it DMABUF files into V4L2 nodes. It is recommended to close a DMABUF file when it
is no longer used to allow the associated memory to be reclaimed. </para> is no longer used to allow the associated memory to be reclaimed.</para>
</refsect1> </refsect1>
<refsect1> <refsect1>
@ -170,9 +170,9 @@ multi-planar API. Otherwise this value must be set to zero. </entry>
<row> <row>
<entry>__u32</entry> <entry>__u32</entry>
<entry><structfield>flags</structfield></entry> <entry><structfield>flags</structfield></entry>
<entry>Flags for the newly created file, currently only <constant> <entry>Flags for the newly created file, currently only
O_CLOEXEC </constant>, <constant>O_RDONLY</constant>, <constant>O_WRONLY <constant>O_CLOEXEC</constant>, <constant>O_RDONLY</constant>, <constant>O_WRONLY</constant>,
</constant>, and <constant>O_RDWR</constant> are supported, refer to the manual and <constant>O_RDWR</constant> are supported, refer to the manual
of open() for more details.</entry> of open() for more details.</entry>
</row> </row>
<row> <row>
@ -200,9 +200,9 @@ set the array to zero.</entry>
<term><errorcode>EINVAL</errorcode></term> <term><errorcode>EINVAL</errorcode></term>
<listitem> <listitem>
<para>A queue is not in MMAP mode or DMABUF exporting is not <para>A queue is not in MMAP mode or DMABUF exporting is not
supported or <structfield> flags </structfield> or <structfield> type supported or <structfield>flags</structfield> or <structfield>type</structfield>
</structfield> or <structfield> index </structfield> or <structfield> plane or <structfield>index</structfield> or <structfield>plane</structfield> fields
</structfield> fields are invalid.</para> are invalid.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
</variablelist> </variablelist>