]> git-server-git.apps.pok.os.sepia.ceph.com Git - ceph.git/commitdiff
doc/dev/crimson: add links to seastar documents
authorKefu Chai <kchai@redhat.com>
Thu, 24 Sep 2020 16:37:16 +0000 (00:37 +0800)
committerKefu Chai <kchai@redhat.com>
Tue, 6 Oct 2020 09:59:11 +0000 (17:59 +0800)
Signed-off-by: Kefu Chai <kchai@redhat.com>
doc/dev/crimson.rst

index 2412a7b9d8f7970317cbc06f7580c90b38bdfa5e..954b88a374c473ea837c179dfa41343c5c577aec 100644 (file)
@@ -179,6 +179,22 @@ corresponding test results are highlighted.
 
 .. _cbt: https://github.com/ceph/cbt
 
+Hacking Crimson
+===============
+
+
+Seastar Documents
+-----------------
+
+See `Seastar Tutorial <https://github.com/scylladb/seastar/blob/master/doc/tutorial.md>`_ .
+Or build a browsable version and start an HTTP server::
+
+  $ cd seastar
+  $ ./configure.py --mode debug
+  $ ninja -C build/debug docs
+  $ python3 -m http.server -d build/debug/doc/html
+
+You might want to install ``pandoc`` and other dependencies beforehand.
 
 Debugging Crimson
 =================