summaryrefslogtreecommitdiffstats
path: root/doc/client/index.txt
diff options
context:
space:
mode:
authorSol Jerome <solj@ices.utexas.edu>2010-04-10 16:20:14 -0500
committerSol Jerome <solj@ices.utexas.edu>2010-04-10 16:20:14 -0500
commit1999c74bba44c20c37c70d93245e02305a44652a (patch)
treecfd461689888753990d0e3f48c673663f42f3ddd /doc/client/index.txt
parentb5a201ea431cc3cf33c77364bb0bbf33716401bd (diff)
downloadbcfg2-1999c74bba44c20c37c70d93245e02305a44652a.tar.gz
bcfg2-1999c74bba44c20c37c70d93245e02305a44652a.tar.bz2
bcfg2-1999c74bba44c20c37c70d93245e02305a44652a.zip
doc: Style consistency updates
Signed-off-by: Sol Jerome <solj@ices.utexas.edu>
Diffstat (limited to 'doc/client/index.txt')
-rw-r--r--doc/client/index.txt27
1 files changed, 17 insertions, 10 deletions
diff --git a/doc/client/index.txt b/doc/client/index.txt
index 536bedfbb..5e6551387 100644
--- a/doc/client/index.txt
+++ b/doc/client/index.txt
@@ -5,10 +5,11 @@
The Bcfg2 Client
================
-The Bcfg2 client is responsible for determining what reconfiguration
-operations must be undertaken on the client, but does not perform
-any processing of the target configuration description. We chose this
-architecture, as opposed to one with a smarter client, for a few reasons:
+The Bcfg2 client attempts to reconcile the current configuration state
+with the configuration passed down from the server using various client
+tools. It does not perform any processing of the target configuration
+description. We chose this architecture, as opposed to one with a smarter
+client, for a few reasons:
* Client failure forces administrators to perform an O(n) reconfiguration
operation. Simpler code is easier to debug and maintain.
@@ -22,16 +23,22 @@ architecture, as opposed to one with a smarter client, for a few reasons:
deployment engine that can be driven by anything that writes a
compatible configuration description.
+Available client tools
+----------------------
+
.. toctree::
:maxdepth: 2
+ :glob:
- agent
- debugging
- metadata
- modes
+ tools/*
+
+Other client-related documentation
+----------------------------------
.. toctree::
:maxdepth: 2
- :glob:
- tools/*
+ agent
+ debugging
+ metadata
+ modes