diff options
| author | OpenShift Merge Robot <openshift-merge-robot@users.noreply.github.com> | 2020-01-17 17:08:23 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-01-17 17:08:23 +0100 |
| commit | f5e614b63f641078b3a74b048f815fea54d03475 (patch) | |
| tree | ede0e86b2570556d38dd61459a390bdf2beec14f | |
| parent | acbb6c064dbcfcb8332e318602a728f311cfcf1a (diff) | |
| parent | 38ba9e692285198cefdb8b54aa72c6ce2c7b59ee (diff) | |
| download | podman-f5e614b63f641078b3a74b048f815fea54d03475.tar.gz podman-f5e614b63f641078b3a74b048f815fea54d03475.tar.bz2 podman-f5e614b63f641078b3a74b048f815fea54d03475.zip | |
Merge pull request #4721 from openSUSE/tag-docs
Update `tag` documentation regarding 'alias' usage
| -rw-r--r-- | cmd/podman/tag.go | 4 | ||||
| -rw-r--r-- | docs/source/markdown/podman-tag.1.md | 12 |
2 files changed, 9 insertions, 7 deletions
diff --git a/cmd/podman/tag.go b/cmd/podman/tag.go index eb43d695c..215b716b8 100644 --- a/cmd/podman/tag.go +++ b/cmd/podman/tag.go @@ -12,7 +12,7 @@ var ( tagDescription = "Adds one or more additional names to locally-stored image." _tagCommand = &cobra.Command{ - Use: "tag [flags] IMAGE TAG [TAG...]", + Use: "tag [flags] IMAGE TARGET_NAME [TARGET_NAME...]", Short: "Add an additional name to a local image", Long: tagDescription, RunE: func(cmd *cobra.Command, args []string) error { @@ -51,7 +51,7 @@ func tagCmd(c *cliconfig.TagValues) error { for _, tagName := range args[1:] { if err := newImage.TagImage(tagName); err != nil { - return errors.Wrapf(err, "error adding '%s' to image %q", tagName, newImage.InputName) + return errors.Wrapf(err, "error adding %q to image %q", tagName, newImage.InputName) } } return nil diff --git a/docs/source/markdown/podman-tag.1.md b/docs/source/markdown/podman-tag.1.md index 291d95228..064ea401d 100644 --- a/docs/source/markdown/podman-tag.1.md +++ b/docs/source/markdown/podman-tag.1.md @@ -4,14 +4,15 @@ podman\-tag - Add an additional name to a local image ## SYNOPSIS -**podman tag** *image*[:*tag*] *target-name*[:*tag*] [*options*] +**podman tag** *image*[:*tag*] [*target-name*[:*tag*]...] [*options*] -**podman image tag** *image*[:*tag*] *target-name*[:*tag*] [*options*] +**podman image tag** *image*[:*tag*] [*target-name*[:*tag*]...] [*options*] ## DESCRIPTION -Assigns a new alias to an image. An alias refers to the entire image name, including the optional -*tag* after the `:`. If you do not provide *tag*, podman will default to `latest` for both -the *image* and the *target-name*. +Assigns a new image name to an existing image. A full name refers to the entire +image name, including the optional *tag* after the `:`. If there is no *tag* +provided, then podman will default to `latest` for both the *image* and the +*target-name*. ## OPTIONS @@ -32,4 +33,5 @@ $ podman tag httpd myregistryhost:5000/fedora/httpd:v2 podman(1) ## HISTORY +December 2019, Update description to refer to 'name' instead of 'alias' by Sascha Grunert <sgrunert@suse.com> July 2017, Originally compiled by Ryan Cole <rycole@redhat.com> |