Commit 18049dad authored by Iustin Pop's avatar Iustin Pop

Cleanup haddock documentation a bit

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: default avatarIustin Pop <iustin@google.com>
Reviewed-by: default avatarMichael Hanselmann <hansmi@google.com>
parent 4cd79ca8
......@@ -1596,7 +1596,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 \
......
{-# 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
......
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.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment