Complete binary tree description with string keys.

Update some entries in developer doc.
Add some preference description in POD.

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

diff --git a/doc/README.binarytrees b/doc/README.binarytrees
index 7b4d3b039b21b5d710b75e79445c97f608e9a23a..6e09e1373fc73e71cf0fa4fb69783e3d8db5fb16 100644 (file)
--- a/doc/README.binarytrees
+++ b/doc/README.binarytrees
@@ -215,4 +215,13 @@ in the same tree :
 
 
 3.3 se_tree_insert_string / se_tree_lookup_string
-to be added...
+void emem_tree_insert_string(emem_tree_t* h, const gchar* k, void* v, guint32 flags);
+void* emem_tree_lookup_string(emem_tree_t* h, const gchar* k, guint32 flags);
+These functions are essentially wrappers for se_tree_insert32_array and
+se_tree_lookup32_array, tailered to text strings. They extend the text string
+into an array key and use that to key the se_tree_insert32_array and
+se_tree_lookup32_array functions.
+In order to support text string in a case insensitive way add the
+EMEM_TREE_STRING_NOCASE flag. This will uppercase all string data before using
+it as key data.
+

diff --git a/doc/README.developer b/doc/README.developer
index 0e53e4914e0eb5564c2da1b034c986177b2e01d7..7e81034081c2d702dc075a383e24f692af8affb8 100644 (file)
--- a/doc/README.developer
+++ b/doc/README.developer
@@ -1462,17 +1462,14 @@ information about the its data type is needed. It helps to look at
 the header_field_info struct to see what information is expected:
 
 struct header_field_info {
-       char                            *name;
-       char                            *abbrev;
+       const char                      *name;
+       const char                      *abbrev;
        enum ftenum                     type;
        int                             display;
-       void                            *strings;
-       guint                           bitmask;
-       char                            *blurb;
-
-       int                             id;       /* calculated */
-       int                             parent;
-       int                             bitshift; /* calculated */
+       const void                      *strings;
+       guint32                         bitmask;
+       const char                      *blurb;
+       .....
 };
 
 name
@@ -1695,12 +1692,15 @@ If the field is a bitfield, then the bitmask is the mask which will
 leave only the bits needed to make the field when ANDed with a value.
 The proto_tree routines will calculate 'bitshift' automatically
 from 'bitmask', by finding the rightmost set bit in the bitmask.
+This shift is applied before applying string mapping functions or 
+filtering.
 If the field is not a bitfield, then bitmask should be set to 0.
 
 blurb
 -----
-This is a string giving a proper description of the field.
-It should be at least one grammatically complete sentence.
+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.
 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
@@ -2631,9 +2631,10 @@ compile).
   - Edit the diff file - remove any changes unrelated to your new dissector,
     e.g. changes in config.nmake
 
-  - Send a note with the attached diff file requesting its inclusion to
-    <mailto:wireshark-dev[AT]wireshark.org>. You can also use this procedure for
-    providing patches to your dissector or any other part of Wireshark.
+  - Submit a bug report to the Wireshark bug database, found at
+    <http://bugs.wireshark.org>, qualified as an enhancement and attach your
+    diff file there. Set the review request flag to '?' so it will pop up in
+    the patch review list.
 
   - Create a Wiki page on the protocol at <http://wiki.wireshark.org>.
     A template is provided so it is easy to setup in a consistent style.

diff --git a/doc/wireshark.pod b/doc/wireshark.pod
index 46ef538e1145aa5f3f292ab0d2ece3a502b9771a..121ed20dcc2bc804ac33fe46195b6986eadea244 100644 (file)
--- a/doc/wireshark.pod
+++ b/doc/wireshark.pod
@@ -1607,16 +1607,36 @@ slashes or backslashes will automatically be added.
 
 =item File Open Preview timeout
 
+This items allows the user to define how much time is spend reading the
+capture file to present preview data in the File Open dialog.
+
 =item Open Recent maximum list entries
 
+The File menu supports a recent file list. This items allows the user to
+specify how many files are kept track of in this list.
+
 =item Ask for unsaved capture files
 
+When closing a capture file or Wireshark itself if the file isn't saved yet
+the user is presented the option to save the file when this item is set.
+
 =item Wrap during find
 
+This items determines the behaviour when reaching the beginning or the end
+of a capture file. When set the search wraps around and continues, otherwise
+it stops.
+
 =item Settings dialogs show a save button
 
+This item determines if the various dialogs sport an explicit Save button
+or that save is implicit in Ok / Apply.
+
 =item Web browser command
 
+This entry specifies the command line to launch a web browser. It is used
+to access online content, like the Wiki and user guide. Use '%s' to place
+the request URL in the command line.
+
 =back
 
 =item Layout Preferences