Add a simple help page for LTE RLC stats.

svn path=/trunk/; revision=31616

9 files changed, 48 insertions, 4 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
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>
diff --git a/gtk/help_dlg.c b/gtk/help_dlg.c
index 2400e41b8d..cb79f0ce64 100644
--- a/gtk/help_dlg.c
+++ b/gtk/help_dlg.c
@@ -290,7 +290,10 @@ topic_action(topic_action_e action)
         help_topic_html("ChStatCompareCaptureFiles.html");
         break;
     case(HELP_STATS_LTE_MAC_TRAFFIC_DIALOG):
-        help_topic_html("ChStatLTEMACTraffic.html");
+        help_topic_html("ChTelLTEMACTraffic.html");
+        break;
+    case(HELP_STATS_LTE_RLC_TRAFFIC_DIALOG):
+        help_topic_html("ChTelLTERLCTraffic.html");
         break;
     case(HELP_STATS_WLAN_TRAFFIC_DIALOG):
         help_topic_html("ChStatWLANTraffic.html");
diff --git a/gtk/help_dlg.h b/gtk/help_dlg.h
index bcb7d8238a..cb0bb45ba4 100644
--- a/gtk/help_dlg.h
+++ b/gtk/help_dlg.h
@@ -82,6 +82,7 @@ typedef enum {
     HELP_STATS_IO_GRAPH_DIALOG,
     HELP_STATS_COMPARE_FILES_DIALOG,
     HELP_STATS_LTE_MAC_TRAFFIC_DIALOG,
+    HELP_STATS_LTE_RLC_TRAFFIC_DIALOG,
     HELP_STATS_WLAN_TRAFFIC_DIALOG,
     HELP_CAPTURE_INTERFACE_OPTIONS_DIALOG,
     HELP_CAPTURE_INTERFACES_DETAILS_DIALOG,
diff --git a/gtk/rlc_lte_stat_dlg.c b/gtk/rlc_lte_stat_dlg.c
index 24203ff299..86a7b1337f 100644
--- a/gtk/rlc_lte_stat_dlg.c
+++ b/gtk/rlc_lte_stat_dlg.c
@@ -1008,8 +1008,7 @@ static void rlc_lte_stat_dlg_create(void)
     window_set_cancel_button(rlc_lte_stat_dlg_w, close_bt, window_cancel_button_cb);
 
     help_bt = g_object_get_data(G_OBJECT(bbox), GTK_STOCK_HELP);
-    /* TODO: use own symbol!!! */
-    g_signal_connect(help_bt, "clicked", G_CALLBACK(topic_cb), (gpointer)HELP_STATS_LTE_MAC_TRAFFIC_DIALOG);
+    g_signal_connect(help_bt, "clicked", G_CALLBACK(topic_cb), (gpointer)HELP_STATS_LTE_RLC_TRAFFIC_DIALOG);
 
     /* Set callbacks */
     g_signal_connect(rlc_lte_stat_dlg_w, "delete_event", G_CALLBACK(window_delete_event_cb), NULL);