Move validate command into doc fragment and fix a few typos

This commit is contained in:
Jeff Widman 2015-06-02 14:07:30 -07:00 committed by Matt Clay
parent e7af5d2384
commit 70b3290a3b
4 changed files with 5 additions and 34 deletions

View file

@ -70,14 +70,6 @@ options:
choices: [ "yes", "no" ]
default: "yes"
aliases: [ "thirsty" ]
validate:
description:
- The validation command to run before copying into place. The path to the file to
validate is passed in via '%s' which must be present as in the visudo example below.
The command is passed securely so shell features like expansion and pipes won't work.
required: false
default: ""
version_added: "1.2"
directory_mode:
description:
- When doing a recursive copy set the mode for the directories. If this is not set we will use the system
@ -86,6 +78,7 @@ options:
required: false
version_added: "1.5"
extends_documentation_fragment: files
extends_documentation_fragment: validate
author:
- "Ansible Core Team"
- "Michael DeHaan"

View file

@ -31,6 +31,7 @@ author:
- "Daniel Hokka Zakrissoni (@dhozac)"
- "Ahti Kitsik (@ahtik)"
extends_documentation_fragment: files
extends_documentation_fragment: validate
short_description: Ensure a particular line is in a file, or replace an
existing line using a back-referenced regular expression.
description:
@ -116,16 +117,6 @@ options:
description:
- Create a backup file including the timestamp information so you can
get the original file back if you somehow clobbered it incorrectly.
validate:
required: false
description:
- validation to run before copying into place.
Use %s in the command to indicate the current file to validate.
The command is passed securely so shell features like
expansion and pipes won't work.
required: false
default: None
version_added: "1.4"
others:
description:
- All arguments accepted by the M(file) module also work here.

View file

@ -27,6 +27,7 @@ DOCUMENTATION = """
module: replace
author: "Evan Kaufman (@EvanK)"
extends_documentation_fragment: files
extends_documentation_fragment: validate
short_description: Replace all instances of a particular string in a
file using a back-referenced regular expression.
description:
@ -61,12 +62,6 @@ options:
description:
- Create a backup file including the timestamp information so you can
get the original file back if you somehow clobbered it incorrectly.
validate:
required: false
description:
- validation to run before copying into place
required: false
default: None
others:
description:
- All arguments accepted by the M(file) module also work here.

View file

@ -38,15 +38,6 @@ options:
required: false
choices: [ "yes", "no" ]
default: "no"
validate:
description:
- The validation command to run before copying into place.
- The path to the file to validate is passed in via '%s' which must be present as in the visudo example below.
- validation to run before copying into place. The command is passed
securely so shell features like expansion and pipes won't work.
required: false
default: ""
version_added: "1.2"
force:
description:
- the default is C(yes), which will replace the remote file when contents
@ -62,6 +53,7 @@ author:
- Ansible Core Team
- Michael DeHaan
extends_documentation_fragment: files
extends_documentation_fragment: validate
'''
EXAMPLES = '''