DocBook/media: improve timestamp documentation

PATCH New Hans Verkuil 1 participant 1 message May 8, 2015

Subsystems (2)

Documentation Media (V4L/DVB)

lore

Share & tools

lore

Hans Verkuil

author

2015-05-08 10:55 UTC #0 lore raw

PATCH 1/1 DocBook/media: improve timestamp documentation

Explain which clock was used to make the timestamp.

Signed-off-by Hans Verkuil <[email protected]>

---
 Documentation/DocBook/media/v4l/vidioc-dqevent.xml | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

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

index 50ccd33..c9c3c77 100644
@@ -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>

Signature · 1 line

2.1.4