Add seealso section to Windows and related modules (#49845)

* Add seealso section to Windows and related modules

* Fixes after review
This commit is contained in:
Dag Wieers 2018-12-15 03:23:59 +01:00 committed by GitHub
commit 26474c6902
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
105 changed files with 479 additions and 129 deletions

View file

@ -76,6 +76,9 @@ options:
- The path to the file to validate is passed in via '%s' which must be present as in the sshd example below.
- The command is passed securely so shell features like expansion and pipes won't work.
version_added: '2.0'
seealso:
- module: copy
- module: win_copy
author:
- Stephen Fromm (@sfromm)
extends_documentation_fragment:

View file

@ -104,13 +104,18 @@ extends_documentation_fragment:
- files
- validate
- decrypt
author:
- Ansible Core Team
- Michael DeHaan
notes:
- The M(copy) module recursively copy facility does not scale to lots (>hundreds) of files.
For alternative, see M(synchronize) module, which is a wrapper around C(rsync).
- For Windows targets, use the M(win_copy) module instead.
seealso:
- module: assemble
- module: file
- module: template
- module: win_copy
author:
- Ansible Core Team
- Michael DeHaan
'''
EXAMPLES = r'''

View file

@ -23,12 +23,6 @@ description:
- Alternatively, remove files, symlinks or directories.
- Many other modules support the same options as the C(file) module - including M(copy), M(template), and M(assemble).
- For Windows targets, use the M(win_file) module instead.
notes:
- For Windows targets, use the M(win_file) module instead.
- See also M(copy), M(template) and M(assemble).
author:
- Ansible Core Team
- Michael DeHaan
options:
path:
description:
@ -104,6 +98,17 @@ options:
- Based on default Python format (see time.strftime doc).
default: "%Y%m%d%H%M.%S"
version_added: '2.7'
notes:
- For Windows targets, use the M(win_file) module instead.
seealso:
- module: assemble
- module: copy
- module: stat
- module: template
- module: win_file
author:
- Ansible Core Team
- Michael DeHaan
'''
EXAMPLES = '''

View file

@ -17,12 +17,6 @@ ANSIBLE_METADATA = {'metadata_version': '1.1',
DOCUMENTATION = """
---
module: lineinfile
author:
- Daniel Hokka Zakrissoni (@dhozac)
- Ahti Kitsik (@ahtik)
extends_documentation_fragment:
- files
- validate
short_description: Manage lines in text files
description:
- This module ensures a particular line is in a file, or replace an
@ -122,8 +116,18 @@ options:
others:
description:
- All arguments accepted by the M(file) module also work here.
extends_documentation_fragment:
- files
- validate
notes:
- As of Ansible 2.3, the I(dest) option has been changed to I(path) as default, but I(dest) still works as well.
seealso:
- module: blockinfile
- module: file
- module: win_lineinfile
author:
- Daniel Hokka Zakrissoni (@dhozac)
- Ahti Kitsik (@ahtik)
"""
EXAMPLES = r"""

View file

@ -73,6 +73,9 @@ options:
aliases: [ attr, attributes ]
notes:
- For Windows targets, use the M(win_stat) module instead.
seealso:
- module: file
- module: win_stat
author: Bruce Pennypacker (@bpennypacker)
'''

View file

@ -185,7 +185,9 @@ notes:
encounters an error. Those synchronizing large numbers of files that are willing to trade safety for performance should call rsync directly.
- link_destination is subject to the same limitations as the underlaying rsync daemon. Hard links are only preserved if the relative subtrees
of the source and destination are the same. Attempts to hardlink into a directory that is a subdirectory of the source will be prevented.
seealso:
- module: copy
- module: win_robocopy
author:
- Timothy Appnel (@tima)
'''

View file

@ -16,8 +16,6 @@ DOCUMENTATION = '''
---
module: tempfile
version_added: "2.3"
author:
- Krzysztof Magosa (@krzysztof-magosa)
short_description: Creates temporary files and directories.
description:
- The C(tempfile) module creates temporary files and directories. C(mktemp) command takes different parameters on various systems, this module helps
@ -43,6 +41,10 @@ options:
default: ""
notes:
- For Windows targets, use the M(win_tempfile) module instead.
seealso:
- module: win_tempfile
author:
- Krzysztof Magosa (@krzysztof-magosa)
'''
EXAMPLES = """

View file

@ -124,6 +124,10 @@ notes:
- You can use the M(copy) module with the C(content:) option if you prefer the template inline,
as part of the playbook.
- For Windows you can use M(win_template) which uses '\\r\\n' as C(newline_sequence) by default.
seealso:
- module: copy
- module: win_copy
- module: win_template
author:
- Ansible Core Team
- Michael DeHaan

View file

@ -20,7 +20,6 @@ DOCUMENTATION = r'''
module: unarchive
version_added: '1.4'
short_description: Unpacks an archive after (optionally) copying it from the local machine.
extends_documentation_fragment: [ decrypt, files ]
description:
- The C(unarchive) module unpacks an archive.
- By default, it will copy the source file from the local system to the target before unpacking.
@ -86,7 +85,9 @@ options:
type: 'bool'
default: 'yes'
version_added: "2.2"
author: Michael DeHaan
extends_documentation_fragment:
- decrypt
- files
todo:
- Re-implement tar support using native tarfile module.
- Re-implement zip support using native zipfile module.
@ -100,6 +101,9 @@ notes:
- Existing files/directories in the destination which are not in the archive
are ignored for purposes of deciding if the archive should be unpacked or not.
- For Windows targets, use the M(win_unzip) module instead.
seealso:
- module: win_unzip
author: Michael DeHaan
'''
EXAMPLES = r'''