Merge pull request ceph#37395 from tchaikov/wip-doc-crimson

doc/dev/crimson: add instruction on running install-deps.sh for build… Reviewed-by: Radoslaw Zarzynski <rzarzyns@redhat.com>
zalsader · Oct 6, 2020 · 37e7425 · 37e7425
2 parents 67efea0 + 16ae762
commit 37e7425
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 1 deletion.
diff --git a/doc/dev/crimson.rst b/doc/dev/crimson.rst
@@ -15,6 +15,7 @@ Building Crimson
 
 Crismon is not enabled by default. To enable it::
 
+  $ WITH_SEASTAR=true ./install-deps.sh
   $ mkdir build && cd build
   $ cmake -DWITH_SEASTAR=ON ..
 
@@ -178,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
 =================

diff --git a/src/seastar b/src/seastar
+3 −3		CMakeLists.txt
+6 −6		README.md
+2 −2		configure.py
+10 −14		doc/CMakeLists.txt
+1 −1		doc/Doxyfile.in
+1 −0		doc/compatibility.md
+130 −54		doc/htmlsplit.py
+1 −1		doc/md2html
+10 −3		doc/tutorial.md
+41 −41		include/seastar/core/chunked_fifo.hh
+21 −3		include/seastar/core/circular_buffer.hh
+4 −4		include/seastar/core/coroutine.hh
+9 −9		include/seastar/core/expiring_fifo.hh
+141 −94		include/seastar/core/future.hh
+11 −0		include/seastar/core/internal/api-level.hh
+5 −0		include/seastar/core/io_queue.hh
+7 −0		include/seastar/core/on_internal_error.hh
+0 −1		include/seastar/core/reactor.hh
+7 −1		include/seastar/core/scheduling.hh
+1 −1		include/seastar/core/seastar.hh
+21 −1		include/seastar/core/semaphore.hh
+21 −18		include/seastar/core/shared_future.hh
+2 −0		include/seastar/core/shared_ptr.hh
+42 −0		include/seastar/net/tls.hh
+7 −3		include/seastar/rpc/rpc_impl.hh
+173 −0		scripts/io-trace-parse.py
+7 −0		src/core/io_queue.cc
+11 −1		src/core/memory.cc
+7 −0		src/core/on_internal_error.cc
+1 −0		src/core/reactor.cc
+0 −2		src/core/reactor_backend.cc
+3 −1		src/core/resource.cc
+1 −0		src/net/posix-stack.cc
+70 −0		src/net/tls.cc
+74 −44		src/rpc/lz4_fragmented_compressor.cc
+4 −4		src/util/log.cc
+1 −1		tests/unit/coroutines_test.cc
+9 −1		tests/unit/futures_test.cc
+67 −41		tests/unit/rpc_test.cc
+20 −0		tests/unit/semaphore_test.cc
+27 −1		tests/unit/tls_test.cc