diff mbox

[RFC,1/3] v4l: Move event documentation from SUBSCRIBE_EVENT to DQEVENT

Message ID 1311082688-16185-1-git-send-email-sakari.ailus@iki.fi (mailing list archive)
State Accepted
Headers show

Commit Message

Sakari Ailus July 19, 2011, 1:38 p.m. UTC
Move documentation of structures used in DQEVENT from SUBSCRIBE_EVENT to
DQEVENT.

Signed-off-by: Sakari Ailus <sakari.ailus@iki.fi>
---
 Documentation/DocBook/media/v4l/vidioc-dqevent.xml |  107 ++++++++++++++++++++
 .../DocBook/media/v4l/vidioc-subscribe-event.xml   |  107 --------------------
 2 files changed, 107 insertions(+), 107 deletions(-)

Comments

Hans Verkuil July 26, 2011, 10:11 a.m. UTC | #1
On Tuesday, July 19, 2011 15:38:06 Sakari Ailus wrote:
> Move documentation of structures used in DQEVENT from SUBSCRIBE_EVENT to
> DQEVENT.
> 
> Signed-off-by: Sakari Ailus <sakari.ailus@iki.fi>

Acked-by: Hans Verkuil <hans.verkuil@cisco.com>

This is a much better place!

Regards,

	Hans

> ---
>  Documentation/DocBook/media/v4l/vidioc-dqevent.xml |  107 ++++++++++++++++++++
>  .../DocBook/media/v4l/vidioc-subscribe-event.xml   |  107 --------------------
>  2 files changed, 107 insertions(+), 107 deletions(-)
> 
> diff --git a/Documentation/DocBook/media/v4l/vidioc-dqevent.xml b/Documentation/DocBook/media/v4l/vidioc-dqevent.xml
> index 7769642..5200b68 100644
> --- a/Documentation/DocBook/media/v4l/vidioc-dqevent.xml
> +++ b/Documentation/DocBook/media/v4l/vidioc-dqevent.xml
> @@ -135,6 +135,113 @@
>        </tgroup>
>      </table>
>  
> +    <table frame="none" pgwide="1" id="v4l2-event-vsync">
> +      <title>struct <structname>v4l2_event_vsync</structname></title>
> +      <tgroup cols="3">
> +	&cs-str;
> +	<tbody valign="top">
> +	  <row>
> +	    <entry>__u8</entry>
> +	    <entry><structfield>field</structfield></entry>
> +	    <entry>The upcoming field. See &v4l2-field;.</entry>
> +	  </row>
> +	</tbody>
> +      </tgroup>
> +    </table>
> +
> +    <table frame="none" pgwide="1" id="v4l2-event-ctrl">
> +      <title>struct <structname>v4l2_event_ctrl</structname></title>
> +      <tgroup cols="4">
> +	&cs-str;
> +	<tbody valign="top">
> +	  <row>
> +	    <entry>__u32</entry>
> +	    <entry><structfield>changes</structfield></entry>
> +	    <entry></entry>
> +	    <entry>A bitmask that tells what has changed. See <xref linkend="changes-flags" />.</entry>
> +	  </row>
> +	  <row>
> +	    <entry>__u32</entry>
> +	    <entry><structfield>type</structfield></entry>
> +	    <entry></entry>
> +	    <entry>The type of the control. See &v4l2-ctrl-type;.</entry>
> +	  </row>
> +	  <row>
> +	    <entry>union (anonymous)</entry>
> +	    <entry></entry>
> +	    <entry></entry>
> +	    <entry></entry>
> +	  </row>
> +	  <row>
> +	    <entry></entry>
> +	    <entry>__s32</entry>
> +	    <entry><structfield>value</structfield></entry>
> +	    <entry>The 32-bit value of the control for 32-bit control types.
> +		This is 0 for string controls since the value of a string
> +		cannot be passed using &VIDIOC-DQEVENT;.</entry>
> +	  </row>
> +	  <row>
> +	    <entry></entry>
> +	    <entry>__s64</entry>
> +	    <entry><structfield>value64</structfield></entry>
> +	    <entry>The 64-bit value of the control for 64-bit control types.</entry>
> +	  </row>
> +	  <row>
> +	    <entry>__u32</entry>
> +	    <entry><structfield>flags</structfield></entry>
> +	    <entry></entry>
> +	    <entry>The control flags. See <xref linkend="control-flags" />.</entry>
> +	  </row>
> +	  <row>
> +	    <entry>__s32</entry>
> +	    <entry><structfield>minimum</structfield></entry>
> +	    <entry></entry>
> +	    <entry>The minimum value of the control. See &v4l2-queryctrl;.</entry>
> +	  </row>
> +	  <row>
> +	    <entry>__s32</entry>
> +	    <entry><structfield>maximum</structfield></entry>
> +	    <entry></entry>
> +	    <entry>The maximum value of the control. See &v4l2-queryctrl;.</entry>
> +	  </row>
> +	  <row>
> +	    <entry>__s32</entry>
> +	    <entry><structfield>step</structfield></entry>
> +	    <entry></entry>
> +	    <entry>The step value of the control. See &v4l2-queryctrl;.</entry>
> +	  </row>
> +	  <row>
> +	    <entry>__s32</entry>
> +	    <entry><structfield>default_value</structfield></entry>
> +	    <entry></entry>
> +	    <entry>The default value value of the control. See &v4l2-queryctrl;.</entry>
> +	  </row>
> +	</tbody>
> +      </tgroup>
> +    </table>
> +
> +    <table pgwide="1" frame="none" id="changes-flags">
> +      <title>Changes</title>
> +      <tgroup cols="3">
> +	&cs-def;
> +	<tbody valign="top">
> +	  <row>
> +	    <entry><constant>V4L2_EVENT_CTRL_CH_VALUE</constant></entry>
> +	    <entry>0x0001</entry>
> +	    <entry>This control event was triggered because the value of the control
> +		changed. Special case: if a button control is pressed, then this
> +		event is sent as well, even though there is not explicit value
> +		associated with a button control.</entry>
> +	  </row>
> +	  <row>
> +	    <entry><constant>V4L2_EVENT_CTRL_CH_FLAGS</constant></entry>
> +	    <entry>0x0002</entry>
> +	    <entry>This control event was triggered because the control flags
> +		changed.</entry>
> +	  </row>
> +	</tbody>
> +      </tgroup>
> +    </table>
>    </refsect1>
>    <refsect1>
>      &return-value;
> diff --git a/Documentation/DocBook/media/v4l/vidioc-subscribe-event.xml b/Documentation/DocBook/media/v4l/vidioc-subscribe-event.xml
> index 69c0d8a..275be96 100644
> --- a/Documentation/DocBook/media/v4l/vidioc-subscribe-event.xml
> +++ b/Documentation/DocBook/media/v4l/vidioc-subscribe-event.xml
> @@ -183,113 +183,6 @@
>        </tgroup>
>      </table>
>  
> -    <table frame="none" pgwide="1" id="v4l2-event-vsync">
> -      <title>struct <structname>v4l2_event_vsync</structname></title>
> -      <tgroup cols="3">
> -	&cs-str;
> -	<tbody valign="top">
> -	  <row>
> -	    <entry>__u8</entry>
> -	    <entry><structfield>field</structfield></entry>
> -	    <entry>The upcoming field. See &v4l2-field;.</entry>
> -	  </row>
> -	</tbody>
> -      </tgroup>
> -    </table>
> -
> -    <table frame="none" pgwide="1" id="v4l2-event-ctrl">
> -      <title>struct <structname>v4l2_event_ctrl</structname></title>
> -      <tgroup cols="4">
> -	&cs-str;
> -	<tbody valign="top">
> -	  <row>
> -	    <entry>__u32</entry>
> -	    <entry><structfield>changes</structfield></entry>
> -	    <entry></entry>
> -	    <entry>A bitmask that tells what has changed. See <xref linkend="changes-flags" />.</entry>
> -	  </row>
> -	  <row>
> -	    <entry>__u32</entry>
> -	    <entry><structfield>type</structfield></entry>
> -	    <entry></entry>
> -	    <entry>The type of the control. See &v4l2-ctrl-type;.</entry>
> -	  </row>
> -	  <row>
> -	    <entry>union (anonymous)</entry>
> -	    <entry></entry>
> -	    <entry></entry>
> -	    <entry></entry>
> -	  </row>
> -	  <row>
> -	    <entry></entry>
> -	    <entry>__s32</entry>
> -	    <entry><structfield>value</structfield></entry>
> -	    <entry>The 32-bit value of the control for 32-bit control types.
> -		This is 0 for string controls since the value of a string
> -		cannot be passed using &VIDIOC-DQEVENT;.</entry>
> -	  </row>
> -	  <row>
> -	    <entry></entry>
> -	    <entry>__s64</entry>
> -	    <entry><structfield>value64</structfield></entry>
> -	    <entry>The 64-bit value of the control for 64-bit control types.</entry>
> -	  </row>
> -	  <row>
> -	    <entry>__u32</entry>
> -	    <entry><structfield>flags</structfield></entry>
> -	    <entry></entry>
> -	    <entry>The control flags. See <xref linkend="control-flags" />.</entry>
> -	  </row>
> -	  <row>
> -	    <entry>__s32</entry>
> -	    <entry><structfield>minimum</structfield></entry>
> -	    <entry></entry>
> -	    <entry>The minimum value of the control. See &v4l2-queryctrl;.</entry>
> -	  </row>
> -	  <row>
> -	    <entry>__s32</entry>
> -	    <entry><structfield>maximum</structfield></entry>
> -	    <entry></entry>
> -	    <entry>The maximum value of the control. See &v4l2-queryctrl;.</entry>
> -	  </row>
> -	  <row>
> -	    <entry>__s32</entry>
> -	    <entry><structfield>step</structfield></entry>
> -	    <entry></entry>
> -	    <entry>The step value of the control. See &v4l2-queryctrl;.</entry>
> -	  </row>
> -	  <row>
> -	    <entry>__s32</entry>
> -	    <entry><structfield>default_value</structfield></entry>
> -	    <entry></entry>
> -	    <entry>The default value value of the control. See &v4l2-queryctrl;.</entry>
> -	  </row>
> -	</tbody>
> -      </tgroup>
> -    </table>
> -
> -    <table pgwide="1" frame="none" id="changes-flags">
> -      <title>Changes</title>
> -      <tgroup cols="3">
> -	&cs-def;
> -	<tbody valign="top">
> -	  <row>
> -	    <entry><constant>V4L2_EVENT_CTRL_CH_VALUE</constant></entry>
> -	    <entry>0x0001</entry>
> -	    <entry>This control event was triggered because the value of the control
> -		changed. Special case: if a button control is pressed, then this
> -		event is sent as well, even though there is not explicit value
> -		associated with a button control.</entry>
> -	  </row>
> -	  <row>
> -	    <entry><constant>V4L2_EVENT_CTRL_CH_FLAGS</constant></entry>
> -	    <entry>0x0002</entry>
> -	    <entry>This control event was triggered because the control flags
> -		changed.</entry>
> -	  </row>
> -	</tbody>
> -      </tgroup>
> -    </table>
>    </refsect1>
>    <refsect1>
>      &return-value;
> 
--
To unsubscribe from this list: send the line "unsubscribe linux-media" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
diff mbox

Patch

diff --git a/Documentation/DocBook/media/v4l/vidioc-dqevent.xml b/Documentation/DocBook/media/v4l/vidioc-dqevent.xml
index 7769642..5200b68 100644
--- a/Documentation/DocBook/media/v4l/vidioc-dqevent.xml
+++ b/Documentation/DocBook/media/v4l/vidioc-dqevent.xml
@@ -135,6 +135,113 @@ 
       </tgroup>
     </table>
 
+    <table frame="none" pgwide="1" id="v4l2-event-vsync">
+      <title>struct <structname>v4l2_event_vsync</structname></title>
+      <tgroup cols="3">
+	&cs-str;
+	<tbody valign="top">
+	  <row>
+	    <entry>__u8</entry>
+	    <entry><structfield>field</structfield></entry>
+	    <entry>The upcoming field. See &v4l2-field;.</entry>
+	  </row>
+	</tbody>
+      </tgroup>
+    </table>
+
+    <table frame="none" pgwide="1" id="v4l2-event-ctrl">
+      <title>struct <structname>v4l2_event_ctrl</structname></title>
+      <tgroup cols="4">
+	&cs-str;
+	<tbody valign="top">
+	  <row>
+	    <entry>__u32</entry>
+	    <entry><structfield>changes</structfield></entry>
+	    <entry></entry>
+	    <entry>A bitmask that tells what has changed. See <xref linkend="changes-flags" />.</entry>
+	  </row>
+	  <row>
+	    <entry>__u32</entry>
+	    <entry><structfield>type</structfield></entry>
+	    <entry></entry>
+	    <entry>The type of the control. See &v4l2-ctrl-type;.</entry>
+	  </row>
+	  <row>
+	    <entry>union (anonymous)</entry>
+	    <entry></entry>
+	    <entry></entry>
+	    <entry></entry>
+	  </row>
+	  <row>
+	    <entry></entry>
+	    <entry>__s32</entry>
+	    <entry><structfield>value</structfield></entry>
+	    <entry>The 32-bit value of the control for 32-bit control types.
+		This is 0 for string controls since the value of a string
+		cannot be passed using &VIDIOC-DQEVENT;.</entry>
+	  </row>
+	  <row>
+	    <entry></entry>
+	    <entry>__s64</entry>
+	    <entry><structfield>value64</structfield></entry>
+	    <entry>The 64-bit value of the control for 64-bit control types.</entry>
+	  </row>
+	  <row>
+	    <entry>__u32</entry>
+	    <entry><structfield>flags</structfield></entry>
+	    <entry></entry>
+	    <entry>The control flags. See <xref linkend="control-flags" />.</entry>
+	  </row>
+	  <row>
+	    <entry>__s32</entry>
+	    <entry><structfield>minimum</structfield></entry>
+	    <entry></entry>
+	    <entry>The minimum value of the control. See &v4l2-queryctrl;.</entry>
+	  </row>
+	  <row>
+	    <entry>__s32</entry>
+	    <entry><structfield>maximum</structfield></entry>
+	    <entry></entry>
+	    <entry>The maximum value of the control. See &v4l2-queryctrl;.</entry>
+	  </row>
+	  <row>
+	    <entry>__s32</entry>
+	    <entry><structfield>step</structfield></entry>
+	    <entry></entry>
+	    <entry>The step value of the control. See &v4l2-queryctrl;.</entry>
+	  </row>
+	  <row>
+	    <entry>__s32</entry>
+	    <entry><structfield>default_value</structfield></entry>
+	    <entry></entry>
+	    <entry>The default value value of the control. See &v4l2-queryctrl;.</entry>
+	  </row>
+	</tbody>
+      </tgroup>
+    </table>
+
+    <table pgwide="1" frame="none" id="changes-flags">
+      <title>Changes</title>
+      <tgroup cols="3">
+	&cs-def;
+	<tbody valign="top">
+	  <row>
+	    <entry><constant>V4L2_EVENT_CTRL_CH_VALUE</constant></entry>
+	    <entry>0x0001</entry>
+	    <entry>This control event was triggered because the value of the control
+		changed. Special case: if a button control is pressed, then this
+		event is sent as well, even though there is not explicit value
+		associated with a button control.</entry>
+	  </row>
+	  <row>
+	    <entry><constant>V4L2_EVENT_CTRL_CH_FLAGS</constant></entry>
+	    <entry>0x0002</entry>
+	    <entry>This control event was triggered because the control flags
+		changed.</entry>
+	  </row>
+	</tbody>
+      </tgroup>
+    </table>
   </refsect1>
   <refsect1>
     &return-value;
diff --git a/Documentation/DocBook/media/v4l/vidioc-subscribe-event.xml b/Documentation/DocBook/media/v4l/vidioc-subscribe-event.xml
index 69c0d8a..275be96 100644
--- a/Documentation/DocBook/media/v4l/vidioc-subscribe-event.xml
+++ b/Documentation/DocBook/media/v4l/vidioc-subscribe-event.xml
@@ -183,113 +183,6 @@ 
       </tgroup>
     </table>
 
-    <table frame="none" pgwide="1" id="v4l2-event-vsync">
-      <title>struct <structname>v4l2_event_vsync</structname></title>
-      <tgroup cols="3">
-	&cs-str;
-	<tbody valign="top">
-	  <row>
-	    <entry>__u8</entry>
-	    <entry><structfield>field</structfield></entry>
-	    <entry>The upcoming field. See &v4l2-field;.</entry>
-	  </row>
-	</tbody>
-      </tgroup>
-    </table>
-
-    <table frame="none" pgwide="1" id="v4l2-event-ctrl">
-      <title>struct <structname>v4l2_event_ctrl</structname></title>
-      <tgroup cols="4">
-	&cs-str;
-	<tbody valign="top">
-	  <row>
-	    <entry>__u32</entry>
-	    <entry><structfield>changes</structfield></entry>
-	    <entry></entry>
-	    <entry>A bitmask that tells what has changed. See <xref linkend="changes-flags" />.</entry>
-	  </row>
-	  <row>
-	    <entry>__u32</entry>
-	    <entry><structfield>type</structfield></entry>
-	    <entry></entry>
-	    <entry>The type of the control. See &v4l2-ctrl-type;.</entry>
-	  </row>
-	  <row>
-	    <entry>union (anonymous)</entry>
-	    <entry></entry>
-	    <entry></entry>
-	    <entry></entry>
-	  </row>
-	  <row>
-	    <entry></entry>
-	    <entry>__s32</entry>
-	    <entry><structfield>value</structfield></entry>
-	    <entry>The 32-bit value of the control for 32-bit control types.
-		This is 0 for string controls since the value of a string
-		cannot be passed using &VIDIOC-DQEVENT;.</entry>
-	  </row>
-	  <row>
-	    <entry></entry>
-	    <entry>__s64</entry>
-	    <entry><structfield>value64</structfield></entry>
-	    <entry>The 64-bit value of the control for 64-bit control types.</entry>
-	  </row>
-	  <row>
-	    <entry>__u32</entry>
-	    <entry><structfield>flags</structfield></entry>
-	    <entry></entry>
-	    <entry>The control flags. See <xref linkend="control-flags" />.</entry>
-	  </row>
-	  <row>
-	    <entry>__s32</entry>
-	    <entry><structfield>minimum</structfield></entry>
-	    <entry></entry>
-	    <entry>The minimum value of the control. See &v4l2-queryctrl;.</entry>
-	  </row>
-	  <row>
-	    <entry>__s32</entry>
-	    <entry><structfield>maximum</structfield></entry>
-	    <entry></entry>
-	    <entry>The maximum value of the control. See &v4l2-queryctrl;.</entry>
-	  </row>
-	  <row>
-	    <entry>__s32</entry>
-	    <entry><structfield>step</structfield></entry>
-	    <entry></entry>
-	    <entry>The step value of the control. See &v4l2-queryctrl;.</entry>
-	  </row>
-	  <row>
-	    <entry>__s32</entry>
-	    <entry><structfield>default_value</structfield></entry>
-	    <entry></entry>
-	    <entry>The default value value of the control. See &v4l2-queryctrl;.</entry>
-	  </row>
-	</tbody>
-      </tgroup>
-    </table>
-
-    <table pgwide="1" frame="none" id="changes-flags">
-      <title>Changes</title>
-      <tgroup cols="3">
-	&cs-def;
-	<tbody valign="top">
-	  <row>
-	    <entry><constant>V4L2_EVENT_CTRL_CH_VALUE</constant></entry>
-	    <entry>0x0001</entry>
-	    <entry>This control event was triggered because the value of the control
-		changed. Special case: if a button control is pressed, then this
-		event is sent as well, even though there is not explicit value
-		associated with a button control.</entry>
-	  </row>
-	  <row>
-	    <entry><constant>V4L2_EVENT_CTRL_CH_FLAGS</constant></entry>
-	    <entry>0x0002</entry>
-	    <entry>This control event was triggered because the control flags
-		changed.</entry>
-	  </row>
-	</tbody>
-      </tgroup>
-    </table>
   </refsect1>
   <refsect1>
     &return-value;