[aravis] documentation: minor fixes



commit 423f191a4e3e69a0ed9576ad0064a1c1ee9f5e3a
Author: Emmanuel Pacaud <emmanuel gnome org>
Date:   Fri Aug 15 20:51:12 2014 +0200

    documentation: minor fixes

 docs/reference/aravis/aravis-docs.xml |    2 +-
 docs/reference/aravis/aravis-gv.xml   |    9 +++++++--
 2 files changed, 8 insertions(+), 3 deletions(-)
---
diff --git a/docs/reference/aravis/aravis-docs.xml b/docs/reference/aravis/aravis-docs.xml
index b0dc721..b2d6ae5 100644
--- a/docs/reference/aravis/aravis-docs.xml
+++ b/docs/reference/aravis/aravis-docs.xml
@@ -7,7 +7,7 @@
 <book id="index">
        <bookinfo>
                <title>Aravis Reference Manual</title>
-               <releaseinfo>For Aravis 0.2.</releaseinfo>
+               <releaseinfo>For Aravis 0.4.</releaseinfo>
                <legalnotice>
                        <para>
                                Permission is granted to copy, distribute and/or modify this
diff --git a/docs/reference/aravis/aravis-gv.xml b/docs/reference/aravis/aravis-gv.xml
index 6d0261f..254682d 100644
--- a/docs/reference/aravis/aravis-gv.xml
+++ b/docs/reference/aravis/aravis-gv.xml
@@ -5,11 +5,16 @@
                <title>Introduction</title>
 
                <para>
-                       This part contains a description of the protocol implemented by Aravis for the 
control of the gigabit ethenet cameras. This protocol is a standard used by many video cameras manufacturers 
for their products. It is a closed standard which should not be confused by what is used on 'IP cameras'. In 
the case of 'IP cameras' the video stream is a compressed stream (jpeg, h264...) send over HTTP or RTSP, 
whereas in Aravis, the video stream is a raw stream, mainly targeted to industrial applications.
+                       This part contains a description of the protocol implemented by Aravis for the 
control of the gigabit ethenet cameras. This protocol is a standard used by many video cameras manufacturers 
for their products. It is a closed standard which should not be confused by what is used on 'IP cameras'. In 
the case of 'IP cameras' the video stream is a compressed stream (jpeg, h264...) send over HTTP or RTSP, 
whereas in Aravis, the video stream is a raw stream, mainly targeted to industrial applications (though the 
protocol supports non raw payload, it is not yet implemented in Aravis).
                </para>
 
                <para>
-                       The protocol implemented by Aravis library is based on UDP packets transmited over an 
ethernet link. Two different types of packets are used: GVCP packets and GVSP packets. GVCP packets are used 
for the control of the devices, and GVSP for the transmission of the data stream.            </para>
+                       The protocol implemented by Aravis library is based on UDP packets transmited over an 
ethernet link. Two different types of packets are used: GVCP packets and GVSP packets. GVCP packets are used 
for the control of the devices, and GVSP for the transmission of the data stream.
+               </para>
+
+               <para>
+                       This documentation is the result of a reverse engineering, which means it is far from 
complete. A more complete description of the ethernet protocol can be found in the GVSP and GVCP dissectors 
found in Wireshark sources.
+               </para> 
        </chapter>
 
        <chapter id="aravis-gvcp">


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]