aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorJoerg Mayer <jmayer@loplof.de>2014-09-13 07:31:14 +0200
committerJörg Mayer <jmayer@loplof.de>2014-09-13 05:34:39 +0000
commit6a7414f7263df58e38a4473559a646fd39883667 (patch)
tree2e1e1bda4a1fe6f090922647387ea1b5f51d74ee /doc
parent0a0654a7aa58d16063d9bc35e61c7917fa5d1e58 (diff)
README.dissector was split from README.developer in 2013 - update some
documents referring to the split out sections. Remove trailing whitespace while at this. Change-Id: I36cfe0ac55e8f653bffbf850e01f582aacf85557 Reviewed-on: https://code.wireshark.org/review/4094 Reviewed-by: Jörg Mayer <jmayer@loplof.de>
Diffstat (limited to 'doc')
-rw-r--r--doc/README.developer1
-rw-r--r--doc/README.heuristic2
-rw-r--r--doc/README.plugins30
-rw-r--r--doc/README.request_response_tracking2
4 files changed, 18 insertions, 17 deletions
diff --git a/doc/README.developer b/doc/README.developer
index c5e29deb7f..7c4f310207 100644
--- a/doc/README.developer
+++ b/doc/README.developer
@@ -29,6 +29,7 @@ You'll find additional information in the following README files:
- README.capture - the capture engine internals
- README.design - Wireshark software design - incomplete
- README.developer - this file
+- README.dissector - How to dissect a packet
- README.display_filter - Display Filter Engine
- README.idl2wrs - CORBA IDL converter
- README.packaging - how to distribute a software package containing WS
diff --git a/doc/README.heuristic b/doc/README.heuristic
index 1d99bde5db..72cd3caab2 100644
--- a/doc/README.heuristic
+++ b/doc/README.heuristic
@@ -8,7 +8,7 @@ remarks and patches to the developer mailing list.
Prerequisites
-------------
-As this file is an addition to README.developer, it is essential to read
+As this file is an addition to README.dissector, it is essential to read
and understand that document first.
diff --git a/doc/README.plugins b/doc/README.plugins
index 44b097df71..e703cfcd3d 100644
--- a/doc/README.plugins
+++ b/doc/README.plugins
@@ -1,7 +1,7 @@
1. Plugins
Writing a "plugin" dissector is not very different from writing a standard
-one. In fact all of the functions described in README.developer can be
+one. In fact all of the functions described in README.dissector can be
used in the plugins exactly as they are used in standard dissectors.
(Note, however, that not all OSes on which Wireshark runs can support
@@ -52,7 +52,7 @@ with "foo".
Your plugins/foo/Makefile.common should only list the main source file(s),
which exports register_*() and handoff_*(), for your dissector in the
-DISSECTOR_SRC variable. All other supporting source files should be
+DISSECTOR_SRC variable. All other supporting source files should be
listed in the DISSECTOR_SUPPORT_SRC variable.
The header files for your dissector, if any, must be listed in the
DISSECTOR_INCLUDES variable. The DISSECTOR_INCLUDES variable should not
@@ -75,30 +75,30 @@ for building the plugin. Its contents should match that in moduleinfo.h
2.8 plugin.rc.in
-Your plugins/foo/plugin.rc.in is the Windows resource template file used
+Your plugins/foo/plugin.rc.in is the Windows resource template file used
to add the plugin specific information as resources to the DLL.
No modifications are needed here.
3. Changes to existing Wireshark files
There are two ways to add your plugin dissector to the build, as a custom
-extension or as a permanent addition. The custom extension is easy to
-configure, but won't be used for inclusion in the distribution if that's
+extension or as a permanent addition. The custom extension is easy to
+configure, but won't be used for inclusion in the distribution if that's
your goal. Setting up the permanent addition is somewhat more involved.
3.1 Custom extension
-Go to the plugins directory and copy the three Custom.*.example files to
-Custom.*. Now you have three files ready for building a plugin with the
+Go to the plugins directory and copy the three Custom.*.example files to
+Custom.*. Now you have three files ready for building a plugin with the
name "foo". Replace the name if you so require.
-If you want to add the plugin to your own Windows installer add a text
-file named custom_plugins.txt to the packaging/nsis directory, with a
+If you want to add the plugin to your own Windows installer add a text
+file named custom_plugins.txt to the packaging/nsis directory, with a
"File" statement for NSIS:
File "..\..\plugins\foo\foo.dll"
-Then open packaging/nsis/Custom.nmake and add the relative path to your
+Then open packaging/nsis/Custom.nmake and add the relative path to your
DLL to CUSTOM_PLUGINS:
CUSTOM_PLUGINS= \
@@ -166,7 +166,7 @@ plugin_ldadd = $(_CUSTOM_plugin_ldadd_) \
3.2.4 Changes to the top level configure.ac
-You need to add your plugins Makefile (in alphbetical order) to the
+You need to add your plugins Makefile (in alphbetical order) to the
AC_OUTPUT rule in the configure.ac
AC_OUTPUT(
@@ -180,7 +180,7 @@ AC_OUTPUT(
3.2.5 Changes to epan/Makefile.am
-Add the relative path of all your plugin source files (in alphbetical
+Add the relative path of all your plugin source files (in alphbetical
order) to plugin_src:
plugin_src = \
@@ -225,7 +225,7 @@ PLUGINS= \
3.2.7.2 Changes to packaging/nsis/wireshark.nsi
-Add the relative path of your plugin DLL (in alphbetical order) to the
+Add the relative path of your plugin DLL (in alphbetical order) to the
list of "File" statements in the "Dissector Plugins" section:
File "${STAGING_DIR}\plugins\${VERSION}\ethercat.dll"
@@ -235,7 +235,7 @@ File "${STAGING_DIR}\plugins\${VERSION}\irda.dll"
3.2.7.3 Other installers
-The U3 and PortableApps installers build their manifests, including
+The U3 and PortableApps installers build their manifests, including
plugins, from wireshark.nsi via the packaging/ws-manifest.pl script.
4. Development and plugins on Unix
@@ -246,7 +246,7 @@ The first thing is that you'll have to run autogen.sh and configure once
more to setup your build environment.
The good news is that if you are working on a single plugin then you will
-find recompiling the plugin MUCH faster than recompiling a dissector and
+find recompiling the plugin MUCH faster than recompiling a dissector and
then linking it back into Wireshark. Use "make -C plugins" to compile just
your plugins.
diff --git a/doc/README.request_response_tracking b/doc/README.request_response_tracking
index 5c77c8d64e..09d945e40d 100644
--- a/doc/README.request_response_tracking
+++ b/doc/README.request_response_tracking
@@ -57,7 +57,7 @@ data you may want to keep track of from a request to a response.
We also need a structure that holds persistent information for each
conversation. A conversation is identified by SRC/DST address, protocol and
-SRC/DST port, see README.developer.
+SRC/DST port, see README.dissector, section 2.2.
In this case we only want to have a hash table to track the actual
transactions that occur for this unique conversation.
Some protocols negotiate session parameters during a login phase and those