summaryrefslogtreecommitdiff
path: root/docs/source/markdown/podman-pull.1.md.in
Commit message (Collapse)AuthorAge
* Man pages: refactor common options: --disable-content-trustEd Santiago2022-08-23
| | | | | | | | | | | | A NOP option. I chose the container word, of course, and the word 'option' instead of 'flag'. I also hyphenated where needed. I'm choosing to eliminate the "not on remote" text, because I don't think it's true: podman-remote happily accepts that flag on all those commands, including build. (It's marked as hidden on build, but still accepted). Signed-off-by: Ed Santiago <santiago@redhat.com>
* Merge pull request #15412 from edsantiago/docs_dedup_credsOpenShift Merge Robot2022-08-22
|\ | | | | Man pages: refactor common options: --creds
| * Man pages: refactor common options: --credsEd Santiago2022-08-22
| | | | | | | | | | | | | | | | | | | | | | | | | | Refactor the --creds option. I went with the one in podman-pull The main difference between all of them is the '####' line, differences in the param descriptions. podman-pull had the clearest one. This is another one that hack/markdown-preprocess-review is good for reviewing. Signed-off-by: Ed Santiago <santiago@redhat.com>
* | Merge pull request #15409 from vrothberg/fix-15300OpenShift Merge Robot2022-08-22
|\ \ | |/ |/| [CI:DOCS] elaborate on image lookups of foreign platforms
| * [CI:DOCS] elaborate on image lookups of foreign platformsValentin Rothberg2022-08-22
| | | | | | | | | | | | | | | | | | | | | | | | | | | | After pulling/creating an image of a foreign platform, Podman will happily use it when looking it up in the local storage and will not pull down the image matching the host platform. As discussed in #12682, the reasoning for it is Docker compatibility and the fact that user already rely on the behavior. While Podman is now emitting a warning when an image is in use not matching the local platform, the documentation was lacking that information. Fixes: #15300 Signed-off-by: Valentin Rothberg <vrothberg@redhat.com>
* | Man pages: refactor common options: cert-dirEd Santiago2022-08-22
|/ | | | | | | ...and, tweak markdown-process-review so it can detect and remove identical files, making review easier. Signed-off-by: Ed Santiago <santiago@redhat.com>
* Man pages: refactor common options: authfileEd Santiago2022-08-16
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Refactor the --authfile option. My suggestion for review: 1) run hack/markdown-preprocess-review and immediately Ctrl-Q to quit out of diffuse, which is completely unusable for this many files; then 2) cd /tmp/markdown-preprocess-review.diffs/authfile - this is the directory created by the review script 3) rm podman-image-sign* podman-log* podman-search.1.md.in - because they're essentially identical to podman-create 4) rm podman-manifest-* podman-push.* - because they're 100% identical to podman-kube-play 5) rm podman-kube-play* - because it's apart-from-whitespace identical to podman-build (use "wdiff" to confirm) 6) rm podman-auto-update* - because that's the one I chose (hence == zzz-chosen.md) (You should obviously run your own diff/cmp before rm, to confirm my assertions about which files are identical). After all that, you have a manageable number of files which you can scan, read, diff against zzz-chosen.md, even run diffuse. This option is IMHO the poster child for why we need this kind of man page refactoring. Signed-off-by: Ed Santiago <santiago@redhat.com>
* Man pages: refactor common options: archEd Santiago2022-08-15
| | | | | | | | | | | | | | | | | | Smaller, more reviewable chunks. This is just one option, --arch. Future PRs may, if the reviewing is easy, include multiple options. This one includes fixes to the preprocessor script, though: * big oops, I was not handling '<<something pod|something>>' where 'pod' appears other than the beginning of the string. * I was also not handling 'container<<| or pod>>', where one side was empty. * Behavior change: <<subcommand>>, on podman-pod-foo, becomes just 'foo' (not 'pod foo'). This will be useful in a future PR where we refactor --pod-id-file. Signed-off-by: Ed Santiago <santiago@redhat.com>
* Refactor common man page options, phase 2Ed Santiago2022-08-09
Followup to #15174. These are the options that are easy(ish) to review: those that have only drifted slightly, and need only minor tweaks to bring back to sanity. For the most part, I went with the text in podman-run because that was cleaned up in #5192 way back in 2020. These diffs primarily consist of using '**' (star star) instead of backticks, plus other formatting and punctuation changes. This PR also adds a README in the options dir, and a new convention: <<container text...|pod text...>> which tries to do the right thing based on whether the man page name includes "-pod-" or not. Since that's kind of hairy code, I've also added a test suite for it. Finally, since this is impossible to review by normal means, I'm temporarily committing hack/markdown-preprocess-review, a script that will diff option-by-option. I will remove it once we finish this cleanup, but be advised that there are still 130+ options left to examine, and some of those are going to be really hard to reunite. Review script usage: simply run it (you need to have 'diffuse' installed). It isn't exactly obvious, but it shouldn't take more than a minute to figure out. The rightmost column (zzz-chosen.md) is the "winner", the actual content that will be used henceforth. You really want an ultrawide screen here. Signed-off-by: Ed Santiago <santiago@redhat.com>