summaryrefslogtreecommitdiffstats
path: root/doc/wsdg_src/wsdg_preface.adoc
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-09-19 04:14:53 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-09-19 04:14:53 +0000
commita86c5f7cae7ec9a3398300555a0b644689d946a1 (patch)
tree39fe4b107c71174fd1e8a8ceb9a4d2aa14116248 /doc/wsdg_src/wsdg_preface.adoc
parentReleasing progress-linux version 4.2.6-1~progress7.99u1. (diff)
downloadwireshark-a86c5f7cae7ec9a3398300555a0b644689d946a1.tar.xz
wireshark-a86c5f7cae7ec9a3398300555a0b644689d946a1.zip
Merging upstream version 4.4.0.
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'doc/wsdg_src/wsdg_preface.adoc')
-rw-r--r--doc/wsdg_src/wsdg_preface.adoc84
1 files changed, 84 insertions, 0 deletions
diff --git a/doc/wsdg_src/wsdg_preface.adoc b/doc/wsdg_src/wsdg_preface.adoc
new file mode 100644
index 00000000..6b20969c
--- /dev/null
+++ b/doc/wsdg_src/wsdg_preface.adoc
@@ -0,0 +1,84 @@
+[#Preface]
+["preface",id="Preface"]
+== 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 Windows developers, as a lot of the tools and methods used when building Wireshark are much more common in the UNIX world than on Windows.
+
+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],
+updated for VS2013 by mailto:{wsdg-author-email2}[Graham Bloice],
+and updated for later versions of Visual Studio by various contributors.
+
+It is written in AsciiDoc.
+
+[#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}.
+
+[#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}[].
+
+