src/ceph/doc/dev/wireshark.rst

   1 =====================
   2  Wireshark Dissector
   3 =====================
   4
   5 Wireshark has support for the Ceph protocol and it will be shipped in the 1.12.1
   6 release.
   7
   8 Using
   9 =====
  10
  11 To use the Wireshark dissector you must build it from `git`__, the process is
  12 outlined in great detail in the `Building and Installing`__ section of the
  13 `Wireshark Users Guide`__.
  14
  15 __ `Wireshark git`_
  16 __ WSUG_BI_
  17 __ WSUG_
  18
  19 Developing
  20 ==========
  21
  22 The Ceph dissector lives in `Wireshark git`_ at
  23 ``epan/dissectors/packet-ceph.c``.  At the top of that file there are some
  24 comments explaining how to insert new functionality or to update the encoding
  25 of existing types.
  26
  27 Before you start hacking on Wireshark code you should look at the
  28 ``doc/README.developer`` and ``doc/README.dissector`` documents as they explain
  29 the basics of writing dissectors.  After reading those two documents you should
  30 be prepared to work on the Ceph dissector.  `The Wireshark
  31 developers guide`__ also contains a lot of useful information but it is less
  32 directed and is more useful as a reference then an introduction.
  33
  34 __ WSDG_
  35
  36 .. _WSUG: https://www.wireshark.org/docs/wsug_html_chunked/
  37 .. _WSDG: https://www.wireshark.org/docs/wsdg_html_chunked/
  38 .. _WSUG_BI: https://www.wireshark.org/docs/wsug_html_chunked/ChapterBuildInstall.html
  39 .. _Wireshark git: https://www.wireshark.org/develop.html
  40
  41 .. vi: textwidth=80 noexpandtab