Move the glossary to a separate file

Currently we have an insignificant glossary at the end of the design-2.0
document. This patch moves it to a separate file with the goal that it
will grow and all files can refer to it.

Signed-off-by: Iustin Pop <iustin@google.com>
Reviewed-by: Guido Trotter <ultrotter@google.com>

diff --git a/Makefile.am b/Makefile.am
index 043ca8e..2b63afc 100644 (file)
--- a/Makefile.am
+++ b/Makefile.am
@@ -111,6 +111,7 @@ http_PYTHON = \
 docrst = \
        doc/admin.rst \
        doc/design-2.0.rst \
+       doc/glossary.rst \
        doc/hooks.rst \
        doc/iallocator.rst \
        doc/index.rst \

diff --git a/doc/design-2.0.rst b/doc/design-2.0.rst
index a1de866..9d25f74 100644 (file)
--- a/doc/design-2.0.rst
+++ b/doc/design-2.0.rst
@@ -332,9 +332,10 @@ and instead have always one logfile per daemon model:
 - rapi-access.log, an additional log file for the RAPI that will be
   in the standard HTTP log format for possible parsing by other tools
 
-Since the `watcher`_ will only submit jobs to the master for startup
-of the instances, its log file will contain less information than
-before, mainly that it will start the instance, but not the results.
+Since the :term:`watcher` will only submit jobs to the master for
+startup of the instances, its log file will contain less information
+than before, mainly that it will start the instance, but not the
+results.
 
 Node daemon changes
 +++++++++++++++++++
@@ -799,7 +800,7 @@ The following definitions for instance parameters will be used below:
   a hypervisor parameter (or hypervisor specific parameter) is defined
   as a parameter that is interpreted by the hypervisor support code in
   Ganeti and usually is specific to a particular hypervisor (like the
-  kernel path for `PVM`_ which makes no sense for `HVM`_).
+  kernel path for :term:`PVM` which makes no sense for :term:`HVM`).
 
 :backend parameter:
   a backend parameter is defined as an instance parameter that can be
@@ -1991,41 +1992,3 @@ option is::
   to set, string
 :$OPTION: cluster default option, string,
 :$VALUE: cluster default option value, string.
-
-Glossary
-========
-
-Since this document is only a delta from the Ganeti 1.2, there are
-some unexplained terms. Here is a non-exhaustive list.
-
-.. _HVM:
-
-HVM
-  hardware virtualization mode, where the virtual machine is oblivious
-  to the fact that's being virtualized and all the hardware is emulated
-
-.. _LU:
-
-LogicalUnit
-  the code associated with an OpCode, i.e. the code that implements the
-  startup of an instance
-
-.. _opcode:
-
-OpCode
-  a data structure encapsulating a basic cluster operation; for example,
-  start instance, add instance, etc.;
-
-.. _PVM:
-
-PVM
-  para-virtualization mode, where the virtual machine knows it's being
-  virtualized and as such there is no need for hardware emulation
-
-.. _watcher:
-
-watcher
-  ``ganeti-watcher`` is a tool that should be run regularly from cron
-  and takes care of restarting failed instances, restarting secondary
-  DRBD devices, etc. For more details, see the man page
-  ``ganeti-watcher(8)``.

diff --git a/doc/glossary.rst b/doc/glossary.rst
new file mode 100644 (file)
index 0000000..6bbf0a9
--- /dev/null
+++ b/doc/glossary.rst
@@ -0,0 +1,30 @@
+========
+Glossary
+========
+
+.. if you add new entries, keep the alphabetical sorting!
+
+.. glossary::
+
+  HVM
+    Hardware virtualization mode, where the virtual machine is
+    oblivious to the fact that's being virtualized and all the
+    hardware is emulated.
+
+  LogicalUnit
+    The code associated with an OpCode, e.g. the code that implements
+    the startup of an instance.
+
+  OpCode
+    A data structure encapsulating a basic cluster operation; for example,
+    start instance, add instance, etc.
+
+  PVM
+    Para-virtualization mode, where the virtual machine knows it's being
+    virtualized and as such there is no need for hardware emulation.
+
+  watcher
+    ``ganeti-watcher`` is a tool that should be run regularly from cron
+    and takes care of restarting failed instances, restarting secondary
+    DRBD devices, etc. For more details, see the man page
+    :manpage:`ganeti-watcher(8)`.

diff --git a/doc/index.rst b/doc/index.rst
index f9e698a..4a4a38d 100644 (file)
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -13,8 +13,10 @@ Contents:
    admin.rst
    security.rst
    design-2.0.rst
+   design-2.1.rst
    hooks.rst
    iallocator.rst
    rapi.rst
+   glossary.rst
 
 Also see the :ref:`search`.