aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorGuy Harris <guy@alum.mit.edu>2009-12-12 02:33:16 +0000
committerGuy Harris <guy@alum.mit.edu>2009-12-12 02:33:16 +0000
commited9f7440e3cc8e265a8d29c2d6e4cb5c3bb504ad (patch)
tree163cece7a2edf4a443465480f26982f8e079efd6 /doc
parent6b45b0a901ec2c6f4aab9509451abf4b835de14d (diff)
Clarify that BASE_RANGE_STRING is a flag set in the display field, not
itself a valid value for that field - it should be ORed with a value. Indicate that it will never be possible to record in a header_field_info a byte order for all fields, as some protocols do not specify the endianness of fields (for example, DCE RPC uses "receiver makes it right", with the sender sending data in its byte order, with an indication in the packet of what that byte order is). svn path=/trunk/; revision=31248
Diffstat (limited to 'doc')
-rw-r--r--doc/README.developer8
1 files changed, 6 insertions, 2 deletions
diff --git a/doc/README.developer b/doc/README.developer
index fd6147ed22..da73e951f4 100644
--- a/doc/README.developer
+++ b/doc/README.developer
@@ -1089,7 +1089,8 @@ FIELDTYPE FT_NONE, FT_BOOLEAN, FT_UINT8, FT_UINT16, FT_UINT24,
FT_UINT_STRING, FT_ETHER, FT_BYTES, FT_UINT_BYTES, FT_IPv4,
FT_IPv6, FT_IPXNET, FT_FRAMENUM, FT_PROTOCOL, FT_GUID, FT_OID
FIELDBASE BASE_NONE, BASE_DEC, BASE_HEX, BASE_OCT, BASE_DEC_HEX,
- BASE_HEX_DEC, BASE_RANGE_STRING, BASE_CUSTOM
+ BASE_HEX_DEC, or BASE_CUSTOM, possibly ORed with
+ BASE_RANGE_STRING
FIELDCONVERT VALS(x), RVALS(x), TFS(x), NULL
BITMASK Usually 0x0 unless using the TFS(x) field conversion.
FIELDDESCR A brief description of the field, or NULL.
@@ -1736,7 +1737,10 @@ in the 'display' field. You may not use BASE_NONE for integers.
It is possible that in the future we will record the endianness of
integers. If so, it is likely that we'll use a bitmask on the display field
so that integers would be represented as BEND|BASE_DEC or LEND|BASE_HEX.
-But that has not happened yet.
+But that has not happened yet; note that there are protocols for which
+no endianness is specified, such as the X11 protocol and the DCE RPC
+protocol, so it would not be possible to record the endianness of all
+integral fields.
strings
-------