aboutsummaryrefslogtreecommitdiffstats
path: root/docbook
diff options
context:
space:
mode:
authorMartin Mathieson <martin.r.mathieson@googlemail.com>2010-01-22 12:42:53 +0000
committerMartin Mathieson <martin.r.mathieson@googlemail.com>2010-01-22 12:42:53 +0000
commita33e4ee41ef1f5408cf76b5cec564244aae15820 (patch)
treea6db0dd68ac4cf3901d43312e6a5e80f8bbd8a2b /docbook
parent1a51e034090e7dcfa128c57d3313ae7f72e99c66 (diff)
downloadwireshark-a33e4ee41ef1f5408cf76b5cec564244aae15820.tar.gz
wireshark-a33e4ee41ef1f5408cf76b5cec564244aae15820.tar.bz2
wireshark-a33e4ee41ef1f5408cf76b5cec564244aae15820.zip
Add a simple help page for LTE RLC stats.
svn path=/trunk/; revision=31616
Diffstat (limited to 'docbook')
-rw-r--r--docbook/CMakeLists.txt1
-rw-r--r--docbook/Makefile.common1
-rw-r--r--docbook/user-guide.xml1
-rw-r--r--docbook/wsug_graphics/ws-stats-lte-rlc-traffic.pngbin0 -> 35942 bytes
-rw-r--r--docbook/wsug_src/WSUG_chapter_telephony.xml35
-rw-r--r--docbook/wsug_src/WSUG_chapter_use.xml5
6 files changed, 42 insertions, 1 deletions
diff --git a/docbook/CMakeLists.txt b/docbook/CMakeLists.txt
index d2d6d713c7..4d549027c2 100644
--- a/docbook/CMakeLists.txt
+++ b/docbook/CMakeLists.txt
@@ -125,6 +125,7 @@ set(WSUG_GRAPHICS
wsug_graphics/ws-stats-srt-dcerpc.png
wsug_graphics/ws-stats-summary.png
wsug_graphics/ws-stats-lte-mac-traffic.png
+ wsug_graphics/ws-stats-lte-rlc-traffic.png
wsug_graphics/ws-stats-wlan-traffic.png
wsug_graphics/ws-statusbar-empty.png
wsug_graphics/ws-statusbar-loaded.png
diff --git a/docbook/Makefile.common b/docbook/Makefile.common
index 1eddea1df9..02624dec4e 100644
--- a/docbook/Makefile.common
+++ b/docbook/Makefile.common
@@ -103,6 +103,7 @@ WSUG_GRAPHICS = \
wsug_graphics/ws-stats-srt-dcerpc.png \
wsug_graphics/ws-stats-summary.png \
wsug_graphics/ws-stats-lte-mac-traffic.png \
+ wsug_graphics/ws-stats-lte-rlc-traffic.png \
wsug_graphics/ws-stats-wlan-traffic.png \
wsug_graphics/ws-statusbar-empty.png \
wsug_graphics/ws-statusbar-loaded.png \
diff --git a/docbook/user-guide.xml b/docbook/user-guide.xml
index 18a729e536..0c09cc6399 100644
--- a/docbook/user-guide.xml
+++ b/docbook/user-guide.xml
@@ -242,6 +242,7 @@ FILE SECTION
<!ENTITY WiresharkStatsIOGraphs SYSTEM "./wsug_graphics/ws-stats-iographs.png" NDATA PNG>
<!ENTITY WiresharkStatsWLANTraffic SYSTEM "./wsug_graphics/ws-stats-wlan-traffic.png" NDATA PNG>
<!ENTITY WiresharkStatsLTEMACTraffic SYSTEM "./wsug_graphics/ws-stats-lte-mac-traffic.png" NDATA PNG>
+ <!ENTITY WiresharkStatsLTERLCTraffic SYSTEM "./wsug_graphics/ws-stats-lte-rlc-traffic.png" NDATA PNG>
<!ENTITY WiresharkStatsSrtDcerpcFilter SYSTEM "./wsug_graphics/ws-stats-srt-dcerpc-filter.png" NDATA PNG>
<!ENTITY WiresharkStatsSrtDcerpc SYSTEM "./wsug_graphics/ws-stats-srt-dcerpc.png" NDATA PNG>
diff --git a/docbook/wsug_graphics/ws-stats-lte-rlc-traffic.png b/docbook/wsug_graphics/ws-stats-lte-rlc-traffic.png
new file mode 100644
index 0000000000..f035816ec2
--- /dev/null
+++ b/docbook/wsug_graphics/ws-stats-lte-rlc-traffic.png
Binary files differ
diff --git a/docbook/wsug_src/WSUG_chapter_telephony.xml b/docbook/wsug_src/WSUG_chapter_telephony.xml
index 891dc15efd..31e8be7ed8 100644
--- a/docbook/wsug_src/WSUG_chapter_telephony.xml
+++ b/docbook/wsug_src/WSUG_chapter_telephony.xml
@@ -72,7 +72,40 @@
the traffic broken down by individual channel.
</para>
</section>
-
+
+ <section id="ChTelLTERLCTraffic">
+ <title>LTE RLC Traffic Statistics</title>
+ <para>
+ Statistics of the captured LTE RLC traffic. This window will summarize the
+ LTE RLC traffic found in the capture.
+ </para>
+
+ <figure><title>The "LTE RLC Traffic Statistics" window</title>
+ <graphic entityref="WiresharkStatsLTERLCTraffic" format="PNG"/>
+ </figure>
+
+ <para>
+ At the top, the check-box allows this window to include RLC PDUs found
+ withing MAC PDUs or not. This will affect both the PDUs counted as well
+ as the display filters generated (see below).
+ </para>
+
+ <para>
+ The upper list shows summaries of each active UE.
+ Each row in the lower list shows statistical highlights for individual
+ channels within the selected UE.
+ </para>
+
+ <para>
+ The lower part of the windows allows display filters to be generated and
+ set for the selected channel. Note that in the case of Acknowledged
+ Mode channels, if a single direction is chosen, the generated filter will
+ show data in that direction and control PDUs in the opposite direction.
+ </para>
+
+ </section>
+
+
<section id="ChTelXXX">
<title>The protocol specific statistics windows</title>
<para>
diff --git a/docbook/wsug_src/WSUG_chapter_use.xml b/docbook/wsug_src/WSUG_chapter_use.xml
index 0b58e55ac6..c5bae8c135 100644
--- a/docbook/wsug_src/WSUG_chapter_use.xml
+++ b/docbook/wsug_src/WSUG_chapter_use.xml
@@ -1784,6 +1784,11 @@
<entry><para>See <xref linkend="ChTelLTEMACTraffic"/></para></entry>
</row>
<row>
+ <entry><command>LTE RLC...</command></entry>
+ <entry></entry>
+ <entry><para>See <xref linkend="ChTelLTERLCTraffic"/></para></entry>
+ </row>
+ <row>
<entry><command>MTP3</command></entry>
<entry></entry>
<entry><para>See <xref linkend="ChTelXXX"/></para></entry>