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

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>
This commit is contained in:
Joerg Mayer 2014-09-13 07:31:14 +02:00 committed by Jörg Mayer
parent 0a0654a7aa
commit 6a7414f726
7 changed files with 34 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/README.developer
View File

@ -29,6 +29,7 @@ You'll find additional information in the following README files:
- README.capture - the capture engine internals - README.capture - the capture engine internals
- README.design - Wireshark software design - incomplete - README.design - Wireshark software design - incomplete
- README.developer - this file - README.developer - this file
- README.dissector - How to dissect a packet
- README.display_filter - Display Filter Engine - README.display_filter - Display Filter Engine
- README.idl2wrs - CORBA IDL converter - README.idl2wrs - CORBA IDL converter
- README.packaging - how to distribute a software package containing WS - README.packaging - how to distribute a software package containing WS

2
doc/README.heuristic
View File

@ -8,7 +8,7 @@ remarks and patches to the developer mailing list.
Prerequisites 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. and understand that document first.

2
doc/README.plugins
View File

@ -1,7 +1,7 @@
1. Plugins 1. Plugins
Writing a "plugin" dissector is not very different from writing a standard 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. used in the plugins exactly as they are used in standard dissectors.
(Note, however, that not all OSes on which Wireshark runs can support (Note, however, that not all OSes on which Wireshark runs can support

2
doc/README.request_response_tracking
View File

@ -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 We also need a structure that holds persistent information for each
conversation. A conversation is identified by SRC/DST address, protocol and 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 In this case we only want to have a hash table to track the actual
transactions that occur for this unique conversation. transactions that occur for this unique conversation.
Some protocols negotiate session parameters during a login phase and those Some protocols negotiate session parameters during a login phase and those

6
docbook/wsdg_src/WSDG_chapter_dissection.asciidoc
View File

@ -34,9 +34,9 @@ built-in one. So starting with a plugin makes initial development simpler, while
the finished code may make more sense as a built-in dissector. the finished code may make more sense as a built-in dissector.
[NOTE] [NOTE]
.Read README.developer .Read README.dissector
==== ====
The file 'doc/README.developer' contains detailed information about implementing The file 'doc/README.dissector' contains detailed information about implementing
a dissector. In many cases it is more up to date than this document. a dissector. In many cases it is more up to date than this document.
==== ====
@ -1130,7 +1130,7 @@ us to record statistics by packet type.
=== How to use conversations === How to use conversations
Some info about how to use conversations in a dissector can be found in the file Some info about how to use conversations in a dissector can be found in the file
'doc/README.developer', chapter 2.2. 'doc/README.dissector', chapter 2.2.
++++++++++++++++++++++++++++++++++++++ ++++++++++++++++++++++++++++++++++++++
<!-- End of WSDG Chapter Dissection --> <!-- End of WSDG Chapter Dissection -->

3
docbook/wsdg_src/WSDG_chapter_env_intro.asciidoc
View File

@ -396,7 +396,8 @@ various other sources of information:
.Read the README .Read the README
==== ====
'README.developer' is packed full with all kinds of details relevant 'README.developer' is packed full with all kinds of details relevant
to the developer of Wireshark source code. It advices you around common to the developer of Wireshark source code. Its companion file
'README.dissector' advises you around common
pitfalls, shows you basic layout of dissector code, shows details of the pitfalls, shows you basic layout of dissector code, shows details of the
APIs available to the dissector developer, etc. APIs available to the dissector developer, etc.
==== ====