Commit 22ac4136 authored by Michael Hanselmann's avatar Michael Hanselmann

More documentation and man page fixes

- Include numbers in man page references
- Use “:manpage:” where appropriate
- Don't escape underscore in verbatim text (e.g. “``always_failover``)
  as it would show up in the generated man page
- Quote whole paths, not just build-time part
Signed-off-by: default avatarMichael Hanselmann <hansmi@google.com>
Reviewed-by: default avatarGuido Trotter <ultrotter@google.com>
parent dbb4f850
......@@ -703,7 +703,7 @@ New features
- Instance migration can fall back to failover if instance is not
running.
- Filters can be used when listing nodes, instances, groups and locks;
see *ganeti(7)* manpage.
see :manpage:`ganeti(7)` manpage.
- Added post-execution status as variables to :doc:`hooks <hooks>`
environment.
- Instance tags are exported/imported together with the instance.
......
......@@ -322,7 +322,7 @@ after shutting down an instance, execute the following::
.. warning:: Do not use the Xen or KVM commands directly to stop
instances. If you run for example ``xm shutdown`` or ``xm destroy``
on an instance Ganeti will automatically restart it (via
the :command:`ganeti-watcher` command which is launched via cron).
the :command:`ganeti-watcher(8)` command which is launched via cron).
Querying instances
~~~~~~~~~~~~~~~~~~
......@@ -1217,7 +1217,7 @@ upgrade the Ganeti software, or simply restart the software on any node:
Watcher control
+++++++++++++++
The :manpage:`ganeti-watcher` is a program, usually scheduled via
The :manpage:`ganeti-watcher(8)` is a program, usually scheduled via
``cron``, that takes care of cluster maintenance operations (restarting
downed instances, activating down DRBD disks, etc.). However, during
maintenance and troubleshooting, this can get in your way; disabling it
......
......@@ -1621,7 +1621,7 @@ 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
:manpage:`ganeti-os-api` man page. All these variables will be
:manpage:`ganeti-os-interface(7)` man page. All these variables will be
available to all scripts.
Some scripts will need a few more information to work. These will have
......
......@@ -655,7 +655,7 @@ installed.
can be added, of course, if needed.
Alternatively, you can create your own OS definitions. See the manpage
:manpage:`ganeti-os-interface`.
:manpage:`ganeti-os-interface(7)`.
Initializing the cluster
++++++++++++++++++++++++
......
......@@ -30,7 +30,7 @@ EXPORT
Exports an instance to the target node. All the instance data and
its configuration will be exported under the
``@CUSTOM_EXPORT_DIR@/``*instance* directory on the target node.
``@CUSTOM_EXPORT_DIR@/$instance`` directory on the target node.
The ``--shutdown-timeout`` is used to specify how much time to wait
before forcing the shutdown (xm destroy in xen, killing the kvm
......
......@@ -340,7 +340,7 @@ auto\_balance
will be set to true if not specified.
always\_failover
Default value for the ``always\_failover`` flag for instances; if
Default value for the ``always_failover`` flag for instances; if
not set, ``False`` is used.
......
......@@ -672,7 +672,7 @@ useful for having different subdirectories for different
instances. The full path of the directory where the disk files are
stored will consist of cluster-wide file storage directory + optional
subdirectory + instance name. Example:
``@RPL_FILE_STORAGE_DIR@``*/mysubdir/instance1.example.com*. This
``@RPL_FILE_STORAGE_DIR@/mysubdir/instance1.example.com``. This
option is only relevant for instances using the file storage backend.
The ``--file-driver`` specifies the driver to use for file-based
......@@ -1600,7 +1600,7 @@ The ``--no-runtime-changes`` option forbids migrate to alter an
instance's runtime before migrating it (eg. ballooning an instance
down because the target node doesn't have enough available memory).
If an instance has the backend parameter ``always\_failover`` set to
If an instance has the backend parameter ``always_failover`` set to
true, then the migration is automatically converted into a failover.
See **ganeti(7)** for a description of ``--submit`` and other common
......
......@@ -191,8 +191,9 @@ OK
that the computation failed and any values present should not be
relied upon.
Many of the INI_/FIN_ metrics will be also displayed with a TRL_ prefix,
and denote the cluster status at the end of the tiered allocation run.
Many of the ``INI_``/``FIN_`` metrics will be also displayed with a
``TRL_`` prefix, and denote the cluster status at the end of the tiered
allocation run.
The human output format should be self-explanatory, so it is not
described further.
......
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