Update docs/command output for volume pruning #4497
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
In previous versions of the Docker API, `system prune --volumes` and `volume prune` would remove all dangling volumes. With API v1.42, this was changed so that only anonymous volumes would be removed unless the all filter was specified. Some of the docs were updated in docker#4218, however, there were a couple of places left that didn't make the anonymous vs named volumes distinction clear. This replaces docker#4079, which was bitrotted by docker#4218. See also docker#4028. Closes docker#4079. Signed-off-by: Ed Morley <501702+edmorley@users.noreply.github.com>
neersighted
approved these changes
Aug 12, 2023
cpuguy83
approved these changes
Aug 16, 2023
|
The |
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## master #4497 +/- ##
==========================================
+ Coverage 58.97% 59.39% +0.41%
==========================================
Files 286 288 +2
Lines 24773 24780 +7
==========================================
+ Hits 14611 14717 +106
+ Misses 9275 9176 -99
Partials 887 887 |
vvoland
approved these changes
Aug 17, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In previous versions of the Docker API,
system prune --volumesandvolume prunewould remove all dangling volumes. With API v1.42, this was changed so that only anonymous volumes would be removed unless the all filter was specified.Some of the docs were updated in #4218, however, there were a couple of places left that didn't make the anonymous vs named volumes distinction clear.
This replaces #4079, which was bitrotted by #4218. See also #4028.
Closes #4079.
- What I did
docker system prune --helpusage text's description of the--volumesoptiondocker system prune --volumesto be clearer that only anonymous volumes will be removeddocker volume prune --helpusage text, so the overall command description no longer confusingly uses the word "all", given that by default it doesn't remove all volumes- How I did it
See above
- How to verify it
Run
docker system prune --help,docker system prune --volumesanddocker volume prune --help.- Description for the changelog
N/A (since these are only single word edits to usage text/misc command output, I don't think it needs a changelog entry - happy to add one if preferred though).
- A picture of a cute animal (not mandatory but encouraged)