osmith
/
wireshark
forked from osmocom/wireshark
1
0
Fork 0
Code Pull Requests Releases Wiki Activity

Do a little more to discourage the use of proto_tree_add_text(): don't 

use it as example in a few places and point out that if you're not using the
return value to build a subtree, you probably shouldn't be using the function.

svn path=/trunk/; revision=46617
This commit is contained in:
Jeff Morriss 2012-12-19 15:54:40 +00:00
parent 3859fdc040
commit 456acec892
1 changed files with 9 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
doc/README.developer
View File

@ -179,9 +179,8 @@ support "%ll" for printing 64-bit integral data types. Instead, for
GLib routines, and routines that use them, such as all the routines in GLib routines, and routines that use them, such as all the routines in
Wireshark that take format arguments, use G_GINT64_MODIFIER, for example: Wireshark that take format arguments, use G_GINT64_MODIFIER, for example:
proto_tree_add_text(tree, tvb, offset, 8, proto_tree_add_uint64_format_value(tree, hf_uint64, tvb, offset, len,
"Sequence Number: %" G_GINT64_MODIFIER "u", val, "%" G_GINT64_MODIFIER "u", val);
sequence_number);
When specifying an integral constant that doesn't fit in 32 bits, don't When specifying an integral constant that doesn't fit in 32 bits, don't
use "LL" at the end of the constant - not all compilers use "LL" for use "LL" at the end of the constant - not all compilers use "LL" for
@ -494,7 +493,7 @@ I.e. do not write code such as
char buffer[1024]; char buffer[1024];
... ...
foo_to_str(buffer, ... foo_to_str(buffer, ...
proto_tree_add_text(... buffer ... proto_tree_add_string(... buffer ...
instead write the code as instead write the code as
static void static void
@ -507,7 +506,7 @@ instead write the code as
char *buffer; char *buffer;
... ...
foo_to_str(&buffer, ... foo_to_str(&buffer, ...
proto_tree_add_text(... *buffer ... proto_tree_add_string(... *buffer ...
Use wmem_ allocated buffers. They are very fast and nice. These buffers are all Use wmem_ allocated buffers. They are very fast and nice. These buffers are all
automatically free()d when the dissection of the current packet ends so you automatically free()d when the dissection of the current packet ends so you
@ -2631,8 +2630,11 @@ converted all the old-style proto_tree calls to the new-style proto_tree
calls. In other words, you should not use this in new code unless you've got calls. In other words, you should not use this in new code unless you've got
a specific reason (see below). a specific reason (see below).
This can also be used for items with subtrees, which may not have values This can (and should only) be used for items with subtrees, which may not
themselves - the items in the subtree are the ones with values. have values themselves - the items in the subtree are the ones with values.
In other words, if you're using proto_tree_add_text() and not using the
return value to build a new tree, you probably shouldn't be using this
function: you probably should be using proto_tree_add_item() instead.
For a subtree, the label on the subtree might reflect some of the items For a subtree, the label on the subtree might reflect some of the items
in the subtree. This means the label can't be set until at least some in the subtree. This means the label can't be set until at least some