[media] Fix DV_TIMINGS_CAP documentation
authorHans Verkuil <hverkuil@xs4all.nl>
Wed, 11 Jul 2012 10:48:52 +0000 (07:48 -0300)
committerMauro Carvalho Chehab <mchehab@redhat.com>
Mon, 30 Jul 2012 23:22:05 +0000 (20:22 -0300)
This patch fixes the DV_TIMINGS_CAP documentation: part of it was copy-and-paste from
the ENUM_DV_TIMINGS documentation.

Regards,

Hans

Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
Documentation/DocBook/media/v4l/vidioc-dv-timings-cap.xml

index 6673ce5..cd7720d 100644 (file)
       interface and may change in the future.</para>
     </note>
 
-    <para>To query the available timings, applications initialize the
-<structfield>index</structfield> field and zero the reserved array of &v4l2-dv-timings-cap;
-and call the <constant>VIDIOC_DV_TIMINGS_CAP</constant> ioctl with a pointer to this
-structure. Drivers fill the rest of the structure or return an
-&EINVAL; when the index is out of bounds. To enumerate all supported DV timings,
-applications shall begin at index zero, incrementing by one until the
-driver returns <errorcode>EINVAL</errorcode>. Note that drivers may enumerate a
-different set of DV timings after switching the video input or
-output.</para>
+    <para>To query the capabilities of the DV receiver/transmitter applications can call
+this ioctl and the driver will fill in the structure. Note that drivers may return
+different values after switching the video input or output.</para>
 
     <table pgwide="1" frame="none" id="v4l2-bt-timings-cap">
       <title>struct <structname>v4l2_bt_timings_cap</structname></title>
@@ -115,7 +109,7 @@ output.</para>
          <row>
            <entry>__u32</entry>
            <entry><structfield>reserved</structfield>[16]</entry>
-           <entry></entry>
+           <entry>Reserved for future extensions. Drivers must set the array to zero.</entry>
          </row>
        </tbody>
       </tgroup>