From fd07c6b3c58032a2e795940de2e5cf53318ee0cf Mon Sep 17 00:00:00 2001
From: Iustin Pop <iustin@google.com>
Date: Sat, 9 May 2009 23:18:08 +0200
Subject: [PATCH] Some small doc updates
We change some formatting to sphinx-specific, to show how the
documentation can be improved.
Signed-off-by: Iustin Pop <iustin@google.com>
Reviewed-by: Guido Trotter <ultrotter@google.com>
---
doc/admin.rst | 13 +++++++------
doc/design-2.0.rst | 4 ++--
doc/iallocator.rst | 2 +-
doc/install.rst | 4 ++--
4 files changed, 12 insertions(+), 11 deletions(-)
diff --git a/doc/admin.rst b/doc/admin.rst
index 56a397263..f44aef2ef 100644
--- a/doc/admin.rst
+++ b/doc/admin.rst
@@ -1,7 +1,7 @@
Ganeti administrator's guide
============================
-Documents Ganeti version 2.0
+Documents Ganeti version |version|
.. contents::
@@ -173,8 +173,8 @@ Importing an instance is similar to creating a new one. The command is::
gnt-backup import -n TARGET_NODE -t DISK_TEMPLATE \
--src-node=NODE --src-dir=DIR INSTANCE_NAME
-Most of the options available for the command *gnt-instance add* are
-supported here too.
+Most of the options available for the command :command:`gnt-instance
+add` are supported here too.
High availability features
--------------------------
@@ -262,6 +262,7 @@ you can deactivate them with the deactivate-disks command, which works
in the same way.
Accessing an instance's console
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The command to access a running instance's console is::
@@ -281,8 +282,8 @@ command to ran to see a complete status for all your nodes is::
Cluster-wide debugging
~~~~~~~~~~~~~~~~~~~~~~
-The *gnt-cluster* command offers several options to run tests or
-execute cluster-wide operations. For example::
+The :command:`gnt-cluster` command offers several options to run tests
+or execute cluster-wide operations. For example::
gnt-cluster command
gnt-cluster copyfile
@@ -291,4 +292,4 @@ execute cluster-wide operations. For example::
gnt-cluster getmaster
gnt-cluster version
-See the man page *gnt-cluster* to know more about their usage.
+See the man page :manpage:`gnt-cluster` to know more about their usage.
diff --git a/doc/design-2.0.rst b/doc/design-2.0.rst
index 9d25f748c..73cfa6424 100644
--- a/doc/design-2.0.rst
+++ b/doc/design-2.0.rst
@@ -1558,8 +1558,8 @@ DEBUG_LEVEL
These are only the basic variables we are thinking of now, but more
may come during the implementation and they will be documented in the
-``ganeti-os-api`` man page. All these variables will be available to
-all scripts.
+:manpage:`ganeti-os-api` man page. All these variables will be
+available to all scripts.
Some scripts will need a few more information to work. These will have
per-script variables, such as for example:
diff --git a/doc/iallocator.rst b/doc/iallocator.rst
index f4b8bfcf8..58719a0b8 100644
--- a/doc/iallocator.rst
+++ b/doc/iallocator.rst
@@ -223,7 +223,7 @@ nodes
No allocations should be made on nodes having either the ``drained``
or ``offline`` flags set. More details about these of node status
- flags is available in the manpage *ganeti(7)*.
+ flags is available in the manpage :manpage:`ganeti(7)`.
Respone message
diff --git a/doc/install.rst b/doc/install.rst
index 83e6c8ca4..bfbeee7c7 100644
--- a/doc/install.rst
+++ b/doc/install.rst
@@ -1,7 +1,7 @@
Ganeti installation tutorial
============================
-Documents Ganeti version 2.0
+Documents Ganeti version |version|
.. contents::
@@ -450,7 +450,7 @@ installed.
apt-get install debootstrap dump kpartx
Alternatively, you can create your own OS definitions. See the manpage
-*ganeti-os-interface*.
+:manpage:`ganeti-os-interface`.
Initializing the cluster
++++++++++++++++++++++++
--
GitLab