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

======================
 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
Commit	Line	Data
7c673cae FG	1	======================
	2	Library architecture
	3	======================
	4
	5	Ceph is structured into libraries which are built and then combined together to
	6	make executables and other libraries.
	7
	8	- libcommon: a collection of utilities which are available to nearly every ceph
	9	library and executable. In general, libcommon should not contain global
	10	variables, because it is intended to be linked into libraries such as
	11	libcephfs.so.
	12
	13	- libglobal: a collection of utilities focused on the needs of Ceph daemon
	14	programs. In here you will find pidfile management functions, signal
	15	handlers, and so forth.
	16
	17	.. todo:: document other libraries
	18