diff options
| author | baude <bbaude@redhat.com> | 2018-05-15 08:15:08 -0500 |
|---|---|---|
| committer | Atomic Bot <atomic-devel@projectatomic.io> | 2018-05-15 20:38:56 +0000 |
| commit | 061384413c86a7a8845d68526bc947240ad494e5 (patch) | |
| tree | d3c3537191ce66c9324f1b6e732cc01ad4076501 | |
| parent | 5f6cdebacbcd295e2d30572136c5ffe3a86467ec (diff) | |
| download | podman-061384413c86a7a8845d68526bc947240ad494e5.tar.gz podman-061384413c86a7a8845d68526bc947240ad494e5.tar.bz2 podman-061384413c86a7a8845d68526bc947240ad494e5.zip | |
improve podman commit documentation and error messages
document --format|-f in the commit man page. also, improve the error
message when user tries to use -m with the oci image format.
Resolves: 765
Signed-off-by: baude <bbaude@redhat.com>
Closes: #768
Approved by: rhatdan
| -rw-r--r-- | cmd/podman/commit.go | 2 | ||||
| -rw-r--r-- | docs/podman-commit.1.md | 6 |
2 files changed, 6 insertions, 2 deletions
diff --git a/cmd/podman/commit.go b/cmd/podman/commit.go index 14b7ddace..9e468c2d9 100644 --- a/cmd/podman/commit.go +++ b/cmd/podman/commit.go @@ -80,7 +80,7 @@ func commitCmd(c *cli.Context) error { case "oci": mimeType = buildah.OCIv1ImageManifest if c.IsSet("message") { - return errors.Errorf("messages cannot be added to the OCIv1 image format.") + return errors.Errorf("messages are only compatible with the docker image format (-f docker)") } case "docker": mimeType = buildah.Dockerv2ImageManifest diff --git a/docs/podman-commit.1.md b/docs/podman-commit.1.md index 499f16015..cde76d175 100644 --- a/docs/podman-commit.1.md +++ b/docs/podman-commit.1.md @@ -29,12 +29,16 @@ Apply the following possible instructions to the created image: **CMD** | **ENTRYPOINT** | **ENV** | **EXPOSE** | **LABEL** | **STOPSIGNAL** | **USER** | **VOLUME** | **WORKDIR** Can be set multiple times +**--format, -f** +Set the format of the image manifest and metadata. The currently supported formats are _oci_ and _docker_. If +not specifically set, the default format used is _oci_. + **--iidfile** *ImageIDfile* Write the image ID to the file. **--message, -m** -Set commit message for committed image +Set commit message for committed image. The message field is not supported in _oci_ format. **--pause, -p** Pause the container when creating an image |