From c268e9b0d563cfd248fae611c06e39430e1bad6c Mon Sep 17 00:00:00 2001 From: Guy Harris Date: Sat, 22 Feb 2020 20:35:43 -0800 Subject: [PATCH] Use "must" instead of "should" to avoid ambiguity. As I said in https://ask.wireshark.org/question/10361/how-to-properly-use-heuristic-dissector-for-tcp/?answer=10363#post-id-10363 "Should" has multiple meanings; there's "Used to indicate obligation, duty, or correctness, typically when criticizing someone's actions.", as in "I think we should trust our people more", and there's "Used to indicate what is probable.", as in "the bus should arrive in a few minutes". You're reading it in the latter sense; it was intended in the former sense. That sentence should probably be changed to "Wireshark must be then set up..." to avoid the ambiguity. Make it so (over half a year later, sigh), and change another case where "should" is meant in the first sense while we're at it. Change-Id: I90198d1616619c75802deeeb703ceee0c8bac1bf Reviewed-on: https://code.wireshark.org/review/36155 Reviewed-by: Guy Harris --- doc/README.heuristic | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/README.heuristic b/doc/README.heuristic index af53b74535..2852a748ca 100644 --- a/doc/README.heuristic +++ b/doc/README.heuristic @@ -60,7 +60,7 @@ SCTP, TCP, TIPC and UDP dissectors all provide this capability via their option enabled by default. Once a packet for a particular "connection" has been identified as belonging -to a particular protocol, Wireshark should then be set up to always directly +to a particular protocol, Wireshark must then be set up to always directly call the dissector for that protocol. This removes the overhead of having to identify each packet of the connection heuristically. @@ -94,7 +94,7 @@ that it's not good enough to distinguish between two given protocols. Note: The heuristic code in a dissector *must not* cause an exception (before returning FALSE) as this will prevent following heuristic dissector handoffs. In practice, this normally means - that a test should be done to verify that the required data is + that a test must be done to verify that the required data is available in the tvb before fetching from the tvb. (See the example below).