Split node/instance parsing into functions

[ganeti-local] / haddock-prologue

diff --git a/haddock-prologue b/haddock-prologue
index 7216b93..b4bf7f9 100644 (file)
--- a/haddock-prologue
+++ b/haddock-prologue
@@ -1,5 +1,7 @@
-This is the internal documentation for hn1, an experimental N+1
-cluster solver.
+This is the internal documentation for htools, a couple of small tools
+for Ganeti cluster analysis.
 
-Start with the "Main" module, the follow with "Cluster" and then the
-rest.
+The "Ganeti.HTools.Cluster" module is the one holding most high-level
+logic, the "Ganeti.HTools.Node" and "Ganeti.HTools.Instance" modules
+hold the model for nodes and instances respectively, while the
+"Ganeti.HTools.Rapi" contains the RAPI collector.