Skip to contentSkip to conversation

DocBook media: improve event documentation

PATCH In review Hans Verkuil 2 participants 2 messages Mar 18, 2015 – Mar 25, 2015

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 DocBook media: improve event documentation

It always annoyed me that the event type documentation was separate from the struct v4l2_event documentation. This patch moves it all to one place, VIDIOC_DQEVENT.

This makes much more sense.

Also changed the 'changes-flags' ref to 'ctrl-changes-flags' since this referred to control changes. There is a src-changes-flags as well, so 'changes-flags' was a bit vague.

Documentation/DocBook/media/v4l/compat.xml +1 -1
index 350dfb3..a0aef85 100644
@@ -2491,7 +2491,7 @@ that used it. It was originally scheduled for removal in 2.6.35.
         </listitem>
         <listitem>
 	  <para>Added <constant>V4L2_EVENT_CTRL_CH_RANGE</constant> control event
-	  changes flag. See <xref linkend="changes-flags"/>.</para>
+	  changes flag. See <xref linkend="ctrl-changes-flags"/>.</para>
         </listitem>
       </orderedlist>
     </section>
Documentation/DocBook/media/v4l/vidioc-dqevent.xml +111 -4

139 lines not on this page · raw message

Documentation/DocBook/media/v4l/vidioc-subscribe-event.xml +3 -108

123 lines not on this page · raw message

#1 lore raw

Hi Hans,

Quoted 4 lines · Hans Verkuil

It always annoyed me that the event type documentation was separate from the struct v4l2_event documentation. This patch moves it all to one place, VIDIOC_DQEVENT.

This makes much more sense.

I think the original reasoning was that in order to get an event of a particular kind, the user must first subscribe the type. That's why the event types were documented in conjunction with VIDIOC_SUBSCRIBE_EVENT, not with VIDIOC_DQEVENT.

Should I write the documentation again, I'd put it where it now is. I have no strict opinion on that though.

Signature · 4 lines
Kind regards,

Sakari Ailus
e-mail: [email protected]	XMPP: [email protected]