diff options
authorGerald Combs <gerald@wireshark.org>2019-12-31 15:35:50 -0800
committerGerald Combs <gerald@wireshark.org>2020-01-03 16:37:08 +0000
commitfac6a2179e0a921341456a3bb31896c39d639b92 (patch)
parent4778386e71ef1c57fc6b9bdd2be5e18b490531e6 (diff)
WSUG: Add a Packet Lengths dialog section.
Add a section for the Packet Lengths window. Use title case for the column headers. Fix a button name and other issues elsewhere. Change-Id: I339d56aa169158e0788acd02a897729205e9f50e Reviewed-on: https://code.wireshark.org/review/35615 Reviewed-by: Gerald Combs <gerald@wireshark.org>
-rw-r--r--docbook/wsug_graphics/ws-stats-packet-lengths.pngbin0 -> 92831 bytes
7 files changed, 48 insertions, 9 deletions
diff --git a/docbook/CMakeLists.txt b/docbook/CMakeLists.txt
index ee03d98b6f..7aa9daf726 100644
--- a/docbook/CMakeLists.txt
+++ b/docbook/CMakeLists.txt
@@ -192,6 +192,7 @@ set(WSUG_GRAPHICS
wsug_graphics/ws-stats-iographs.png # GTK+
+ wsug_graphics/ws-stats-packet-lengths.png
wsug_graphics/ws-stats-srt-dcerpc-filter.png # GTK+
wsug_graphics/ws-stats-srt-dcerpc.png # GTK+
diff --git a/docbook/attributes.adoc b/docbook/attributes.adoc
index 34089fb796..fa002e0088 100644
--- a/docbook/attributes.adoc
+++ b/docbook/attributes.adoc
@@ -86,4 +86,4 @@
:multiplication: ×
:cmd: ⌘
-:missing: Not yet written. See https://wiki.wireshark.org/Development/SubmittingPatches.
+:missing: Not yet written. If you would like to fix this, see https://wiki.wireshark.org/Development/SubmittingPatches.
diff --git a/docbook/wsug_graphics/ws-stats-packet-lengths.png b/docbook/wsug_graphics/ws-stats-packet-lengths.png
new file mode 100644
index 0000000000..7b22e4d17f
--- /dev/null
+++ b/docbook/wsug_graphics/ws-stats-packet-lengths.png
Binary files differ
diff --git a/docbook/wsug_src/WSUG_chapter_statistics.adoc b/docbook/wsug_src/WSUG_chapter_statistics.adoc
index bbe90026dd..3e93f364b6 100644
--- a/docbook/wsug_src/WSUG_chapter_statistics.adoc
+++ b/docbook/wsug_src/WSUG_chapter_statistics.adoc
@@ -326,7 +326,45 @@ it before (or while) you are doing a live capture.
=== Packet Lengths
+Shows the distribution of packet lengths and related information.
+.The “Packet Lengths” window
+Information is broken down by packet length ranges as shown above.
+Packet Lengths::
+The range of packet lengths.
+The number of packets that fall into this range.
+The arithmetic mean length of the packets in this range.
+Min Val, Max Val::
+The minimum and maximum lengths in this range.
+Rate (ms)::
+The average packets per millisecond for the packets in this range.
+The percentage of packets in this range, by count.
+Burst Rate::
+Packet bursts are detected by counting the number of packets in a given time interval and comparing that count to the intervals across a window of time.
+Statistics for the interval with the maximum number of packets are shown.
+By default, bursts are detected across 5 millisecond intervals and intervals are compared across 100 millisecond windows.
+These calculations can be adjusted in the “Statistics” section of the <<ChCustPreferencesSection,Preferences Dialog>>.
+Burst Start::
+The start time, in seconds from the beginning of the capture, for the interval with the maximum number of packets.
+You can show statistics for a portion of the capture by entering a display filter into the _Display filter_ entry and pressing btn:[Apply].
+btn:[Copy] copies the statistics to the clipboard.
+btn:[Save as...] lets you save the data as text, CSV, YAML, or XML.
diff --git a/docbook/wsug_src/WSUG_chapter_use.adoc b/docbook/wsug_src/WSUG_chapter_use.adoc
index 4077e58360..057a2a7301 100644
--- a/docbook/wsug_src/WSUG_chapter_use.adoc
+++ b/docbook/wsug_src/WSUG_chapter_use.adoc
@@ -72,7 +72,7 @@ other GUI programs.
The layout of the main window can be customized by changing preference settings.
-See <<ChCustPreferencesSection>> for details!
+See <<ChCustPreferencesSection>> for details.
@@ -905,7 +905,7 @@ addresses), the IP dissector will overwrite this by its own (such as the IP
addresses), the TCP dissector will overwrite the IP information, and so on.
There are a lot of different columns available. Which columns are displayed can
-be selected by preference settings, see <<ChCustPreferencesSection>>.
+be selected by preference settings. See <<ChCustPreferencesSection>>.
The default columns will show:
diff --git a/docbook/wsug_src/WSUG_chapter_work.adoc b/docbook/wsug_src/WSUG_chapter_work.adoc
index a099d854a1..31d6fc1935 100644
--- a/docbook/wsug_src/WSUG_chapter_work.adoc
+++ b/docbook/wsug_src/WSUG_chapter_work.adoc
@@ -903,7 +903,7 @@ This will be greyed out if no filter is selected.
Saves the filter settings and closes the dialog.
Closes the dialog without saving any changes.
diff --git a/epan/stats_tree.c b/epan/stats_tree.c
index 13c9738b32..18499582c9 100644
--- a/epan/stats_tree.c
+++ b/epan/stats_tree.c
@@ -1066,17 +1066,17 @@ stats_tree_get_column_name (gint col_index)
return "Average";
case COL_MIN:
- return "Min val";
+ return "Min Val";
case COL_MAX:
- return "Max val";
+ return "Max Val";
case COL_RATE:
return "Rate (ms)";
return "Percent";
- return prefs.st_burst_showcount?"Burst count":"Burst rate";
+ return prefs.st_burst_showcount ? "Burst Count" : "Burst Rate";
- return "Burst start";
+ return "Burst Start";
return "(Unknown)";