Improve the note on how to deal with items with subtrees when the text

for the item should reflect what's in the subtree.


git-svn-id: http://anonsvn.wireshark.org/wireshark/trunk@4832 f5534014-38df-0310-8fa8-9805f1628bb7

1 files changed, 7 insertions, 6 deletions

diff --git a/doc/README.developer b/doc/README.developer
index 4b05a18d56..c7b524da7b 100644
--- a/doc/README.developer
+++ b/doc/README.developer
@@ -1,4 +1,4 @@
-$Id: README.developer,v 1.46 2002/01/21 07:52:35 guy Exp $
+$Id: README.developer,v 1.47 2002/02/28 23:23:12 guy Exp $
 
 This file is a HOWTO for Ethereal developers. It describes how to start coding
 a Ethereal protocol dissector and the use some of the important functions and
@@ -101,7 +101,7 @@ code inside
 
 is needed only if you are using the "snprintf()" function.
 
-The "$Id: README.developer,v 1.46 2002/01/21 07:52:35 guy Exp $"
+The "$Id: README.developer,v 1.47 2002/02/28 23:23:12 guy Exp $"
 in the comment will be updated by CVS when the file is
 checked in; it will allow the RCS "ident" command to report which
 version of the file is currently checked out.
@@ -111,7 +111,7 @@ version of the file is currently checked out.
  * Routines for PROTONAME dissection
  * Copyright 2000, YOUR_NAME <YOUR_EMAIL_ADDRESS>
  *
- * $Id: README.developer,v 1.46 2002/01/21 07:52:35 guy Exp $
+ * $Id: README.developer,v 1.47 2002/02/28 23:23:12 guy Exp $
  *
  * Ethereal - Network traffic analyzer
  * By Gerald Combs <gerald@ethereal.com>
@@ -1165,6 +1165,7 @@ of the items in the subtree have been dissected.  To do this, use
 arguments corresponding to '%' format items in that string, and replaces
 the text for the item created by 'proto_tree_add_text()' with the result
 of applying the arguments to the format string. 
+
 'proto_item_append_text()' is similar, but it appends to the text for
 the item the result of applying the arguments to the format string.
 
@@ -1182,9 +1183,9 @@ available without dissecting any of the data in the subtree.
 
 Note that an exception might thrown when trying to extract the values of
 the items used to set the label, if not all the bytes of the item are
-available.  Thus, one should set the text of the item as soon as all the
-values used to set it have been extracted, rather than setting it only
-after the entire subtree has been dissected.
+available.  Thus, one should create the item with text that is as
+meaningful as possible, and set it or append additional information to
+it as the values needed to supply that information is extracted.
 
 1.7 Utility routines