summaryrefslogtreecommitdiff
path: root/docs
Commit message (Collapse)AuthorAge
* Merge pull request #5233 from QiWang19/login/out-parameterOpenShift Merge Robot2020-02-19
|\ | | | | fix mandatory parameter in login/logout
| * fix mandatory parameter in login/logoutQi Wang2020-02-18
| | | | | | | | | | | | | | fix #5146 Insted of using a registry as mandatory parameter, this path allows podman to use the first registry from registries.conf. Signed-off-by: Qi Wang <qiwan@redhat.com>
* | Merge pull request #5243 from Akasurde/misc_typoOpenShift Merge Robot2020-02-18
|\ \ | |/ |/| Misc typo fixes
| * Misc typo fixesAbhijeet Kasurde2020-02-18
| | | | | | | | Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
* | Merge pull request #5223 from vrothberg/ps-image-idOpenShift Merge Robot2020-02-18
|\ \ | |/ |/| podman-ps: support image IDs
| * podman-ps: support image IDsValentin Rothberg2020-02-17
| | | | | | | | | | | | | | Support printing image IDs via `--format "{{.ImageID}}"`. Fixes: #5160 Signed-off-by: Valentin Rothberg <rothberg@redhat.com>
* | Update documentation of commit command to show image reference is optionalAllan Jacquet-Cretides2020-02-15
|/ | | | | | | | | | | Following Commit ba1d1304a67b ("make image reference for commit optional") Updates usage text used by cobra and markdown document used to generate MAN page. Fixes: #5145 Signed-off-by: Allan Jacquet-Cretides <allan.jacquet@gmail.com>
* Merge pull request #5199 from leorochael/patch-1OpenShift Merge Robot2020-02-14
|\ | | | | Enhance fuse-overlayfs instructions.
| * Enhance fuse-overlayfs instructions.Leonardo Rochael Almeida2020-02-13
| | | | | | | | | | | | | | | | | | | | | | The `fuse-overlayfs` package provided by Ubuntu up to 19.10, is not recent enough and causes errors on `buildah commit`, for instance. Adjust the rootless tutorial to point this out and to provide more detailed instructions on how to obtain `fuse-overlayfs` and configure it for use by `libpod`. Signed-off-by: Leonardo Rochael Almeida <leorochael@gmail.com>
* | Merge pull request #5192 from kolyshkin/manOpenShift Merge Robot2020-02-14
|\ \ | |/ |/| podman-run(1): fixes
| * podman(1): fixesKir Kolyshkin2020-02-13
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | I saw some bad formatting when reading "man podman-run" and proceeded to fix it. I have now opened a can of worms... This commit tries to fix some of the formatting, wording and other bugs I came across (unfortunately not all of them). Can't list every fix that I made here, but in general: - format lists as such (prepend items with "- "); - format examples as such (enclose in ```...```); - format literal values (option names, literal values) as **bold**; - format man page references as **page**(1). - format replacements (option values) and file names as _italic_; - remove some duplicate info (such as what's the default value); - move option value description to option syntax; - end sentences with a period. To test: ```console $ make docs $ man ./docs/build/man/podman-run.1 ### check terminal formatting $ man -Tps ./docs/build/man/podman-run.1 > podman-run.ps $ ps2pdf podman-run.ps ### optional $ evince podman-run.pdf ### check printer formatting (or use ps viewr ``` NOTE - there is much more to do here; - I haven't checked any factual contents, this is about formatting Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com>
* | Merge pull request #5115 from QiWang19/images-formatOpenShift Merge Robot2020-02-13
|\ \ | | | | | | images --format compatible with docker
| * | images --format compatible with dockerQi Wang2020-02-10
| | | | | | | | | | | | | | | | | | | | | This patch lets valid values of --format be compatible with docker. Replace CreatedTime with CreatedAt, Created with CreatedSince. Keep CreatedTime and Created are valid as hidden options. Signed-off-by: Qi Wang <qiwan@redhat.com>
* | | Merge pull request #5152 from QiWang19/device-cgroup-ruleOpenShift Merge Robot2020-02-13
|\ \ \ | |_|/ |/| | support device-cgroup-rule
| * | support device-cgroup-ruleQi Wang2020-02-12
| |/ | | | | | | | | | | | | fix #4876 Add `--device-cgroup-rule` to podman create and run. This enables to add device rules after the container has been created. Signed-off-by: Qi Wang <qiwan@redhat.com>
* | Merge pull request #5144 from marusak/doc_fixesOpenShift Merge Robot2020-02-12
|\ \ | |/ |/| [CI:DOCS] podman system service doc fixes
| * doc: Fix examples for 'podman system service'Matej Marusak2020-02-10
| | | | | | | | Signed-off-by: Matej Marusak <mmarusak@redhat.com>
* | docs: add workaround for --device with rootless containers (II)Stefan Becker2020-02-10
|/ | | | | | | | | | Update documentation for crun >= 0.11. See https://github.com/containers/crun/commit/6df930821d80a8e151674f0fda1321fba93bb92d Fixes #4477 Signed-off-by: Stefan Becker <chemobejk@gmail.com>
* Move podman-service to podman-system-serviceMatthew Heon2020-02-06
| | | | | | Fixes #5108 Signed-off-by: Matthew Heon <mheon@redhat.com>
* Force --all when --filter is passed to podman psMatthew Heon2020-02-04
| | | | | | | | | | When we filter, it should be out of all containers, not just running ones, by default - this is necessary to ensure Docker compatability. Fixes #5050 Signed-off-by: Matthew Heon <mheon@redhat.com>
* Update XML to not embed quote in PATH on windowsJhon Honce2020-01-31
| | | | | | | | * Remove the unsupported commend in lua script Fixes #4335 Signed-off-by: Jhon Honce <jhonce@redhat.com>
* Merge pull request #5028 from baude/commitimageOpenShift Merge Robot2020-01-30
|\ | | | | make image reference for commit optional
| * make image reference for commit optionalBrent Baude2020-01-30
| | | | | | | | | | | | | | | | to match docker compat, the image tag should be optional. Fixes: #5027 Signed-off-by: Brent Baude <bbaude@redhat.com>
* | Merge pull request #5024 from rpjday/markdown/asterisksOpenShift Merge Robot2020-01-30
|\ \ | |/ |/| markdown: fix erroneous asterisk markup for options
| * markdown: fix erroneous asterisk markup for optionsRobert P. J. Day2020-01-30
| | | | | | | | | | | | | | Fix option markup in a number of man pages so it renders properly when viewing online. Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
* | Merge pull request #4951 from rpjday/docs/unshareOpenShift Merge Robot2020-01-30
|\ \ | |/ |/| markdown: fix grammar/formatting, standardize on markdown
| * markdown: fix grammar/formatting, standardize on markdownRobert P. J. Day2020-01-23
| | | | | | | | | | | | | | | | | | | | | | While fixing grammar and list formatting issues, standardize on markdown as follows: - commands are marked by '**' - files are marked by backquotes - list items are marked with leading '-' Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
* | Merge pull request #4997 from jwhonce/issues/4364OpenShift Merge Robot2020-01-28
|\ \ | | | | | | Update remote client bridge documentation.
| * | Update remote client bridge documentation.Jhon Honce2020-01-28
| | | | | | | | | | | | | | | | | | * Add PODMAN_VARLINK_BRIDGE examples. Signed-off-by: Jhon Honce <jhonce@redhat.com>
* | | Merge pull request #4984 from baude/pullarchoverrideOpenShift Merge Robot2020-01-28
|\ \ \ | | | | | | | | expose --arch-override option for pull
| * | | expose --arch-override option for pullBrent Baude2020-01-27
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | We no longer wish to hide the --arch-override from the cli on pulls. we now expose it. docs updated. tests already exist. Fixes: #4849 Signed-off-by: Brent Baude <bbaude@redhat.com>
* | | | docs: replace '~' with $HOME in markdown as '~' isn't rendered properlyRobert P. J. Day2020-01-28
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Apparently, a tilde is currently rendered as a single space, making a mess of command examples that use it, so use $HOME instead. https://github.com/mattermost/mattermost-server/issues/8228 Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
* | | | Merge pull request #4999 from rpjday/docs/network_rstOpenShift Merge Robot2020-01-28
|\ \ \ \ | | | | | | | | | | docs: fix incomplete heading underlining in network.rst
| * | | | docs: fix incomplete heading underlining in network.rstRobert P. J. Day2020-01-28
| | |/ / | |/| | | | | | | | | | | | | | | | | | Lack of proper underlining generates processing diagnostic. Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
* | | | Merge pull request #4995 from rpjday/docs/podman_stopOpenShift Merge Robot2020-01-28
|\ \ \ \ | | | | | | | | | | docs: add missing hyphen for '-t' option, command '$' prompts
| * | | | docs: add missing hyphen for '-t' option, command '$' promptsRobert P. J. Day2020-01-28
| |/ / / | | | | | | | | | | | | Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
* | | | Merge pull request #4974 from rhatdan/manOpenShift Merge Robot2020-01-28
|\ \ \ \ | |/ / / |/| | | Cleanup man pages exit code descriptions
| * | | Cleanup man pages exit code descriptionsDaniel J Walsh2020-01-26
| | | | | | | | | | | | | | | | | | | | | | | | | | | | The conversion of markdown to man pages is causing "_" to cover entire lines. This PR cleans this up and fixes some of the english. Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
* | | | Merge pull request #4982 from rpjday/rpjday/exists_sudoOpenShift Merge Robot2020-01-27
|\ \ \ \ | | | | | | | | | | docs: remove reference to "sudo" in "podman exists" examples
| * | | | docs: remove reference to "sudo" in "podman exists" examplesRobert P. J. Day2020-01-26
| | |/ / | |/| | | | | | | | | | | | | | | | | | | | | | In both of "podman {container,image} exists" man pages, there are superfluous uses of "sudo" in examples -- get rid of them. Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
* | | | docs: add boolean values and defaults to "man podman-history" optionsRobert P. J. Day2020-01-26
| | | | | | | | | | | | | | | | Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
* | | | Merge pull request #4979 from rpjday/rpjday/system_pruneOpenShift Merge Robot2020-01-26
|\ \ \ \ | | | | | | | | | | docs: fix system-prune markdown; reword for clarity
| * | | | docs: fix system-prune markdown; reword for clarityRobert P. J. Day2020-01-26
| |/ / / | | | | | | | | | | | | | | | | | | | | | | | | In addition to tweaking markdown, reword the explanation of the "--volumes" option for clarity. Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
* / / / docs: clean up "man podman-rm", "man podman-rmi"Robert P. J. Day2020-01-26
|/ / / | | | | | | | | | | | | | | | | | | Standardize markdown for options and commands, and add leading dollar signs to emphasize commands being run. Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
* | | Merge pull request #4933 from rpjday/docs/markdown/inspectOpenShift Merge Robot2020-01-26
|\ \ \ | |/ / |/| | markdown: reword 'podman-inspect' to properly explain '--size'
| * | markdown: reword 'podman-inspect' to properly explain '--size'Robert P. J. Day2020-01-22
| | | | | | | | | | | | | | | | | | | | | Reword the man page to clarify that the '--size' option displays the container size in addition to the normal output. Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
* | | Merge pull request #4926 from TomSweeneyRedHat/dev/tsweeney/fixsystemdfOpenShift Merge Robot2020-01-25
|\ \ \ | | | | | | | | Fix example format in system df man
| * | | Fix example format in system df manTomSweeneyRedHat2020-01-22
| | |/ | |/| | | | | | | | | | | | | | | | Fix the formatting of the examples in the podman system df man page. Signed-off-by: TomSweeneyRedHat <tsweeney@redhat.com>
* / | seccomp policy: expect profile in config labelValentin Rothberg2020-01-23
|/ / | | | | | | | | | | | | | | Move the seccomp profile from a manifest annotation to a config label. This way, we can support it for Docker images as well and provide an easy way to add that data via Dockerfiles. Signed-off-by: Valentin Rothberg <rothberg@redhat.com>
* | Merge pull request #4929 from rpjday/docs/migrateOpenShift Merge Robot2020-01-22
|\ \ | | | | | | markdown: remove erroneous spaces after '**'
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2024-09-27 04:11:39 +0000