Mutually reference Windows and non-Windows modules (#25482)

* Mutually reference Windows and non-Windows modules

To make it easier for Windows or non-Windows users to find the relevant
module information, we are mutually referencing both variants in their
documentation.

We are also adding a special note if a module works on both Windows and
non-Windows targets.

* Mutually reference Windows and non-Windows modules

To make it easier for Windows or non-Windows users to find the relevant
module information, we are mutually referencing both variants in their
documentation.

We are also adding a special note if a module works on both Windows and
non-Windows targets.

* Replace 'look at' with 'use', as requested

ci_complete
This commit is contained in:
Dag Wieers 2017-06-26 16:26:53 +01:00 committed by John R Barker
commit 7d7051fc54
50 changed files with 137 additions and 20 deletions

View file

@ -29,25 +29,23 @@ DOCUMENTATION = '''
module: async_status
short_description: Obtain status of asynchronous task
description:
- "This module gets the status of an asynchronous task."
- This module gets the status of an asynchronous task.
- This module is also supported for Windows targets.
version_added: "0.5"
options:
jid:
description:
- Job or task identifier
required: true
default: null
aliases: []
mode:
description:
- if C(status), obtain the status; if C(cleanup), clean up the async job cache
located in C(~/.ansible_async/) for the specified job I(jid).
required: false
choices: [ "status", "cleanup" ]
default: "status"
notes:
- See also U(http://docs.ansible.com/playbooks_async.html)
requirements: []
- This module is also supported for Windows targets.
author:
- "Ansible Core Team"
- "Michael DeHaan"