From: John Wilkins Date: Mon, 18 Aug 2014 21:28:38 +0000 (-0700) Subject: doc: Move wireshark documentation to dev. X-Git-Tag: v0.85~16 X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=acee2e5833842b0008762b338873dd51bcb7ef09;p=ceph.git doc: Move wireshark documentation to dev. Signed-off-by: John Wilkins --- diff --git a/doc/dev/wireshark.rst b/doc/dev/wireshark.rst new file mode 100644 index 00000000000..e03b3621caa --- /dev/null +++ b/doc/dev/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 diff --git a/doc/wireshark.rst b/doc/wireshark.rst deleted file mode 100644 index e03b3621caa..00000000000 --- a/doc/wireshark.rst +++ /dev/null @@ -1,41 +0,0 @@ -===================== - 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