Browse Source

[media] DocBook/media: improve timestamp documentation

Explain which clock was used to make the timestamp.

Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
Hans Verkuil 10 years ago
parent
commit
200a280509
1 changed files with 4 additions and 1 deletions
  1. 4 1
      Documentation/DocBook/media/v4l/vidioc-dqevent.xml

+ 4 - 1
Documentation/DocBook/media/v4l/vidioc-dqevent.xml

@@ -133,7 +133,10 @@
 	    <entry>struct timespec</entry>
 	    <entry><structfield>timestamp</structfield></entry>
             <entry></entry>
-	    <entry>Event timestamp.</entry>
+	    <entry>Event timestamp. The timestamp has been taken from the
+	    <constant>CLOCK_MONOTONIC</constant> clock. To access the
+	    same clock outside V4L2, use <function>clock_gettime(2)</function>.
+	    </entry>
 	  </row>
 	  <row>
 	    <entry>u32</entry>