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: Fix --rm=false flag in container_run.md #5435

Merged
merged 1 commit into from
Sep 16, 2024

Conversation

juliogarciape
Copy link
Contributor

- What I did

Corrected the usage of the --rm=false flag in the container_run.md documentation example. See Docker Container Run - Clean up for reference.

- How I did it

Removed the incorrect --rm=false flag from the example and updated it to use the --rm flag to comply with the example text: Automatically remove the container when it exits. Also for the --rm=true flag it is not necessary to specify true, as that is the default behavior.

- How to verify it

  1. Run the command docker run --rm alpine echo "Hello World" in a Docker environment to confirm that the container is automatically removed after execution.
  2. Run the command docker run --rm=false alpine echo "Hello World" in a Docker environment to confirm that the container is not automatically removed after execution.
  3. All available Docker documentation and CLI help indicate that the --rm flag is used to remove a container when it exits. There is an error in the example of container run when it states that setting --rm=false will remove a container when it exits.

- Description for the changelog

docs/cli/container_run: Fix example usage of `--rm=false` flag to `--rm` in container_run.md

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

@juliogarciape juliogarciape requested review from thaJeztah and a team as code owners September 14, 2024 00:49
Copy link
Collaborator

@laurazard laurazard left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@codecov-commenter
Copy link

codecov-commenter commented Sep 16, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 59.75%. Comparing base (a18c896) to head (605c9bf).
Report is 16 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #5435   +/-   ##
=======================================
  Coverage   59.75%   59.75%           
=======================================
  Files         345      345           
  Lines       23428    23428           
=======================================
  Hits        13999    13999           
  Misses       8455     8455           
  Partials      974      974           

Copy link
Member

@thaJeztah thaJeztah left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks!

@thaJeztah thaJeztah merged commit a4619f3 into docker:master Sep 16, 2024
101 checks passed
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.

4 participants