aboutsummaryrefslogtreecommitdiff
path: root/docs/source/markdown/podman-build.1.md.in
Commit message (Collapse)AuthorAge
* Fixup Buildah mergeEd Santiago2022-09-23
| | | | | | | | | | | | | Changes since 2022-09-09: - man page: add --skip-unused-stages (buildah 4249) - man page: bring in new Note for --cache-ttl (4248) - system tests: de-stutter (4205) - (internal): in skip() applier: escape asterisk, otherwise the "bud with --dns* flags" sed expression never applies. Signed-off-by: Ed Santiago <santiago@redhat.com> Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
* Man pages: Refactor common options: --dnsEd Santiago2022-09-15
| | | | | | | | | | | | | | Only between podman-build, create, and run. podman-pod-create is too different. As usual I went with the podman-run version. This means keeping the word "flag" (which should be "option"), for ease of review. I will fix in my in-progress cleanup PR. For podman-build, I removed "during the build" and changed it to a note for that man page only. Signed-off-by: Ed Santiago <santiago@redhat.com>
* Man pages: refactor common options: --shm-sizeEd Santiago2022-09-14
| | | | | | | | | | | | | Mostly went with the podman-run version. For ease of review, I kept the "you" word -- I will fix that in my in-progress cleanup PR. This affects lots of files, each of which had slightly different wording, but this actually isn't as bad as it looks. The diffs were minor, and I'm pretty sure the new refactored text applies equally well to all the man pages. Signed-off-by: Ed Santiago <santiago@redhat.com>
* Man pages: refactor common options: --tls-verifyEd Santiago2022-09-13
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Ugh. This had about five different variations among twelve files. I went with the version from podman-create, kube play, login, pull, push, run. The others: - manifest-add and create did not include the "true, false, missing" text. Now they do. (If this text is N/A to these two, please yell). Also, these two were written with "talking" instead of "contacting" the registry. - podman-build had "does not work with remote", but this does not seem to be true, so I removed it. None of the other files had that. - the wording in podman-search is just weird, with "if needed" and "is listed" and unclear "insecure registries". I just nuked it all. If that wording was deliberate, for some reason that applies only to podman-search, please yell. - podman-container-runlabel has one diff that I like, actually spelling out containers-registries.conf(5), but incorporating that would make this even harder to review. I will add that to my in-progress doc-cleanup PR. Review recommendation: run hack/markdown-preprocess-review but just quit out of it immediately (on both popups). Ignore it completely. Then cd /tmp/markdown-preprocess-review.diffs/tls-verify and run $ clear;for i in podman-*;do echo;echo $i;wdiff -t $i zzz-chosen.md;done This will show the major diffs between each version and the chosen one. Assumes you have wdiff installed. If you have another colorize-actual- individual-word-diffs tool installed, use that. I like cdif[1]. [1] https://github.com/kaz-utashiro/sdif-tools Signed-off-by: Ed Santiago <santiago@redhat.com>
* Fixes for vendoring BuildahEd Santiago2022-09-09
| | | | | | | | | | | | | | | | | | | | | This commit was automatically cherry-picked by buildah-vendor-treadmill v0.3 from the buildah vendor treadmill PR, #13808 Changes since 2022-08-16: - buildah 4139: minor line-number changes to the diff file because helpers.bash got edited - buildah 4190: skip the new test if remote - buildah 4195: add --retry / --retry-delay - changes to deal with vendoring gomega, units - changes to the podman login error message in system test Signed-off-by: Paul Holzinger <pholzing@redhat.com>
* Merge pull request #15621 from ventifus/fix-manpage-headerOpenShift Merge Robot2022-09-06
|\ | | | | [CI:DOCS] Fix manpage header formatting
| * Fix manpage headersAndrew Denton2022-09-06
| | | | | | | | Signed-off-by: Andrew Denton <adenton@redhat.com>
* | Man pages: refactor common options: --deviceEd Santiago2022-09-06
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The refactors are starting to get harder to review - sorry. Here the differences are pretty small, mostly changes to the "it is a combination" wording and some asteriskization. The more significant diffs are that there are some Notes that are pod- or container- or build-specific; I needed to move those from the middle to the end, then keep them in the source files themselves. I don't think this affects readability of the resulting man pages, but your opinion may differ. Last important thing: I included the /dev/fuse text in the common option, which means it will now show up in podman-build (it was not previously there). If this text is not applicable to podman-build, please LMK ASAP so I can just move it back to individual source files. Signed-off-by: Ed Santiago <santiago@redhat.com>
* | Man pages: refactor common options: --memory*Ed Santiago2022-09-05
| | | | | | | | | | | | | | | | | | (memory-star, i.e., several memory options) that didn't get included in #15276. Most of them are shoo-ins; the two in container-clone and pod-clone deserve special attention because of the "If unspecified" wording. Signed-off-by: Ed Santiago <santiago@redhat.com>
* | Fix list of default capabilitiesDaniel J Walsh2022-09-05
|/ | | | | | Fixes: https://github.com/containers/podman/issues/15626 Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
* Merge pull request #15429 from graywolf-at-work/document-transportOpenShift Merge Robot2022-08-23
|\ | | | | Document restrictions on transport in FROM
| * Document restrictions on transport in FROMTomas Volf2022-08-23
| | | | | | | | | | | | | | | | When using remote podman client, not all transports work as expected. So document this limitation. Fixes: containers/podman#15141 Signed-off-by: Tomas Volf <tomas.volf@showmax.com>
* | 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>
* docs: specify git protocol is not supported for github hosted repoAditya R2022-08-11
| | | | | | | | | | | | | Build from URL does not supports `git://` is source is hosted on Github. Reason: https://github.blog/2021-09-01-improving-git-protocol-security-github/ [CI:DOCS] [NO NEW TESTS NEEDED] [NO TESTS NEEDED] Similar to: https://github.com/containers/buildah/pull/4179 Signed-off-by: Aditya R <arajan@redhat.com>
* Document behavior of --timestamp when only FROM is usedTomas Volf2022-08-10
| | | | | | Fixes: #15171 Signed-off-by: Tomas Volf <tomas.volf@showmax.com>
* Man pages: refactor common optionsEd Santiago2022-08-09
Continued. Harder-to-review ones this time. Signed-off-by: Ed Santiago <santiago@redhat.com>