Skip to content

[DOCS] Update save and load docs to make dir loading support clearer#27961

Merged
ashley-cui merged 1 commit into
podman-container-tools:mainfrom
ninja-quokka:load_and_save_docs
Jun 23, 2026
Merged

[DOCS] Update save and load docs to make dir loading support clearer#27961
ashley-cui merged 1 commit into
podman-container-tools:mainfrom
ninja-quokka:load_and_save_docs

Conversation

@ninja-quokka

Copy link
Copy Markdown
Contributor

Podman remote clients don't support loading images from directories, this patch aims to make that clearer.

This patch also aims to make it clearer that podman-load can load from URLs, directories and tar archives.

Fixes: #27952

Checklist

Ensure you have completed the following checklist for your pull request to be reviewed:

  • Certify you wrote the patch or otherwise have the right to pass it on as an open-source patch by signing all
    commits. (git commit -s). (If needed, use git commit -s --amend). The author email must match
    the sign-off email address. See CONTRIBUTING.md
    for more information.
  • Referenced issues using Fixes: #00000 in commit message (if applicable)
  • Tests have been added/updated (or no tests are needed)
  • Documentation has been updated (or no documentation changes are needed)
  • All commits pass make validatepr (format/lint checks)
  • Release note entered in the section below (or None if no user-facing changes)

Does this PR introduce a user-facing change?

None

@baude baude left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM

@GadgetSteve

Copy link
Copy Markdown

IMHO these changes do not make it clearer that save formats oci_dir and docker_dir will result in directories that cannot be loaded on Windows with the podman load command - there is some, small, footnote, mention of not being compatible with podman_remote but on Windows the command being used is not podman_remote it is podman.

I feel that this change, with increased emphasis on saving to & load from directories makes it less clear to me personally and possibly to others.

Please consider, in the main text, something like:

podman\-load - Load image(s) from tar archives (all platforms), directories (Linux only), or URLs into container storage.

| **oci-dir**        | A directory using the OCI Image Format (only loadable on Linux Hosts)        |                                    |
| **docker-dir**     | **dir** transport (see **containers-transports(5)**) with v2s2 manifest type (only loadable on Linux Hosts) |

@jankaluza

Copy link
Copy Markdown
Contributor

LGTM.

@ninja-quokka

Copy link
Copy Markdown
Contributor Author

IMHO these changes do not make it clearer that save formats oci_dir and docker_dir will result in directories that cannot be loaded on Windows with the podman load command - there is some, small, footnote, mention of not being compatible with podman_remote but on Windows the command being used is not podman_remote it is podman.

I feel that this change, with increased emphasis on saving to & load from directories makes it less clear to me personally and possibly to others.

Please consider, in the main text, something like:

podman\-load - Load image(s) from tar archives (all platforms), directories (Linux only), or URLs into container storage.

| **oci-dir**        | A directory using the OCI Image Format (only loadable on Linux Hosts)        |                                    |
| **docker-dir**     | **dir** transport (see **containers-transports(5)**) with v2s2 manifest type (only loadable on Linux Hosts) |

Sadly we support Podman remote on Linux hosts so your example isn't 100% correct sadly. I think the foot note is an improvement so I'm going to mark this PR as ready for review (even thought the wonderful Podman maintainers have already started reviewing this patch!)

@ninja-quokka ninja-quokka marked this pull request as ready for review February 1, 2026 07:14
@ninja-quokka

Copy link
Copy Markdown
Contributor Author

/cc @Luap99 @Honny1 <3

@Honny1 Honny1 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I have only one small nit. Otherwise LGTM.

Comment thread docs/source/markdown/podman-load.1.md Outdated
Comment thread docs/source/markdown/podman-load.1.md Outdated
Comment thread docs/source/markdown/podman-load.1.md Outdated
Comment thread docs/source/markdown/podman-load.1.md Outdated
@github-actions

github-actions Bot commented Mar 8, 2026

Copy link
Copy Markdown

A friendly reminder that this PR had no activity for 30 days.

@Honny1

Honny1 commented Mar 10, 2026

Copy link
Copy Markdown
Contributor

@ninja-quokka PTAL

@github-actions github-actions Bot removed the stale-pr label Mar 11, 2026
@ashley-cui

Copy link
Copy Markdown
Contributor

@ninja-quokka Friendly ping - if you still have the time for this, a rebase would be necessary when you update it :)

Podman remote clients don't support loading images from directories,
this patch aims to make that clearer.

This patch also aims to make it clearer that podman-load can load from
URLs, directories and tar archives.

Drop incorrect claims that --input is required on remote clients
(stdin reading is supported) and avoid 'Linux only' wording since
podman has native FreeBSD support.

Fixes: podman-container-tools#27952

Signed-off-by: Lewis Denny <lewisdenny@me.com>
@ninja-quokka

Copy link
Copy Markdown
Contributor Author

@ninja-quokka Friendly ping - if you still have the time for this, a rebase would be necessary when you update it :)

Thank you for the ping @ashley-cui !

Rebased and addressed feedback :)

@ashley-cui

Copy link
Copy Markdown
Contributor

LGTM. Thanks!

@ashley-cui ashley-cui merged commit a61215a into podman-container-tools:main Jun 23, 2026
66 of 70 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Documentation for image save does not show some formats as not loadable

7 participants