diff options
author | Joerg Mayer <jmayer@loplof.de> | 2014-09-13 07:31:14 +0200 |
---|---|---|
committer | Jörg Mayer <jmayer@loplof.de> | 2014-09-13 05:34:39 +0000 |
commit | 6a7414f7263df58e38a4473559a646fd39883667 (patch) | |
tree | 2e1e1bda4a1fe6f090922647387ea1b5f51d74ee /docbook | |
parent | 0a0654a7aa58d16063d9bc35e61c7917fa5d1e58 (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 'docbook')
-rw-r--r-- | docbook/wsdg_src/WSDG_chapter_build_intro.asciidoc | 6 | ||||
-rw-r--r-- | docbook/wsdg_src/WSDG_chapter_dissection.asciidoc | 22 | ||||
-rw-r--r-- | docbook/wsdg_src/WSDG_chapter_env_intro.asciidoc | 3 |
3 files changed, 16 insertions, 15 deletions
diff --git a/docbook/wsdg_src/WSDG_chapter_build_intro.asciidoc b/docbook/wsdg_src/WSDG_chapter_build_intro.asciidoc index 2c4177ca37..a0b9a2cf1c 100644 --- a/docbook/wsdg_src/WSDG_chapter_build_intro.asciidoc +++ b/docbook/wsdg_src/WSDG_chapter_build_intro.asciidoc @@ -1,7 +1,7 @@ ++++++++++++++++++++++++++++++++++++++ <!-- WSDG Chapter Build Introduction --> ++++++++++++++++++++++++++++++++++++++ - + [[ChapterBuildIntro]] == Introduction @@ -28,7 +28,7 @@ Wireshark consists of the following major parts: === Coding Style -The coding style guides for Wireshark can be found in the "Code style" +The coding style guides for Wireshark can be found in the "Code style" section of the file 'doc/README.developer'. [[ChCodeGLib]] @@ -51,4 +51,4 @@ See https://developer.gnome.org/glib/[] for details about GLib. ++++++++++++++++++++++++++++++++++++++ <!-- End of WSDG Chapter Build Introduction --> -++++++++++++++++++++++++++++++++++++++
\ No newline at end of file +++++++++++++++++++++++++++++++++++++++ diff --git a/docbook/wsdg_src/WSDG_chapter_dissection.asciidoc b/docbook/wsdg_src/WSDG_chapter_dissection.asciidoc index 7f7884023b..015322b638 100644 --- a/docbook/wsdg_src/WSDG_chapter_dissection.asciidoc +++ b/docbook/wsdg_src/WSDG_chapter_dissection.asciidoc @@ -1,7 +1,7 @@ ++++++++++++++++++++++++++++++++++++++ <!-- WSDG Chapter Dissection --> ++++++++++++++++++++++++++++++++++++++ - + [[ChapterDissection]] == Packet dissection @@ -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. [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. ==== @@ -302,7 +302,7 @@ Now we can enhance the protocol display with some detail. ti = proto_tree_add_item(tree, proto_foo, tvb, 0, -1, ENC_NA); foo_tree = proto_item_add_subtree(ti, ett_foo); proto_tree_add_item(foo_tree, hf_foo_pdu_type, tvb, 0, 1, ENC_BIG_ENDIAN); - } + } ---- ==== @@ -432,7 +432,7 @@ static const value_string packettypenames[] = { { 2, "Terminate" }, { 3, "Data" }, { 0, NULL } -}; +}; ---- ==== @@ -785,7 +785,7 @@ msg_init_protocol(void) { fragment_table_init(&msg_fragment_table); reassembled_table_init(&msg_reassembled_table); -} +} ---- ==== @@ -1060,7 +1060,7 @@ WS_DLL_PUBLIC_DEF void plugin_register_tap_listener(void) register_foo_stat_trees(); } -#endif +#endif ---- ==== @@ -1097,7 +1097,7 @@ static void foo_stats_tree_init(stats_tree* st) { st_node_packets = stats_tree_create_node(st, st_str_packets, 0, TRUE); st_node_packet_types = stats_tree_create_pivot(st, st_str_packet_types, st_node_packets); -} +} ---- ==== @@ -1116,7 +1116,7 @@ static int foo_stats_tree_packet(stats_tree* st, packet_info* pinfo, epan_dissec stats_tree_tick_pivot(st, st_node_packet_types, val_to_str(pi->packet_type, msgtypevalues, "Unknown packet type (%d)")); return 1; -} +} ---- ==== @@ -1130,9 +1130,9 @@ us to record statistics by packet type. === How to use conversations 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 --> ++++++++++++++++++++++++++++++++++++++ - + diff --git a/docbook/wsdg_src/WSDG_chapter_env_intro.asciidoc b/docbook/wsdg_src/WSDG_chapter_env_intro.asciidoc index cae53b2656..c270f91bd7 100644 --- a/docbook/wsdg_src/WSDG_chapter_env_intro.asciidoc +++ b/docbook/wsdg_src/WSDG_chapter_env_intro.asciidoc @@ -396,7 +396,8 @@ various other sources of information: .Read the README ==== '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 APIs available to the dissector developer, etc. ==== |