search

ansible-collections / community.general

Ansible Community General Collection
https://galaxy.ansible.com/ui/repo/published/community/general/
GNU General Public License v3.0
840 stars 1.54k forks source link

Update M(..) and :seealso: to use FQCN #632

Closed samccann closed 4 years ago

samccann commented 4 years ago
SUMMARY

M() and :seealso: in module docstrings must now use FQCN.

The following M() references need to be updated: grep -rl "M(" ./ ./lookup/etcd3.py ./doc_fragments/docker.py ./doc_fragments/mysql.py ./modules/identity/onepassword_info.py ./modules/system/timezone.py ./modules/system/sefcontext.py ./modules/system/ohai.py ./modules/system/interfaces_file.py ./modules/system/filesystem.py ./modules/notification/say.py ./modules/notification/bearychat.py ./modules/cloud/online/online_user_facts.py ./modules/cloud/online/online_server_facts.py ./modules/cloud/docker/docker_swarm.py ./modules/cloud/docker/docker_image_info.py ./modules/cloud/docker/docker_node.py ./modules/cloud/docker/docker_network.py ./modules/cloud/docker/docker_container_info.py ./modules/cloud/docker/docker_network_info.py ./modules/cloud/docker/docker_container.py ./modules/cloud/google/gcdns_zone.py ./modules/cloud/google/gcdns_record.py ./modules/cloud/google/gcspanner.py ./modules/cloud/google/gcp_target_proxy.py ./modules/cloud/google/gce.py ./modules/cloud/google/gcp_url_map.py ./modules/cloud/lxd/lxd_container.py ./modules/cloud/smartos/smartos_image_info.py ./modules/cloud/scaleway/scaleway_security_group_facts.py ./modules/cloud/scaleway/scaleway_volume_facts.py ./modules/cloud/scaleway/scaleway_image_facts.py ./modules/cloud/scaleway/scaleway_server_facts.py ./modules/cloud/scaleway/scaleway_organization_facts.py ./modules/cloud/scaleway/scaleway_ip_facts.py ./modules/cloud/scaleway/scaleway_snapshot_facts.py ./modules/cloud/misc/ovirt.py ./modules/cloud/misc/helm.py ./modules/cloud/misc/rhevm.py ./modules/cloud/ovirt/ovirt_storage_template_facts.py ./modules/cloud/ovirt/ovirt_scheduling_policy_facts.py ./modules/cloud/ovirt/ovirt_host_storage_facts.py ./modules/cloud/ovirt/ovirt_api_facts.py ./modules/cloud/ovirt/ovirt_group_facts.py ./modules/cloud/ovirt/ovirt_tag_facts.py ./modules/cloud/ovirt/ovirt_storage_vm_facts.py ./modules/cloud/ovirt/ovirt_cluster_facts.py ./modules/cloud/ovirt/ovirt_vm_facts.py ./modules/cloud/ovirt/ovirt_quota_facts.py ./modules/cloud/ovirt/ovirt_host_facts.py ./modules/cloud/ovirt/ovirt_external_provider_facts.py ./modules/cloud/ovirt/ovirt_nic_facts.py ./modules/cloud/ovirt/ovirt_snapshot_facts.py ./modules/cloud/ovirt/ovirt_user_facts.py ./modules/cloud/ovirt/ovirt_network_facts.py ./modules/cloud/ovirt/ovirt_affinity_label_facts.py ./modules/cloud/ovirt/ovirt_permission_facts.py ./modules/cloud/ovirt/ovirt_template_facts.py ./modules/cloud/ovirt/ovirt_disk_facts.py ./modules/cloud/ovirt/ovirt_storage_domain_facts.py ./modules/cloud/ovirt/ovirt_event_facts.py ./modules/cloud/ovirt/ovirt_datacenter_facts.py ./modules/cloud/ovirt/ovirt_vmpool_facts.py ./modules/cloud/xenserver/xenserver_guest.py ./modules/cloud/xenserver/xenserver_guest_powerstate.py ./modules/cloud/xenserver/xenserver_guest_info.py ./modules/cloud/kubevirt/kubevirt_template.py ./modules/cloud/kubevirt/kubevirt_pvc.py ./modules/cloud/kubevirt/kubevirt_vm.py ./modules/storage/purestorage/purefa_facts.py ./modules/storage/purestorage/purefb_facts.py ./modules/storage/netapp/na_ontap_gather_facts.py ./modules/storage/netapp/na_cdot_volume.py ./modules/storage/netapp/sf_volume_access_group_manager.py ./modules/storage/netapp/sf_check_connections.py ./modules/storage/netapp/na_cdot_user.py ./modules/storage/netapp/na_cdot_svm.py ./modules/storage/netapp/na_cdot_qtree.py ./modules/storage/netapp/na_cdot_license.py ./modules/storage/netapp/na_cdot_user_role.py ./modules/storage/netapp/sf_volume_manager.py ./modules/storage/netapp/sf_account_manager.py ./modules/storage/netapp/na_cdot_aggregate.py ./modules/storage/netapp/sf_snapshot_schedule_manager.py ./modules/storage/netapp/na_cdot_lun.py ./modules/storage/glusterfs/gluster_heal_info.py ./modules/database/mssql/mssql_db.py ./modules/database/mysql/mysql_info.py ./modules/database/vertica/vertica_info.py ./modules/database/postgresql/postgresql_pg_hba.py ./modules/database/postgresql/postgresql_membership.py ./modules/database/postgresql/postgresql_query.py ./modules/database/postgresql/postgresql_set.py ./modules/web_infrastructure/deploy_helper.py ./modules/web_infrastructure/nginx_status_facts.py ./modules/web_infrastructure/sophos_utm/utm_dns_host.py ./modules/web_infrastructure/sophos_utm/utm_network_interface_address.py ./modules/web_infrastructure/sophos_utm/utm_proxy_location_info.py ./modules/web_infrastructure/sophos_utm/utm_proxy_frontend.py ./modules/web_infrastructure/sophos_utm/utm_proxy_frontend_info.py ./modules/web_infrastructure/sophos_utm/utm_proxy_exception.py ./modules/web_infrastructure/sophos_utm/utm_proxy_auth_profile.py ./modules/web_infrastructure/sophos_utm/utm_ca_host_key_cert_info.py ./modules/web_infrastructure/sophos_utm/utm_aaa_group.py ./modules/web_infrastructure/sophos_utm/utm_network_interface_address_info.py ./modules/web_infrastructure/sophos_utm/utm_ca_host_key_cert.py ./modules/web_infrastructure/sophos_utm/utm_proxy_location.py ./modules/web_infrastructure/sophos_utm/utm_aaa_group_info.py ./modules/source_control/git_config.py ./modules/source_control/github/github_hooks.py ./modules/files/ini_file.py ./modules/net_tools/ldap/ldap_attr.py ./modules/net_tools/ldap/ldap_entry.py ./modules/net_tools/ldap/ldap_attrs.py ./modules/net_tools/ldap/ldap_passwd.py ./modules/net_tools/hetzner_firewall_info.py ./modules/net_tools/hetzner_firewall.py ./modules/remote_management/hpilo/hpilo_info.py ./modules/remote_management/redfish/idrac_redfish_info.py ./modules/remote_management/redfish/redfish_info.py ./modules/remote_management/imc/imc_rest.py ./modules/remote_management/oneview/oneview_network_set_info.py ./modules/remote_management/oneview/oneview_fcoe_network_info.py ./modules/remote_management/oneview/oneview_datacenter_info.py ./modules/remote_management/oneview/oneview_san_manager_info.py ./modules/remote_management/oneview/oneview_logical_interconnect_group_info.py ./modules/remote_management/oneview/oneview_ethernet_network_info.py ./modules/remote_management/oneview/oneview_fc_network_info.py ./modules/remote_management/oneview/oneview_enclosure_info.py ./modules/packaging/os/flatpak_remote.py ./modules/packaging/os/rhn_register.py ./modules/packaging/os/pulp_repo.py ./modules/packaging/os/svr4pkg.py ./modules/packaging/os/flatpak.py ./modules/packaging/language/easy_install.py ./callback/say.py

The following :seealso: references must be updated:

grep -rl seealso ./ ./lookup/etcd3.py ./modules/system/lvg.py ./modules/database/mysql/mysql_replication.py ./modules/database/mysql/mysql_info.py ./modules/database/mysql/mysql_user.py ./modules/database/mysql/mysql_db.py ./modules/database/mysql/mysql_variables.py ./modules/database/misc/redis_info.py ./modules/database/misc/redis.py ./modules/database/postgresql/postgresql_pg_hba.py ./modules/database/postgresql/postgresql_ping.py ./modules/database/postgresql/postgresql_user.py ./modules/database/postgresql/postgresql_membership.py ./modules/database/postgresql/postgresql_db.py ./modules/database/postgresql/postgresql_sequence.py ./modules/database/postgresql/postgresql_tablespace.py ./modules/database/postgresql/postgresql_slot.py ./modules/database/postgresql/postgresql_owner.py ./modules/database/postgresql/postgresql_publication.py ./modules/database/postgresql/postgresql_info.py ./modules/database/postgresql/postgresql_idx.py ./modules/database/postgresql/postgresql_query.py ./modules/database/postgresql/postgresql_subscription.py ./modules/database/postgresql/postgresql_schema.py ./modules/database/postgresql/postgresql_lang.py ./modules/database/postgresql/postgresql_set.py ./modules/database/postgresql/postgresql_user_obj_stat_info.py ./modules/database/postgresql/postgresql_copy.py ./modules/database/postgresql/postgresql_table.py ./modules/database/postgresql/postgresql_privs.py ./modules/database/postgresql/postgresql_ext.py ./modules/web_infrastructure/jboss.py ./modules/files/archive.py ./modules/files/xml.py ./modules/net_tools/hetzner_failover_ip.py ./modules/net_tools/hetzner_failover_ip_info.py ./modules/net_tools/hetzner_firewall_info.py ./modules/net_tools/hetzner_firewall.py ./modules/remote_management/wakeonlan.py ./callback/diy.py

You may find this set of scripts useful. They would have to be forked for more general use as they were written specifically for the Ansible-maintained collections for their 1.0.0 release:

https://github.com/ansible-network/collection_prep

ISSUE TYPE
COMPONENT NAME
ANSIBLE VERSION
samccann commented 4 years ago

gah... the greps to figure out if these aren't updated are actually: grep -ER ' seealso([^.)]+)' . and grep -ER ' M([^.)]+)' .