beautify spacing in config descriptions

Signed-off-by: Ketan Kelkar <[email protected]>
IBM · Sep 9, 2024 · e6f934f · e6f934f
1 parent e0db3e7
commit e6f934f
Show file tree

Hide file tree

Showing 27 changed files with 660 additions and 568 deletions.
diff --git a/zos_basics/constructs/inventories/host_vars/zos_host.yml b/zos_basics/constructs/inventories/host_vars/zos_host.yml
@@ -5,27 +5,30 @@
 
 ################################################################################
 # Description of the properties used in this configuration:
-# - Property `PYZ` is the python installation home path on the z/OS managed node (target),
-#    e.g, pyz: "/usr/lpp/IBM/cyp/v3r12/pyz"
-# - Property `PYZ_VERSION` is the version of python on the z/OS managed node (target),
-#    e.g, pyz_version: "3.12"
-# - Property `ZOAU` is the ZOAU installation home on the z/OS managed node (target),
-#    e.g, zoau: "/usr/lpp/IBM/zoautil"
-# - Property `ZOAU_PYTHON_LIBRARY_PATH` is the path to the Z Open Automation Utilities (ZOAU) python library.
-#    Specifically, the path points to the directory containing `zoautil_py`.
-#    Packages installed using 'pip' generally default to the 'site-packages' directory within the
-#    Python installation, eg "/usr/lpp/IBM/cyp/v3r12/pyz/lib/python3.12/site-packages/".
-#    If the installation uses options such as `--user` or `--target`, the module is installed
-#    to a non-default location which must be configured to `ZOAU_PYTHON_LIBRARY_PATH`.
-#    If the wheel installation method is used with the `--target` or `--user` option,
-#   `ZOAU_PYTHON_LIBRARY_PATH` should point to the directory the wheel file was installed to.
-#    e.g ("/usr/zoau-wheel/")
-#    Else `ZOAU_PYTHON_LIBRARY_PATH` should point to the directory containing the pre-compiled binary.
-#    For ZOAU v1.2.x, the pre-compiled binary is located in the `lib` directory.
-#    e.g ("/usr/lpp/IBM/zoautil/lib" or "{{ ZOAU }}/lib")
+# - Property `PYZ` is the python installation home path on the z/OS managed
+#    (target) node e.g, PYZ: "/usr/lpp/IBM/cyp/v3r12/pyz"
+# - Property `PYZ_VERSION` is the version of python on the z/OS managed
+#    (target) node e.g, PYZ_VERSION: "3.12".
+# - Property `ZOAU` is the ZOAU installation home on the z/OS managed (target)
+#    node, e.g, ZOAU: "/usr/lpp/IBM/zoautil".
+# - Property `ZOAU_PYTHON_LIBRARY_PATH` is the path to the Z Open Automation
+#    Utilities (ZOAU) python library. Specifically, the path points to the
+#    directory containing 'zoautil_py'. Packages installed using 'pip' generally
+#    default to the 'site-packages' directory within the python installation,
+#    eg "/usr/lpp/IBM/cyp/v3r12/pyz/lib/python3.12/site-packages/".
+#    If the installation uses options such as '--user' or '--target', the module
+#    is installed to a non-default location which must be configured in
+#    `ZOAU_PYTHON_LIBRARY_PATH`.
+#    If the wheel installation method is used with the '--target' or '--user'
+#    option, `ZOAU_PYTHON_LIBRARY_PATH` should point to the directory the wheel
+#    file was installed to. e.g ZOAU_PYTHON_LIBRARY_PATH: "/usr/zoau-wheel/".
+#    Else 'ZOAU_PYTHON_LIBRARY_PATH' should point to the directory containing
+#    the pre-compiled binary.
+#    For ZOAU v1.2.x, the pre-compiled binary is located in the 'lib' directory.
+#    e.g "/usr/lpp/IBM/zoautil/lib" or "{{ ZOAU }}/lib".
 #    For ZOAU v1.3.x, the pre-compiled binary is located in a sub-directory
-#    corresponding to the `PYZ_VERSION` inside the `lib` directory,
-#    e.g ("/usr/lpp/IBM/zoautil/lib/3.12" or "{{ ZOAU }}/lib/{{ PYZ_VERSION }}")
+#    corresponding to the `PYZ_VERSION` inside the 'lib' directory,
+#    e.g "/usr/lpp/IBM/zoautil/lib/3.12" or "{{ ZOAU }}/lib/{{ PYZ_VERSION }}".
 # - Property `ansible_python_interpreter` is the z/OS managed node (target) Python
 #    binary installation path, e.g, ansible_python_interpreter: "{{PYZ}}/bin/python3"
 #
@@ -56,6 +59,6 @@ ZOAU: "path_to_zoau_installation_on_zos_target"
 
 ################################################################################
 # Do not configure, variable substitution will correctly set the
-# variable`ansible_python_interpreter`
+# variable `ansible_python_interpreter`
 ################################################################################
 ansible_python_interpreter: "{{ PYZ }}/bin/python3"
diff --git a/zos_basics/factgathering/inventories/host_vars/zos_host.yml b/zos_basics/factgathering/inventories/host_vars/zos_host.yml
@@ -5,27 +5,30 @@
 
 ################################################################################
 # Description of the properties used in this configuration:
-# - Property `PYZ` is the python installation home path on the z/OS managed node (target),
-#    e.g, pyz: "/usr/lpp/IBM/cyp/v3r12/pyz"
-# - Property `PYZ_VERSION` is the version of python on the z/OS managed node (target),
-#    e.g, pyz_version: "3.12"
-# - Property `ZOAU` is the ZOAU installation home on the z/OS managed node (target),
-#    e.g, zoau: "/usr/lpp/IBM/zoautil"
-# - Property `ZOAU_PYTHON_LIBRARY_PATH` is the path to the Z Open Automation Utilities (ZOAU) python library.
-#    Specifically, the path points to the directory containing `zoautil_py`.
-#    Packages installed using 'pip' generally default to the 'site-packages' directory within the
-#    Python installation, eg "/usr/lpp/IBM/cyp/v3r12/pyz/lib/python3.12/site-packages/".
-#    If the installation uses options such as `--user` or `--target`, the module is installed
-#    to a non-default location which must be configured to `ZOAU_PYTHON_LIBRARY_PATH`.
-#    If the wheel installation method is used with the `--target` or `--user` option,
-#   `ZOAU_PYTHON_LIBRARY_PATH` should point to the directory the wheel file was installed to.
-#    e.g ("/usr/zoau-wheel/")
-#    Else `ZOAU_PYTHON_LIBRARY_PATH` should point to the directory containing the pre-compiled binary.
-#    For ZOAU v1.2.x, the pre-compiled binary is located in the `lib` directory.
-#    e.g ("/usr/lpp/IBM/zoautil/lib" or "{{ ZOAU }}/lib")
+# - Property `PYZ` is the python installation home path on the z/OS managed
+#    (target) node e.g, PYZ: "/usr/lpp/IBM/cyp/v3r12/pyz"
+# - Property `PYZ_VERSION` is the version of python on the z/OS managed
+#    (target) node e.g, PYZ_VERSION: "3.12".
+# - Property `ZOAU` is the ZOAU installation home on the z/OS managed (target)
+#    node, e.g, ZOAU: "/usr/lpp/IBM/zoautil".
+# - Property `ZOAU_PYTHON_LIBRARY_PATH` is the path to the Z Open Automation
+#    Utilities (ZOAU) python library. Specifically, the path points to the
+#    directory containing 'zoautil_py'. Packages installed using 'pip' generally
+#    default to the 'site-packages' directory within the python installation,
+#    eg "/usr/lpp/IBM/cyp/v3r12/pyz/lib/python3.12/site-packages/".
+#    If the installation uses options such as '--user' or '--target', the module
+#    is installed to a non-default location which must be configured in
+#    `ZOAU_PYTHON_LIBRARY_PATH`.
+#    If the wheel installation method is used with the '--target' or '--user'
+#    option, `ZOAU_PYTHON_LIBRARY_PATH` should point to the directory the wheel
+#    file was installed to. e.g ZOAU_PYTHON_LIBRARY_PATH: "/usr/zoau-wheel/".
+#    Else 'ZOAU_PYTHON_LIBRARY_PATH' should point to the directory containing
+#    the pre-compiled binary.
+#    For ZOAU v1.2.x, the pre-compiled binary is located in the 'lib' directory.
+#    e.g "/usr/lpp/IBM/zoautil/lib" or "{{ ZOAU }}/lib".
 #    For ZOAU v1.3.x, the pre-compiled binary is located in a sub-directory
-#    corresponding to the `PYZ_VERSION` inside the `lib` directory,
-#    e.g ("/usr/lpp/IBM/zoautil/lib/3.12" or "{{ ZOAU }}/lib/{{ PYZ_VERSION }}")
+#    corresponding to the `PYZ_VERSION` inside the 'lib' directory,
+#    e.g "/usr/lpp/IBM/zoautil/lib/3.12" or "{{ ZOAU }}/lib/{{ PYZ_VERSION }}".
 # - Property `ansible_python_interpreter` is the z/OS managed node (target) Python
 #    binary installation path, e.g, ansible_python_interpreter: "{{PYZ}}/bin/python3"
 #
@@ -56,6 +59,6 @@ ZOAU: "path_to_zoau_installation_on_zos_target"
 
 ################################################################################
 # Do not configure, variable substitution will correctly set the
-# variable`ansible_python_interpreter`
+# variable `ansible_python_interpreter`
 ################################################################################
 ansible_python_interpreter: "{{ PYZ }}/bin/python3"
diff --git a/zos_concepts/certificate_management/inventories/host_vars/zos_host.yml b/zos_concepts/certificate_management/inventories/host_vars/zos_host.yml
@@ -5,27 +5,30 @@
 
 ################################################################################
 # Description of the properties used in this configuration:
-# - Property `PYZ` is the python installation home path on the z/OS managed node (target),
-#    e.g, pyz: "/usr/lpp/IBM/cyp/v3r12/pyz"
-# - Property `PYZ_VERSION` is the version of python on the z/OS managed node (target),
-#    e.g, pyz_version: "3.12"
-# - Property `ZOAU` is the ZOAU installation home on the z/OS managed node (target),
-#    e.g, zoau: "/usr/lpp/IBM/zoautil"
-# - Property `ZOAU_PYTHON_LIBRARY_PATH` is the path to the Z Open Automation Utilities (ZOAU) python library.
-#    Specifically, the path points to the directory containing `zoautil_py`.
-#    Packages installed using 'pip' generally default to the 'site-packages' directory within the
-#    Python installation, eg "/usr/lpp/IBM/cyp/v3r12/pyz/lib/python3.12/site-packages/".
-#    If the installation uses options such as `--user` or `--target`, the module is installed
-#    to a non-default location which must be configured to `ZOAU_PYTHON_LIBRARY_PATH`.
-#    If the wheel installation method is used with the `--target` or `--user` option,
-#   `ZOAU_PYTHON_LIBRARY_PATH` should point to the directory the wheel file was installed to.
-#    e.g ("/usr/zoau-wheel/")
-#    Else `ZOAU_PYTHON_LIBRARY_PATH` should point to the directory containing the pre-compiled binary.
-#    For ZOAU v1.2.x, the pre-compiled binary is located in the `lib` directory.
-#    e.g ("/usr/lpp/IBM/zoautil/lib" or "{{ ZOAU }}/lib")
+# - Property `PYZ` is the python installation home path on the z/OS managed
+#    (target) node e.g, PYZ: "/usr/lpp/IBM/cyp/v3r12/pyz"
+# - Property `PYZ_VERSION` is the version of python on the z/OS managed
+#    (target) node e.g, PYZ_VERSION: "3.12".
+# - Property `ZOAU` is the ZOAU installation home on the z/OS managed (target)
+#    node, e.g, ZOAU: "/usr/lpp/IBM/zoautil".
+# - Property `ZOAU_PYTHON_LIBRARY_PATH` is the path to the Z Open Automation
+#    Utilities (ZOAU) python library. Specifically, the path points to the
+#    directory containing 'zoautil_py'. Packages installed using 'pip' generally
+#    default to the 'site-packages' directory within the python installation,
+#    eg "/usr/lpp/IBM/cyp/v3r12/pyz/lib/python3.12/site-packages/".
+#    If the installation uses options such as '--user' or '--target', the module
+#    is installed to a non-default location which must be configured in
+#    `ZOAU_PYTHON_LIBRARY_PATH`.
+#    If the wheel installation method is used with the '--target' or '--user'
+#    option, `ZOAU_PYTHON_LIBRARY_PATH` should point to the directory the wheel
+#    file was installed to. e.g ZOAU_PYTHON_LIBRARY_PATH: "/usr/zoau-wheel/".
+#    Else 'ZOAU_PYTHON_LIBRARY_PATH' should point to the directory containing
+#    the pre-compiled binary.
+#    For ZOAU v1.2.x, the pre-compiled binary is located in the 'lib' directory.
+#    e.g "/usr/lpp/IBM/zoautil/lib" or "{{ ZOAU }}/lib".
 #    For ZOAU v1.3.x, the pre-compiled binary is located in a sub-directory
-#    corresponding to the `PYZ_VERSION` inside the `lib` directory,
-#    e.g ("/usr/lpp/IBM/zoautil/lib/3.12" or "{{ ZOAU }}/lib/{{ PYZ_VERSION }}")
+#    corresponding to the `PYZ_VERSION` inside the 'lib' directory,
+#    e.g "/usr/lpp/IBM/zoautil/lib/3.12" or "{{ ZOAU }}/lib/{{ PYZ_VERSION }}".
 # - Property `ansible_python_interpreter` is the z/OS managed node (target) Python
 #    binary installation path, e.g, ansible_python_interpreter: "{{PYZ}}/bin/python3"
 #
@@ -56,6 +59,6 @@ ZOAU: "path_to_zoau_installation_on_zos_target"
 
 ################################################################################
 # Do not configure, variable substitution will correctly set the
-# variable`ansible_python_interpreter`
+# variable `ansible_python_interpreter`
 ################################################################################
 ansible_python_interpreter: "{{ PYZ }}/bin/python3"
diff --git a/zos_concepts/data_sets/copy_edit_submit/inventories/host_vars/zos_host.yml b/zos_concepts/data_sets/copy_edit_submit/inventories/host_vars/zos_host.yml
@@ -5,27 +5,30 @@
 
 ################################################################################
 # Description of the properties used in this configuration:
-# - Property `PYZ` is the python installation home path on the z/OS managed node (target),
-#    e.g, pyz: "/usr/lpp/IBM/cyp/v3r12/pyz"
-# - Property `PYZ_VERSION` is the version of python on the z/OS managed node (target),
-#    e.g, pyz_version: "3.12"
-# - Property `ZOAU` is the ZOAU installation home on the z/OS managed node (target),
-#    e.g, zoau: "/usr/lpp/IBM/zoautil"
-# - Property `ZOAU_PYTHON_LIBRARY_PATH` is the path to the Z Open Automation Utilities (ZOAU) python library.
-#    Specifically, the path points to the directory containing `zoautil_py`.
-#    Packages installed using 'pip' generally default to the 'site-packages' directory within the
-#    Python installation, eg "/usr/lpp/IBM/cyp/v3r12/pyz/lib/python3.12/site-packages/".
-#    If the installation uses options such as `--user` or `--target`, the module is installed
-#    to a non-default location which must be configured to `ZOAU_PYTHON_LIBRARY_PATH`.
-#    If the wheel installation method is used with the `--target` or `--user` option,
-#   `ZOAU_PYTHON_LIBRARY_PATH` should point to the directory the wheel file was installed to.
-#    e.g ("/usr/zoau-wheel/")
-#    Else `ZOAU_PYTHON_LIBRARY_PATH` should point to the directory containing the pre-compiled binary.
-#    For ZOAU v1.2.x, the pre-compiled binary is located in the `lib` directory.
-#    e.g ("/usr/lpp/IBM/zoautil/lib" or "{{ ZOAU }}/lib")
+# - Property `PYZ` is the python installation home path on the z/OS managed
+#    (target) node e.g, PYZ: "/usr/lpp/IBM/cyp/v3r12/pyz"
+# - Property `PYZ_VERSION` is the version of python on the z/OS managed
+#    (target) node e.g, PYZ_VERSION: "3.12".
+# - Property `ZOAU` is the ZOAU installation home on the z/OS managed (target)
+#    node, e.g, ZOAU: "/usr/lpp/IBM/zoautil".
+# - Property `ZOAU_PYTHON_LIBRARY_PATH` is the path to the Z Open Automation
+#    Utilities (ZOAU) python library. Specifically, the path points to the
+#    directory containing 'zoautil_py'. Packages installed using 'pip' generally
+#    default to the 'site-packages' directory within the python installation,
+#    eg "/usr/lpp/IBM/cyp/v3r12/pyz/lib/python3.12/site-packages/".
+#    If the installation uses options such as '--user' or '--target', the module
+#    is installed to a non-default location which must be configured in
+#    `ZOAU_PYTHON_LIBRARY_PATH`.
+#    If the wheel installation method is used with the '--target' or '--user'
+#    option, `ZOAU_PYTHON_LIBRARY_PATH` should point to the directory the wheel
+#    file was installed to. e.g ZOAU_PYTHON_LIBRARY_PATH: "/usr/zoau-wheel/".
+#    Else 'ZOAU_PYTHON_LIBRARY_PATH' should point to the directory containing
+#    the pre-compiled binary.
+#    For ZOAU v1.2.x, the pre-compiled binary is located in the 'lib' directory.
+#    e.g "/usr/lpp/IBM/zoautil/lib" or "{{ ZOAU }}/lib".
 #    For ZOAU v1.3.x, the pre-compiled binary is located in a sub-directory
-#    corresponding to the `PYZ_VERSION` inside the `lib` directory,
-#    e.g ("/usr/lpp/IBM/zoautil/lib/3.12" or "{{ ZOAU }}/lib/{{ PYZ_VERSION }}")
+#    corresponding to the `PYZ_VERSION` inside the 'lib' directory,
+#    e.g "/usr/lpp/IBM/zoautil/lib/3.12" or "{{ ZOAU }}/lib/{{ PYZ_VERSION }}".
 # - Property `ansible_python_interpreter` is the z/OS managed node (target) Python
 #    binary installation path, e.g, ansible_python_interpreter: "{{PYZ}}/bin/python3"
 #
@@ -56,6 +59,6 @@ ZOAU: "path_to_zoau_installation_on_zos_target"
 
 ################################################################################
 # Do not configure, variable substitution will correctly set the
-# variable`ansible_python_interpreter`
+# variable `ansible_python_interpreter`
 ################################################################################
 ansible_python_interpreter: "{{ PYZ }}/bin/python3"
diff --git a/zos_concepts/data_sets/data_set_basics/inventories/host_vars/zos_host.yml b/zos_concepts/data_sets/data_set_basics/inventories/host_vars/zos_host.yml
@@ -5,27 +5,30 @@
 
 ################################################################################
 # Description of the properties used in this configuration:
-# - Property `PYZ` is the python installation home path on the z/OS managed node (target),
-#    e.g, pyz: "/usr/lpp/IBM/cyp/v3r12/pyz"
-# - Property `PYZ_VERSION` is the version of python on the z/OS managed node (target),
-#    e.g, pyz_version: "3.12"
-# - Property `ZOAU` is the ZOAU installation home on the z/OS managed node (target),
-#    e.g, zoau: "/usr/lpp/IBM/zoautil"
-# - Property `ZOAU_PYTHON_LIBRARY_PATH` is the path to the Z Open Automation Utilities (ZOAU) python library.
-#    Specifically, the path points to the directory containing `zoautil_py`.
-#    Packages installed using 'pip' generally default to the 'site-packages' directory within the
-#    Python installation, eg "/usr/lpp/IBM/cyp/v3r12/pyz/lib/python3.12/site-packages/".
-#    If the installation uses options such as `--user` or `--target`, the module is installed
-#    to a non-default location which must be configured to `ZOAU_PYTHON_LIBRARY_PATH`.
-#    If the wheel installation method is used with the `--target` or `--user` option,
-#   `ZOAU_PYTHON_LIBRARY_PATH` should point to the directory the wheel file was installed to.
-#    e.g ("/usr/zoau-wheel/")
-#    Else `ZOAU_PYTHON_LIBRARY_PATH` should point to the directory containing the pre-compiled binary.
-#    For ZOAU v1.2.x, the pre-compiled binary is located in the `lib` directory.
-#    e.g ("/usr/lpp/IBM/zoautil/lib" or "{{ ZOAU }}/lib")
+# - Property `PYZ` is the python installation home path on the z/OS managed
+#    (target) node e.g, PYZ: "/usr/lpp/IBM/cyp/v3r12/pyz"
+# - Property `PYZ_VERSION` is the version of python on the z/OS managed
+#    (target) node e.g, PYZ_VERSION: "3.12".
+# - Property `ZOAU` is the ZOAU installation home on the z/OS managed (target)
+#    node, e.g, ZOAU: "/usr/lpp/IBM/zoautil".
+# - Property `ZOAU_PYTHON_LIBRARY_PATH` is the path to the Z Open Automation
+#    Utilities (ZOAU) python library. Specifically, the path points to the
+#    directory containing 'zoautil_py'. Packages installed using 'pip' generally
+#    default to the 'site-packages' directory within the python installation,
+#    eg "/usr/lpp/IBM/cyp/v3r12/pyz/lib/python3.12/site-packages/".
+#    If the installation uses options such as '--user' or '--target', the module
+#    is installed to a non-default location which must be configured in
+#    `ZOAU_PYTHON_LIBRARY_PATH`.
+#    If the wheel installation method is used with the '--target' or '--user'
+#    option, `ZOAU_PYTHON_LIBRARY_PATH` should point to the directory the wheel
+#    file was installed to. e.g ZOAU_PYTHON_LIBRARY_PATH: "/usr/zoau-wheel/".
+#    Else 'ZOAU_PYTHON_LIBRARY_PATH' should point to the directory containing
+#    the pre-compiled binary.
+#    For ZOAU v1.2.x, the pre-compiled binary is located in the 'lib' directory.
+#    e.g "/usr/lpp/IBM/zoautil/lib" or "{{ ZOAU }}/lib".
 #    For ZOAU v1.3.x, the pre-compiled binary is located in a sub-directory
-#    corresponding to the `PYZ_VERSION` inside the `lib` directory,
-#    e.g ("/usr/lpp/IBM/zoautil/lib/3.12" or "{{ ZOAU }}/lib/{{ PYZ_VERSION }}")
+#    corresponding to the `PYZ_VERSION` inside the 'lib' directory,
+#    e.g "/usr/lpp/IBM/zoautil/lib/3.12" or "{{ ZOAU }}/lib/{{ PYZ_VERSION }}".
 # - Property `ansible_python_interpreter` is the z/OS managed node (target) Python
 #    binary installation path, e.g, ansible_python_interpreter: "{{PYZ}}/bin/python3"
 #
@@ -56,6 +59,6 @@ ZOAU: "path_to_zoau_installation_on_zos_target"
 
 ################################################################################
 # Do not configure, variable substitution will correctly set the
-# variable`ansible_python_interpreter`
+# variable `ansible_python_interpreter`
 ################################################################################
 ansible_python_interpreter: "{{ PYZ }}/bin/python3"