Merge pull request #2361 from TomSweeneyRedHat/dev/tsweeney/cobraex4

Add 4th chunk of Cobra Examples
This commit is contained in:
OpenShift Merge Robot
2019-02-18 22:14:57 +01:00
committed by GitHub
10 changed files with 30 additions and 11 deletions

View File

@ -26,7 +26,9 @@ var (
cleanupCommand.GlobalFlags = MainGlobalOpts
return cleanupCmd(&cleanupCommand)
},
Example: "CONTAINER-NAME [CONTAINER-NAME ...]",
Example: `podman container cleanup --latest
podman container cleanup ctrID1 ctrID2 ctrID3
podman container cleanup --all`,
}
)

View File

@ -26,7 +26,9 @@ var (
restartCommand.GlobalFlags = MainGlobalOpts
return restartCmd(&restartCommand)
},
Example: "CONTAINER [CONTAINER ...]",
Example: `podman restart ctrID
podman restart --latest
podman restart ctrID1 ctrID2`,
}
)

View File

@ -29,7 +29,9 @@ var (
restoreCommand.GlobalFlags = MainGlobalOpts
return restoreCmd(&restoreCommand)
},
Example: "CONTAINER-NAME [CONTAINER-NAME ...]",
Example: `podman container restore ctrID
podman container restore --latest
podman container restore --all`,
}
)

View File

@ -31,7 +31,9 @@ Executes a command as described by a container image label.
runlabelCommand.GlobalFlags = MainGlobalOpts
return runlabelCmd(&runlabelCommand)
},
Example: "",
Example: `podman container runlabel run imageID
podman container runlabel --pull install imageID arg1 arg2
podman container runlabel --display run myImage`,
}
)
@ -49,7 +51,7 @@ func init() {
flags.StringVar(&runlabelCommand.Opt2, "opt2", "", "Optional parameter to pass for install")
flags.StringVar(&runlabelCommand.Opt3, "opt3", "", "Optional parameter to pass for install")
flags.MarkHidden("opt1")
flags.MarkHidden("opt3")
flags.MarkHidden("opt2")
flags.MarkHidden("opt3")
flags.BoolVarP(&runlabelCommand.Pull, "pull", "p", false, "Pull the image if it does not exist locally prior to executing the label contents")

View File

@ -41,7 +41,9 @@ var (
saveCommand.GlobalFlags = MainGlobalOpts
return saveCmd(&saveCommand)
},
Example: "",
Example: `podman save --quiet -o myimage.tar imageID
podman save --format docker-dir -o ubuntu-dir ubuntu
podman save > alpine-all.tar alpine:latest`,
}
)

View File

@ -36,7 +36,9 @@ var (
searchCommand.GlobalFlags = MainGlobalOpts
return searchCmd(&searchCommand)
},
Example: "TERM",
Example: `podman search --filter=is-official --limit 3 alpine
podman search registry.fedoraproject.org/ # only works with v2 registries
podman search --format "table {{.Index}} {{.Name}}" registry.fedoraproject.org/fedora`,
}
)

View File

@ -41,7 +41,9 @@ var (
statsCommand.GlobalFlags = MainGlobalOpts
return statsCmd(&statsCommand)
},
Example: "",
Example: `podman stats --all --no-stream
podman stats ctrID
podman stats --no-stream --format "table {{.ID}} {{.Name}} {{.MemUsage}}" ctrID`,
}
)

View File

@ -20,7 +20,9 @@ var (
tagCommand.GlobalFlags = MainGlobalOpts
return tagCmd(&tagCommand)
},
Example: "IMAGE-NAME [IMAGE-NAME ...]",
Example: `podman tag 0e3bbc2 fedora:latest
podman tag imageID:latest myNewImage:newTag
podman tag httpd myregistryhost:5000/fedora/httpd:v2`,
}
)

View File

@ -42,7 +42,9 @@ the latest container.
topCommand.GlobalFlags = MainGlobalOpts
return topCmd(&topCommand)
},
Example: "CONTAINER-NAME [format descriptors]",
Example: `podman top ctrID
podman top --latest
podman top ctrID pid seccomp args %C`,
}
)

View File

@ -32,7 +32,8 @@ var (
varlinkCommand.GlobalFlags = MainGlobalOpts
return varlinkCmd(&varlinkCommand)
},
Example: "VARLINK_URI",
Example: `podman varlink unix:/run/podman/io.podman
podman varlink --timeout 5000 unix:/run/podman/io.podman`,
}
)