summaryrefslogtreecommitdiff
path: root/docbook/wsdg_src/WSDG_preface.asciidoc
blob: 21cec677361d491b74c58f0eceefdb5b7f38b243 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
++++++++++++++++++++++++++++++++++++++
<!-- WSDG Preface -->
++++++++++++++++++++++++++++++++++++++

[[PreForeword]]

=== Foreword

This book tries to give you a guide to start your own experiments into
the wonderful world of Wireshark development.

Developers who are new to Wireshark often have a hard time getting
their development environment up and running. This is
especially true for Win32 developers, as a lot of the tools and methods
used when building Wireshark are much more common in the UNIX world than
on Win32.

The first part of this book will describe how to set up the environment
needed to develop Wireshark.

The second part of this book will describe how to change the Wireshark
source code.

We hope that you find this book useful, and look forward to your comments.

[[PreAudience]]

=== Who should read this document?

The intended audience of this book is anyone going into the development of
Wireshark.

This book is not intended to explain the usage of Wireshark in general.
Please refer the
{wireshark-users-guide-url}[Wireshark User's Guide] about Wireshark usage.

By reading this book, you will learn how to develop Wireshark. It will
hopefully guide you around some common problems that frequently appear for
new (and sometimes even advanced) developers of Wireshark.

[[PreAck]]

=== Acknowledgements

The authors would like to thank the whole Wireshark team for their
assistance. In particular, the authors would like to thank:

* Gerald Combs, for initiating the Wireshark project.

* Guy Harris, for many helpful hints and his effort in maintaining
the various contributions on the mailing lists.

* Frank Singleton from whose `README.idl2wrs` <<ChDissectIdl2wrs>> is derived.

The authors would also like to thank the following people for their
helpful feedback on this document:

* XXX - Please give feedback :-)

And of course a big thank you to the many, many contributors of the
Wireshark development community!

[[PreAbout]]

=== About this document

This book was developed by mailto:{wsdg-author-email}[Ulf Lamping]
and updated for VS2013 by mailto:{wsdg-author-email2}[Graham Bloice]

It is written in AsciiDoc.

You will find some specially marked parts in this book:

[WARNING]
.This is a warning
====
You should pay attention to a warning, as otherwise data loss might occur.
====

[NOTE]
.This is a note
====
A note will point you to common mistakes and things that might not be
obvious.
====

[TIP]
.This is a tip
====
Tips will be helpful for your everyday work developing Wireshark.
====

[[PreDownload]]

=== Where to get the latest copy of this document?

The latest copy of this documentation can always be found at:
{wireshark-developers-guide-url} in A4 PDF, US letter PDF, single HTML,
and chunked HTML.

[[PreFeedback]]

=== Providing feedback about this document

Should you have any feedback about this document, please send it to the
authors through mailto:{wireshark-dev-list-email}[].