From f88f4ad3ed78325622f30eb6ea5c6cfdddb69734 Mon Sep 17 00:00:00 2001 From: Andreas Maier Date: Mon, 12 Sep 2016 17:58:50 +0200 Subject: [PATCH] Fixed doc links to resource types. Signed-off-by: Andreas Maier --- docs/appendix.rst | 3 ++- zhmcclient/_activation_profile.py | 4 ++-- zhmcclient/_adapter.py | 6 +++--- zhmcclient/_cpc.py | 2 +- zhmcclient/_hba.py | 2 +- zhmcclient/_lpar.py | 2 +- zhmcclient/_nic.py | 2 +- zhmcclient/_partition.py | 4 ++-- zhmcclient/_port.py | 6 +++--- zhmcclient/_virtual_function.py | 5 +++-- zhmcclient/_virtual_switch.py | 6 +++--- 11 files changed, 22 insertions(+), 20 deletions(-) diff --git a/docs/appendix.rst b/docs/appendix.rst index 79e0d35a..b85923ea 100644 --- a/docs/appendix.rst +++ b/docs/appendix.rst @@ -134,9 +134,10 @@ attaching storage. Scope: CPC in DPM mode Adapter Port + Port The physical connector port (jack) of an :term:`Adapter`. - For details, see section :ref:`Adapter ports`. + For details, see section :ref:`Ports`. Scope: CPC in DPM mode diff --git a/zhmcclient/_activation_profile.py b/zhmcclient/_activation_profile.py index 1c5cac41..ce20653a 100644 --- a/zhmcclient/_activation_profile.py +++ b/zhmcclient/_activation_profile.py @@ -13,8 +13,8 @@ # limitations under the License. """ -**Activation Profiles** control the activation of :term:`CPCs ` and -:term:`LPARs `. They are used to tailor the operation of a CPC and are +An :term:`Activation Profile` controls the activation of a :term:`CPC` +or :term:`LPAR`. They are used to tailor the operation of a CPC and are stored in the Support Element associated with the CPC. Activation Profile resources are contained in CPC resources. diff --git a/zhmcclient/_adapter.py b/zhmcclient/_adapter.py index 4373ac3c..39a84ba8 100644 --- a/zhmcclient/_adapter.py +++ b/zhmcclient/_adapter.py @@ -13,10 +13,10 @@ # limitations under the License. """ -An **Adapter** is a physical adapter card (e.g. OSA-Express adapter, Crypto -adapter) or a logical adapter (e.g. HiperSockets switch). +An :term:`Adapter` is a physical adapter card (e.g. OSA-Express adapter, +Crypto adapter) or a logical adapter (e.g. HiperSockets switch). -Adapter resources are contained in CPC resources. +Adapter resources are contained in :term:`CPC` resources. Adapters only exist in CPCs that are in DPM mode. diff --git a/zhmcclient/_cpc.py b/zhmcclient/_cpc.py index cd9f8a2f..0b0b7341 100644 --- a/zhmcclient/_cpc.py +++ b/zhmcclient/_cpc.py @@ -13,7 +13,7 @@ # limitations under the License. """ -A **Central Processor Complex (CPC)** is a physical z Systems or LinuxONE +A :term:`CPC` (Central Processor Complex) is a physical z Systems or LinuxONE computer. A particular HMC can manage multiple CPCs. diff --git a/zhmcclient/_hba.py b/zhmcclient/_hba.py index 5484a4f8..f4a9774a 100644 --- a/zhmcclient/_hba.py +++ b/zhmcclient/_hba.py @@ -13,7 +13,7 @@ # limitations under the License. """ -A **Host Bus Adapter (HBA)** is a logical entity that provides a +A :term:`HBA` (Host Bus Adapter) is a logical entity that provides a :term:`Partition` with access to external storage area networks (SANs) through an :term:`FCP Adapter`. More specifically, an HBA connects a Partition with an :term:`Adapter Port` on an FCP Adapter. diff --git a/zhmcclient/_lpar.py b/zhmcclient/_lpar.py index c3a3ac0b..8d204744 100644 --- a/zhmcclient/_lpar.py +++ b/zhmcclient/_lpar.py @@ -13,7 +13,7 @@ # limitations under the License. """ -A **Logical Partition (LPAR)** is a subset of the hardware resources of a +A :term:`LPAR` (Logical Partition) is a subset of the hardware resources of a :term:`CPC` in classic mode (or ensemble mode), virtualized as a separate computer. diff --git a/zhmcclient/_nic.py b/zhmcclient/_nic.py index 73232396..10b65a7f 100644 --- a/zhmcclient/_nic.py +++ b/zhmcclient/_nic.py @@ -13,7 +13,7 @@ # limitations under the License. """ -A **Network Interface Card (NIC)** is a logical entity that provides a +A :term:`NIC` (Network Interface Card) is a logical entity that provides a :term:`Partition` with access to external communication networks through a :term:`Network Adapter`. More specifically, a NIC connects a Partition with a :term:`Network Port`, or with a :term:`Virtual Switch` which then connects to diff --git a/zhmcclient/_partition.py b/zhmcclient/_partition.py index 9a2eb06b..e8a337db 100644 --- a/zhmcclient/_partition.py +++ b/zhmcclient/_partition.py @@ -13,8 +13,8 @@ # limitations under the License. """ -A **Partition** is a subset of the hardware resources of a :term:`CPC` in DPM -mode, virtualized as a separate computer. +A :term:`Partition` is a subset of the hardware resources of a :term:`CPC` +in DPM mode, virtualized as a separate computer. Partitions can be created and deleted dynamically, and their resources such as CPU, memory or I/O devices can be configured dynamically. diff --git a/zhmcclient/_port.py b/zhmcclient/_port.py index cb99a1ed..12c148d3 100644 --- a/zhmcclient/_port.py +++ b/zhmcclient/_port.py @@ -13,11 +13,11 @@ # limitations under the License. """ -A **Port** is a physical connector port (jack) of an :term:`Adapter`. +A :term:`Port` is a physical connector port (jack) of an :term:`Adapter`. Port resources are contained in Adapter resources. -Ports only exist in CPCs that are in DPM mode. +Ports only exist in :term:`CPCs ` that are in DPM mode. """ from __future__ import absolute_import @@ -30,7 +30,7 @@ class PortManager(BaseManager): """ - Manager providing access to the :term:`Ports ` in a particular + Manager providing access to the :term:`Ports ` of a particular :term:`Adapter`. Derived from :class:`~zhmcclient.BaseManager`; see there for common methods diff --git a/zhmcclient/_virtual_function.py b/zhmcclient/_virtual_function.py index e5bcf14c..b54b37d1 100644 --- a/zhmcclient/_virtual_function.py +++ b/zhmcclient/_virtual_function.py @@ -13,8 +13,9 @@ # limitations under the License. """ -A **Virtual Function** is a logical entity that provides a :term:`Partition` -with access to :term:`Accelerator Adapters `. +A :term:`Virtual Function` is a logical entity that provides a +:term:`Partition` with access to +:term:`Accelerator Adapters `. Virtual Function resources are contained in Partition resources. diff --git a/zhmcclient/_virtual_switch.py b/zhmcclient/_virtual_switch.py index 2566370c..3a8a0664 100644 --- a/zhmcclient/_virtual_switch.py +++ b/zhmcclient/_virtual_switch.py @@ -13,15 +13,15 @@ # limitations under the License. """ -A **Virtual Switch** is a virtualized networking switch connecting +A :term:`Virtual Switch` is a virtualized networking switch connecting :term:`NICs ` with a :term:`Network Port`. Virtual Switches are generated automatically every time a new :term:`Network Adapter` is detected and configured. -Virtual Switch resources are contained in CPC resources. +Virtual Switch resources are contained in :term:`CPC` resources. -Virtual Switches only exist in :term:`CPCs ` that are in DPM mode. +Virtual Switches only exist in CPCs that are in DPM mode. """ from __future__ import absolute_import