From 5a19bd35ae1dd19b0bdf2a4df9d1261c18797d85 Mon Sep 17 00:00:00 2001
From: Iustin Pop <iustin@google.com>
Date: Thu, 17 Mar 2011 18:06:03 +0100
Subject: [PATCH] Integrate htools man pages in the main tree
This moves the man pages to their right place, removes the static
footer and header, and adds Makefile rules for the new .1 man pages.
Signed-off-by: Iustin Pop <iustin@google.com>
Reviewed-by: Michael Hanselmann <hansmi@google.com>
---
Makefile.am | 15 +++++++++++----
man/footer.rst | 14 +++++++++-----
{htools/man => man}/hail.rst | 21 ++-------------------
{htools/man => man}/hbal.rst | 21 ++-------------------
{htools/man => man}/hscan.rst | 21 ++-------------------
{htools/man => man}/hspace.rst | 21 ++-------------------
6 files changed, 28 insertions(+), 85 deletions(-)
rename {htools/man => man}/hail.rst (83%)
rename {htools/man => man}/hbal.rst (97%)
rename {htools/man => man}/hscan.rst (81%)
rename {htools/man => man}/hspace.rst (95%)
diff --git a/Makefile.am b/Makefile.am
index 81c1dfba5..0fbad8a1f 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -447,13 +447,17 @@ man_MANS = \
man/gnt-instance.8 \
man/gnt-job.8 \
man/gnt-node.8 \
- man/gnt-os.8
+ man/gnt-os.8 \
+ man/hail.1 \
+ man/hbal.1 \
+ man/hscan.1 \
+ man/hspace.1
-manrst = $(patsubst %.7,%.rst,$(patsubst %.8,%.rst,$(man_MANS)))
+manrst = $(patsubst %.1,%.rst,$(patsubst %.7,%.rst,$(patsubst %.8,%.rst,$(man_MANS))))
manhtml = $(patsubst %.rst,%.html,$(manrst))
mangen = $(patsubst %.rst,%.gen,$(manrst))
maninput = \
- $(patsubst %.7,%.7.in,$(patsubst %.8,%.8.in,$(man_MANS))) \
+ $(patsubst %.1,%.1.in,$(patsubst %.7,%.7.in,$(patsubst %.8,%.8.in,$(man_MANS)))) \
$(patsubst %.html,%.html.in,$(manhtml)) \
man/footer.man man/footer.html $(mangen)
@@ -635,7 +639,7 @@ man/footer.html: man/footer.rst
man/%.gen: man/%.rst lib/query.py lib/build/sphinx_ext.py
PYTHONPATH=. $(RUN_IN_TEMPDIR) $(CURDIR)/$(DOCPP) < $< > $@
-man/%.7.in man/%.8.in: man/%.gen man/footer.man
+man/%.7.in man/%.8.in man/%.1.in: man/%.gen man/footer.man
@test -n "$(PANDOC)" || \
{ echo 'pandoc' not found during configure; exit 1; }
set -o pipefail ; \
@@ -650,6 +654,9 @@ man/%.html.in: man/%.gen man/footer.html
$(PANDOC) -s -f rst -t html -A man/footer.html $< | \
sed -e 's/\\@/@/g' > $@
+man/%.1: man/%.1.in $(REPLACE_VARS_SED)
+ sed -f $(REPLACE_VARS_SED) < $< > $@
+
man/%.7: man/%.7.in $(REPLACE_VARS_SED)
sed -f $(REPLACE_VARS_SED) < $< > $@
diff --git a/man/footer.rst b/man/footer.rst
index 5dbde27d2..98e639738 100644
--- a/man/footer.rst
+++ b/man/footer.rst
@@ -23,14 +23,18 @@ Ganeti daemons: **ganeti-watcher**(8) (automatic instance restarter),
daemon), **ganeti-masterd**(8) (master daemon), **ganeti-rapi**(8)
(remote API daemon).
+Ganeti htools: **hbal**(1) (cluster balancer), **hspace**(1) (capacity
+calculation), **hail**(1) (IAllocator plugin), **hscan**(1) (data
+gatherer from remote clusters).
+
COPYRIGHT
---------
-Copyright (C) 2006, 2007, 2008, 2009, 2010 Google Inc. Permission
-is granted to copy, distribute and/or modify under the terms of the
-GNU General Public License as published by the Free Software
-Foundation; either version 2 of the License, or (at your option)
-any later version.
+Copyright (C) 2006, 2007, 2008, 2009, 2010, 2011 Google
+Inc. Permission is granted to copy, distribute and/or modify under the
+terms of the GNU General Public License as published by the Free
+Software Foundation; either version 2 of the License, or (at your
+option) any later version.
On Debian systems, the complete text of the GNU General Public
License can be found in /usr/share/common-licenses/GPL.
diff --git a/htools/man/hail.rst b/man/hail.rst
similarity index 83%
rename from htools/man/hail.rst
rename to man/hail.rst
index 22c228a35..e5a5156f0 100644
--- a/htools/man/hail.rst
+++ b/man/hail.rst
@@ -1,5 +1,5 @@
-HAIL(1) htools | Ganeti H-tools
-===============================
+HAIL(1) Ganeti | Version @GANETI_VERSION@
+=========================================
NAME
----
@@ -93,20 +93,3 @@ EXIT STATUS
The exist status of the command will be zero, unless for some reason
the algorithm fatally failed (e.g. wrong node or instance data).
-
-SEE ALSO
---------
-
-**hbal**(1), **hspace**(1), **hscan**(1), **ganeti**(7),
-**gnt-instance**(8), **gnt-node**(8)
-
-COPYRIGHT
----------
-
-Copyright (C) 2009, 2010, 2011 Google Inc. Permission is granted to
-copy, distribute and/or modify under the terms of the GNU General
-Public License as published by the Free Software Foundation; either
-version 2 of the License, or (at your option) any later version.
-
-On Debian systems, the complete text of the GNU General Public License
-can be found in /usr/share/common-licenses/GPL.
diff --git a/htools/man/hbal.rst b/man/hbal.rst
similarity index 97%
rename from htools/man/hbal.rst
rename to man/hbal.rst
index a63ab902d..edff5dfc5 100644
--- a/htools/man/hbal.rst
+++ b/man/hbal.rst
@@ -1,5 +1,5 @@
-HBAL(1) htools | Ganeti H-tools
-===============================
+HBAL(1) Ganeti | Version @GANETI_VERSION@
+=========================================
NAME
----
@@ -647,20 +647,3 @@ e.g. in step 8, both the migrate and the replace-disks are
done. Otherwise, if only the migrate is done, the input data is
changed in a way that the program will output a different solution
list (but hopefully will end in the same state).
-
-SEE ALSO
---------
-
-**hspace**(1), **hscan**(1), **hail**(1), **ganeti**(7),
-**gnt-instance**(8), **gnt-node**(8)
-
-COPYRIGHT
----------
-
-Copyright (C) 2009, 2010, 2011 Google Inc. Permission is granted to
-copy, distribute and/or modify under the terms of the GNU General
-Public License as published by the Free Software Foundation; either
-version 2 of the License, or (at your option) any later version.
-
-On Debian systems, the complete text of the GNU General Public License
-can be found in /usr/share/common-licenses/GPL.
diff --git a/htools/man/hscan.rst b/man/hscan.rst
similarity index 81%
rename from htools/man/hscan.rst
rename to man/hscan.rst
index 497c96cf7..f5b78650e 100644
--- a/htools/man/hscan.rst
+++ b/man/hscan.rst
@@ -1,5 +1,5 @@
-HSCAN(1) htools | Ganeti H-tools
-================================
+HSCAN(1) Ganeti | Version @GANETI_VERSION@
+==========================================
NAME
----
@@ -107,20 +107,3 @@ EXAMPLE
cluster1 2 2 0 0 1008 652 255 253 0.24404762
$ ls -l cluster1.data
-rw-r--r-- 1 root root 364 2009-03-23 07:26 cluster1.data
-
-SEE ALSO
---------
-
-**hbal**(1), **hspace**(1), **hail**(1), **ganeti**(7),
-**gnt-instance**(8), **gnt-node**(8)
-
-COPYRIGHT
----------
-
-Copyright (C) 2009, 2010, 2011 Google Inc. Permission is granted to
-copy, distribute and/or modify under the terms of the GNU General
-Public License as published by the Free Software Foundation; either
-version 2 of the License, or (at your option) any later version.
-
-On Debian systems, the complete text of the GNU General Public License
-can be found in /usr/share/common-licenses/GPL.
diff --git a/htools/man/hspace.rst b/man/hspace.rst
similarity index 95%
rename from htools/man/hspace.rst
rename to man/hspace.rst
index 08095b557..386b4ad67 100644
--- a/htools/man/hspace.rst
+++ b/man/hspace.rst
@@ -1,5 +1,5 @@
-HSPACE(1) htools | Ganeti H-tools
-=================================
+HSPACE(1) Ganeti | Version @GANETI_VERSION@
+===========================================
NAME
----
@@ -401,20 +401,3 @@ really big clusters.
The algorithm doesn't rebalance the cluster or try to get the optimal
fit; it just allocates in the best place for the current step, without
taking into consideration the impact on future placements.
-
-SEE ALSO
---------
-
-**hbal**(1), **hscan**(1), **hail**(1), **ganeti**(7),
-**gnt-instance**(8), **gnt-node**(8)
-
-COPYRIGHT
----------
-
-Copyright (C) 2009, 2010, 2011 Google Inc. Permission is granted to
-copy, distribute and/or modify under the terms of the GNU General
-Public License as published by the Free Software Foundation; either
-version 2 of the License, or (at your option) any later version.
-
-On Debian systems, the complete text of the GNU General Public License
-can be found in /usr/share/common-licenses/GPL.
--
GitLab