osmocom
/
wireshark
14
0
Fork 1
Code Issues Pull Requests Projects Releases Wiki Activity
wireshark/docbook/wsdg_src/WSDG_chapter_build_intro.as...

51 lines
1.3 KiB
Plaintext
Raw Normal View History

AsciiDoc: Convert some comments. Convert some passthrough XML comments left over from the DocBook → AsciiDoc conversion to AsciiDoc / Asciidoctor comments. Change-Id: Iaf44bcf0b8a3a383e735b2b4394722cbbb2bdff3 Reviewed-on: https://code.wireshark.org/review/25615 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2018-02-05 16:59:45 +00:00
// WSDG Chapter Build Introduction
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>
2014-09-13 05:31:14 +00:00
Convert three more WSDG chapters: works, build, and capture. Start adding references to Qt and wsutil. Fix a file extension in CMakeLists.txt. Change-Id: I0cbe7e802d88a05effff40b5de72669e22c0df53 Reviewed-on: https://code.wireshark.org/review/79 Reviewed-by: Gerald Combs <gerald@wireshark.org> Tested-by: Gerald Combs <gerald@wireshark.org>
2014-02-02 19:00:30 +00:00
[[ChapterBuildIntro]]
== Introduction
[[ChCodeOverview]]
=== Source overview
Wireshark consists of the following major parts:
Docs: Make our AsciiDoc markup more compatible with AsciiDoctor. Start using markup that is preferred by Asciidoctor but compatible with both generators. Add a missing "cpp" attribute and set a couple of Asciidoctor-specific compatibility attributes. Change-Id: Iff4c31362e4493b97a85f46db2c39b18c336536f Reviewed-on: https://code.wireshark.org/review/25600 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2018-02-04 19:39:56 +00:00
* Packet dissection - in the _/epan/dissector_ and _/plugin/\*_ directories
Convert three more WSDG chapters: works, build, and capture. Start adding references to Qt and wsutil. Fix a file extension in CMakeLists.txt. Change-Id: I0cbe7e802d88a05effff40b5de72669e22c0df53 Reviewed-on: https://code.wireshark.org/review/79 Reviewed-by: Gerald Combs <gerald@wireshark.org> Tested-by: Gerald Combs <gerald@wireshark.org>
2014-02-02 19:00:30 +00:00
More AsciiDoc → Asciidoctor updates. Switch from AsciiDoc's smart quotes markup to the quotes themselves. Use double curly quotes in place of singles. Switch from XML entities to their direct equivalents where we can. Switch from hex entities to decimal entities where we can't or it's not convenient. (Asciidoctor PDF doesn't yet handle hex entities). Change-Id: Iaf5ec33249e1c91b3d50b5d96251763243b72836 Reviewed-on: https://code.wireshark.org/review/25606 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2018-02-04 23:15:02 +00:00
* File I/O - using Wireshark’s own wiretap library
Convert three more WSDG chapters: works, build, and capture. Start adding references to Qt and wsutil. Fix a file extension in CMakeLists.txt. Change-Id: I0cbe7e802d88a05effff40b5de72669e22c0df53 Reviewed-on: https://code.wireshark.org/review/79 Reviewed-by: Gerald Combs <gerald@wireshark.org> Tested-by: Gerald Combs <gerald@wireshark.org>
2014-02-02 19:00:30 +00:00
Docs: Make our AsciiDoc markup more compatible with AsciiDoctor. Start using markup that is preferred by Asciidoctor but compatible with both generators. Add a missing "cpp" attribute and set a couple of Asciidoctor-specific compatibility attributes. Change-Id: Iff4c31362e4493b97a85f46db2c39b18c336536f Reviewed-on: https://code.wireshark.org/review/25600 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2018-02-04 19:39:56 +00:00
* Capture - using the libpcap/winpcap library, in _/wiretap_
Convert three more WSDG chapters: works, build, and capture. Start adding references to Qt and wsutil. Fix a file extension in CMakeLists.txt. Change-Id: I0cbe7e802d88a05effff40b5de72669e22c0df53 Reviewed-on: https://code.wireshark.org/review/79 Reviewed-by: Gerald Combs <gerald@wireshark.org> Tested-by: Gerald Combs <gerald@wireshark.org>
2014-02-02 19:00:30 +00:00
Docs: Remove a bunch of GTK+ references. Change-Id: Icab98813d0b81a7337562e9857429d4bb98dc44c Reviewed-on: https://code.wireshark.org/review/26817 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Gerald Combs <gerald@wireshark.org>
2018-04-09 04:11:26 +00:00
* User interface - using Qt and associated libraries
Convert three more WSDG chapters: works, build, and capture. Start adding references to Qt and wsutil. Fix a file extension in CMakeLists.txt. Change-Id: I0cbe7e802d88a05effff40b5de72669e22c0df53 Reviewed-on: https://code.wireshark.org/review/79 Reviewed-by: Gerald Combs <gerald@wireshark.org> Tested-by: Gerald Combs <gerald@wireshark.org>
2014-02-02 19:00:30 +00:00
* Utilities - miscellaneous helper code
Docs: Remove a bunch of GTK+ references. Change-Id: Icab98813d0b81a7337562e9857429d4bb98dc44c Reviewed-on: https://code.wireshark.org/review/26817 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Gerald Combs <gerald@wireshark.org>
2018-04-09 04:11:26 +00:00
* Help - using an external web browser and text output
Convert three more WSDG chapters: works, build, and capture. Start adding references to Qt and wsutil. Fix a file extension in CMakeLists.txt. Change-Id: I0cbe7e802d88a05effff40b5de72669e22c0df53 Reviewed-on: https://code.wireshark.org/review/79 Reviewed-by: Gerald Combs <gerald@wireshark.org> Tested-by: Gerald Combs <gerald@wireshark.org>
2014-02-02 19:00:30 +00:00
[[ChCodeStyle]]
=== Coding Style
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>
2014-09-13 05:31:14 +00:00
The coding style guides for Wireshark can be found in the "Code style"
Docs: Make our AsciiDoc markup more compatible with AsciiDoctor. Start using markup that is preferred by Asciidoctor but compatible with both generators. Add a missing "cpp" attribute and set a couple of Asciidoctor-specific compatibility attributes. Change-Id: Iff4c31362e4493b97a85f46db2c39b18c336536f Reviewed-on: https://code.wireshark.org/review/25600 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2018-02-04 19:39:56 +00:00
section of the file _doc/README.developer_.
Convert three more WSDG chapters: works, build, and capture. Start adding references to Qt and wsutil. Fix a file extension in CMakeLists.txt. Change-Id: I0cbe7e802d88a05effff40b5de72669e22c0df53 Reviewed-on: https://code.wireshark.org/review/79 Reviewed-by: Gerald Combs <gerald@wireshark.org> Tested-by: Gerald Combs <gerald@wireshark.org>
2014-02-02 19:00:30 +00:00
[[ChCodeGLib]]
=== The GLib library
Docs: Remove a bunch of GTK+ references. Change-Id: Icab98813d0b81a7337562e9857429d4bb98dc44c Reviewed-on: https://code.wireshark.org/review/26817 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Gerald Combs <gerald@wireshark.org>
2018-04-09 04:11:26 +00:00
GLib is used as a basic platform abstraction library. It doesn't provide
Convert three more WSDG chapters: works, build, and capture. Start adding references to Qt and wsutil. Fix a file extension in CMakeLists.txt. Change-Id: I0cbe7e802d88a05effff40b5de72669e22c0df53 Reviewed-on: https://code.wireshark.org/review/79 Reviewed-by: Gerald Combs <gerald@wireshark.org> Tested-by: Gerald Combs <gerald@wireshark.org>
2014-02-02 19:00:30 +00:00
any direct GUI functionality.
Docs: Remove a bunch of GTK+ references. Change-Id: Icab98813d0b81a7337562e9857429d4bb98dc44c Reviewed-on: https://code.wireshark.org/review/26817 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Gerald Combs <gerald@wireshark.org>
2018-04-09 04:11:26 +00:00
To quote the GLib Reference Manual:
Convert three more WSDG chapters: works, build, and capture. Start adding references to Qt and wsutil. Fix a file extension in CMakeLists.txt. Change-Id: I0cbe7e802d88a05effff40b5de72669e22c0df53 Reviewed-on: https://code.wireshark.org/review/79 Reviewed-by: Gerald Combs <gerald@wireshark.org> Tested-by: Gerald Combs <gerald@wireshark.org>
2014-02-02 19:00:30 +00:00
____
GLib provides the core application building blocks for libraries and
applications written in C. It provides the core object system used in GNOME, the
main loop implementation, and a large set of utility functions for strings and
common data structures.
____
GLib contains lots of useful things for platform independent development.
See https://developer.gnome.org/glib/[] for details about GLib.
AsciiDoc: Convert some comments. Convert some passthrough XML comments left over from the DocBook → AsciiDoc conversion to AsciiDoc / Asciidoctor comments. Change-Id: Iaf44bcf0b8a3a383e735b2b4394722cbbb2bdff3 Reviewed-on: https://code.wireshark.org/review/25615 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2018-02-05 16:59:45 +00:00
// End of WSDG Chapter Build Introduction