Use semantic markup (#645)

* Use semantic markup.

* Linting.

* Define docsite targets.

* Forgot one env var.

* Add array stubs.
This commit is contained in:
Felix Fontein
2023-06-22 07:01:31 +02:00
committed by GitHub
parent f94beeb027
commit 024bdec919
34 changed files with 571 additions and 547 deletions
+15 -15
View File
@@ -42,21 +42,21 @@ options:
description:
- The command to execute.
- Since this is a list of arguments, no quoting is needed.
- Exactly one of I(argv) or I(command) must be specified.
- Exactly one of O(argv) or O(command) must be specified.
command:
type: str
description:
- The command to execute.
- Exactly one of I(argv) or I(command) must be specified.
- Exactly one of O(argv) or O(command) must be specified.
chdir:
type: str
description:
- The directory to run the command in.
detach:
description:
- Whether to run the command synchronously (I(detach=false), default) or asynchronously (I(detach=true)).
- If set to C(true), I(stdin) cannot be provided, and the return values C(stdout), C(stderr) and
C(rc) are not returned.
- Whether to run the command synchronously (O(detach=false), default) or asynchronously (O(detach=true)).
- If set to V(true), O(stdin) cannot be provided, and the return values RV(stdout), RV(stderr), and
RV(rc) are not returned.
type: bool
default: false
version_added: 2.1.0
@@ -68,12 +68,12 @@ options:
type: str
description:
- Set the stdin of the command directly to the specified value.
- Can only be used if I(detach=false).
- Can only be used if O(detach=false).
stdin_add_newline:
type: bool
default: true
description:
- If set to C(true), appends a newline to I(stdin).
- If set to V(true), appends a newline to O(stdin).
strip_empty_ends:
type: bool
default: true
@@ -87,15 +87,15 @@ options:
env:
description:
- Dictionary of environment variables with their respective values to be passed to the command ran inside the container.
- Values which might be parsed as numbers, booleans or other types by the YAML parser must be quoted (for example C("true")) in order to avoid data loss.
- Please note that if you are passing values in with Jinja2 templates, like C("{{ value }}"), you need to add C(| string) to prevent Ansible to
convert strings such as C("true") back to booleans. The correct way is to use C("{{ value | string }}").
- Values which might be parsed as numbers, booleans or other types by the YAML parser must be quoted (for example V("true")) in order to avoid data loss.
- Please note that if you are passing values in with Jinja2 templates, like V("{{ value }}"), you need to add V(| string) to prevent Ansible to
convert strings such as V("true") back to booleans. The correct way is to use V("{{ value | string }}").
type: dict
version_added: 2.1.0
notes:
- Does not support C(check_mode).
- Does B(not work with TCP TLS sockets) when using I(stdin). This is caused by the inability to send C(close_notify) without closing the connection
- Does B(not work with TCP TLS sockets) when using O(stdin). This is caused by the inability to send C(close_notify) without closing the connection
with Python's C(SSLSocket)s. See U(https://github.com/ansible-collections/community.docker/issues/605) for more information.
author:
- "Felix Fontein (@felixfontein)"
@@ -134,23 +134,23 @@ EXAMPLES = '''
RETURN = '''
stdout:
type: str
returned: success and I(detach=false)
returned: success and O(detach=false)
description:
- The standard output of the container command.
stderr:
type: str
returned: success and I(detach=false)
returned: success and O(detach=false)
description:
- The standard error output of the container command.
rc:
type: int
returned: success and I(detach=false)
returned: success and O(detach=false)
sample: 0
description:
- The exit code of the command.
exec_id:
type: str
returned: success and I(detach=true)
returned: success and O(detach=true)
sample: 249d9e3075655baf705ed8f40488c5e9434049cf3431976f1bfdb73741c574c5
description:
- The execution ID of the command.