diff options
| author | Guy Harris <guy@alum.mit.edu> | 2020-02-22 20:35:43 -0800 |
|---|---|---|
| committer | Guy Harris <guy@alum.mit.edu> | 2020-02-23 04:36:23 +0000 |
| commit | c268e9b0d563cfd248fae611c06e39430e1bad6c (patch) | |
| tree | b3009612657b68cd2e4624c4db980df30a1c5802 /doc | |
| parent | e4138a3b98ac5782d3cc55de1c8c65352172fa10 (diff) | |
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 <guy@alum.mit.edu>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/README.heuristic | 4 |
1 files 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). |