summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorAllan Jacquet-Cretides <allan.jacquet@gmail.com>2020-02-15 10:48:23 +0100
committerAllan Jacquet-Cretides <allan.jacquet@gmail.com>2020-02-15 11:11:00 +0100
commit59c91069c0429acee16b638027c4eae6fe826c75 (patch)
treefad303dcac0797902819e8772bc598046e379a90 /docs
parent9e9b157aa925d8d427999389aabf915dcad83355 (diff)
downloadpodman-59c91069c0429acee16b638027c4eae6fe826c75.tar.gz
podman-59c91069c0429acee16b638027c4eae6fe826c75.tar.bz2
podman-59c91069c0429acee16b638027c4eae6fe826c75.zip
Update documentation of commit command to show image reference is optional
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>
Diffstat (limited to 'docs')
-rw-r--r--docs/source/markdown/podman-commit.1.md8
1 files changed, 7 insertions, 1 deletions
diff --git a/docs/source/markdown/podman-commit.1.md b/docs/source/markdown/podman-commit.1.md
index 042ec7934..66d8811aa 100644
--- a/docs/source/markdown/podman-commit.1.md
+++ b/docs/source/markdown/podman-commit.1.md
@@ -4,7 +4,7 @@
podman\-commit - Create new image based on the changed container
## SYNOPSIS
-**podman commit** [*options*] *container* *image*
+**podman commit** [*options*] *container* [*image*]
**podman container commit** [*options*] *container* [*image*]
@@ -18,6 +18,7 @@ image. If this is not desired, the `--pause` flag can be set to false. When the
is complete, Podman will print out the ID of the new image.
If *image* does not begin with a registry name component, `localhost` will be added to the name.
+If *image* is not provided, the values for the `REPOSITORY` and `TAG` values of the created image will each be set to `<none>`.
## OPTIONS
@@ -86,6 +87,11 @@ $ podman commit -q --pause=false containerID image-committed
e3ce4d93051ceea088d1c242624d659be32cf1667ef62f1d16d6b60193e2c7a8
```
+```
+$ podman commit containerID
+e3ce4d93051ceea088d1c242624d659be32cf1667ef62f1d16d6b60193e2c7a8
+```
+
## SEE ALSO
podman(1), podman-run(1), podman-create(1)