Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit c046707f authored by Hans Verkuil's avatar Hans Verkuil Committed by Mauro Carvalho Chehab
Browse files

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



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

Signed-off-by: default avatarHans Verkuil <hans.verkuil@cisco.com>
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab@osg.samsung.com>
parent 4c34cc5e

Documentation/DocBook/media/v4l/vidioc-expbuf.xml

+19 −19
Original line number Diff line number Diff line
@@ -67,19 +67,19 @@ previously used with &v4l2-requestbuffers;<structfield> type </structfield>. 
Applications must also set the <structfield>index</structfield> field. Valid

index numbers range from zero to the number of buffers allocated with

&VIDIOC-REQBUFS; (&v4l2-requestbuffers; <structfield>count</structfield>)

minus one.  For the multi-planar API, applications set the <structfield> plane

</structfield> field to the index of the plane to be exported. Valid planes

minus one.  For the multi-planar API, applications set the <structfield>plane</structfield>

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

format. For the single-planar API, applications must set <structfield> plane

</structfield> to zero.  Additional flags may be posted in the <structfield>

flags </structfield> field.  Refer to a manual for open() for details.

format. For the single-planar API, applications must set <structfield>plane</structfield>

to zero.  Additional flags may be posted in the <structfield>flags</structfield>

field.  Refer to a manual for open() for details.

Currently only O_CLOEXEC, O_RDONLY, O_WRONLY, and O_RDWR are supported.  All

other fields must be set to zero.

In the case of multi-planar API, every plane is exported separately using

multiple <constant>VIDIOC_EXPBUF</constant> calls.</para>



<para> After calling <constant>VIDIOC_EXPBUF</constant> the <structfield> fd

</structfield> field will be set by a driver.  This is a DMABUF file

<para>After calling <constant>VIDIOC_EXPBUF</constant> the <structfield>fd</structfield>

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

<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
@@ -170,9 +170,9 @@ multi-planar API. Otherwise this value must be set to zero. </entry> 
	  <row>

	    <entry>__u32</entry>

	    <entry><structfield>flags</structfield></entry>

	    <entry>Flags for the newly created file, currently only <constant>

O_CLOEXEC </constant>, <constant>O_RDONLY</constant>, <constant>O_WRONLY

</constant>, and <constant>O_RDWR</constant> are supported, refer to the manual

	    <entry>Flags for the newly created file, currently only

<constant>O_CLOEXEC</constant>, <constant>O_RDONLY</constant>, <constant>O_WRONLY</constant>,

and <constant>O_RDWR</constant> are supported, refer to the manual

of open() for more details.</entry>

	  </row>

	  <row>
@@ -200,9 +200,9 @@ set the array to zero.</entry> 
	<term><errorcode>EINVAL</errorcode></term>

	<listitem>

	  <para>A queue is not in MMAP mode or DMABUF exporting is not

supported or <structfield> flags </structfield> or <structfield> type

</structfield> or <structfield> index </structfield> or <structfield> plane

</structfield> fields are invalid.</para>

supported or <structfield>flags</structfield> or <structfield>type</structfield>

or <structfield>index</structfield> or <structfield>plane</structfield> fields

are invalid.</para>

	</listitem>

      </varlistentry>

    </variablelist>