Skip to content

[27.x backport] docs, man: remove confusing example for "--isolation"#5721

Merged
thaJeztah merged 1 commit intodocker:27.xfrom
thaJeztah:27.x_backport_docs
Jan 3, 2025
Merged

[27.x backport] docs, man: remove confusing example for "--isolation"#5721
thaJeztah merged 1 commit intodocker:27.xfrom
thaJeztah:27.x_backport_docs

Conversation

@thaJeztah
Copy link
Copy Markdown
Member

This snippet was added in docker@38ec5d8. The intent was to indicate that an empty value is equivalent to passing "default" as value. However, passing the --isolation flag without a value (i.e., no = specified) will fail in many cases, as any string after it will be parsed as value (e.g. docker run --isolation busybox would consider busybox as value).

This patch removes these lines as they add more confusion than addressing.

(cherry picked from commit 7b7a4c0)

- Description for the changelog

- A picture of a cute animal (not mandatory but encouraged)

This snippet was added in [docker/cli@38ec5d8][1]. The intent was to indicate
that an empty value is equivalent to passing "default" as value. However,
passing the `--isolation` flag _without a value_ (i.e., no `=` specified)
will fail in many cases, as any string after it will be parsed as value
(e.g. `docker run --isolation busybox` would consider `busybox` as value).

This patch removes these lines as they add more confusion than addressing.

[1]: moby/moby@38ec5d8

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
(cherry picked from commit 7b7a4c0)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
@thaJeztah thaJeztah added this to the 27.5.0 milestone Jan 3, 2025
@thaJeztah thaJeztah self-assigned this Jan 3, 2025
@thaJeztah thaJeztah requested a review from a team as a code owner January 3, 2025 17:43
@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented Jan 3, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 58.58%. Comparing base (074820d) to head (261d224).
Report is 3 commits behind head on 27.x.

Additional details and impacted files
@@           Coverage Diff           @@
##             27.x    #5721   +/-   ##
=======================================
  Coverage   58.58%   58.58%           
=======================================
  Files         346      346           
  Lines       29322    29322           
=======================================
  Hits        17178    17178           
  Misses      11171    11171           
  Partials      973      973           

@thaJeztah thaJeztah merged commit 498a416 into docker:27.x Jan 3, 2025
@thaJeztah thaJeztah deleted the 27.x_backport_docs branch January 3, 2025 18:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants