initial code repo

[stor4nfv.git] / src / ceph / doc / dev / libs.rst

diff --git a/src/ceph/doc/dev/libs.rst b/src/ceph/doc/dev/libs.rst
new file mode 100644 (file)
index 0000000..203dd38
--- /dev/null
+++ b/src/ceph/doc/dev/libs.rst
@@ -0,0 +1,18 @@
+======================
+ Library architecture
+======================
+
+Ceph is structured into libraries which are built and then combined together to
+make executables and other libraries.
+
+- libcommon: a collection of utilities which are available to nearly every ceph
+  library and executable. In general, libcommon should not contain global
+  variables, because it is intended to be linked into libraries such as
+  libcephfs.so.
+
+- libglobal: a collection of utilities focused on the needs of Ceph daemon
+  programs. In here you will find pidfile management functions, signal
+  handlers, and so forth.
+
+.. todo:: document other libraries
+