Skip to content

Commit

Permalink
Removed zhmcclient requirement in module docs
Browse files Browse the repository at this point in the history
Details:

* The requirements section of the module documentation strings currently
  lists the zhmcclient package with the minimum version needed for the
  module. This results in different versions which is not a very useful
  statement for users of the collection. Plus, it is likely that some
  versions became incorrect meanwhile, and these versions are often
  below the minimum version stated in the requirements file which is
  what we test with for package level = minimum.

  This change removes the item about the zhmcclient package in the
  requirements section of the module documentations.

Signed-off-by: Andreas Maier <andreas.r.maier@gmx.de>
  • Loading branch information
andy-maier committed Nov 19, 2020
1 parent 6eb2905 commit 63b294c
Show file tree
Hide file tree
Showing 34 changed files with 1 addition and 34 deletions.
1 change: 0 additions & 1 deletion docs/modules/zhmc_adapter.html
Expand Up @@ -200,7 +200,6 @@ <h2><a class="toc-backref" href="#id2">Requirements</a><a class="headerlink" hre
<p>The below requirements are needed on the host that executes this module.</p>
<ul class="simple">
<li><p>Access to the WS API of the HMC of the targeted Z system (see <a class="reference internal" href="../appendix.html#term-HMC-API"><span class="xref std std-term">HMC API</span></a>). The targeted Z system must be in the Dynamic Partition Manager (DPM) operational mode.</p></li>
<li><p>Python package zhmcclient &gt;=0.20.0</p></li>
</ul>
</div>
<div class="section" id="parameters">
Expand Down
1 change: 0 additions & 1 deletion docs/modules/zhmc_cpc.html
Expand Up @@ -200,7 +200,6 @@ <h2><a class="toc-backref" href="#id2">Requirements</a><a class="headerlink" hre
<p>The below requirements are needed on the host that executes this module.</p>
<ul class="simple">
<li><p>Access to the WS API of the HMC of the targeted Z system (see <a class="reference internal" href="../appendix.html#term-HMC-API"><span class="xref std std-term">HMC API</span></a>). The targeted Z system must be in the Dynamic Partition Manager (DPM) operational mode</p></li>
<li><p>Python package zhmcclient &gt;=0.20.0</p></li>
</ul>
</div>
<div class="section" id="parameters">
Expand Down
1 change: 0 additions & 1 deletion docs/modules/zhmc_crypto_attachment.html
Expand Up @@ -201,7 +201,6 @@ <h2><a class="toc-backref" href="#id2">Requirements</a><a class="headerlink" hre
<p>The below requirements are needed on the host that executes this module.</p>
<ul class="simple">
<li><p>Access to the WS API of the HMC of the targeted Z system (see <a class="reference internal" href="../appendix.html#term-HMC-API"><span class="xref std std-term">HMC API</span></a>). The targeted Z system must be in the Dynamic Partition Manager (DPM) operational mode.</p></li>
<li><p>Python package zhmcclient &gt;=0.20.0</p></li>
</ul>
</div>
<div class="section" id="parameters">
Expand Down
1 change: 0 additions & 1 deletion docs/modules/zhmc_hba.html
Expand Up @@ -201,7 +201,6 @@ <h2><a class="toc-backref" href="#id2">Requirements</a><a class="headerlink" hre
<ul class="simple">
<li><p>Access to the WS API of the HMC of the targeted Z system (see <a class="reference internal" href="../appendix.html#term-HMC-API"><span class="xref std std-term">HMC API</span></a>). The targeted Z system must be in the Dynamic Partition Manager (DPM) operational mode.</p></li>
<li><p>The targeted Z system must be a z13 generation. The z14 and later generations manage HBAs automatically via the “dpm-storage-management” firmware feature.</p></li>
<li><p>Python package zhmcclient &gt;=0.14.0</p></li>
</ul>
</div>
<div class="section" id="parameters">
Expand Down
1 change: 0 additions & 1 deletion docs/modules/zhmc_nic.html
Expand Up @@ -200,7 +200,6 @@ <h2><a class="toc-backref" href="#id2">Requirements</a><a class="headerlink" hre
<p>The below requirements are needed on the host that executes this module.</p>
<ul class="simple">
<li><p>Access to the WS API of the HMC of the targeted Z system (see <a class="reference internal" href="../appendix.html#term-HMC-API"><span class="xref std std-term">HMC API</span></a>). The targeted Z system must be in the Dynamic Partition Manager (DPM) operational mode.</p></li>
<li><p>Python package zhmcclient &gt;=0.14.0</p></li>
</ul>
</div>
<div class="section" id="parameters">
Expand Down
1 change: 0 additions & 1 deletion docs/modules/zhmc_partition.html
Expand Up @@ -203,7 +203,6 @@ <h2><a class="toc-backref" href="#id2">Requirements</a><a class="headerlink" hre
<p>The below requirements are needed on the host that executes this module.</p>
<ul class="simple">
<li><p>Access to the WS API of the HMC of the targeted Z system (see <a class="reference internal" href="../appendix.html#term-HMC-API"><span class="xref std std-term">HMC API</span></a>). The targeted Z system must be in the Dynamic Partition Manager (DPM) operational mode.</p></li>
<li><p>Python package zhmcclient &gt;=0.14.0</p></li>
</ul>
</div>
<div class="section" id="parameters">
Expand Down
1 change: 0 additions & 1 deletion docs/modules/zhmc_storage_group.html
Expand Up @@ -203,7 +203,6 @@ <h2><a class="toc-backref" href="#id2">Requirements</a><a class="headerlink" hre
<ul class="simple">
<li><p>Access to the WS API of the HMC of the targeted Z system (see <a class="reference internal" href="../appendix.html#term-HMC-API"><span class="xref std std-term">HMC API</span></a>). The targeted Z system must be in the Dynamic Partition Manager (DPM) operational mode.</p></li>
<li><p>The Z system must be of generation z14 or later, to have the “dpm-storage-management” firmware feature.</p></li>
<li><p>Python package zhmcclient &gt;=0.20.0</p></li>
</ul>
</div>
<div class="section" id="parameters">
Expand Down
1 change: 0 additions & 1 deletion docs/modules/zhmc_storage_group_attachment.html
Expand Up @@ -203,7 +203,6 @@ <h2><a class="toc-backref" href="#id2">Requirements</a><a class="headerlink" hre
<ul class="simple">
<li><p>Access to the WS API of the HMC of the targeted Z system (see <a class="reference internal" href="../appendix.html#term-HMC-API"><span class="xref std std-term">HMC API</span></a>). The targeted Z system must be in the Dynamic Partition Manager (DPM) operational mode.</p></li>
<li><p>The Z system must be of generation z14 or later, to have the “dpm-storage-management” firmware feature.</p></li>
<li><p>Python package zhmcclient &gt;=0.20.0</p></li>
</ul>
</div>
<div class="section" id="parameters">
Expand Down
1 change: 0 additions & 1 deletion docs/modules/zhmc_storage_volume.html
Expand Up @@ -203,7 +203,6 @@ <h2><a class="toc-backref" href="#id2">Requirements</a><a class="headerlink" hre
<ul class="simple">
<li><p>Access to the WS API of the HMC of the targeted Z system (see <a class="reference internal" href="../appendix.html#term-HMC-API"><span class="xref std std-term">HMC API</span></a>). The targeted Z system must be in the Dynamic Partition Manager (DPM) operational mode.</p></li>
<li><p>The Z system must be of generation z14 or later, to have the “dpm-storage-management” firmware feature.</p></li>
<li><p>Python package zhmcclient &gt;=0.20.0</p></li>
</ul>
</div>
<div class="section" id="parameters">
Expand Down
1 change: 0 additions & 1 deletion docs/modules/zhmc_user.html
Expand Up @@ -200,7 +200,6 @@ <h2><a class="toc-backref" href="#id2">Requirements</a><a class="headerlink" hre
<p>The below requirements are needed on the host that executes this module.</p>
<ul class="simple">
<li><p>Access to the WS API of the HMC of the targeted Z system (see <a class="reference internal" href="../appendix.html#term-HMC-API"><span class="xref std std-term">HMC API</span></a>). The targeted Z system can be in any operational mode (classic, DPM)</p></li>
<li><p>Python package zhmcclient &gt;=0.23.0</p></li>
</ul>
</div>
<div class="section" id="parameters">
Expand Down
1 change: 0 additions & 1 deletion docs/modules/zhmc_virtual_function.html
Expand Up @@ -200,7 +200,6 @@ <h2><a class="toc-backref" href="#id2">Requirements</a><a class="headerlink" hre
<p>The below requirements are needed on the host that executes this module.</p>
<ul class="simple">
<li><p>Access to the WS API of the HMC of the targeted Z system (see <a class="reference internal" href="../appendix.html#term-HMC-API"><span class="xref std std-term">HMC API</span></a>). The targeted Z system must be in the Dynamic Partition Manager (DPM) operational mode.</p></li>
<li><p>Python package zhmcclient &gt;=0.14.0</p></li>
</ul>
</div>
<div class="section" id="parameters">
Expand Down
2 changes: 1 addition & 1 deletion docs/searchindex.js

Large diffs are not rendered by default.

1 change: 0 additions & 1 deletion docs_source/modules/zhmc_adapter.rst
Expand Up @@ -23,7 +23,6 @@ Requirements
The below requirements are needed on the host that executes this module.

- Access to the WS API of the HMC of the targeted Z system (see :term:`HMC API`). The targeted Z system must be in the Dynamic Partition Manager (DPM) operational mode.
- Python package zhmcclient >=0.20.0



Expand Down
1 change: 0 additions & 1 deletion docs_source/modules/zhmc_cpc.rst
Expand Up @@ -23,7 +23,6 @@ Requirements
The below requirements are needed on the host that executes this module.

- Access to the WS API of the HMC of the targeted Z system (see :term:`HMC API`). The targeted Z system must be in the Dynamic Partition Manager (DPM) operational mode
- Python package zhmcclient >=0.20.0



Expand Down
1 change: 0 additions & 1 deletion docs_source/modules/zhmc_crypto_attachment.rst
Expand Up @@ -25,7 +25,6 @@ Requirements
The below requirements are needed on the host that executes this module.

- Access to the WS API of the HMC of the targeted Z system (see :term:`HMC API`). The targeted Z system must be in the Dynamic Partition Manager (DPM) operational mode.
- Python package zhmcclient >=0.20.0



Expand Down
1 change: 0 additions & 1 deletion docs_source/modules/zhmc_hba.rst
Expand Up @@ -24,7 +24,6 @@ The below requirements are needed on the host that executes this module.

- Access to the WS API of the HMC of the targeted Z system (see :term:`HMC API`). The targeted Z system must be in the Dynamic Partition Manager (DPM) operational mode.
- The targeted Z system must be a z13 generation. The z14 and later generations manage HBAs automatically via the "dpm-storage-management" firmware feature.
- Python package zhmcclient >=0.14.0



Expand Down
1 change: 0 additions & 1 deletion docs_source/modules/zhmc_nic.rst
Expand Up @@ -23,7 +23,6 @@ Requirements
The below requirements are needed on the host that executes this module.

- Access to the WS API of the HMC of the targeted Z system (see :term:`HMC API`). The targeted Z system must be in the Dynamic Partition Manager (DPM) operational mode.
- Python package zhmcclient >=0.14.0



Expand Down
1 change: 0 additions & 1 deletion docs_source/modules/zhmc_partition.rst
Expand Up @@ -25,7 +25,6 @@ Requirements
The below requirements are needed on the host that executes this module.

- Access to the WS API of the HMC of the targeted Z system (see :term:`HMC API`). The targeted Z system must be in the Dynamic Partition Manager (DPM) operational mode.
- Python package zhmcclient >=0.14.0



Expand Down
1 change: 0 additions & 1 deletion docs_source/modules/zhmc_storage_group.rst
Expand Up @@ -24,7 +24,6 @@ The below requirements are needed on the host that executes this module.

- Access to the WS API of the HMC of the targeted Z system (see :term:`HMC API`). The targeted Z system must be in the Dynamic Partition Manager (DPM) operational mode.
- The Z system must be of generation z14 or later, to have the "dpm-storage-management" firmware feature.
- Python package zhmcclient >=0.20.0



Expand Down
1 change: 0 additions & 1 deletion docs_source/modules/zhmc_storage_group_attachment.rst
Expand Up @@ -24,7 +24,6 @@ The below requirements are needed on the host that executes this module.

- Access to the WS API of the HMC of the targeted Z system (see :term:`HMC API`). The targeted Z system must be in the Dynamic Partition Manager (DPM) operational mode.
- The Z system must be of generation z14 or later, to have the "dpm-storage-management" firmware feature.
- Python package zhmcclient >=0.20.0



Expand Down
1 change: 0 additions & 1 deletion docs_source/modules/zhmc_storage_volume.rst
Expand Up @@ -24,7 +24,6 @@ The below requirements are needed on the host that executes this module.

- Access to the WS API of the HMC of the targeted Z system (see :term:`HMC API`). The targeted Z system must be in the Dynamic Partition Manager (DPM) operational mode.
- The Z system must be of generation z14 or later, to have the "dpm-storage-management" firmware feature.
- Python package zhmcclient >=0.20.0



Expand Down
1 change: 0 additions & 1 deletion docs_source/modules/zhmc_user.rst
Expand Up @@ -23,7 +23,6 @@ Requirements
The below requirements are needed on the host that executes this module.

- Access to the WS API of the HMC of the targeted Z system (see :term:`HMC API`). The targeted Z system can be in any operational mode (classic, DPM)
- Python package zhmcclient >=0.23.0



Expand Down
1 change: 0 additions & 1 deletion docs_source/modules/zhmc_virtual_function.rst
Expand Up @@ -23,7 +23,6 @@ Requirements
The below requirements are needed on the host that executes this module.

- Access to the WS API of the HMC of the targeted Z system (see :term:`HMC API`). The targeted Z system must be in the Dynamic Partition Manager (DPM) operational mode.
- Python package zhmcclient >=0.14.0



Expand Down
1 change: 0 additions & 1 deletion plugins/modules/zhmc_adapter.py
Expand Up @@ -43,7 +43,6 @@
- Access to the WS API of the HMC of the targeted Z system
(see :term:`HMC API`). The targeted Z system must be in the Dynamic
Partition Manager (DPM) operational mode.
- Python package zhmcclient >=0.20.0
options:
hmc_host:
description:
Expand Down
1 change: 0 additions & 1 deletion plugins/modules/zhmc_cpc.py
Expand Up @@ -43,7 +43,6 @@
- Access to the WS API of the HMC of the targeted Z system
(see :term:`HMC API`). The targeted Z system must be in the Dynamic
Partition Manager (DPM) operational mode
- Python package zhmcclient >=0.20.0
options:
hmc_host:
description:
Expand Down
1 change: 0 additions & 1 deletion plugins/modules/zhmc_crypto_attachment.py
Expand Up @@ -47,7 +47,6 @@
- Access to the WS API of the HMC of the targeted Z system
(see :term:`HMC API`). The targeted Z system must be in the Dynamic
Partition Manager (DPM) operational mode.
- Python package zhmcclient >=0.20.0
options:
hmc_host:
description:
Expand Down
1 change: 0 additions & 1 deletion plugins/modules/zhmc_hba.py
Expand Up @@ -49,7 +49,6 @@
- The targeted Z system must be a z13 generation. The z14 and later
generations manage HBAs automatically via the "dpm-storage-management"
firmware feature.
- Python package zhmcclient >=0.14.0
options:
hmc_host:
description:
Expand Down
1 change: 0 additions & 1 deletion plugins/modules/zhmc_nic.py
Expand Up @@ -46,7 +46,6 @@
- Access to the WS API of the HMC of the targeted Z system
(see :term:`HMC API`). The targeted Z system must be in the Dynamic
Partition Manager (DPM) operational mode.
- Python package zhmcclient >=0.14.0
options:
hmc_host:
description:
Expand Down
1 change: 0 additions & 1 deletion plugins/modules/zhmc_partition.py
Expand Up @@ -51,7 +51,6 @@
- Access to the WS API of the HMC of the targeted Z system
(see :term:`HMC API`). The targeted Z system must be in the Dynamic
Partition Manager (DPM) operational mode.
- Python package zhmcclient >=0.14.0
options:
hmc_host:
description:
Expand Down
1 change: 0 additions & 1 deletion plugins/modules/zhmc_storage_group.py
Expand Up @@ -53,7 +53,6 @@
Partition Manager (DPM) operational mode.
- The Z system must be of generation z14 or later, to have the
"dpm-storage-management" firmware feature.
- Python package zhmcclient >=0.20.0
options:
hmc_host:
description:
Expand Down
1 change: 0 additions & 1 deletion plugins/modules/zhmc_storage_group_attachment.py
Expand Up @@ -52,7 +52,6 @@
Partition Manager (DPM) operational mode.
- The Z system must be of generation z14 or later, to have the
"dpm-storage-management" firmware feature.
- Python package zhmcclient >=0.20.0
options:
hmc_host:
description:
Expand Down
1 change: 0 additions & 1 deletion plugins/modules/zhmc_storage_volume.py
Expand Up @@ -52,7 +52,6 @@
Partition Manager (DPM) operational mode.
- The Z system must be of generation z14 or later, to have the
"dpm-storage-management" firmware feature.
- Python package zhmcclient >=0.20.0
options:
hmc_host:
description:
Expand Down
1 change: 0 additions & 1 deletion plugins/modules/zhmc_user.py
Expand Up @@ -42,7 +42,6 @@
- Access to the WS API of the HMC of the targeted Z system
(see :term:`HMC API`). The targeted Z system can be in any operational
mode (classic, DPM)
- Python package zhmcclient >=0.23.0
options:
hmc_host:
description:
Expand Down
1 change: 0 additions & 1 deletion plugins/modules/zhmc_virtual_function.py
Expand Up @@ -46,7 +46,6 @@
- Access to the WS API of the HMC of the targeted Z system
(see :term:`HMC API`). The targeted Z system must be in the Dynamic
Partition Manager (DPM) operational mode.
- Python package zhmcclient >=0.14.0
options:
hmc_host:
description:
Expand Down

0 comments on commit 63b294c

Please sign in to comment.