docs: import: assorted fixes and touch-ups#6053
Merged
Merged
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #6053 +/- ##
=======================================
Coverage 58.99% 58.99%
=======================================
Files 358 358
Lines 30004 30004
=======================================
Hits 17700 17700
Misses 11323 11323
Partials 981 981 🚀 New features to boost your workflow:
|
- Put the content related to `--changes` under a heading with the correct anchor, so that it will be linked from the "options" table. - Move note about `sudo` to be under the right example. - Update some examples to directly read from a file instead of piping. - Add heading for the `--message` flag. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Update the list of accepted "change" commands to match what's accepted by the daemon. This list is the same for "docker commit" and "docker import", which is defined by the [`validCommitCommands`] variable. [`validCommitCommands`]: https://github.com/moby/moby/blob/v28.1.1/builder/dockerfile/builder.go#L30-L42 Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
The `--platform` flag originally was added for the experimental LCOW feature and only accepted the target operating system. Current versions of Docker allow passing both OS and Architecture, so updating the documentation to reflect this. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Benehiko
approved these changes
May 7, 2025
Member
Author
|
Let me bring this one in; some of this should also be applied to |
This file contains hidden or 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
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.
docker commit --change#169docs: import: fix anchor-links and minor touch-up
--changeunder a heading with the correctanchor, so that it will be linked from the "options" table.
sudoto be under the right example.--messageflag.docs: import: update list of supported options for --change
Update the list of accepted "change" commands to match what's accepted
by the daemon. This list is the same for "docker commit" and "docker import",
which is defined by the
validCommitCommandsvariable.docs: import: update documentation for --platform
The
--platformflag originally was added for the experimental LCOWfeature and only accepted the target operating system. Current versions
of Docker allow passing both OS and Architecture, so updating the
documentation to reflect this.
docs: import: add example for multiple --change flags
- What I did
- How I did it
- How to verify it
- Human readable description for the release notes
- A picture of a cute animal (not mandatory but encouraged)