From d708ea6792216b2103fa4fdc1aa810de637fdc44 Mon Sep 17 00:00:00 2001
From: adobdin <dobdin@gmail.com>
Date: Fri, 15 Apr 2016 05:41:34 +0000
Subject: [PATCH] fix: docs

---
 doc/source/.specification.rst.swp | Bin 0 -> 12288 bytes
 doc/source/conf.py                |   4 ++--
 doc/source/configuration.rst      |  13 ++++++++++++-
 doc/source/index.rst              |   4 ++--
 doc/source/specification.rst      |   5 ++++-
 doc/source/usage.rst              |  19 ++++++-------------
 setup.py                          |   2 +-
 sphinx-build.sh                   |   1 +
 8 files changed, 28 insertions(+), 20 deletions(-)
 create mode 100644 doc/source/.specification.rst.swp

diff --git a/doc/source/.specification.rst.swp b/doc/source/.specification.rst.swp
new file mode 100644
index 0000000000000000000000000000000000000000..77d3dee05943022b15f685cdd6ff20aa34677f0e
GIT binary patch
literal 12288
zcmeI2&5j#I5P&<JIFJy*l|w-e4kORZ5(2xj010xzhiD@$KNpbFp02T5?&%u3d)DiO
zBodFntMCLo1!p+&1RSZJah8Zf_P{BqS}OPa)bCeyvE8eqZ<hDrxVo!&-BjwQr#HX-
z?c|19E|rSf<2FCPVrfGwV|{tvy<G9>=&)XGOP$J=f~j|PvR$_?{kk^P)RBhJU>$pG
zY-<~xEcq(L^m4cIRtN}zs|XCKEl;ki5AS?%lvQuN_b$Bs*4I~A$$KFn1cZPP5CTF#
z2nYcoAO!wL1X6!ZJ>z;_JJiHK0gUU~zxKneY(hW?2mv7=1cZPP5CTF#2nYcoAOwWK
zD@Z^aPWla{zGKP%|3Cl!|JR#J{mJqN%kL~dvmCR$&hpC*r5>}KURUZJmS5TS3CoWx
z-?NOqUO^U;vJemgLO=)z0U;m+gn$qb0{?-)7rNO(B3SU@-o?YEH+TV`)Hd&*J*<=}
zAX0~*L$k5x82JKWh1Rd338)hqD4|%R$Dm!6bf{L3?i8TCfx^)`mPJvpkNac>r^5nz
ziqWnd=8%&E&@dh*)((2kMX&kYMki><CvANM@@_vR5%7n>1`gR!*KvqgvFk4fzAQNx
zqqAQ=v)r*Y4XGb^Yhl(7=)jXfa5knHo7_8?!|gUu2UXp4CW2wtO`@=We=IU$uftg2
zY7c=N*M8ezViit64~aMopMQ3a^;sir5aPab)^B44XEZ)I<T(b0PVd2BkBo*q1azn)
z&JV6Lu+y`7wqn5AMaH8&lfJBVq7nuVc#dJe%Ze3zo;43fZ1^0^q?~(&7uXCr<znQ>
zk;&tTqsVF76rsq~6?14UpW_Df4GliAca!lxU<l4JL8k}bZ01ut*i9}tQ;q+`nsEs0
zahC1wP1#RY9NrUmBX{y(+UdwKMh|na?da}>XR`>)2Vmng8?Bv^IqiAO5{LBUOAejF
z&?Fv9x36+jd&m9B!=hWvIh<{1a0Yf1wp<*SeTdzXbF|AdjQ-pP@*R5SFpk|W^XCwZ
zYyo$xi#dFhKR(VM$JNmsPO2kz{ndtZOGGZ`xZ*~RP2Hr_$3<OZ?ntjqMcnR~c&sZ5
d>$<Nm?@MF#+Ee5aib{PtEp_(dsrt*Oe*@E~a$Eoa

literal 0
HcmV?d00001

diff --git a/doc/source/conf.py b/doc/source/conf.py
index 0773e3e..2e3cad3 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -269,8 +269,8 @@ man_pages = [
 #  dir menu entry, description, category)
 texinfo_documents = [
   (master_doc, 'timmy', u'timmy Documentation',
-   author, 'timmy', 'One line description of project.',
-   'Miscellaneous'),
+   author, 'timmy', 'Small tool for MOS',
+   ''),
 ]
 
 # Documents to append as an appendix to all manuals.
diff --git a/doc/source/configuration.rst b/doc/source/configuration.rst
index 1a50982..7f40486 100644
--- a/doc/source/configuration.rst
+++ b/doc/source/configuration.rst
@@ -2,7 +2,7 @@
 Configuration
 =============
 
-There is default configuration file ``config.yaml``, which is used by the scripts by default.
+There is default configuration file ``config.yaml``, which can be used by the scripts.
 If you wish to keep several configuration files, that is possible - just copy it and explicitly provide the name of it once you launch a script (``--config`` option).
 
 Here is the description of available parameters in configuration file:
@@ -16,5 +16,16 @@ Here is the description of available parameters in configuration file:
 * **rqdir** the path of *rqdir*, the directory containing info about commands to execute and logs to gather
 * **out-dir** directory to store output data
 * **timeout** timeout for SSH commands in seconds
+* **archives** directory to store the generated archives
+* **log_files** path and filters for log files
+
+Nodes which are stored in fuel database can be filtered by the following parameters:
+ * roles,
+ * online
+ * status the list of statuses ex. ['ready', 'discover']
+ * **node_ids** the list of ids, ex. [0,5,6]
+
+* **hard_filter** hard filter for nodes
+* **soft_filter** soft filters for nodes
 
 Once you are done with the configuration, you might want to familiarize yourself with :doc:`Usage </usage>`.
diff --git a/doc/source/index.rst b/doc/source/index.rst
index 70b92c3..bf66522 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -11,6 +11,7 @@ Contents:
 .. toctree::
    :maxdepth: 2
 
+   specification
    configuration
    usage
 
@@ -21,5 +22,4 @@ Indices and tables
 ..
   * :ref:`genindex`
   * :ref:`modindex`
-* :ref:`search`
-
+  * :ref:`search`
diff --git a/doc/source/specification.rst b/doc/source/specification.rst
index 9b0cffc..19bcaa3 100644
--- a/doc/source/specification.rst
+++ b/doc/source/specification.rst
@@ -10,4 +10,7 @@ Specification
 * Commands (from ./cmds directory) are separated by roles (detected automatically) by the symlinks. So the command list may depend on release, roles and OS, there also can be commands that run everywhere. Also there are commands that are executed *only on one node* by its *role*, first encountered.
 * Human-readable format output of 'fuel node list'
 * Modular: possible to create a special package that contains only some required commands.
-* some archives are being created - *general* and *logs-**
+* some archives are being created - *general.tar.bz2* and *logs-***
+
+Back to :doc:`Index </index>`.
+
diff --git a/doc/source/usage.rst b/doc/source/usage.rst
index 725fc03..881eb32 100644
--- a/doc/source/usage.rst
+++ b/doc/source/usage.rst
@@ -2,27 +2,20 @@
 Usage
 =====
 
-The easiest way to launch timmy would be running the ``launch.sh`` script.
+The easiest way to launch timmy would be running the ``timmy.py`` script.
 However, you need to :doc:`configure </configuration>` it first.
 
-Basically, the ``launch.sh`` is a simple wrapper that launches ``cmds.py`` and ``getlogs.py``.
-The first script launches commands on remote hosts and records outputs, and the second one gathers some logs.
+Basically, the ``timmy.py`` is a simple wrapper that launches ``cli.py``.
 
-The ``cmds.py`` script accepts the following parameters:
+The script accepts the following parameters:
 
 * ``--config`` the configuration file location, default is *config.yaml*
-* ``-o``, ``--dest-file`` the location for output archives, default is */tmp*
+* ``-o``, ``--dest-file`` the location for output archives, default is */tmp/archives/general.tar.bz2*
 * ``-e``, ``--extended`` execute commands once by roles
 * ``-c``, ``--cluster`` ability to provide the cluster ID
 * ``-d``, ``--debug`` debugging mode, return more debugging info
 * ``-v``, ``--verbose`` verbose mode
-
-The ``getlogs.py`` script accepts the following parameters:
-
-* ``-a``, ``--dest-file`` the location for output archives, default is */tmp*
-* ``-l``, ``--log-dir`` directory for storing logs, default is *./logs/*
-* ``-c``, ``--cluster`` ability to provide the cluster ID
-* ``-d``, ``--debug`` debugging mode, return more debugging info
-* ``-v``, ``--verbose`` verbose mode
+* ``--only-logs`` collect only logs from nodes (without commands)
+* ``-l``, ``--logs`` collect log files from nodes
 
 Back to :doc:`Index </index>`.
diff --git a/setup.py b/setup.py
index 278d95c..9adcb58 100644
--- a/setup.py
+++ b/setup.py
@@ -13,7 +13,7 @@ setup(name='timmy',
       author_email = 'dobdin@gmail.com',
       license = 'Apache2',
       url = 'https://github.com/adobdin/timmy',
-      #  long_description=read('README'),
+      long_description=read('README.md'),
       packages = ["timmy"],
       data_files = rqfiles,
       include_package_data = True,
diff --git a/sphinx-build.sh b/sphinx-build.sh
index 28438c4..46073ad 100755
--- a/sphinx-build.sh
+++ b/sphinx-build.sh
@@ -18,3 +18,4 @@
 
 sphinx-build -b html doc/source/ doc/build/
 rm -f "./*.pyc"
+rm -f "./timmy/*.pyc"