opensource/podman
1
0
Fork 0
mirror of https://github.com/containers/podman.git synced 2025-10-18 11:42:55 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update tag documentation regarding 'alias' usage

Browse Source 
The word `alias` is not very common when speaking about image names and
tags. So we just refer to image name as the overall identifier of an
image.

Signed-off-by: Sascha Grunert <sgrunert@suse.com>
This commit is contained in:
Sascha Grunert
2019-12-17 11:28:07 +01:00
parent 74b89da27c
commit 38ba9e6922
2 changed files with 9 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
cmd/podman/tag.go
View File

@ -12,7 +12,7 @@ var (
tagDescription = "Adds one or more additional names to locally-stored image." tagDescription = "Adds one or more additional names to locally-stored image."
_tagCommand = &cobra.Command{ _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", Short: "Add an additional name to a local image",
Long: tagDescription, Long: tagDescription,
RunE: func(cmd *cobra.Command, args []string) error { RunE: func(cmd *cobra.Command, args []string) error {
@ -51,7 +51,7 @@ func tagCmd(c *cliconfig.TagValues) error {
for _, tagName := range args[1:] { for _, tagName := range args[1:] {
if err := newImage.TagImage(tagName); err != nil { 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 return nil

12
docs/source/markdown/podman-tag.1.md
View File

@ -4,14 +4,15 @@
podman\-tag - Add an additional name to a local image podman\-tag - Add an additional name to a local image
## SYNOPSIS ## 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 ## DESCRIPTION
Assigns a new alias to an image. An alias refers to the entire image name, including the optional Assigns a new image name to an existing image. A full name refers to the entire
*tag* after the `:`. If you do not provide *tag*, podman will default to `latest` for both image name, including the optional *tag* after the `:`. If there is no *tag*
the *image* and the *target-name*. provided, then podman will default to `latest` for both the *image* and the
*target-name*.
## OPTIONS ## OPTIONS
@ -32,4 +33,5 @@ $ podman tag httpd myregistryhost:5000/fedora/httpd:v2
podman(1) podman(1)
## HISTORY ## 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> July 2017, Originally compiled by Ryan Cole <rycole@redhat.com>