Skip to content

Commit

Permalink
Merge pull request #70 from zhmcclient/andy/docs-links
Browse files Browse the repository at this point in the history
Fixed doc links to resource types.
  • Loading branch information
leopoldjuergen authored Sep 13, 2016
2 parents 6fffd1d + f88f4ad commit 2ae2e52
Show file tree
Hide file tree
Showing 11 changed files with 22 additions and 20 deletions.
3 changes: 2 additions & 1 deletion docs/appendix.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 2 additions & 2 deletions zhmcclient/_activation_profile.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@
# limitations under the License.

"""
**Activation Profiles** control the activation of :term:`CPCs <CPC>` and
:term:`LPARs <LPAR>`. 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.
Expand Down
6 changes: 3 additions & 3 deletions zhmcclient/_adapter.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion zhmcclient/_cpc.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion zhmcclient/_hba.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion zhmcclient/_lpar.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion zhmcclient/_nic.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions zhmcclient/_partition.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
6 changes: 3 additions & 3 deletions zhmcclient/_port.py
Original file line number Diff line number Diff line change
Expand Up @@ -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 <CPC>` that are in DPM mode.
"""

from __future__ import absolute_import
Expand All @@ -30,7 +30,7 @@

class PortManager(BaseManager):
"""
Manager providing access to the :term:`Ports <Port>` in a particular
Manager providing access to the :term:`Ports <Port>` of a particular
:term:`Adapter`.
Derived from :class:`~zhmcclient.BaseManager`; see there for common methods
Expand Down
5 changes: 3 additions & 2 deletions zhmcclient/_virtual_function.py
Original file line number Diff line number Diff line change
Expand Up @@ -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 <Accelerator Adapter>`.
A :term:`Virtual Function` is a logical entity that provides a
:term:`Partition` with access to
:term:`Accelerator Adapters <Accelerator Adapter>`.
Virtual Function resources are contained in Partition resources.
Expand Down
6 changes: 3 additions & 3 deletions zhmcclient/_virtual_switch.py
Original file line number Diff line number Diff line change
Expand Up @@ -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 <NIC>` 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 <CPC>` that are in DPM mode.
Virtual Switches only exist in CPCs that are in DPM mode.
"""

from __future__ import absolute_import
Expand Down

0 comments on commit 2ae2e52

Please sign in to comment.