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

Minor rewording; Also: add note to not use "" for a hf[] array blurb. 

svn path=/trunk/; revision=32940
This commit is contained in:
Bill Meier 2010-05-25 00:00:58 +00:00
parent fbbf502752
commit 9bafe20643
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/README.developer
View File

@ -1113,7 +1113,7 @@ FIELDDISPLAY For FT_UINT{8,16,24,32,64} and FT_INT{8,16,24,32,64):
BASE_NONE
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.
FIELDDESCR A brief description of the field, or NULL. [Please do not use ""].
PARENT_SUBFIELD Lower level protocol field used for lookup, i.e. "tcp.port"
ID_VALUE Lower level protocol field value that identifies this protocol
For example the TCP or UDP port number
@ -1806,9 +1806,9 @@ field would be set to NULL.
You can also use an extended version of the value_string for faster lookups.
It requires a value_string as input.
It will use the value as a pointer to the string if all values from 0 to max
are present in the array, otherwise a binary search will be used this requires
that the values are in assending order. The init macro will performe a check on the value string
the first time it is used to determine which search algorithm fits an fall back to a linear search
are present in the array; otherwise if the values are in assending order
a binary search will be used. The init macro will perform a check on the value string
the first time it is used to determine which search algorithm fits and fall back to a linear search
if the value_string does not meet the criteria above.
Use this macro to initialise the extended value_string:
@ -1888,7 +1888,7 @@ blurb
-----
This is a string giving a proper description of the field. It should be
at least one grammatically complete sentence, or NULL in which case the
name field is used.
name field is used. (Please do not use "").
It is meant to provide a more detailed description of the field than the
name alone provides. This information will be used in the man page, and
in a future GUI display-filter creation tool. We might also add tooltips