Skip to content

docs/refactor: Update the documentation for --rm flag in run.md #4293

Closed
tumunshaily wants to merge 1 commit into
docker:masterfrom
tumunshaily:master
Closed

docs/refactor: Update the documentation for --rm flag in run.md #4293
tumunshaily wants to merge 1 commit into
docker:masterfrom
tumunshaily:master

Conversation

@tumunshaily
Copy link
Copy Markdown

The current description for the --rm flag doesn't talk about removing the anonyms volume deletion. As add the flag is also responsible for deleting the anonyms volume created with the container.

Signed-off-by: tumunshaily tumunshaily@gmail.com

… the anonyms volume deletion. As add the flag is also responsible for deleting the anonyms volume created with the container.

Signed-off-by: tumunshaily <tumunshaily@gmail.com>
@thaJeztah
Copy link
Copy Markdown
Member

Thanks for contributing! I'm slightly on the fence whether Auto-remove is the right term to start the flag description with. Perhaps "Automatically remove the container and its anonymous volumes upon exit."

This section of the documentation is automatically generated from the source-code, so if we want to update the description, the code should be updated.

flags.BoolVar(&copts.autoRemove, "rm", false, "Automatically remove the container when it exits")

We should probably (also) update the section that describes the --rm flag;

## Clean up (--rm)

There's also some other parts that mention the flag description, e.g.;

@dvdksn ptal

@dvdksn
Copy link
Copy Markdown
Contributor

dvdksn commented Jun 26, 2023

The revision suggested by @thaJeztah SGTM: "Automatically remove [...]"

@thaJeztah
Copy link
Copy Markdown
Member

superseded by #5084

@thaJeztah thaJeztah closed this May 14, 2026
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