docbook/wsdg_src/WSDG_preface.asciidoc

   1 ++++++++++++++++++++++++++++++++++++++
   2 <!-- WSDG Preface -->
   3 ++++++++++++++++++++++++++++++++++++++
   4
   5 [[PreForeword]]
   6
   7 === Foreword
   8
   9 This book tries to give you a guide to start your own experiments into
  10 the wonderful world of Wireshark development.
  11
  12 Developers who are new to Wireshark often have a hard time getting
  13 their development environment up and running. This is
  14 especially true for Win32 developers, as a lot of the tools and methods
  15 used when building Wireshark are much more common in the UNIX world than
  16 on Win32.
  17
  18 The first part of this book will describe how to set up the environment
  19 needed to develop Wireshark.
  20
  21 The second part of this book will describe how to change the Wireshark
  22 source code.
  23
  24 We hope that you find this book useful, and look forward to your comments.
  25
  26 [[PreAudience]]
  27
  28 === Who should read this document?
  29
  30 The intended audience of this book is anyone going into the development of
  31 Wireshark.
  32
  33 This book is not intended to explain the usage of Wireshark in general.
  34 Please refer the
  35 {wireshark-users-guide-url}[Wireshark User's Guide] about Wireshark usage.
  36
  37 By reading this book, you will learn how to develop Wireshark. It will
  38 hopefully guide you around some common problems that frequently appear for
  39 new (and sometimes even advanced) developers of Wireshark.
  40
  41 [[PreAck]]
  42
  43 === Acknowledgements
  44
  45 The authors would like to thank the whole Wireshark team for their
  46 assistance. In particular, the authors would like to thank:
  47
  48 * Gerald Combs, for initiating the Wireshark project.
  49
  50 * Guy Harris, for many helpful hints and his effort in maintaining
  51 the various contributions on the mailing lists.
  52
  53 * Frank Singleton from whose `README.idl2wrs` <<ChDissectIdl2wrs>> is derived.
  54
  55 The authors would also like to thank the following people for their
  56 helpful feedback on this document:
  57
  58 * XXX - Please give feedback :-)
  59
  60 And of course a big thank you to the many, many contributors of the
  61 Wireshark development community!
  62
  63 [[PreAbout]]
  64
  65 === About this document
  66
  67 This book was developed by mailto:{wsdg-author-email}[Ulf Lamping]
  68 and updated for VS2013 by mailto:{wsdg-author-email2}[Graham Bloice]
  69
  70 It is written in AsciiDoc.
  71
  72 You will find some specially marked parts in this book:
  73
  74 [WARNING]
  75 .This is a warning
  76 ====
  77 You should pay attention to a warning, as otherwise data loss might occur.
  78 ====
  79
  80 [NOTE]
  81 .This is a note
  82 ====
  83 A note will point you to common mistakes and things that might not be
  84 obvious.
  85 ====
  86
  87 [TIP]
  88 .This is a tip
  89 ====
  90 Tips will be helpful for your everyday work developing Wireshark.
  91 ====
  92
  93 [[PreDownload]]
  94
  95 === Where to get the latest copy of this document?
  96
  97 The latest copy of this documentation can always be found at:
  98 {wireshark-developers-guide-url} in A4 PDF, US letter PDF, single HTML,
  99 and chunked HTML.
 100
 101 [[PreFeedback]]
 102
 103 === Providing feedback about this document
 104
 105 Should you have any feedback about this document, please send it to the
 106 authors through mailto:{wireshark-dev-list-email}[].
 107
 108