Skip to content

docs: import: assorted fixes and touch-ups#6053

Merged
thaJeztah merged 4 commits into
docker:masterfrom
thaJeztah:import_docs
May 8, 2025
Merged

docs: import: assorted fixes and touch-ups#6053
thaJeztah merged 4 commits into
docker:masterfrom
thaJeztah:import_docs

Conversation

@thaJeztah
Copy link
Copy Markdown
Member

@thaJeztah thaJeztah commented May 6, 2025


docs: import: fix anchor-links and minor touch-up

  • Put the content related to --change 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.

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 validCommitCommands variable.

docs: import: update documentation for --platform

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.

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)

@thaJeztah thaJeztah added this to the 28.1.2 milestone May 6, 2025
@thaJeztah thaJeztah requested a review from a team as a code owner May 6, 2025 17:30
@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented May 6, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 58.99%. Comparing base (25a1681) to head (4520a39).

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:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

thaJeztah added 4 commits May 6, 2025 19:40
- 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>
@thaJeztah
Copy link
Copy Markdown
Member Author

Let me bring this one in; some of this should also be applied to docker commit, which uses the same list of "changes" that are allowed, so I'll probably open a follow-up PR to apply similar changes there.

@thaJeztah thaJeztah merged commit 6f85626 into docker:master May 8, 2025
87 checks passed
@thaJeztah thaJeztah deleted the import_docs branch May 8, 2025 10:53
@thaJeztah thaJeztah modified the milestones: 28.1.2, 28.2.0 May 15, 2025
@thaJeztah thaJeztah self-assigned this May 16, 2025
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.

docker import: Need a -c example docker import: Need a -c example

4 participants