forked from osmocom/wireshark
70 lines
2.2 KiB
XML
70 lines
2.2 KiB
XML
<!-- WSDG Chapter Build Introduction -->
|
|
<!-- $Id$ -->
|
|
|
|
<chapter id="ChapterBuildIntro">
|
|
<title>Introduction</title>
|
|
|
|
<section id="ChCodeOverview">
|
|
<title>Source overview</title>
|
|
<para>
|
|
Wireshark consists of the following major parts:
|
|
<itemizedlist>
|
|
<listitem><para>
|
|
Packet dissection - in the /epan/dissector and /plugin/* directory
|
|
</para></listitem>
|
|
<listitem><para>
|
|
File I/O - using Wireshark's own wiretap library
|
|
</para></listitem>
|
|
<listitem><para>
|
|
Capture - using the libpcap/winpcap library, in /wiretap
|
|
</para></listitem>
|
|
<listitem><para>
|
|
User interface - using the GTK+ (and corresponding) libraries
|
|
</para></listitem>
|
|
<listitem><para>
|
|
Help - using an external webbrowser and GTK text output
|
|
</para></listitem>
|
|
</itemizedlist>
|
|
Beside this, some other minor parts and additional helpers exist.
|
|
</para>
|
|
<para>
|
|
Currently there's no clean separation of the modules in the code.
|
|
However, as the development team switched from Concurrent Versions System
|
|
(CVS) to Subversion (SVN) some time ago,
|
|
directory cleanup is much easier now. So there's a chance that
|
|
the directory structure will become clean in the future.
|
|
</para>
|
|
</section>
|
|
|
|
<section id="ChCodeStyle">
|
|
<title>Coding styleguides</title>
|
|
<para>
|
|
The coding styleguides for Wireshark can be found in the "Code style"
|
|
section of the file <filename>doc/README.developer</filename>.
|
|
</para>
|
|
</section>
|
|
|
|
<section id="ChCodeGLib">
|
|
<title>The GLib library</title>
|
|
<para>
|
|
Glib is used as a basic platform abstraction library, it's not related to
|
|
GUI things.
|
|
</para>
|
|
<para>
|
|
To quote the Glib documentation: <quote>GLib is a general-purpose utility
|
|
library, which provides many useful
|
|
data types, macros, type conversions, string utilities, file utilities,
|
|
a main loop abstraction, and so on. It works on many UNIX-like platforms,
|
|
Windows, OS/2 and BeOS. GLib is released under the GNU Library General
|
|
Public License (GNU LGPL).</quote>
|
|
</para>
|
|
<para>
|
|
GLib contains lot's of useful things for platform independent development.
|
|
See <ulink url="http://developer.gnome.org/doc/API/2.0/glib/index.html"/>
|
|
for details about GLib.
|
|
</para>
|
|
</section>
|
|
|
|
</chapter>
|
|
<!-- End of WSDG Chapter Build Introduction -->
|