From 2ea69c7ecca1e8be7e9d9f94dfdcac6090f1c69d Mon Sep 17 00:00:00 2001 From: Gerald Morrison <67469729+morri-son@users.noreply.github.com> Date: Fri, 8 Nov 2024 12:28:01 +0100 Subject: [PATCH] change short text for help topic (#1058) #### What this PR does / why we need it Improve short text for help topic --------- Co-authored-by: Hilmar Falkenberg --- api/oci/ref_test.go | 44 ++++++++++++------- .../download/config/registration_test.go | 5 +-- cmds/ocm/commands/verbs/install/cmd.go | 2 +- docs/reference/ocm.md | 2 +- docs/reference/ocm_install.md | 2 +- docs/reference/ocm_install_plugins.md | 2 +- 6 files changed, 35 insertions(+), 22 deletions(-) diff --git a/api/oci/ref_test.go b/api/oci/ref_test.go index f0d27516c5..c95850ef03 100644 --- a/api/oci/ref_test.go +++ b/api/oci/ref_test.go @@ -3,11 +3,11 @@ package oci_test import ( "strings" - "github.com/mandelsoft/goutils/generics" . "github.com/mandelsoft/goutils/testutils" . "github.com/onsi/ginkgo/v2" . "github.com/onsi/gomega" + "github.com/mandelsoft/goutils/generics" godigest "github.com/opencontainers/go-digest" "ocm.software/ocm/api/oci" @@ -255,8 +255,10 @@ var _ = Describe("ref parsing", func() { }, ArtSpec: oci.ArtSpec{ Repository: r, - ArtVersion: oci.ArtVersion{Tag: Pointer([]byte(uv)), - Digest: Dig([]byte(ud))}, + ArtVersion: oci.ArtVersion{ + Tag: Pointer([]byte(uv)), + Digest: Dig([]byte(ud)), + }, }, }) }) @@ -293,8 +295,10 @@ var _ = Describe("ref parsing", func() { }, ArtSpec: oci.ArtSpec{ Repository: r, - ArtVersion: oci.ArtVersion{Tag: Pointer([]byte(uv)), - Digest: Dig([]byte(ud))}, + ArtVersion: oci.ArtVersion{ + Tag: Pointer([]byte(uv)), + Digest: Dig([]byte(ud)), + }, }, }) }) @@ -343,8 +347,10 @@ var _ = Describe("ref parsing", func() { }, ArtSpec: oci.ArtSpec{ Repository: r, - ArtVersion: oci.ArtVersion{Tag: Pointer([]byte(uv)), - Digest: Dig([]byte(ud))}, + ArtVersion: oci.ArtVersion{ + Tag: Pointer([]byte(uv)), + Digest: Dig([]byte(ud)), + }, }, }) }) @@ -382,8 +388,10 @@ var _ = Describe("ref parsing", func() { }, ArtSpec: oci.ArtSpec{ Repository: "library/" + r, - ArtVersion: oci.ArtVersion{Tag: Pointer([]byte(uv)), - Digest: Dig([]byte(ud))}, + ArtVersion: oci.ArtVersion{ + Tag: Pointer([]byte(uv)), + Digest: Dig([]byte(ud)), + }, }, }) }) @@ -418,8 +426,10 @@ var _ = Describe("ref parsing", func() { }, ArtSpec: oci.ArtSpec{ Repository: r, - ArtVersion: oci.ArtVersion{Tag: Pointer([]byte(uv)), - Digest: Dig([]byte(ud))}, + ArtVersion: oci.ArtVersion{ + Tag: Pointer([]byte(uv)), + Digest: Dig([]byte(ud)), + }, }, }) }) @@ -596,8 +606,10 @@ var _ = Describe("ref parsing", func() { }, ArtSpec: oci.ArtSpec{ Repository: "repo/repo", - ArtVersion: oci.ArtVersion{Tag: &tag, - Digest: &digest}, + ArtVersion: oci.ArtVersion{ + Tag: &tag, + Digest: &digest, + }, }, }) CheckRef("http://127.0.0.1:443/repo/repo:v1@"+digest.String(), &oci.RefSpec{ @@ -609,8 +621,10 @@ var _ = Describe("ref parsing", func() { }, ArtSpec: oci.ArtSpec{ Repository: "repo/repo", - ArtVersion: oci.ArtVersion{Tag: &tag, - Digest: &digest}, + ArtVersion: oci.ArtVersion{ + Tag: &tag, + Digest: &digest, + }, }, }) CheckRef("directory::a/b", &oci.RefSpec{ diff --git a/api/ocm/extensions/download/config/registration_test.go b/api/ocm/extensions/download/config/registration_test.go index e2f81a3f40..f68f6efb41 100644 --- a/api/ocm/extensions/download/config/registration_test.go +++ b/api/ocm/extensions/download/config/registration_test.go @@ -6,17 +6,16 @@ import ( . "github.com/mandelsoft/goutils/testutils" . "github.com/onsi/ginkgo/v2" . "github.com/onsi/gomega" + "ocm.software/ocm/api/ocm" "ocm.software/ocm/api/ocm/extensions/download" + me "ocm.software/ocm/api/ocm/extensions/download/config" "ocm.software/ocm/api/ocm/ocmutils" "ocm.software/ocm/api/tech/helm" - - me "ocm.software/ocm/api/ocm/extensions/download/config" ) var _ = Describe("Download Handler regigistration", func() { It("register by ocm config", func() { - ctx := ocm.New() cfg := me.New() diff --git a/cmds/ocm/commands/verbs/install/cmd.go b/cmds/ocm/commands/verbs/install/cmd.go index ea1ca8661f..87cbb3dbb3 100644 --- a/cmds/ocm/commands/verbs/install/cmd.go +++ b/cmds/ocm/commands/verbs/install/cmd.go @@ -12,7 +12,7 @@ import ( // NewCommand creates a new command. func NewCommand(ctx clictx.Context) *cobra.Command { cmd := utils.MassageCommand(&cobra.Command{ - Short: "Install elements.", + Short: "Install new OCM CLI components ", }, verbs.Install) cmd.AddCommand(plugins.NewCommand(ctx)) return cmd diff --git a/docs/reference/ocm.md b/docs/reference/ocm.md index c88be56806..f99a049602 100644 --- a/docs/reference/ocm.md +++ b/docs/reference/ocm.md @@ -369,7 +369,7 @@ by a certificate delivered with the signature. * [ocm execute](ocm_execute.md) — Execute an element. * [ocm get](ocm_get.md) — Get information about artifacts and components * [ocm hash](ocm_hash.md) — Hash and normalization operations -* [ocm install](ocm_install.md) — Install elements. +* [ocm install](ocm_install.md) — Install new OCM CLI components * [ocm list](ocm_list.md) — List information about components * [ocm set](ocm_set.md) — Set information about OCM repositories * [ocm show](ocm_show.md) — Show tags or versions diff --git a/docs/reference/ocm_install.md b/docs/reference/ocm_install.md index fc01db3356..3646334332 100644 --- a/docs/reference/ocm_install.md +++ b/docs/reference/ocm_install.md @@ -1,4 +1,4 @@ -## ocm install — Install Elements. +## ocm install — Install New OCM CLI Components ### Synopsis diff --git a/docs/reference/ocm_install_plugins.md b/docs/reference/ocm_install_plugins.md index 9e501520c0..9c20720c97 100644 --- a/docs/reference/ocm_install_plugins.md +++ b/docs/reference/ocm_install_plugins.md @@ -87,6 +87,6 @@ $ ocm install plugin -r demo #### Parents -* [ocm install](ocm_install.md) — Install elements. +* [ocm install](ocm_install.md) — Install new OCM CLI components * [ocm](ocm.md) — Open Component Model command line client