Doc fix for docker_container image_name_mismatch (#991) (#997)

* doc-fix-image-name-mismatch

* Update description.

---------

Co-authored-by: Felix Fontein <felix@fontein.de>
(cherry picked from commit 6595d299e2)

Co-authored-by: Michael <meeque@users.noreply.github.com>
This commit is contained in:
patchback[bot] 2024-11-23 14:30:42 +01:00 committed by GitHub
parent 46e860dcdb
commit 8fc562825c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -482,8 +482,8 @@ options:
- Determines what the module does if the image matches, but the image name in the container's configuration - Determines what the module does if the image matches, but the image name in the container's configuration
does not match the image name provided to the module. does not match the image name provided to the module.
- "This is ignored if C(image: ignore) is set in O(comparisons)." - "This is ignored if C(image: ignore) is set in O(comparisons)."
- If set to V(recreate) the container will be recreated. - If set to V(recreate) (default) the container will be recreated.
- If set to V(ignore) (currently the default) the container will not be recreated because of this. It might still get recreated for other reasons. - If set to V(ignore) the container will not be recreated because of this. It might still get recreated for other reasons.
This has been the default behavior of the module for a long time, but might not be what users expect. This has been the default behavior of the module for a long time, but might not be what users expect.
- Since community.docker 3.5.0, the default V(ignore) has been deprecated. If not specified, a deprecation warning - Since community.docker 3.5.0, the default V(ignore) has been deprecated. If not specified, a deprecation warning
will be emitted if this setting would make a difference. The default will change to V(recreate) in community.docker 4.0.0. will be emitted if this setting would make a difference. The default will change to V(recreate) in community.docker 4.0.0.