From 9a3a59c3a5c838abcd8aaf2217bb3bb5f7e995b2 Mon Sep 17 00:00:00 2001 From: Ed Santiago Date: Wed, 27 Feb 2019 06:01:14 -0700 Subject: Followup to #2456: update examples, add trust - belatedly incorporate review feedback from baude - add usage synopsis for trust-set and trust-show Signed-off-by: Ed Santiago --- cmd/podman/exists.go | 6 +++--- cmd/podman/trust_set_show.go | 4 ++-- 2 files changed, 5 insertions(+), 5 deletions(-) (limited to 'cmd') diff --git a/cmd/podman/exists.go b/cmd/podman/exists.go index c01a6a081..b08761d15 100644 --- a/cmd/podman/exists.go +++ b/cmd/podman/exists.go @@ -40,7 +40,7 @@ var ( imageExistsCommand.GlobalFlags = MainGlobalOpts return imageExistsCmd(&imageExistsCommand) }, - Example: `podman image exists imageID`, + Example: `podman image exists alpine || podman pull alpine`, } _containerExistsCommand = &cobra.Command{ @@ -53,7 +53,7 @@ var ( return containerExistsCmd(&containerExistsCommand) }, - Example: `podman container exists containerID`, + Example: `podman container exists myctr || podman run --name myctr [etc...]`, } _podExistsCommand = &cobra.Command{ @@ -65,7 +65,7 @@ var ( podExistsCommand.GlobalFlags = MainGlobalOpts return podExistsCmd(&podExistsCommand) }, - Example: `podman pod exists podID`, + Example: `podman pod exists mypod || podman pod create --name mypod`, } ) diff --git a/cmd/podman/trust_set_show.go b/cmd/podman/trust_set_show.go index 0a4783d0a..746854249 100644 --- a/cmd/podman/trust_set_show.go +++ b/cmd/podman/trust_set_show.go @@ -23,7 +23,7 @@ var ( showTrustCommand cliconfig.ShowTrustValues setTrustDescription = "Set default trust policy or add a new trust policy for a registry" _setTrustCommand = &cobra.Command{ - Use: "set", + Use: "set [flags] REGISTRY", Short: "Set default trust policy or a new trust policy for a registry", Long: setTrustDescription, Example: "", @@ -36,7 +36,7 @@ var ( showTrustDescription = "Display trust policy for the system" _showTrustCommand = &cobra.Command{ - Use: "show", + Use: "show [flags] [REGISTRY]", Short: "Display trust policy for the system", Long: showTrustDescription, RunE: func(cmd *cobra.Command, args []string) error { -- cgit v1.2.3-54-g00ecf From 69808ff3200cfa0da5b7b42186446ce88ab323d5 Mon Sep 17 00:00:00 2001 From: Ed Santiago Date: Wed, 27 Feb 2019 06:21:27 -0700 Subject: fixup! Correction to 'checkpoint' ...it's a subcommand of 'podman container' Signed-off-by: Ed Santiago --- cmd/podman/checkpoint.go | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'cmd') diff --git a/cmd/podman/checkpoint.go b/cmd/podman/checkpoint.go index 8c4b8ad3c..367065766 100644 --- a/cmd/podman/checkpoint.go +++ b/cmd/podman/checkpoint.go @@ -32,9 +32,9 @@ var ( Args: func(cmd *cobra.Command, args []string) error { return checkAllAndLatest(cmd, args, false) }, - Example: `podman checkpoint --keep ctrID - podman checkpoint --all - podman checkpoint --leave-running --latest`, + Example: `podman container checkpoint --keep ctrID + podman container checkpoint --all + podman container checkpoint --leave-running --latest`, } ) -- cgit v1.2.3-54-g00ecf From 7a66ad7fee5037d1087896761814246b2a4cf56f Mon Sep 17 00:00:00 2001 From: Ed Santiago Date: Wed, 27 Feb 2019 09:00:56 -0700 Subject: fixup! missed some more: - [flags] in generate-kube - optional [IMAGE] in images Signed-off-by: Ed Santiago --- cmd/podman/generate_kube.go | 2 +- cmd/podman/images.go | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) (limited to 'cmd') diff --git a/cmd/podman/generate_kube.go b/cmd/podman/generate_kube.go index 090f99495..fa2872b77 100644 --- a/cmd/podman/generate_kube.go +++ b/cmd/podman/generate_kube.go @@ -17,7 +17,7 @@ var ( containerKubeCommand cliconfig.GenerateKubeValues containerKubeDescription = "Generate Kubernetes Pod YAML" _containerKubeCommand = &cobra.Command{ - Use: "kube CONTAINER | POD", + Use: "kube [flags] CONTAINER | POD", Short: "Generate Kubernetes pod YAML for a container or pod", Long: containerKubeDescription, RunE: func(cmd *cobra.Command, args []string) error { diff --git a/cmd/podman/images.go b/cmd/podman/images.go index c7f80c34a..e6f4d9a60 100644 --- a/cmd/podman/images.go +++ b/cmd/podman/images.go @@ -88,7 +88,7 @@ var ( imagesDescription = "lists locally stored images." _imagesCommand = cobra.Command{ - Use: "images", + Use: "images [flags] [IMAGE]", Short: "List images in local storage", Long: imagesDescription, RunE: func(cmd *cobra.Command, args []string) error { -- cgit v1.2.3-54-g00ecf From 2c0909bccc3648bf40be32232998a87b3a166f1d Mon Sep 17 00:00:00 2001 From: Ed Santiago Date: Wed, 27 Feb 2019 09:34:16 -0700 Subject: fixup! Incorporate review feedback Per tsweeney, add back the original examples Signed-off-by: Ed Santiago --- cmd/podman/exists.go | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) (limited to 'cmd') diff --git a/cmd/podman/exists.go b/cmd/podman/exists.go index b08761d15..109831e74 100644 --- a/cmd/podman/exists.go +++ b/cmd/podman/exists.go @@ -40,7 +40,8 @@ var ( imageExistsCommand.GlobalFlags = MainGlobalOpts return imageExistsCmd(&imageExistsCommand) }, - Example: `podman image exists alpine || podman pull alpine`, + Example: `podman image exists imageID + podman image exists alpine || podman pull alpine`, } _containerExistsCommand = &cobra.Command{ @@ -53,7 +54,8 @@ var ( return containerExistsCmd(&containerExistsCommand) }, - Example: `podman container exists myctr || podman run --name myctr [etc...]`, + Example: `podman container exists containerID + podman container exists myctr || podman run --name myctr [etc...]`, } _podExistsCommand = &cobra.Command{ @@ -65,7 +67,8 @@ var ( podExistsCommand.GlobalFlags = MainGlobalOpts return podExistsCmd(&podExistsCommand) }, - Example: `podman pod exists mypod || podman pod create --name mypod`, + Example: `podman pod exists podID + podman pod exists mypod || podman pod create --name mypod`, } ) -- cgit v1.2.3-54-g00ecf