docs adjustments (batch 2) (#83368)

* docs adjustments

* Update lib/ansible/modules/assemble.py

Co-authored-by: Abhijeet Kasurde <akasurde@redhat.com>

---------

Co-authored-by: Abhijeet Kasurde <akasurde@redhat.com>
pull/83404/head
Alexei Znamensky 2 years ago committed by GitHub
parent 655a8ff38f
commit 70c2b35210
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

@ -61,14 +61,14 @@ options:
type: str type: str
ignore_hidden: ignore_hidden:
description: description:
- A boolean that controls if files that start with a '.' will be included or not. - A boolean that controls if files that start with a C(.) will be included or not.
type: bool type: bool
default: no default: no
version_added: '2.0' version_added: '2.0'
validate: validate:
description: description:
- The validation command to run before copying into place. - 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 sshd example below. - The path to the file to validate is passed in by C(%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. - The command is passed securely so shell features like expansion and pipes won't work.
type: str type: str
version_added: '2.0' version_added: '2.0'

@ -17,14 +17,14 @@ version_added: "1.5"
options: options:
that: that:
description: description:
- A list of string expressions of the same form that can be passed to the 'when' statement. - A list of string expressions of the same form that can be passed to the C(when) statement.
type: list type: list
elements: str elements: str
required: true required: true
fail_msg: fail_msg:
description: description:
- The customized message used for a failing assertion. - The customized message used for a failing assertion.
- This argument was called 'msg' before Ansible 2.7, now it is renamed to 'fail_msg' with alias 'msg'. - This argument was called O(msg) before Ansible 2.7, now it is renamed to O(fail_msg) with alias O(msg).
type: str type: str
aliases: [ msg ] aliases: [ msg ]
version_added: "2.7" version_added: "2.7"
@ -85,7 +85,7 @@ EXAMPLES = r'''
- > - >
"reject" not in some_command_result.stderr "reject" not in some_command_result.stderr
- name: After version 2.7 both 'msg' and 'fail_msg' can customize failing assertion message - name: After version 2.7 both O(msg) and O(fail_msg) can customize failing assertion message
ansible.builtin.assert: ansible.builtin.assert:
that: that:
- my_param <= 100 - my_param <= 100
@ -93,7 +93,7 @@ EXAMPLES = r'''
fail_msg: "'my_param' must be between 0 and 100" fail_msg: "'my_param' must be between 0 and 100"
success_msg: "'my_param' is between 0 and 100" success_msg: "'my_param' is between 0 and 100"
- name: Please use 'msg' when ansible version is smaller than 2.7 - name: Please use O(msg) when ansible version is smaller than 2.7
ansible.builtin.assert: ansible.builtin.assert:
that: that:
- my_param <= 100 - my_param <= 100

@ -33,7 +33,7 @@ options:
marker: marker:
description: description:
- The marker line template. - The marker line template.
- C({mark}) will be replaced with the values in O(marker_begin) (default="BEGIN") and O(marker_end) (default="END"). - C({mark}) will be replaced with the values in O(marker_begin) (default=C(BEGIN)) and O(marker_end) (default=C(END)).
- Using a custom marker without the C({mark}) variable may result in the block being repeatedly inserted on subsequent playbook runs. - Using a custom marker without the C({mark}) variable may result in the block being repeatedly inserted on subsequent playbook runs.
- Multi-line markers are not supported and will result in the block being repeatedly inserted on subsequent playbook runs. - Multi-line markers are not supported and will result in the block being repeatedly inserted on subsequent playbook runs.
- A newline is automatically appended by the module to O(marker_begin) and O(marker_end). - A newline is automatically appended by the module to O(marker_begin) and O(marker_end).
@ -106,7 +106,7 @@ options:
default: no default: no
version_added: '2.16' version_added: '2.16'
notes: notes:
- When using 'with_*' loops be aware that if you do not set a unique mark the block will be overwritten on each iteration. - When using C(with_*) loops be aware that if you do not set a unique mark the block will be overwritten on each iteration.
- As of Ansible 2.3, the O(dest) option has been changed to O(path) as default, but O(dest) still works as well. - As of Ansible 2.3, the O(dest) option has been changed to O(path) as default, but O(dest) still works as well.
- Option O(ignore:follow) has been removed in Ansible 2.5, because this module modifies the contents of the file - Option O(ignore:follow) has been removed in Ansible 2.5, because this module modifies the contents of the file
so O(ignore:follow=no) does not make sense. so O(ignore:follow=no) does not make sense.

@ -50,7 +50,7 @@ options:
free_form: free_form:
description: description:
- The command module takes a free form string as a command to run. - The command module takes a free form string as a command to run.
- There is no actual parameter named 'free form'. - There is no actual parameter named C(free_form).
cmd: cmd:
type: str type: str
description: description:

@ -28,8 +28,8 @@ options:
- Local path to a file to copy to the remote server. - Local path to a file to copy to the remote server.
- This can be absolute or relative. - This can be absolute or relative.
- If path is a directory, it is copied recursively. In this case, if path ends - If path is a directory, it is copied recursively. In this case, if path ends
with "/", only inside contents of that directory are copied to destination. with C(/), only inside contents of that directory are copied to destination.
Otherwise, if it does not end with "/", the directory itself with all contents Otherwise, if it does not end with C(/), the directory itself with all contents
is copied. This behavior is similar to the C(rsync) command line tool. is copied. This behavior is similar to the C(rsync) command line tool.
type: path type: path
content: content:
@ -44,7 +44,7 @@ options:
description: description:
- Remote absolute path where the file should be copied to. - Remote absolute path where the file should be copied to.
- If O(src) is a directory, this must be a directory too. - If O(src) is a directory, this must be a directory too.
- If O(dest) is a non-existent path and if either O(dest) ends with "/" or O(src) is a directory, O(dest) is created. - If O(dest) is a non-existent path and if either O(dest) ends with C(/) or O(src) is a directory, O(dest) is created.
- If O(dest) is a relative path, the starting directory is determined by the remote host. - If O(dest) is a relative path, the starting directory is determined by the remote host.
- If O(src) and O(dest) are files, the parent directory of O(dest) is not created and the task fails if it does not already exist. - If O(src) and O(dest) are files, the parent directory of O(dest) is not created and the task fails if it does not already exist.
type: path type: path
@ -92,7 +92,7 @@ options:
description: description:
- Influence whether O(src) needs to be transferred or already is present remotely. - Influence whether O(src) needs to be transferred or already is present remotely.
- If V(false), it will search for O(src) on the controller node. - If V(false), it will search for O(src) on the controller node.
- If V(true) it will search for O(src) on the managed (remote) node. - If V(true), it will search for O(src) on the managed (remote) node.
- O(remote_src) supports recursive copying as of version 2.8. - O(remote_src) supports recursive copying as of version 2.8.
- O(remote_src) only works with O(mode=preserve) as of version 2.6. - O(remote_src) only works with O(mode=preserve) as of version 2.6.
- Auto-decryption of files does not work when O(remote_src=yes). - Auto-decryption of files does not work when O(remote_src=yes).

@ -18,19 +18,19 @@ description:
- Use this module to manage crontab and environment variables entries. This module allows - Use this module to manage crontab and environment variables entries. This module allows
you to create environment variables and named crontab entries, update, or delete them. you to create environment variables and named crontab entries, update, or delete them.
- 'When crontab jobs are managed: the module includes one line with the description of the - 'When crontab jobs are managed: the module includes one line with the description of the
crontab entry C("#Ansible: <name>") corresponding to the "name" passed to the module, crontab entry C("#Ansible: <name>") corresponding to the O(name) passed to the module,
which is used by future ansible/module calls to find/check the state. The "name" which is used by future ansible/module calls to find/check the state. The O(name)
parameter should be unique, and changing the "name" value will result in a new cron parameter should be unique, and changing the O(name) value will result in a new cron
task being created (or a different one being removed).' task being created (or a different one being removed).'
- When environment variables are managed, no comment line is added, but, when the module - When environment variables are managed, no comment line is added, but, when the module
needs to find/check the state, it uses the "name" parameter to find the environment needs to find/check the state, it uses the O(name) parameter to find the environment
variable definition line. variable definition line.
- When using symbols such as %, they must be properly escaped. - When using symbols such as C(%), they must be properly escaped.
version_added: "0.9" version_added: "0.9"
options: options:
name: name:
description: description:
- Description of a crontab entry or, if env is set, the name of environment variable. - Description of a crontab entry or, if O(env) is set, the name of environment variable.
- This parameter is always required as of ansible-core 2.12. - This parameter is always required as of ansible-core 2.12.
type: str type: str
required: yes required: yes
@ -41,7 +41,7 @@ options:
type: str type: str
job: job:
description: description:
- The command to execute or, if env is set, the value of environment variable. - The command to execute or, if O(env) is set, the value of environment variable.
- The command should not contain line breaks. - The command should not contain line breaks.
- Required if O(state=present). - Required if O(state=present).
type: str type: str
@ -58,10 +58,10 @@ options:
The assumption is that this file is exclusively managed by the module, The assumption is that this file is exclusively managed by the module,
do not use if the file contains multiple entries, NEVER use for /etc/crontab. do not use if the file contains multiple entries, NEVER use for /etc/crontab.
- If this is a relative path, it is interpreted with respect to C(/etc/cron.d). - If this is a relative path, it is interpreted with respect to C(/etc/cron.d).
- Many linux distros expect (and some require) the filename portion to consist solely - Many Linux distros expect (and some require) the filename portion to consist solely
of upper- and lower-case letters, digits, underscores, and hyphens. of upper- and lower-case letters, digits, underscores, and hyphens.
- Using this parameter requires you to specify the O(user) as well, unless O(state) is not V(present). - Using this parameter requires you to specify the O(user) as well, unless O(state=absent).
- Either this parameter or O(name) is required - Either this parameter or O(name) is required.
type: path type: path
backup: backup:
description: description:

Loading…
Cancel
Save