diff options
| author | OpenShift Merge Robot <openshift-merge-robot@users.noreply.github.com> | 2020-02-17 08:47:08 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-02-17 08:47:08 +0100 |
| commit | ff0f8388138f7b66c4312db0e984f0bedcac2558 (patch) | |
| tree | bb1cb2695fd0580227465f2ca4d4785220985096 | |
| parent | 92dbcb8841abae35658e5da1bf6eddee7669ea75 (diff) | |
| parent | 59c91069c0429acee16b638027c4eae6fe826c75 (diff) | |
| download | podman-ff0f8388138f7b66c4312db0e984f0bedcac2558.tar.gz podman-ff0f8388138f7b66c4312db0e984f0bedcac2558.tar.bz2 podman-ff0f8388138f7b66c4312db0e984f0bedcac2558.zip | |
Merge pull request #5218 from Jumanjii/update-go-md2man-pkg-name
Update documentation of commit command to show image reference is optional
| -rw-r--r-- | cmd/podman/commit.go | 5 | ||||
| -rw-r--r-- | docs/source/markdown/podman-commit.1.md | 8 |
2 files changed, 10 insertions, 3 deletions
diff --git a/cmd/podman/commit.go b/cmd/podman/commit.go index b4d249c66..7c35a4832 100644 --- a/cmd/podman/commit.go +++ b/cmd/podman/commit.go @@ -15,7 +15,7 @@ var ( commitDescription = `Create an image from a container's changes. Optionally tag the image created, set the author with the --author flag, set the commit message with the --message flag, and make changes to the instructions with the --change flag.` _commitCommand = &cobra.Command{ - Use: "commit [flags] CONTAINER IMAGE", + Use: "commit [flags] CONTAINER [IMAGE]", Short: "Create new image based on the changed container", Long: commitDescription, RunE: func(cmd *cobra.Command, args []string) error { @@ -26,7 +26,8 @@ var ( }, Example: `podman commit -q --message "committing container to image" reverent_golick image-committed podman commit -q --author "firstName lastName" reverent_golick image-committed - podman commit -q --pause=false containerID image-committed`, + podman commit -q --pause=false containerID image-committed + podman commit containerID`, } // ChangeCmds is the list of valid Changes commands to passed to the Commit call 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) |