From 01a5e900ca5e3ba7d603f628000275ad97a5e744 Mon Sep 17 00:00:00 2001 From: Felix Fontein Date: Thu, 21 Nov 2024 06:22:00 +0100 Subject: [PATCH] Consider action plugin redirects (#360) * Consider action plugin redirects. * Add tests. --- changelogs/fragments/360-action-modules.yml | 6 +++ src/antsibull_docs/docs_parsing/routing.py | 37 +++++++++++++++---- .../collections/ns2/col/foo2_module.rst | 1 + .../ns2/col/foo_1_redirect_module.rst | 25 +++++++++++++ .../ns2/col/foo_2_redirect_module.rst | 25 +++++++++++++ .../ns2/col/foo_3_redirect_module.rst | 25 +++++++++++++ .../ns2/col/foo_4_redirect_module.rst | 24 ++++++++++++ .../ns2/col/foo_5_redirect_module.rst | 27 ++++++++++++++ .../collections/ns2/col/foo_module.rst | 2 +- .../collections/ns2/col/foo2_module.rst | 1 + .../ns2/col/foo_1_redirect_module.rst | 25 +++++++++++++ .../ns2/col/foo_2_redirect_module.rst | 25 +++++++++++++ .../ns2/col/foo_3_redirect_module.rst | 25 +++++++++++++ .../ns2/col/foo_4_redirect_module.rst | 24 ++++++++++++ .../ns2/col/foo_5_redirect_module.rst | 27 ++++++++++++++ .../collections/ns2/col/foo_module.rst | 2 +- .../collections/ns2/col/foo2_module.rst | 1 + .../ns2/col/foo_1_redirect_module.rst | 22 +++++++++++ .../ns2/col/foo_2_redirect_module.rst | 22 +++++++++++ .../ns2/col/foo_3_redirect_module.rst | 22 +++++++++++ .../ns2/col/foo_4_redirect_module.rst | 21 +++++++++++ .../ns2/col/foo_5_redirect_module.rst | 24 ++++++++++++ .../collections/ns2/col/foo_module.rst | 2 +- .../foo2_module.rst | 1 + .../foo_1_redirect_module.rst | 11 ++++++ .../foo_2_redirect_module.rst | 11 ++++++ .../foo_3_redirect_module.rst | 11 ++++++ .../foo_4_redirect_module.rst | 10 +++++ .../foo_5_redirect_module.rst | 13 +++++++ .../foo_module.rst | 2 +- .../collections/ns2/col/foo2_module.rst | 1 + .../ns2/col/foo_1_redirect_module.rst | 11 ++++++ .../ns2/col/foo_2_redirect_module.rst | 11 ++++++ .../ns2/col/foo_3_redirect_module.rst | 11 ++++++ .../ns2/col/foo_4_redirect_module.rst | 10 +++++ .../ns2/col/foo_5_redirect_module.rst | 13 +++++++ .../collections/ns2/col/foo_module.rst | 2 +- .../baseline-squash-hierarchy/foo2_module.rst | 1 + .../foo_1_redirect_module.rst | 25 +++++++++++++ .../foo_2_redirect_module.rst | 25 +++++++++++++ .../foo_3_redirect_module.rst | 25 +++++++++++++ .../foo_4_redirect_module.rst | 24 ++++++++++++ .../foo_5_redirect_module.rst | 27 ++++++++++++++ .../baseline-squash-hierarchy/foo_module.rst | 2 +- .../collections/ns2/col/foo2_module.rst | 1 + .../ns2/col/foo_1_redirect_module.rst | 25 +++++++++++++ .../ns2/col/foo_2_redirect_module.rst | 25 +++++++++++++ .../ns2/col/foo_3_redirect_module.rst | 25 +++++++++++++ .../ns2/col/foo_4_redirect_module.rst | 24 ++++++++++++ .../ns2/col/foo_5_redirect_module.rst | 27 ++++++++++++++ .../collections/ns2/col/foo_module.rst | 2 +- .../ns2/col/meta/runtime.yml | 24 ++++++++++++ 52 files changed, 800 insertions(+), 15 deletions(-) create mode 100644 changelogs/fragments/360-action-modules.yml create mode 100644 tests/functional/baseline-default/collections/ns2/col/foo_1_redirect_module.rst create mode 100644 tests/functional/baseline-default/collections/ns2/col/foo_2_redirect_module.rst create mode 100644 tests/functional/baseline-default/collections/ns2/col/foo_3_redirect_module.rst create mode 100644 tests/functional/baseline-default/collections/ns2/col/foo_4_redirect_module.rst create mode 100644 tests/functional/baseline-default/collections/ns2/col/foo_5_redirect_module.rst create mode 100644 tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_1_redirect_module.rst create mode 100644 tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_2_redirect_module.rst create mode 100644 tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_3_redirect_module.rst create mode 100644 tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_4_redirect_module.rst create mode 100644 tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_5_redirect_module.rst create mode 100644 tests/functional/baseline-no-indexes/collections/ns2/col/foo_1_redirect_module.rst create mode 100644 tests/functional/baseline-no-indexes/collections/ns2/col/foo_2_redirect_module.rst create mode 100644 tests/functional/baseline-no-indexes/collections/ns2/col/foo_3_redirect_module.rst create mode 100644 tests/functional/baseline-no-indexes/collections/ns2/col/foo_4_redirect_module.rst create mode 100644 tests/functional/baseline-no-indexes/collections/ns2/col/foo_5_redirect_module.rst create mode 100644 tests/functional/baseline-simplified-rst-squash-hierarchy/foo_1_redirect_module.rst create mode 100644 tests/functional/baseline-simplified-rst-squash-hierarchy/foo_2_redirect_module.rst create mode 100644 tests/functional/baseline-simplified-rst-squash-hierarchy/foo_3_redirect_module.rst create mode 100644 tests/functional/baseline-simplified-rst-squash-hierarchy/foo_4_redirect_module.rst create mode 100644 tests/functional/baseline-simplified-rst-squash-hierarchy/foo_5_redirect_module.rst create mode 100644 tests/functional/baseline-simplified-rst/collections/ns2/col/foo_1_redirect_module.rst create mode 100644 tests/functional/baseline-simplified-rst/collections/ns2/col/foo_2_redirect_module.rst create mode 100644 tests/functional/baseline-simplified-rst/collections/ns2/col/foo_3_redirect_module.rst create mode 100644 tests/functional/baseline-simplified-rst/collections/ns2/col/foo_4_redirect_module.rst create mode 100644 tests/functional/baseline-simplified-rst/collections/ns2/col/foo_5_redirect_module.rst create mode 100644 tests/functional/baseline-squash-hierarchy/foo_1_redirect_module.rst create mode 100644 tests/functional/baseline-squash-hierarchy/foo_2_redirect_module.rst create mode 100644 tests/functional/baseline-squash-hierarchy/foo_3_redirect_module.rst create mode 100644 tests/functional/baseline-squash-hierarchy/foo_4_redirect_module.rst create mode 100644 tests/functional/baseline-squash-hierarchy/foo_5_redirect_module.rst create mode 100644 tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_1_redirect_module.rst create mode 100644 tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_2_redirect_module.rst create mode 100644 tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_3_redirect_module.rst create mode 100644 tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_4_redirect_module.rst create mode 100644 tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_5_redirect_module.rst diff --git a/changelogs/fragments/360-action-modules.yml b/changelogs/fragments/360-action-modules.yml new file mode 100644 index 00000000..f28a18e2 --- /dev/null +++ b/changelogs/fragments/360-action-modules.yml @@ -0,0 +1,6 @@ +bugfixes: + - "Also consider action plugin redirects/deprecations in runtime metadata for modules, + since for users there is no difference. Also ``ansible.builtin.yum`` only has a action + plugin redirect to ``ansible.builtin.dnf``, so this is needed to ensure that a stub + page generated for ``ansible.builtin.yum`` + (https://github.com/ansible-community/antsibull-docs/pull/360)." diff --git a/src/antsibull_docs/docs_parsing/routing.py b/src/antsibull_docs/docs_parsing/routing.py index 8da11195..92dbb2ad 100644 --- a/src/antsibull_docs/docs_parsing/routing.py +++ b/src/antsibull_docs/docs_parsing/routing.py @@ -44,6 +44,8 @@ "community.network", ) +_DOCUMENTABLE_PLUGINS_WITH_ACTION = frozenset(tuple(DOCUMENTABLE_PLUGINS) + ("action",)) + def calculate_plugin_fqcns( collection_name: str, src_basename: str, dst_basename: str, rel_path: str @@ -242,7 +244,7 @@ def _add_symlink_redirects( collection_metadata: AnsibleCollectionMetadata, plugin_routing_out: dict[str, dict[str, dict[str, t.Any]]], ) -> None: - for plugin_type in DOCUMENTABLE_PLUGINS: + for plugin_type in _DOCUMENTABLE_PLUGINS_WITH_ACTION: directory_name = "modules" if plugin_type == "module" else plugin_type directory_path = os.path.join( collection_metadata.path, "plugins", directory_name @@ -265,7 +267,7 @@ def _add_core_symlink_redirects( collection_metadata: AnsibleCollectionMetadata, plugin_routing_out: dict[str, dict[str, dict[str, t.Any]]], ) -> None: - for plugin_type in DOCUMENTABLE_PLUGINS: + for plugin_type in _DOCUMENTABLE_PLUGINS_WITH_ACTION: directory_name = ( "modules" if plugin_type == "module" @@ -284,6 +286,23 @@ def _add_core_symlink_redirects( plugin_type_routing[redirect_name]["redirect"] = redirect_dst +def _merge_action_into_modules( + plugin_routing_out: dict[str, dict[str, dict[str, t.Any]]] +) -> None: + """ + Merge 'action' routing info into 'modules' routing info. + + Entries in 'action' trump over the corresponding entries in 'modules' + when resolving actions, which is what modules look like to users. + """ + action_routing = plugin_routing_out.pop("action") + module_routing = plugin_routing_out["module"] + for plugin_name, plugin_data in action_routing.items(): + if plugin_name not in module_routing: + module_routing[plugin_name] = {} + module_routing[plugin_name].update(plugin_data) + + async def load_collection_routing( collection_name: str, collection_metadata: AnsibleCollectionMetadata ) -> dict[str, dict[str, dict[str, t.Any]]]: @@ -293,7 +312,7 @@ async def load_collection_routing( meta_runtime = load_meta_runtime(collection_name, collection_metadata) plugin_routing_out: dict[str, dict[str, dict[str, t.Any]]] = {} plugin_routing_in = meta_runtime.get("plugin_routing") or {} - for plugin_type in DOCUMENTABLE_PLUGINS: + for plugin_type in _DOCUMENTABLE_PLUGINS_WITH_ACTION: plugin_type_id = "modules" if plugin_type == "module" else plugin_type plugin_type_routing = plugin_routing_in.get(plugin_type_id) or {} plugin_routing_out[plugin_type] = { @@ -301,17 +320,19 @@ async def load_collection_routing( for plugin_name, plugin_record in plugin_type_routing.items() } + # TODO collapse action + modules + if collection_name == "ansible.builtin": # ansible-core has a special directory structure we currently do not want # (or need) to handle _add_core_symlink_redirects(collection_metadata, plugin_routing_out) - return plugin_routing_out - - _add_symlink_redirects(collection_name, collection_metadata, plugin_routing_out) + else: + _add_symlink_redirects(collection_name, collection_metadata, plugin_routing_out) - if collection_name in COLLECTIONS_WITH_FLATMAPPING: - remove_flatmapping_artifacts(plugin_routing_out) + if collection_name in COLLECTIONS_WITH_FLATMAPPING: + remove_flatmapping_artifacts(plugin_routing_out) + _merge_action_into_modules(plugin_routing_out) return plugin_routing_out diff --git a/tests/functional/baseline-default/collections/ns2/col/foo2_module.rst b/tests/functional/baseline-default/collections/ns2/col/foo2_module.rst index 3a4da710..6d7d21e4 100644 --- a/tests/functional/baseline-default/collections/ns2/col/foo2_module.rst +++ b/tests/functional/baseline-default/collections/ns2/col/foo2_module.rst @@ -54,6 +54,7 @@ Synopsis .. Aliases +Aliases: foo_3_redirect, foo_4_redirect, foo_5_redirect .. Requirements diff --git a/tests/functional/baseline-default/collections/ns2/col/foo_1_redirect_module.rst b/tests/functional/baseline-default/collections/ns2/col/foo_1_redirect_module.rst new file mode 100644 index 00000000..c02a1077 --- /dev/null +++ b/tests/functional/baseline-default/collections/ns2/col/foo_1_redirect_module.rst @@ -0,0 +1,25 @@ +.. Document meta + +:orphan: + +.. meta:: + :antsibull-docs: + +.. Anchors + +.. _ansible_collections.ns2.col.foo_1_redirect_module: + +.. Title + +ns2.col.foo_1_redirect module ++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This redirect is part of the `ns2.col collection `_ (version 2.1.0). + + To use it in a playbook, specify: :code:`ns2.col.foo_1_redirect`. + +- This is a redirect to the :ansplugin:`ns2.col.foo module `. +- This redirect does **not** work with Ansible 2.9. diff --git a/tests/functional/baseline-default/collections/ns2/col/foo_2_redirect_module.rst b/tests/functional/baseline-default/collections/ns2/col/foo_2_redirect_module.rst new file mode 100644 index 00000000..bc4545a2 --- /dev/null +++ b/tests/functional/baseline-default/collections/ns2/col/foo_2_redirect_module.rst @@ -0,0 +1,25 @@ +.. Document meta + +:orphan: + +.. meta:: + :antsibull-docs: + +.. Anchors + +.. _ansible_collections.ns2.col.foo_2_redirect_module: + +.. Title + +ns2.col.foo_2_redirect module ++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This redirect is part of the `ns2.col collection `_ (version 2.1.0). + + To use it in a playbook, specify: :code:`ns2.col.foo_2_redirect`. + +- This is a redirect to the :ansplugin:`ns2.col.foo module `. +- This redirect does **not** work with Ansible 2.9. diff --git a/tests/functional/baseline-default/collections/ns2/col/foo_3_redirect_module.rst b/tests/functional/baseline-default/collections/ns2/col/foo_3_redirect_module.rst new file mode 100644 index 00000000..fd40a53e --- /dev/null +++ b/tests/functional/baseline-default/collections/ns2/col/foo_3_redirect_module.rst @@ -0,0 +1,25 @@ +.. Document meta + +:orphan: + +.. meta:: + :antsibull-docs: + +.. Anchors + +.. _ansible_collections.ns2.col.foo_3_redirect_module: + +.. Title + +ns2.col.foo_3_redirect module ++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This redirect is part of the `ns2.col collection `_ (version 2.1.0). + + To use it in a playbook, specify: :code:`ns2.col.foo_3_redirect`. + +- This is a redirect to the :ansplugin:`ns2.col.foo2 module `. +- This redirect does **not** work with Ansible 2.9. diff --git a/tests/functional/baseline-default/collections/ns2/col/foo_4_redirect_module.rst b/tests/functional/baseline-default/collections/ns2/col/foo_4_redirect_module.rst new file mode 100644 index 00000000..b3ae7f2b --- /dev/null +++ b/tests/functional/baseline-default/collections/ns2/col/foo_4_redirect_module.rst @@ -0,0 +1,24 @@ +.. Document meta + +:orphan: + +.. meta:: + :antsibull-docs: + +.. Anchors + +.. _ansible_collections.ns2.col.foo_4_redirect_module: + +.. Title + +ns2.col.foo_4_redirect +++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin was part of the `ns2.col collection `_ (version 2.1.0). + +This module has been removed +in version 2.0.0 of ns2.col. +It is gone diff --git a/tests/functional/baseline-default/collections/ns2/col/foo_5_redirect_module.rst b/tests/functional/baseline-default/collections/ns2/col/foo_5_redirect_module.rst new file mode 100644 index 00000000..a70101be --- /dev/null +++ b/tests/functional/baseline-default/collections/ns2/col/foo_5_redirect_module.rst @@ -0,0 +1,27 @@ +.. Document meta + +:orphan: + +.. meta:: + :antsibull-docs: + +.. Anchors + +.. _ansible_collections.ns2.col.foo_5_redirect_module: + +.. Title + +ns2.col.foo_5_redirect module ++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This redirect is part of the `ns2.col collection `_ (version 2.1.0). + + +- This redirect has been **deprecated**. Please update your tasks to use the new name ``ns2.col.foo2`` instead. + It will be removed in version 5.0.0 of ns2.col. +- This is a redirect to the :ansplugin:`ns2.col.foo2 module `. +- This redirect does **not** work with Ansible 2.9. +- The collection contains the following information on this deprecation: It will be really gone diff --git a/tests/functional/baseline-default/collections/ns2/col/foo_module.rst b/tests/functional/baseline-default/collections/ns2/col/foo_module.rst index f96918c2..36367cc7 100644 --- a/tests/functional/baseline-default/collections/ns2/col/foo_module.rst +++ b/tests/functional/baseline-default/collections/ns2/col/foo_module.rst @@ -59,7 +59,7 @@ Synopsis .. Aliases -Aliases: foo_redirect +Aliases: foo_1_redirect, foo_2_redirect, foo_redirect .. Requirements diff --git a/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo2_module.rst b/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo2_module.rst index 3a4da710..6d7d21e4 100644 --- a/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo2_module.rst +++ b/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo2_module.rst @@ -54,6 +54,7 @@ Synopsis .. Aliases +Aliases: foo_3_redirect, foo_4_redirect, foo_5_redirect .. Requirements diff --git a/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_1_redirect_module.rst b/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_1_redirect_module.rst new file mode 100644 index 00000000..c02a1077 --- /dev/null +++ b/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_1_redirect_module.rst @@ -0,0 +1,25 @@ +.. Document meta + +:orphan: + +.. meta:: + :antsibull-docs: + +.. Anchors + +.. _ansible_collections.ns2.col.foo_1_redirect_module: + +.. Title + +ns2.col.foo_1_redirect module ++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This redirect is part of the `ns2.col collection `_ (version 2.1.0). + + To use it in a playbook, specify: :code:`ns2.col.foo_1_redirect`. + +- This is a redirect to the :ansplugin:`ns2.col.foo module `. +- This redirect does **not** work with Ansible 2.9. diff --git a/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_2_redirect_module.rst b/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_2_redirect_module.rst new file mode 100644 index 00000000..bc4545a2 --- /dev/null +++ b/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_2_redirect_module.rst @@ -0,0 +1,25 @@ +.. Document meta + +:orphan: + +.. meta:: + :antsibull-docs: + +.. Anchors + +.. _ansible_collections.ns2.col.foo_2_redirect_module: + +.. Title + +ns2.col.foo_2_redirect module ++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This redirect is part of the `ns2.col collection `_ (version 2.1.0). + + To use it in a playbook, specify: :code:`ns2.col.foo_2_redirect`. + +- This is a redirect to the :ansplugin:`ns2.col.foo module `. +- This redirect does **not** work with Ansible 2.9. diff --git a/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_3_redirect_module.rst b/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_3_redirect_module.rst new file mode 100644 index 00000000..fd40a53e --- /dev/null +++ b/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_3_redirect_module.rst @@ -0,0 +1,25 @@ +.. Document meta + +:orphan: + +.. meta:: + :antsibull-docs: + +.. Anchors + +.. _ansible_collections.ns2.col.foo_3_redirect_module: + +.. Title + +ns2.col.foo_3_redirect module ++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This redirect is part of the `ns2.col collection `_ (version 2.1.0). + + To use it in a playbook, specify: :code:`ns2.col.foo_3_redirect`. + +- This is a redirect to the :ansplugin:`ns2.col.foo2 module `. +- This redirect does **not** work with Ansible 2.9. diff --git a/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_4_redirect_module.rst b/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_4_redirect_module.rst new file mode 100644 index 00000000..b3ae7f2b --- /dev/null +++ b/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_4_redirect_module.rst @@ -0,0 +1,24 @@ +.. Document meta + +:orphan: + +.. meta:: + :antsibull-docs: + +.. Anchors + +.. _ansible_collections.ns2.col.foo_4_redirect_module: + +.. Title + +ns2.col.foo_4_redirect +++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin was part of the `ns2.col collection `_ (version 2.1.0). + +This module has been removed +in version 2.0.0 of ns2.col. +It is gone diff --git a/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_5_redirect_module.rst b/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_5_redirect_module.rst new file mode 100644 index 00000000..a70101be --- /dev/null +++ b/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_5_redirect_module.rst @@ -0,0 +1,27 @@ +.. Document meta + +:orphan: + +.. meta:: + :antsibull-docs: + +.. Anchors + +.. _ansible_collections.ns2.col.foo_5_redirect_module: + +.. Title + +ns2.col.foo_5_redirect module ++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This redirect is part of the `ns2.col collection `_ (version 2.1.0). + + +- This redirect has been **deprecated**. Please update your tasks to use the new name ``ns2.col.foo2`` instead. + It will be removed in version 5.0.0 of ns2.col. +- This is a redirect to the :ansplugin:`ns2.col.foo2 module `. +- This redirect does **not** work with Ansible 2.9. +- The collection contains the following information on this deprecation: It will be really gone diff --git a/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_module.rst b/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_module.rst index f96918c2..36367cc7 100644 --- a/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_module.rst +++ b/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_module.rst @@ -59,7 +59,7 @@ Synopsis .. Aliases -Aliases: foo_redirect +Aliases: foo_1_redirect, foo_2_redirect, foo_redirect .. Requirements diff --git a/tests/functional/baseline-no-indexes/collections/ns2/col/foo2_module.rst b/tests/functional/baseline-no-indexes/collections/ns2/col/foo2_module.rst index c535ec76..801e8fa3 100644 --- a/tests/functional/baseline-no-indexes/collections/ns2/col/foo2_module.rst +++ b/tests/functional/baseline-no-indexes/collections/ns2/col/foo2_module.rst @@ -51,6 +51,7 @@ Synopsis .. Aliases +Aliases: foo_3_redirect, foo_4_redirect, foo_5_redirect .. Requirements diff --git a/tests/functional/baseline-no-indexes/collections/ns2/col/foo_1_redirect_module.rst b/tests/functional/baseline-no-indexes/collections/ns2/col/foo_1_redirect_module.rst new file mode 100644 index 00000000..40a4cc40 --- /dev/null +++ b/tests/functional/baseline-no-indexes/collections/ns2/col/foo_1_redirect_module.rst @@ -0,0 +1,22 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ns2.col.foo_1_redirect_module: + +.. Title + +ns2.col.foo_1_redirect module ++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This redirect is part of the `ns2.col collection `_ (version 2.1.0). + + To use it in a playbook, specify: :code:`ns2.col.foo_1_redirect`. + +- This is a redirect to the :ansplugin:`ns2.col.foo module `. +- This redirect does **not** work with Ansible 2.9. diff --git a/tests/functional/baseline-no-indexes/collections/ns2/col/foo_2_redirect_module.rst b/tests/functional/baseline-no-indexes/collections/ns2/col/foo_2_redirect_module.rst new file mode 100644 index 00000000..14bce60b --- /dev/null +++ b/tests/functional/baseline-no-indexes/collections/ns2/col/foo_2_redirect_module.rst @@ -0,0 +1,22 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ns2.col.foo_2_redirect_module: + +.. Title + +ns2.col.foo_2_redirect module ++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This redirect is part of the `ns2.col collection `_ (version 2.1.0). + + To use it in a playbook, specify: :code:`ns2.col.foo_2_redirect`. + +- This is a redirect to the :ansplugin:`ns2.col.foo module `. +- This redirect does **not** work with Ansible 2.9. diff --git a/tests/functional/baseline-no-indexes/collections/ns2/col/foo_3_redirect_module.rst b/tests/functional/baseline-no-indexes/collections/ns2/col/foo_3_redirect_module.rst new file mode 100644 index 00000000..4b2fac06 --- /dev/null +++ b/tests/functional/baseline-no-indexes/collections/ns2/col/foo_3_redirect_module.rst @@ -0,0 +1,22 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ns2.col.foo_3_redirect_module: + +.. Title + +ns2.col.foo_3_redirect module ++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This redirect is part of the `ns2.col collection `_ (version 2.1.0). + + To use it in a playbook, specify: :code:`ns2.col.foo_3_redirect`. + +- This is a redirect to the :ansplugin:`ns2.col.foo2 module `. +- This redirect does **not** work with Ansible 2.9. diff --git a/tests/functional/baseline-no-indexes/collections/ns2/col/foo_4_redirect_module.rst b/tests/functional/baseline-no-indexes/collections/ns2/col/foo_4_redirect_module.rst new file mode 100644 index 00000000..08feb99e --- /dev/null +++ b/tests/functional/baseline-no-indexes/collections/ns2/col/foo_4_redirect_module.rst @@ -0,0 +1,21 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ns2.col.foo_4_redirect_module: + +.. Title + +ns2.col.foo_4_redirect +++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin was part of the `ns2.col collection `_ (version 2.1.0). + +This module has been removed +in version 2.0.0 of ns2.col. +It is gone diff --git a/tests/functional/baseline-no-indexes/collections/ns2/col/foo_5_redirect_module.rst b/tests/functional/baseline-no-indexes/collections/ns2/col/foo_5_redirect_module.rst new file mode 100644 index 00000000..59b5c9df --- /dev/null +++ b/tests/functional/baseline-no-indexes/collections/ns2/col/foo_5_redirect_module.rst @@ -0,0 +1,24 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ns2.col.foo_5_redirect_module: + +.. Title + +ns2.col.foo_5_redirect module ++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This redirect is part of the `ns2.col collection `_ (version 2.1.0). + + +- This redirect has been **deprecated**. Please update your tasks to use the new name ``ns2.col.foo2`` instead. + It will be removed in version 5.0.0 of ns2.col. +- This is a redirect to the :ansplugin:`ns2.col.foo2 module `. +- This redirect does **not** work with Ansible 2.9. +- The collection contains the following information on this deprecation: It will be really gone diff --git a/tests/functional/baseline-no-indexes/collections/ns2/col/foo_module.rst b/tests/functional/baseline-no-indexes/collections/ns2/col/foo_module.rst index ea3795c1..f5c2011e 100644 --- a/tests/functional/baseline-no-indexes/collections/ns2/col/foo_module.rst +++ b/tests/functional/baseline-no-indexes/collections/ns2/col/foo_module.rst @@ -56,7 +56,7 @@ Synopsis .. Aliases -Aliases: foo_redirect +Aliases: foo_1_redirect, foo_2_redirect, foo_redirect .. Requirements diff --git a/tests/functional/baseline-simplified-rst-squash-hierarchy/foo2_module.rst b/tests/functional/baseline-simplified-rst-squash-hierarchy/foo2_module.rst index 5024b73d..ff4e6414 100644 --- a/tests/functional/baseline-simplified-rst-squash-hierarchy/foo2_module.rst +++ b/tests/functional/baseline-simplified-rst-squash-hierarchy/foo2_module.rst @@ -26,6 +26,7 @@ Synopsis - Reference using alias - :literal:`bar` (of module `ns2.col.foo\_redirect `__) and :literal:`baz` (of module `ns2.col.foo\_redirect `__). +Aliases: foo_3_redirect, foo_4_redirect, foo_5_redirect diff --git a/tests/functional/baseline-simplified-rst-squash-hierarchy/foo_1_redirect_module.rst b/tests/functional/baseline-simplified-rst-squash-hierarchy/foo_1_redirect_module.rst new file mode 100644 index 00000000..138b3565 --- /dev/null +++ b/tests/functional/baseline-simplified-rst-squash-hierarchy/foo_1_redirect_module.rst @@ -0,0 +1,11 @@ +.. Created with antsibull-docs + +ns2.col.foo_1_redirect module ++++++++++++++++++++++++++++++ + +- This redirect is part of the `ns2.col collection `_ (version 2.1.0). + + To use it in a playbook, specify: ``ns2.col.foo_1_redirect``. + +- This is a redirect to the ns2.col.foo module. +- This redirect does **not** work with Ansible 2.9. diff --git a/tests/functional/baseline-simplified-rst-squash-hierarchy/foo_2_redirect_module.rst b/tests/functional/baseline-simplified-rst-squash-hierarchy/foo_2_redirect_module.rst new file mode 100644 index 00000000..1b785bc0 --- /dev/null +++ b/tests/functional/baseline-simplified-rst-squash-hierarchy/foo_2_redirect_module.rst @@ -0,0 +1,11 @@ +.. Created with antsibull-docs + +ns2.col.foo_2_redirect module ++++++++++++++++++++++++++++++ + +- This redirect is part of the `ns2.col collection `_ (version 2.1.0). + + To use it in a playbook, specify: ``ns2.col.foo_2_redirect``. + +- This is a redirect to the ns2.col.foo module. +- This redirect does **not** work with Ansible 2.9. diff --git a/tests/functional/baseline-simplified-rst-squash-hierarchy/foo_3_redirect_module.rst b/tests/functional/baseline-simplified-rst-squash-hierarchy/foo_3_redirect_module.rst new file mode 100644 index 00000000..3a90a19b --- /dev/null +++ b/tests/functional/baseline-simplified-rst-squash-hierarchy/foo_3_redirect_module.rst @@ -0,0 +1,11 @@ +.. Created with antsibull-docs + +ns2.col.foo_3_redirect module ++++++++++++++++++++++++++++++ + +- This redirect is part of the `ns2.col collection `_ (version 2.1.0). + + To use it in a playbook, specify: ``ns2.col.foo_3_redirect``. + +- This is a redirect to the ns2.col.foo2 module. +- This redirect does **not** work with Ansible 2.9. diff --git a/tests/functional/baseline-simplified-rst-squash-hierarchy/foo_4_redirect_module.rst b/tests/functional/baseline-simplified-rst-squash-hierarchy/foo_4_redirect_module.rst new file mode 100644 index 00000000..35f7496f --- /dev/null +++ b/tests/functional/baseline-simplified-rst-squash-hierarchy/foo_4_redirect_module.rst @@ -0,0 +1,10 @@ +.. Created with antsibull-docs + +ns2.col.foo_4_redirect +++++++++++++++++++++++ + +This plugin was part of the `ns2.col collection `_ (version 2.1.0). + +This module has been removed +in version 2.0.0 of ns2.col. +It is gone diff --git a/tests/functional/baseline-simplified-rst-squash-hierarchy/foo_5_redirect_module.rst b/tests/functional/baseline-simplified-rst-squash-hierarchy/foo_5_redirect_module.rst new file mode 100644 index 00000000..6026bcfb --- /dev/null +++ b/tests/functional/baseline-simplified-rst-squash-hierarchy/foo_5_redirect_module.rst @@ -0,0 +1,13 @@ +.. Created with antsibull-docs + +ns2.col.foo_5_redirect module ++++++++++++++++++++++++++++++ + +- This redirect is part of the `ns2.col collection `_ (version 2.1.0). + + +- This redirect has been **deprecated**. Please update your tasks to use the new name ``ns2.col.foo2`` instead. + It will be removed in version 5.0.0 of ns2.col. +- This is a redirect to the ns2.col.foo2 module. +- This redirect does **not** work with Ansible 2.9. +- The collection contains the following information on this deprecation: It will be really gone diff --git a/tests/functional/baseline-simplified-rst-squash-hierarchy/foo_module.rst b/tests/functional/baseline-simplified-rst-squash-hierarchy/foo_module.rst index 2b54f194..56244221 100644 --- a/tests/functional/baseline-simplified-rst-squash-hierarchy/foo_module.rst +++ b/tests/functional/baseline-simplified-rst-squash-hierarchy/foo_module.rst @@ -29,7 +29,7 @@ Synopsis - :literal:`FOOBAR1`\ , :literal:`FOOBAR2`\ , :literal:`FOOBAR3`\ , :literal:`FOOBAR4`. -Aliases: foo_redirect +Aliases: foo_1_redirect, foo_2_redirect, foo_redirect .. _ansible_collections.ns2.col.foo_module_requirements: diff --git a/tests/functional/baseline-simplified-rst/collections/ns2/col/foo2_module.rst b/tests/functional/baseline-simplified-rst/collections/ns2/col/foo2_module.rst index 98cbc4d2..461f528e 100644 --- a/tests/functional/baseline-simplified-rst/collections/ns2/col/foo2_module.rst +++ b/tests/functional/baseline-simplified-rst/collections/ns2/col/foo2_module.rst @@ -26,6 +26,7 @@ Synopsis - Reference using alias - :literal:`bar` (of module `ns2.col.foo\_redirect `__) and :literal:`baz` (of module `ns2.col.foo\_redirect `__). +Aliases: foo_3_redirect, foo_4_redirect, foo_5_redirect diff --git a/tests/functional/baseline-simplified-rst/collections/ns2/col/foo_1_redirect_module.rst b/tests/functional/baseline-simplified-rst/collections/ns2/col/foo_1_redirect_module.rst new file mode 100644 index 00000000..8c73db41 --- /dev/null +++ b/tests/functional/baseline-simplified-rst/collections/ns2/col/foo_1_redirect_module.rst @@ -0,0 +1,11 @@ +.. Created with antsibull-docs + +ns2.col.foo_1_redirect module ++++++++++++++++++++++++++++++ + +- This redirect is part of the `ns2.col collection `_ (version 2.1.0). + + To use it in a playbook, specify: ``ns2.col.foo_1_redirect``. + +- This is a redirect to the ns2.col.foo module. +- This redirect does **not** work with Ansible 2.9. diff --git a/tests/functional/baseline-simplified-rst/collections/ns2/col/foo_2_redirect_module.rst b/tests/functional/baseline-simplified-rst/collections/ns2/col/foo_2_redirect_module.rst new file mode 100644 index 00000000..1eb39cc3 --- /dev/null +++ b/tests/functional/baseline-simplified-rst/collections/ns2/col/foo_2_redirect_module.rst @@ -0,0 +1,11 @@ +.. Created with antsibull-docs + +ns2.col.foo_2_redirect module ++++++++++++++++++++++++++++++ + +- This redirect is part of the `ns2.col collection `_ (version 2.1.0). + + To use it in a playbook, specify: ``ns2.col.foo_2_redirect``. + +- This is a redirect to the ns2.col.foo module. +- This redirect does **not** work with Ansible 2.9. diff --git a/tests/functional/baseline-simplified-rst/collections/ns2/col/foo_3_redirect_module.rst b/tests/functional/baseline-simplified-rst/collections/ns2/col/foo_3_redirect_module.rst new file mode 100644 index 00000000..71f185f6 --- /dev/null +++ b/tests/functional/baseline-simplified-rst/collections/ns2/col/foo_3_redirect_module.rst @@ -0,0 +1,11 @@ +.. Created with antsibull-docs + +ns2.col.foo_3_redirect module ++++++++++++++++++++++++++++++ + +- This redirect is part of the `ns2.col collection `_ (version 2.1.0). + + To use it in a playbook, specify: ``ns2.col.foo_3_redirect``. + +- This is a redirect to the ns2.col.foo2 module. +- This redirect does **not** work with Ansible 2.9. diff --git a/tests/functional/baseline-simplified-rst/collections/ns2/col/foo_4_redirect_module.rst b/tests/functional/baseline-simplified-rst/collections/ns2/col/foo_4_redirect_module.rst new file mode 100644 index 00000000..8d9ca0f9 --- /dev/null +++ b/tests/functional/baseline-simplified-rst/collections/ns2/col/foo_4_redirect_module.rst @@ -0,0 +1,10 @@ +.. Created with antsibull-docs + +ns2.col.foo_4_redirect +++++++++++++++++++++++ + +This plugin was part of the `ns2.col collection `_ (version 2.1.0). + +This module has been removed +in version 2.0.0 of ns2.col. +It is gone diff --git a/tests/functional/baseline-simplified-rst/collections/ns2/col/foo_5_redirect_module.rst b/tests/functional/baseline-simplified-rst/collections/ns2/col/foo_5_redirect_module.rst new file mode 100644 index 00000000..097fa837 --- /dev/null +++ b/tests/functional/baseline-simplified-rst/collections/ns2/col/foo_5_redirect_module.rst @@ -0,0 +1,13 @@ +.. Created with antsibull-docs + +ns2.col.foo_5_redirect module ++++++++++++++++++++++++++++++ + +- This redirect is part of the `ns2.col collection `_ (version 2.1.0). + + +- This redirect has been **deprecated**. Please update your tasks to use the new name ``ns2.col.foo2`` instead. + It will be removed in version 5.0.0 of ns2.col. +- This is a redirect to the ns2.col.foo2 module. +- This redirect does **not** work with Ansible 2.9. +- The collection contains the following information on this deprecation: It will be really gone diff --git a/tests/functional/baseline-simplified-rst/collections/ns2/col/foo_module.rst b/tests/functional/baseline-simplified-rst/collections/ns2/col/foo_module.rst index 03c9f64c..e5051d6d 100644 --- a/tests/functional/baseline-simplified-rst/collections/ns2/col/foo_module.rst +++ b/tests/functional/baseline-simplified-rst/collections/ns2/col/foo_module.rst @@ -29,7 +29,7 @@ Synopsis - :literal:`FOOBAR1`\ , :literal:`FOOBAR2`\ , :literal:`FOOBAR3`\ , :literal:`FOOBAR4`. -Aliases: foo_redirect +Aliases: foo_1_redirect, foo_2_redirect, foo_redirect .. _ansible_collections.ns2.col.foo_module_requirements: diff --git a/tests/functional/baseline-squash-hierarchy/foo2_module.rst b/tests/functional/baseline-squash-hierarchy/foo2_module.rst index 3a4da710..6d7d21e4 100644 --- a/tests/functional/baseline-squash-hierarchy/foo2_module.rst +++ b/tests/functional/baseline-squash-hierarchy/foo2_module.rst @@ -54,6 +54,7 @@ Synopsis .. Aliases +Aliases: foo_3_redirect, foo_4_redirect, foo_5_redirect .. Requirements diff --git a/tests/functional/baseline-squash-hierarchy/foo_1_redirect_module.rst b/tests/functional/baseline-squash-hierarchy/foo_1_redirect_module.rst new file mode 100644 index 00000000..c02a1077 --- /dev/null +++ b/tests/functional/baseline-squash-hierarchy/foo_1_redirect_module.rst @@ -0,0 +1,25 @@ +.. Document meta + +:orphan: + +.. meta:: + :antsibull-docs: + +.. Anchors + +.. _ansible_collections.ns2.col.foo_1_redirect_module: + +.. Title + +ns2.col.foo_1_redirect module ++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This redirect is part of the `ns2.col collection `_ (version 2.1.0). + + To use it in a playbook, specify: :code:`ns2.col.foo_1_redirect`. + +- This is a redirect to the :ansplugin:`ns2.col.foo module `. +- This redirect does **not** work with Ansible 2.9. diff --git a/tests/functional/baseline-squash-hierarchy/foo_2_redirect_module.rst b/tests/functional/baseline-squash-hierarchy/foo_2_redirect_module.rst new file mode 100644 index 00000000..bc4545a2 --- /dev/null +++ b/tests/functional/baseline-squash-hierarchy/foo_2_redirect_module.rst @@ -0,0 +1,25 @@ +.. Document meta + +:orphan: + +.. meta:: + :antsibull-docs: + +.. Anchors + +.. _ansible_collections.ns2.col.foo_2_redirect_module: + +.. Title + +ns2.col.foo_2_redirect module ++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This redirect is part of the `ns2.col collection `_ (version 2.1.0). + + To use it in a playbook, specify: :code:`ns2.col.foo_2_redirect`. + +- This is a redirect to the :ansplugin:`ns2.col.foo module `. +- This redirect does **not** work with Ansible 2.9. diff --git a/tests/functional/baseline-squash-hierarchy/foo_3_redirect_module.rst b/tests/functional/baseline-squash-hierarchy/foo_3_redirect_module.rst new file mode 100644 index 00000000..fd40a53e --- /dev/null +++ b/tests/functional/baseline-squash-hierarchy/foo_3_redirect_module.rst @@ -0,0 +1,25 @@ +.. Document meta + +:orphan: + +.. meta:: + :antsibull-docs: + +.. Anchors + +.. _ansible_collections.ns2.col.foo_3_redirect_module: + +.. Title + +ns2.col.foo_3_redirect module ++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This redirect is part of the `ns2.col collection `_ (version 2.1.0). + + To use it in a playbook, specify: :code:`ns2.col.foo_3_redirect`. + +- This is a redirect to the :ansplugin:`ns2.col.foo2 module `. +- This redirect does **not** work with Ansible 2.9. diff --git a/tests/functional/baseline-squash-hierarchy/foo_4_redirect_module.rst b/tests/functional/baseline-squash-hierarchy/foo_4_redirect_module.rst new file mode 100644 index 00000000..b3ae7f2b --- /dev/null +++ b/tests/functional/baseline-squash-hierarchy/foo_4_redirect_module.rst @@ -0,0 +1,24 @@ +.. Document meta + +:orphan: + +.. meta:: + :antsibull-docs: + +.. Anchors + +.. _ansible_collections.ns2.col.foo_4_redirect_module: + +.. Title + +ns2.col.foo_4_redirect +++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin was part of the `ns2.col collection `_ (version 2.1.0). + +This module has been removed +in version 2.0.0 of ns2.col. +It is gone diff --git a/tests/functional/baseline-squash-hierarchy/foo_5_redirect_module.rst b/tests/functional/baseline-squash-hierarchy/foo_5_redirect_module.rst new file mode 100644 index 00000000..a70101be --- /dev/null +++ b/tests/functional/baseline-squash-hierarchy/foo_5_redirect_module.rst @@ -0,0 +1,27 @@ +.. Document meta + +:orphan: + +.. meta:: + :antsibull-docs: + +.. Anchors + +.. _ansible_collections.ns2.col.foo_5_redirect_module: + +.. Title + +ns2.col.foo_5_redirect module ++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This redirect is part of the `ns2.col collection `_ (version 2.1.0). + + +- This redirect has been **deprecated**. Please update your tasks to use the new name ``ns2.col.foo2`` instead. + It will be removed in version 5.0.0 of ns2.col. +- This is a redirect to the :ansplugin:`ns2.col.foo2 module `. +- This redirect does **not** work with Ansible 2.9. +- The collection contains the following information on this deprecation: It will be really gone diff --git a/tests/functional/baseline-squash-hierarchy/foo_module.rst b/tests/functional/baseline-squash-hierarchy/foo_module.rst index f96918c2..36367cc7 100644 --- a/tests/functional/baseline-squash-hierarchy/foo_module.rst +++ b/tests/functional/baseline-squash-hierarchy/foo_module.rst @@ -59,7 +59,7 @@ Synopsis .. Aliases -Aliases: foo_redirect +Aliases: foo_1_redirect, foo_2_redirect, foo_redirect .. Requirements diff --git a/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo2_module.rst b/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo2_module.rst index 6673aed7..b694aca5 100644 --- a/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo2_module.rst +++ b/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo2_module.rst @@ -54,6 +54,7 @@ Synopsis .. Aliases +Aliases: foo_3_redirect, foo_4_redirect, foo_5_redirect .. Requirements diff --git a/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_1_redirect_module.rst b/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_1_redirect_module.rst new file mode 100644 index 00000000..c02a1077 --- /dev/null +++ b/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_1_redirect_module.rst @@ -0,0 +1,25 @@ +.. Document meta + +:orphan: + +.. meta:: + :antsibull-docs: + +.. Anchors + +.. _ansible_collections.ns2.col.foo_1_redirect_module: + +.. Title + +ns2.col.foo_1_redirect module ++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This redirect is part of the `ns2.col collection `_ (version 2.1.0). + + To use it in a playbook, specify: :code:`ns2.col.foo_1_redirect`. + +- This is a redirect to the :ansplugin:`ns2.col.foo module `. +- This redirect does **not** work with Ansible 2.9. diff --git a/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_2_redirect_module.rst b/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_2_redirect_module.rst new file mode 100644 index 00000000..bc4545a2 --- /dev/null +++ b/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_2_redirect_module.rst @@ -0,0 +1,25 @@ +.. Document meta + +:orphan: + +.. meta:: + :antsibull-docs: + +.. Anchors + +.. _ansible_collections.ns2.col.foo_2_redirect_module: + +.. Title + +ns2.col.foo_2_redirect module ++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This redirect is part of the `ns2.col collection `_ (version 2.1.0). + + To use it in a playbook, specify: :code:`ns2.col.foo_2_redirect`. + +- This is a redirect to the :ansplugin:`ns2.col.foo module `. +- This redirect does **not** work with Ansible 2.9. diff --git a/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_3_redirect_module.rst b/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_3_redirect_module.rst new file mode 100644 index 00000000..fd40a53e --- /dev/null +++ b/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_3_redirect_module.rst @@ -0,0 +1,25 @@ +.. Document meta + +:orphan: + +.. meta:: + :antsibull-docs: + +.. Anchors + +.. _ansible_collections.ns2.col.foo_3_redirect_module: + +.. Title + +ns2.col.foo_3_redirect module ++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This redirect is part of the `ns2.col collection `_ (version 2.1.0). + + To use it in a playbook, specify: :code:`ns2.col.foo_3_redirect`. + +- This is a redirect to the :ansplugin:`ns2.col.foo2 module `. +- This redirect does **not** work with Ansible 2.9. diff --git a/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_4_redirect_module.rst b/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_4_redirect_module.rst new file mode 100644 index 00000000..b3ae7f2b --- /dev/null +++ b/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_4_redirect_module.rst @@ -0,0 +1,24 @@ +.. Document meta + +:orphan: + +.. meta:: + :antsibull-docs: + +.. Anchors + +.. _ansible_collections.ns2.col.foo_4_redirect_module: + +.. Title + +ns2.col.foo_4_redirect +++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin was part of the `ns2.col collection `_ (version 2.1.0). + +This module has been removed +in version 2.0.0 of ns2.col. +It is gone diff --git a/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_5_redirect_module.rst b/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_5_redirect_module.rst new file mode 100644 index 00000000..a70101be --- /dev/null +++ b/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_5_redirect_module.rst @@ -0,0 +1,27 @@ +.. Document meta + +:orphan: + +.. meta:: + :antsibull-docs: + +.. Anchors + +.. _ansible_collections.ns2.col.foo_5_redirect_module: + +.. Title + +ns2.col.foo_5_redirect module ++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This redirect is part of the `ns2.col collection `_ (version 2.1.0). + + +- This redirect has been **deprecated**. Please update your tasks to use the new name ``ns2.col.foo2`` instead. + It will be removed in version 5.0.0 of ns2.col. +- This is a redirect to the :ansplugin:`ns2.col.foo2 module `. +- This redirect does **not** work with Ansible 2.9. +- The collection contains the following information on this deprecation: It will be really gone diff --git a/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_module.rst b/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_module.rst index e7438aa6..30e3202e 100644 --- a/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_module.rst +++ b/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_module.rst @@ -59,7 +59,7 @@ Synopsis .. Aliases -Aliases: foo_redirect +Aliases: foo_1_redirect, foo_2_redirect, foo_redirect .. Requirements diff --git a/tests/functional/collections/ansible_collections/ns2/col/meta/runtime.yml b/tests/functional/collections/ansible_collections/ns2/col/meta/runtime.yml index 2f8770f5..d364d6bd 100644 --- a/tests/functional/collections/ansible_collections/ns2/col/meta/runtime.yml +++ b/tests/functional/collections/ansible_collections/ns2/col/meta/runtime.yml @@ -13,6 +13,19 @@ action_groups: - foo2 plugin_routing: + action: + foo_1_redirect: + redirect: ns2.col.foo + foo_2_redirect: + redirect: ns2.col.foo + foo_4_redirect: + tombstone: + removal_version: 2.0.0 + warning_text: It is gone + foo_5_redirect: + deprecation: + removal_version: 5.0.0 + warning_text: It will be really gone become: foo: deprecation: @@ -21,3 +34,14 @@ plugin_routing: modules: foo_redirect: redirect: ns2.col.foo + foo_1_redirect: + redirect: ns2.col.foo2 + foo_3_redirect: + redirect: ns2.col.foo2 + foo_4_redirect: + redirect: ns2.col.foo2 + foo_5_redirect: + deprecation: + removal_version: 10.0.0 + warning_text: It will be eventually gone + redirect: ns2.col.foo2