Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs, man: remove confusing example for "--isolation" #5718

Merged
merged 1 commit into from
Jan 3, 2025

Conversation

thaJeztah
Copy link
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.

- 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>
@codecov-commenter
Copy link

codecov-commenter commented Jan 2, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 59.52%. Comparing base (07aca45) to head (7b7a4c0).
Report is 6 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #5718   +/-   ##
=======================================
  Coverage   59.52%   59.52%           
=======================================
  Files         346      346           
  Lines       29381    29381           
=======================================
  Hits        17488    17488           
  Misses      10923    10923           
  Partials      970      970           

@thaJeztah thaJeztah merged commit 5be685e into docker:master Jan 3, 2025
104 checks passed
@thaJeztah thaJeztah deleted the remove_isolation_hint branch January 3, 2025 13:49
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