aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorGuy Harris <guy@alum.mit.edu>2001-11-27 05:05:02 +0000
committerGuy Harris <guy@alum.mit.edu>2001-11-27 05:05:02 +0000
commit3ab9a4931f6d833c668ead671e40e26c8660f5ef (patch)
tree2333b61b1b2f5695b1d1049e28cace8cd22c514a /doc
parent0fb9bbe02e46d8322c23da4e00a8ecdbd784ac3a (diff)
Clarify what the tvbuff handed to a dissector contains (i.e., it's not
the raw frame data, it's the data that the dissector should look at). svn path=/trunk/; revision=4278
Diffstat (limited to 'doc')
-rw-r--r--doc/README.developer14
1 files changed, 8 insertions, 6 deletions
diff --git a/doc/README.developer b/doc/README.developer
index ab61f26aac..4c162843b7 100644
--- a/doc/README.developer
+++ b/doc/README.developer
@@ -1,4 +1,4 @@
-$Id: README.developer,v 1.39 2001/11/13 23:55:35 gram Exp $
+$Id: README.developer,v 1.40 2001/11/27 05:05:02 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
@@ -85,7 +85,7 @@ code inside
is needed only if you are using the "snprintf()" function.
-The "$Id: README.developer,v 1.39 2001/11/13 23:55:35 gram Exp $"
+The "$Id: README.developer,v 1.40 2001/11/27 05:05:02 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.
@@ -95,7 +95,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.39 2001/11/13 23:55:35 gram Exp $
+ * $Id: README.developer,v 1.40 2001/11/27 05:05:02 guy Exp $
*
* Ethereal - Network traffic analyzer
* By Gerald Combs <gerald@ethereal.com>
@@ -323,9 +323,11 @@ dissect_PROTOABBREV(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree);
NOTE: See the README.tvbuff for more details
The "tvb" argument to a dissector points to a buffer containing the raw
-data for the frame. A tvbuffer is a opaque data structure, the internal
-data structures are hidden and the data must be access via the tvbuffer
-accessors.
+data to be analyzed by the dissector; for example, for a protocol
+running atop UDP, it contains the UDP payload (but not the UDP header,
+or any protocol headers above it). A tvbuffer is a opaque data
+structure, the internal data structures are hidden and the data must be
+access via the tvbuffer accessors.
The accessors are: