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 <hilmar.falkenberg@sap.com>
open-component-model · Nov 8, 2024 · 2ea69c7 · 2ea69c7
1 parent beabf65
commit 2ea69c7
Show file tree

Hide file tree

Showing 6 changed files with 35 additions and 22 deletions.
diff --git 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
@@ -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
@@ -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
@@ -369,7 +369,7 @@ by a certificate delivered with the signature.
 * [ocm <b>execute</b>](ocm_execute.md)	 &mdash; Execute an element.
 * [ocm <b>get</b>](ocm_get.md)	 &mdash; Get information about artifacts and components
 * [ocm <b>hash</b>](ocm_hash.md)	 &mdash; Hash and normalization operations
-* [ocm <b>install</b>](ocm_install.md)	 &mdash; Install elements.
+* [ocm <b>install</b>](ocm_install.md)	 &mdash; Install new OCM CLI components
 * [ocm <b>list</b>](ocm_list.md)	 &mdash; List information about components
 * [ocm <b>set</b>](ocm_set.md)	 &mdash; Set information about OCM repositories
 * [ocm <b>show</b>](ocm_show.md)	 &mdash; Show tags or versions

diff --git a/docs/reference/ocm_install.md b/docs/reference/ocm_install.md
@@ -1,4 +1,4 @@
-## ocm install &mdash; Install Elements.
+## ocm install &mdash; Install New OCM CLI Components
 
 ### Synopsis
 

diff --git 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)	 &mdash; Install elements.
+* [ocm install](ocm_install.md)	 &mdash; Install new OCM CLI components
 * [ocm](ocm.md)	 &mdash; Open Component Model command line client