Commit 55493d52 authored by Anael Beutot's avatar Anael Beutot
Browse files

Updated documentation.

parent 24b17f90
Loading
Loading
Loading
Loading
+11 −11
Original line number Diff line number Diff line
@@ -8,19 +8,18 @@ See ``bin/cc-node``.

Summary of the steps:

Binary:

* First parse command line options and configuration file
* Then register signal handling for ``SIG_USR1`` (reload configuration) and
  ``SIG_TERM`` (terminate process).
* Switch to a daemon context
* Reload logging configuration
* Instanciate and launch a :class:`ccnode.node.Node` in background
* Enter main loop that consist of waiting for signals and reloading configuration
  if needed.
* Instanciate and launch a :class:`ccnode.node.MainLoop`


Organisation of modules/packages
--------------------------------

.. tree ../../ccnode | grep -v \.pyc | grep -v \\.\\.

.. code-block:: text

    |-- config.py
@@ -29,11 +28,16 @@ Organisation of modules/packages
    |   |-- __init__.py
    |   |-- tags.py
    |-- hypervisor
    |   |-- domains
    |   |   |-- __init__.py
    |   |   |-- vm_tags.py
    |   |-- __init__.py
    |   `-- tags.py
    |   |-- lib.py
    |   |-- tags.py
    |-- __init__.py
    |-- jobs.py
    |-- node.py
    |-- plugins.py
    |-- tags.py
    |-- utils.py

@@ -42,10 +46,6 @@ TODO
Node
----

Summary of the :class:`ccnode.node.Node` main loop:

* TODO

.. automodule:: ccnode.node
    :members: