From: Kevin Cox <kevincox@kevincox.ca>
Date: Thu, 14 Aug 2014 20:42:56 +0000 (-0400)
Subject: doc: Add documentation about Wireshark dissector.
X-Git-Tag: v0.85~40^2
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=46d8c97e72587967e4eb3f672ed71fe541fc82fd;p=ceph.git

doc: Add documentation about Wireshark dissector.

Signed-Off-By: Kevin Cox <kevincox@kevincox.ca>
---

diff --git a/doc/index.rst b/doc/index.rst
index 565f481f06cd..5c5a50b88fe8 100644
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -103,3 +103,4 @@ about Ceph, see our `Architecture`_ section.
    Development <dev/index>
    release-notes
    Glossary <glossary>
+   wireshark
diff --git a/doc/wireshark.rst b/doc/wireshark.rst
new file mode 100644
index 000000000000..e03b3621caaf
--- /dev/null
+++ b/doc/wireshark.rst
@@ -0,0 +1,41 @@
+=====================
+ Wireshark Dissector
+=====================
+
+Wireshark has support for the Ceph protocol and it will be shipped in the 1.12.1
+release.
+
+Using
+=====
+
+To use the Wireshark dissector you must build it from `git`__, the process is
+outlined in great detail in the `Building and Installing`__ section of the
+`Wireshark Users Guide`__.
+
+__ `Wireshark git`_
+__ WSUG_BI_
+__ WSUG_
+
+Developing
+==========
+
+The Ceph dissector lives in `Wireshark git`_ at
+``epan/dissectors/packet-ceph.c``.  At the top of that file there are some
+comments explaining how to insert new functionality or to update the encoding
+of existing types.
+
+Before you start hacking on Wireshark code you should look at the
+``doc/README.developer`` and ``doc/README.dissector`` documents as they explain
+the basics of writing dissectors.  After reading those two documents you should
+be prepared to work on the Ceph dissector.  `The Wireshark
+developers guide`__ also contains a lot of useful information but it is less
+directed and is more useful as a reference then an introduction.
+
+__ WSDG_
+
+.. _WSUG: https://www.wireshark.org/docs/wsug_html_chunked/
+.. _WSDG: https://www.wireshark.org/docs/wsdg_html_chunked/
+.. _WSUG_BI: https://www.wireshark.org/docs/wsug_html_chunked/ChapterBuildInstall.html
+.. _Wireshark git: https://www.wireshark.org/develop.html
+
+.. vi: textwidth=80 noexpandtab