While grepping for htools imports in the non-htools subdirectory, I saw that our haddock prologue and title are very very old and refer to the old htools-only state. Let's cleanup a bit…
Signed-off-by: Iustin Pop <[email protected]> --- Makefile.am | 2 +- htools/Ganeti/THH.hs | 2 +- htools/haddock-prologue | 10 ++++------ 3 files changed, 6 insertions(+), 8 deletions(-) diff --git a/Makefile.am b/Makefile.am index 89b4e6d..35c5f9e 100644 --- a/Makefile.am +++ b/Makefile.am @@ -1602,7 +1602,7 @@ hs-apidoc: $(HS_BUILT_SRCS) $(HSCOLOUR) -css -anchor $$file > ../$(APIDOC_HS_DIR)/$$hfile ; \ done ; \ $(HADDOCK) --odir ../$(APIDOC_HS_DIR) --html --ignore-all-exports -w \ - -t ganeti-htools -p haddock-prologue \ + -t ganeti -p haddock-prologue \ --source-module="%{MODULE/.//}.html" \ --source-entity="%{MODULE/.//}.html#%{NAME}" \ $$OPTGHC \ diff --git a/htools/Ganeti/THH.hs b/htools/Ganeti/THH.hs index 95d93fe..9bdde6f 100644 --- a/htools/Ganeti/THH.hs +++ b/htools/Ganeti/THH.hs @@ -1,6 +1,6 @@ {-# LANGUAGE TemplateHaskell #-} -{-| TemplateHaskell helper for HTools. +{-| TemplateHaskell helper for Ganeti Haskell code. As TemplateHaskell require that splices be defined in a separate module, we combine all the TemplateHaskell functionality that HTools diff --git a/htools/haddock-prologue b/htools/haddock-prologue index 5e156d8..a301e8f 100644 --- a/htools/haddock-prologue +++ b/htools/haddock-prologue @@ -1,7 +1,5 @@ -This is the internal documentation for ganeti-htools, a couple of -small tools for Ganeti cluster analysis. +This is the internal documentation for the Haskell components of Ganeti. -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. +The @Ganeti.HTools@ subtree contain the htools-specific component +(rebalancing, allocation, capacity), while the @Ganeti@ tree contains +basic functionality and core components. -- 1.7.10.4
