Fix M(). (#591)

* Fix M(). * Break long line. * Fix the remaining M(...). * Break long line.
2025-07-25 14:20:22 -07:00 · 2020-06-29 14:59:15 +02:00 · 2020-06-29 14:59:15 +02:00 · 097aebadb0
commit 097aebadb0
parent e3d36a3408
126 changed files with 155 additions and 198 deletions
--- a/plugins/modules/cloud/ovirt/ovirt_affinity_label_facts.py
+++ b/plugins/modules/cloud/ovirt/ovirt_affinity_label_facts.py
@ -30,11 +30,9 @@ author: "Ondra Machacek (@machacekondra)"
 deprecated:
    removed_in: 3.0.0  # was Ansible 2.13
    why: When migrating to collection we decided to use only _info modules.
-    alternative: Use C(ovirt_affinity_label_info) from the C(ovirt.ovirt) collection instead
+    alternative: Use M(ovirt.ovirt.ovirt_affinity_label_info) instead.
 description:
    - "Retrieve information about one or more oVirt/RHV affinity labels."
-    - This module was called C(ovirt_affinity_label_facts) before Ansible 2.9, returning C(ansible_facts).
-      Note that the M(ovirt_affinity_label_info) module no longer returns C(ansible_facts)!
 notes:
    - "This module returns a variable C(ovirt_affinity_labels), which
       contains a list of affinity labels. You need to register the result with
--- a/plugins/modules/cloud/ovirt/ovirt_api_facts.py
+++ b/plugins/modules/cloud/ovirt/ovirt_api_facts.py
@ -15,11 +15,9 @@ author: "Ondra Machacek (@machacekondra)"
 deprecated:
    removed_in: 3.0.0  # was Ansible 2.13
    why: When migrating to collection we decided to use only _info modules.
-    alternative: Use C(ovirt_api_info) from the C(ovirt.ovirt) collection instead
+    alternative: Use M(ovirt.ovirt.ovirt_api_info) instead.
 description:
    - "Retrieve information about the oVirt/RHV API."
-    - This module was called C(ovirt_api_facts) before Ansible 2.9, returning C(ansible_facts).
-      Note that the M(ovirt_api_info) module no longer returns C(ansible_facts)!
 notes:
    - "This module returns a variable C(ovirt_api),
       which contains a information about oVirt/RHV API. You need to register the result with
--- a/plugins/modules/cloud/ovirt/ovirt_cluster_facts.py
+++ b/plugins/modules/cloud/ovirt/ovirt_cluster_facts.py
@ -30,11 +30,9 @@ author: "Ondra Machacek (@machacekondra)"
 deprecated:
    removed_in: 3.0.0  # was Ansible 2.13
    why: When migrating to collection we decided to use only _info modules.
-    alternative: Use C(ovirt_cluster_info) from the C(ovirt.ovirt) collection instead
+    alternative: Use M(ovirt.ovirt.ovirt_cluster_info) instead.
 description:
    - "Retrieve information about one or more oVirt/RHV clusters."
-    - This module was called C(ovirt_cluster_facts) before Ansible 2.9, returning C(ansible_facts).
-      Note that the M(ovirt_cluster_info) module no longer returns C(ansible_facts)!
 notes:
    - "This module returns a variable C(ovirt_clusters), which
       contains a list of clusters. You need to register the result with
--- a/plugins/modules/cloud/ovirt/ovirt_datacenter_facts.py
+++ b/plugins/modules/cloud/ovirt/ovirt_datacenter_facts.py
@ -15,11 +15,9 @@ author: "Ondra Machacek (@machacekondra)"
 deprecated:
    removed_in: 3.0.0  # was Ansible 2.13
    why: When migrating to collection we decided to use only _info modules.
-    alternative: Use C(ovirt_datacenter_info) from the C(ovirt.ovirt) collection instead
+    alternative: Use M(ovirt.ovirt.ovirt_datacenter_info) instead.
 description:
    - "Retrieve information about one or more oVirt/RHV datacenters."
-    - This module was called C(ovirt_datacenter_facts) before Ansible 2.9, returning C(ansible_facts).
-      Note that the M(ovirt_datacenter_info) module no longer returns C(ansible_facts)!
 notes:
    - "This module returns a variable C(ovirt_datacenters), which
       contains a list of datacenters. You need to register the result with
--- a/plugins/modules/cloud/ovirt/ovirt_disk_facts.py
+++ b/plugins/modules/cloud/ovirt/ovirt_disk_facts.py
@ -30,11 +30,9 @@ author: "Katerina Koukiou (@KKoukiou)"
 deprecated:
    removed_in: 3.0.0  # was Ansible 2.13
    why: When migrating to collection we decided to use only _info modules.
-    alternative: Use C(ovirt_disk_info) from the C(ovirt.ovirt) collection instead
+    alternative: Use M(ovirt.ovirt.ovirt_disk_info) instead
 description:
    - "Retrieve information about one or more oVirt/RHV disks."
-    - This module was called C(ovirt_disk_facts) before Ansible 2.9, returning C(ansible_facts).
-      Note that the M(ovirt_disk_info) module no longer returns C(ansible_facts)!
 notes:
    - "This module returns a variable C(ovirt_disks), which
       contains a list of disks. You need to register the result with
--- a/plugins/modules/cloud/ovirt/ovirt_event_facts.py
+++ b/plugins/modules/cloud/ovirt/ovirt_event_facts.py
@ -14,11 +14,9 @@ author: "Chris Keller (@nasx)"
 deprecated:
    removed_in: 3.0.0  # was Ansible 2.13
    why: When migrating to collection we decided to use only _info modules.
-    alternative: Use C(ovirt_event_info) from the C(ovirt.ovirt) collection instead
+    alternative: Use M(ovirt.ovirt.ovirt_event_info) instead.
 description:
    - "Retrieve information about one or more oVirt/RHV events."
-    - This module was called C(ovirt_event_facts) before Ansible 2.9, returning C(ansible_facts).
-      Note that the M(ovirt_event_info) module no longer returns C(ansible_facts)!
 options:
    case_sensitive:
        description:
--- a/plugins/modules/cloud/ovirt/ovirt_external_provider_facts.py
+++ b/plugins/modules/cloud/ovirt/ovirt_external_provider_facts.py
@ -30,11 +30,9 @@ author: "Ondra Machacek (@machacekondra)"
 deprecated:
    removed_in: 3.0.0  # was Ansible 2.13
    why: When migrating to collection we decided to use only _info modules.
-    alternative: Use C(ovirt_external_provider_info) from the C(ovirt.ovirt) collection instead
+    alternative: Use M(ovirt.ovirt.ovirt_external_provider_info) instead.
 description:
    - "Retrieve information about one or more oVirt/RHV external providers."
-    - This module was called C(ovirt_external_provider_facts) before Ansible 2.9, returning C(ansible_facts).
-      Note that the M(ovirt_external_provider_info) module no longer returns C(ansible_facts)!
 notes:
    - "This module returns a variable C(ovirt_external_providers), which
       contains a list of external_providers. You need to register the result with
--- a/plugins/modules/cloud/ovirt/ovirt_group_facts.py
+++ b/plugins/modules/cloud/ovirt/ovirt_group_facts.py
@ -30,11 +30,9 @@ author: "Ondra Machacek (@machacekondra)"
 deprecated:
    removed_in: 3.0.0  # was Ansible 2.13
    why: When migrating to collection we decided to use only _info modules.
-    alternative: Use C(ovirt_group_info) from the C(ovirt.ovirt) collection instead
+    alternative: Use M(ovirt.ovirt.ovirt_group_info) instead.
 description:
    - "Retrieve information about one or more oVirt/RHV groups."
-    - This module was called C(ovirt_group_facts) before Ansible 2.9, returning C(ansible_facts).
-      Note that the M(ovirt_group_info) module no longer returns C(ansible_facts)!
 notes:
    - "This module returns a variable C(ovirt_groups), which
       contains a list of groups. You need to register the result with
--- a/plugins/modules/cloud/ovirt/ovirt_host_facts.py
+++ b/plugins/modules/cloud/ovirt/ovirt_host_facts.py
@ -15,11 +15,9 @@ author: "Ondra Machacek (@machacekondra)"
 deprecated:
    removed_in: 3.0.0  # was Ansible 2.13
    why: When migrating to collection we decided to use only _info modules.
-    alternative: Use C(ovirt_host_info) from the C(ovirt.ovirt) collection instead
+    alternative: Use M(ovirt.ovirt.ovirt_host_info) instead.
 description:
    - "Retrieve information about one or more oVirt/RHV hosts."
-    - This module was called C(ovirt_host_facts) before Ansible 2.9, returning C(ansible_facts).
-      Note that the M(ovirt_host_info) module no longer returns C(ansible_facts)!
 notes:
    - "This module returns a variable C(ovirt_hosts), which
       contains a list of hosts. You need to register the result with
--- a/plugins/modules/cloud/ovirt/ovirt_host_storage_facts.py
+++ b/plugins/modules/cloud/ovirt/ovirt_host_storage_facts.py
@ -15,11 +15,9 @@ author: "Daniel Erez (@derez)"
 deprecated:
    removed_in: 3.0.0  # was Ansible 2.13
    why: When migrating to collection we decided to use only _info modules.
-    alternative: Use C(ovirt_host_storage_info) from the C(ovirt.ovirt) collection instead
+    alternative: Use M(ovirt.ovirt.ovirt_host_storage_info) instead.
 description:
    - "Retrieve information about one or more oVirt/RHV HostStorages (applicable only for block storage)."
-    - This module was called C(ovirt_host_storage_facts) before Ansible 2.9, returning C(ansible_facts).
-      Note that the M(ovirt_host_storage_info) module no longer returns C(ansible_facts)!
 options:
    host:
        description:
--- a/plugins/modules/cloud/ovirt/ovirt_network_facts.py
+++ b/plugins/modules/cloud/ovirt/ovirt_network_facts.py
@ -30,11 +30,9 @@ author: "Ondra Machacek (@machacekondra)"
 deprecated:
    removed_in: 3.0.0  # was Ansible 2.13
    why: When migrating to collection we decided to use only _info modules.
-    alternative: Use C(ovirt_network_info) from the C(ovirt.ovirt) collection instead
+    alternative: Use M(ovirt.ovirt.ovirt_network_info) instead.
 description:
    - "Retrieve information about one or more oVirt/RHV networks."
-    - This module was called C(ovirt_network_facts) before Ansible 2.9, returning C(ansible_facts).
-      Note that the M(ovirt_network_info) module no longer returns C(ansible_facts)!
 notes:
    - "This module returns a variable C(ovirt_networks), which
       contains a list of networks. You need to register the result with
--- a/plugins/modules/cloud/ovirt/ovirt_nic_facts.py
+++ b/plugins/modules/cloud/ovirt/ovirt_nic_facts.py
@ -30,11 +30,9 @@ author: "Ondra Machacek (@machacekondra)"
 deprecated:
    removed_in: 3.0.0  # was Ansible 2.13
    why: When migrating to collection we decided to use only _info modules.
-    alternative: Use C(ovirt_nic_info) from the C(ovirt.ovirt) collection instead
+    alternative: Use M(ovirt.ovirt.ovirt_nic_info) instead.
 description:
    - "Retrieve information about one or more oVirt/RHV virtual machine network interfaces."
-    - This module was called C(ovirt_nic_facts) before Ansible 2.9, returning C(ansible_facts).
-      Note that the M(ovirt_nic_info) module no longer returns C(ansible_facts)!
 notes:
    - "This module returns a variable C(ovirt_nics), which
       contains a list of NICs. You need to register the result with
--- a/plugins/modules/cloud/ovirt/ovirt_permission_facts.py
+++ b/plugins/modules/cloud/ovirt/ovirt_permission_facts.py
@ -30,11 +30,9 @@ author: "Ondra Machacek (@machacekondra)"
 deprecated:
    removed_in: 3.0.0  # was Ansible 2.13
    why: When migrating to collection we decided to use only _info modules.
-    alternative: Use C(ovirt_permission_info) from the C(ovirt.ovirt) collection instead
+    alternative: Use M(ovirt.ovirt.ovirt_permission_info) instead.
 description:
    - "Retrieve information about one or more oVirt/RHV permissions."
-    - This module was called C(ovirt_permission_facts) before Ansible 2.9, returning C(ansible_facts).
-      Note that the M(ovirt_permission_info) module no longer returns C(ansible_facts)!
 notes:
    - "This module returns a variable C(ovirt_permissions), which
       contains a list of permissions. You need to register the result with
--- a/plugins/modules/cloud/ovirt/ovirt_quota_facts.py
+++ b/plugins/modules/cloud/ovirt/ovirt_quota_facts.py
@ -30,11 +30,9 @@ author: "Maor Lipchuk (@machacekondra)"
 deprecated:
    removed_in: 3.0.0  # was Ansible 2.13
    why: When migrating to collection we decided to use only _info modules.
-    alternative: Use C(ovirt_quota_info) from the C(ovirt.ovirt) collection instead
+    alternative: Use M(ovirt.ovirt.ovirt_quota_info) instead.
 description:
    - "Retrieve information about one or more oVirt/RHV quotas."
-    - This module was called C(ovirt_quota_facts) before Ansible 2.9, returning C(ansible_facts).
-      Note that the M(ovirt_quota_info) module no longer returns C(ansible_facts)!
 notes:
    - "This module returns a variable C(ovirt_quotas), which
       contains a list of quotas. You need to register the result with
--- a/plugins/modules/cloud/ovirt/ovirt_scheduling_policy_facts.py
+++ b/plugins/modules/cloud/ovirt/ovirt_scheduling_policy_facts.py
@ -30,11 +30,9 @@ author: "Ondra Machacek (@machacekondra)"
 deprecated:
    removed_in: 3.0.0  # was Ansible 2.13
    why: When migrating to collection we decided to use only _info modules.
-    alternative: Use C(ovirt_scheduling_policy_info) from the C(ovirt.ovirt) collection instead
+    alternative: Use M(ovirt.ovirt.ovirt_scheduling_policy_info) instead.
 description:
    - "Retrieve information about one or more oVirt scheduling policies."
-    - This module was called C(ovirt_scheduling_policy_facts) before Ansible 2.9, returning C(ansible_facts).
-      Note that the M(ovirt_scheduling_policy_info) module no longer returns C(ansible_facts)!
 notes:
    - "This module returns a variable C(ovirt_scheduling_policies),
       which contains a list of scheduling policies. You need to register the result with
--- a/plugins/modules/cloud/ovirt/ovirt_snapshot_facts.py
+++ b/plugins/modules/cloud/ovirt/ovirt_snapshot_facts.py
@ -15,11 +15,9 @@ author: "Ondra Machacek (@machacekondra)"
 deprecated:
    removed_in: 3.0.0  # was Ansible 2.13
    why: When migrating to collection we decided to use only _info modules.
-    alternative: Use C(ovirt_snapshot_info) from the C(ovirt.ovirt) collection instead
+    alternative: Use M(ovirt.ovirt.ovirt_snapshot_info) instead.
 description:
    - "Retrieve information about one or more oVirt/RHV virtual machine snapshots."
-    - This module was called C(ovirt_snapshot_facts) before Ansible 2.9, returning C(ansible_facts).
-      Note that the M(ovirt_snapshot_info) module no longer returns C(ansible_facts)!
 notes:
    - "This module returns a variable C(ovirt_snapshots), which
       contains a list of snapshots. You need to register the result with
--- a/plugins/modules/cloud/ovirt/ovirt_storage_domain_facts.py
+++ b/plugins/modules/cloud/ovirt/ovirt_storage_domain_facts.py
@ -30,11 +30,9 @@ author: "Ondra Machacek (@machacekondra)"
 deprecated:
    removed_in: 3.0.0  # was Ansible 2.13
    why: When migrating to collection we decided to use only _info modules.
-    alternative: Use C(ovirt_storage_domain_info) from the C(ovirt.ovirt) collection instead
+    alternative: Use M(ovirt.ovirt.ovirt_storage_domain_info) instead.
 description:
    - "Retrieve information about one or more oVirt/RHV storage domains."
-    - This module was called C(ovirt_storage_domain_facts) before Ansible 2.9, returning C(ansible_facts).
-      Note that the M(ovirt_storage_domain_info) module no longer returns C(ansible_facts)!
 notes:
    - "This module returns a variable C(ovirt_storage_domains), which
       contains a list of storage domains. You need to register the result with
--- a/plugins/modules/cloud/ovirt/ovirt_storage_template_facts.py
+++ b/plugins/modules/cloud/ovirt/ovirt_storage_template_facts.py
@ -30,11 +30,9 @@ author: "Maor Lipchuk (@machacekondra)"
 deprecated:
    removed_in: 3.0.0  # was Ansible 2.13
    why: When migrating to collection we decided to use only _info modules.
-    alternative: Use C(ovirt_storage_template_info) from the C(ovirt.ovirt) collection instead
+    alternative: Use M(ovirt.ovirt.ovirt_storage_template_info) instead.
 description:
    - "Retrieve information about one or more oVirt/RHV templates relate to a storage domain."
-    - This module was called C(ovirt_storage_template_facts) before Ansible 2.9, returning C(ansible_facts).
-      Note that the M(ovirt_storage_template_info) module no longer returns C(ansible_facts)!
 notes:
    - "This module returns a variable C(ovirt_storage_templates), which
       contains a list of templates. You need to register the result with
--- a/plugins/modules/cloud/ovirt/ovirt_storage_vm_facts.py
+++ b/plugins/modules/cloud/ovirt/ovirt_storage_vm_facts.py
@ -30,11 +30,9 @@ author: "Maor Lipchuk (@machacekondra)"
 deprecated:
    removed_in: 3.0.0  # was Ansible 2.13
    why: When migrating to collection we decided to use only _info modules.
-    alternative: Use C(ovirt_storage_vm_info) from the C(ovirt.ovirt) collection instead
+    alternative: Use M(ovirt.ovirt.ovirt_storage_vm_info) instead.
 description:
    - "Retrieve information about one or more oVirt/RHV virtual machines relate to a storage domain."
-    - This module was called C(ovirt_storage_vm_facts) before Ansible 2.9, returning C(ansible_facts).
-      Note that the M(ovirt_storage_vm_info) module no longer returns C(ansible_facts)!
 notes:
    - "This module returns a variable C(ovirt_storage_vms), which
       contains a list of virtual machines. You need to register the result with
--- a/plugins/modules/cloud/ovirt/ovirt_tag_facts.py
+++ b/plugins/modules/cloud/ovirt/ovirt_tag_facts.py
@ -30,11 +30,9 @@ author: "Ondra Machacek (@machacekondra)"
 deprecated:
    removed_in: 3.0.0  # was Ansible 2.13
    why: When migrating to collection we decided to use only _info modules.
-    alternative: Use C(ovirt_tag_info) from the C(ovirt.ovirt) collection instead
+    alternative: Use M(ovirt.ovirt.ovirt_tag_info) instead.
 description:
    - "Retrieve information about one or more oVirt/RHV tags."
-    - This module was called C(ovirt_tag_facts) before Ansible 2.9, returning C(ansible_facts).
-      Note that the M(ovirt_tag_info) module no longer returns C(ansible_facts)!
 notes:
    - "This module returns a variable C(ovirt_tags), which
       contains a list of tags. You need to register the result with
--- a/plugins/modules/cloud/ovirt/ovirt_template_facts.py
+++ b/plugins/modules/cloud/ovirt/ovirt_template_facts.py
@ -30,11 +30,9 @@ author: "Ondra Machacek (@machacekondra)"
 deprecated:
    removed_in: 3.0.0  # was Ansible 2.13
    why: When migrating to collection we decided to use only _info modules.
-    alternative: Use C(ovirt_template_info) from the C(ovirt.ovirt) collection instead
+    alternative: Use M(ovirt.ovirt.ovirt_template_info) instead.
 description:
    - "Retrieve information about one or more oVirt/RHV templates."
-    - This module was called C(ovirt_template_facts) before Ansible 2.9, returning C(ansible_facts).
-      Note that the M(ovirt_template_info) module no longer returns C(ansible_facts)!
 notes:
    - "This module returns a variable C(ovirt_templates), which
       contains a list of templates. You need to register the result with
--- a/plugins/modules/cloud/ovirt/ovirt_user_facts.py
+++ b/plugins/modules/cloud/ovirt/ovirt_user_facts.py
@ -30,11 +30,9 @@ author: "Ondra Machacek (@machacekondra)"
 deprecated:
    removed_in: 3.0.0  # was Ansible 2.13
    why: When migrating to collection we decided to use only _info modules.
-    alternative: Use C(ovirt_user_info) from the C(ovirt.ovirt) collection instead
+    alternative: Use M(ovirt.ovirt.ovirt_user_info) instead.
 description:
    - "Retrieve information about one or more oVirt/RHV users."
-    - This module was called C(ovirt_user_facts) before Ansible 2.9, returning C(ansible_facts).
-      Note that the M(ovirt_user_info) module no longer returns C(ansible_facts)!
 notes:
    - "This module returns a variable C(ovirt_users), which
       contains a list of users. You need to register the result with
--- a/plugins/modules/cloud/ovirt/ovirt_vm_facts.py
+++ b/plugins/modules/cloud/ovirt/ovirt_vm_facts.py
@ -30,11 +30,9 @@ author: "Ondra Machacek (@machacekondra)"
 deprecated:
    removed_in: 3.0.0  # was Ansible 2.13
    why: When migrating to collection we decided to use only _info modules.
-    alternative: Use C(ovirt_vm_info) from the C(ovirt.ovirt) collection instead
+    alternative: Use M(ovirt.ovirt.ovirt_vm_info) instead.
 description:
    - "Retrieve information about one or more oVirt/RHV virtual machines."
-    - This module was called C(ovirt_vm_facts) before Ansible 2.9, returning C(ansible_facts).
-      Note that the M(ovirt_vm_info) module no longer returns C(ansible_facts)!
 notes:
    - "This module returns a variable C(ovirt_vms), which
       contains a list of virtual machines. You need to register the result with
--- a/plugins/modules/cloud/ovirt/ovirt_vmpool_facts.py
+++ b/plugins/modules/cloud/ovirt/ovirt_vmpool_facts.py
@ -30,11 +30,9 @@ author: "Ondra Machacek (@machacekondra)"
 deprecated:
    removed_in: 3.0.0  # was Ansible 2.13
    why: When migrating to collection we decided to use only _info modules.
-    alternative: Use C(ovirt_vmpool_info) from the C(ovirt.ovirt) collection instead
+    alternative: Use M(ovirt.ovirt.ovirt_vmpool_info) instead.
 description:
    - "Retrieve information about one or more oVirt/RHV vmpools."
-    - This module was called C(ovirt_vmpool_facts) before Ansible 2.9, returning C(ansible_facts).
-      Note that the M(ovirt_vmpool_info) module no longer returns C(ansible_facts)!
 notes:
    - "This module returns a variable C(ovirt_vmpools), which
       contains a list of vmpools. You need to register the result with