from Jaap Keuter:
[obnox/wireshark/wip.git] / docbook / edg_src / EDG_chapter_build_intro.xml
1 <!-- EDG Chapter Build Introduction -->
2 <!-- $Id$ -->
3
4 <chapter id="ChapterBuildIntro">
5   <title>Introduction</title>
6   
7   <section id="ChCodeOverview">
8         <title>Source overview</title>
9         <para>
10         Ethereal consists of the following major parts:
11         <itemizedlist>
12         <listitem><para>
13         Packet dissection - in the / and /epan directory
14         </para></listitem>
15         <listitem><para>
16         File I/O - using Ethereal's own wiretap library
17         </para></listitem>
18         <listitem><para>
19         Capture - using the libpcap/winpcap library
20         </para></listitem>
21         <listitem><para>
22         User interface - using the GTK (and corresponding) libraries
23         </para></listitem>
24         <listitem><para>
25         Help - using an external webbrowser and GTK text output
26         </para></listitem>
27         </itemizedlist>
28         Beside this, some other minor parts and additional helpers exist.
29         </para>
30         <para>
31         Currently there's no clean seperation of the modules in the code. 
32         However, as the development team switched from CVS to SVN some time ago, 
33         directory cleanup are much easier now. So there's a chance that
34         the directory structure will become clean in the future.
35         </para>
36   </section>
37
38   <section id="ChCodeStyle">
39         <title>Coding styleguides</title>
40         <para>
41         The coding styleguides for Ethereal can be found in the "Code style" 
42         section of the file <filename>doc/README.developer</filename>.
43         </para>
44   </section>
45
46   <section id="ChCodeGLib">
47         <title>The GLib library</title>
48         <para>
49         Glib is used as a basic platform abstraction library, it's not related to
50         GUI things. 
51         </para>
52         <para>
53         To quote the Glib documentation: <quote>GLib is a general-purpose utility 
54         library, which provides many useful 
55         data types, macros, type conversions, string utilities, file utilities, 
56         a main loop abstraction, and so on. It works on many UNIX-like platforms, 
57         Windows, OS/2 and BeOS. GLib is released under the GNU Library General 
58         Public License (GNU LGPL).</quote>
59         </para>
60         <para>
61         GLib contains lot's of useful things for platform independant development.
62         See XXX for details about GLib.
63         </para>
64   </section>
65
66 </chapter>
67 <!-- End of EUG Chapter Build Introduction -->