summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorMichael Mann <mmann78@netscape.net>2016-07-21 10:21:25 -0400
committerAnders Broman <a.broman58@gmail.com>2016-07-27 03:40:02 +0000
commit8b0e9c66728f6a39bbe3ada1029e13ad1378013a (patch)
treec0c1b4da1845069520d4e131db96e6143e4ca772 /doc
parentb7f1e99f7f4c75fa4bac1ccba77087fb0e50b8ac (diff)
downloadwireshark-8b0e9c66728f6a39bbe3ada1029e13ad1378013a.tar.gz
Follow up for proto_tree_add_checksum.
Fill in the "gaps" so that all dissectors that verify checksums have both a status and expert info field. Also address comments from original proto_tree_add_checksum patch that didn't make it. Ping-Bug: 8859 Change-Id: I2e6640108fd6bb218cb959fe9e4ba98a13e43a2f Reviewed-on: https://code.wireshark.org/review/16590 Petri-Dish: Michael Mann <mmann78@netscape.net> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Anders Broman <a.broman58@gmail.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/README.dissector14
1 files changed, 14 insertions, 0 deletions
diff --git a/doc/README.dissector b/doc/README.dissector
index 74409bd390..94fa462d1c 100644
--- a/doc/README.dissector
+++ b/doc/README.dissector
@@ -1407,6 +1407,11 @@ protocol or field labels to the proto_tree:
value, format, ...);
proto_item *
+ proto_tree_add_checksum(proto_tree *tree, tvbuff_t *tvb, const guint offset,
+ const int hf_checksum, const int hf_checksum_status, struct expert_field* bad_checksum_expert,
+ packet_info *pinfo, guint32 computed_checksum, const guint encoding, const guint flags);
+
+ proto_item *
proto_tree_add_bitmask(tree, tvb, start, header, ett, fields,
encoding);
@@ -1805,6 +1810,15 @@ With these routines, unlike the proto_tree_add_XXX_format() routines,
the name of the field is added automatically as in the
proto_tree_add_XXX() functions; only the value is added with the format.
+proto_tree_add_checksum()
+----------------------------
+proto_tree_add_checksum is used to add a checksum field. The hf field
+provided must be the correct size of the checksum (FT_UINT, FT_UINT16,
+FT_UINT32, etc). Additional parameters are there to provide "status"
+and expert info depending on whether the checksum matches the provided
+value. The "status" and expert info can be used in cases except
+where PROTO_CHECKSUM_NO_FLAGS is used.
+
proto_tree_add_subtree()
---------------------
proto_tree_add_subtree() is used to add a label to the GUI tree and create