add flag docu

open-component-model · Nov 7, 2024 · 05cbf1b · 05cbf1b
1 parent 257329a
commit 05cbf1b
Show file tree

Hide file tree

Showing 5 changed files with 24 additions and 6 deletions.
diff --git a/cmds/ocm/commands/ocmcmds/common/addhdlrs/options.go b/cmds/ocm/commands/ocmcmds/common/addhdlrs/options.go
@@ -8,7 +8,10 @@ import (
 )
 
 type Options struct {
-	Replace           bool
+	// Replace enables to replace existing elements (same raw identity) with a different version instead
+	// of appending a new element.
+	Replace bool
+	// PreserveSignature disables the modification of signature relevant information.
 	PreserveSignature bool
 }
 
@@ -62,6 +65,9 @@ func (o *Options) Description() string {
 	return `
 The <code>--replace</code> option allows users to specify whether adding an
 element with the same name and extra identity but different version as an 
-existing element append (false) or replace (true) the existing element.
+existing element, append (false) or replace (true) the existing element.
+
+The <code>--preserve-signature</code> option prohibits changes of signature 
+relevant elements.
 `
 }
diff --git a/docs/reference/ocm_add_componentversions.md b/docs/reference/ocm_add_componentversions.md
@@ -55,7 +55,10 @@ components will be added by value.
 
 The <code>--replace</code> option allows users to specify whether adding an
 element with the same name and extra identity but different version as an
-existing element append (false) or replace (true) the existing element.
+existing element, append (false) or replace (true) the existing element.
+
+The <code>--preserve-signature</code> option prohibits changes of signature
+relevant elements.
 
 
 The source, resource and reference list can be composed according to the commands

diff --git a/docs/reference/ocm_add_references.md b/docs/reference/ocm_add_references.md
@@ -113,7 +113,10 @@ There are several templaters that can be selected by the <code>--templater</code
 
 The <code>--replace</code> option allows users to specify whether adding an
 element with the same name and extra identity but different version as an
-existing element append (false) or replace (true) the existing element.
+existing element, append (false) or replace (true) the existing element.
+
+The <code>--preserve-signature</code> option prohibits changes of signature
+relevant elements.
 
 
 All yaml/json defined resources can be templated.

diff --git a/docs/reference/ocm_add_resources.md b/docs/reference/ocm_add_resources.md
@@ -977,7 +977,10 @@ shown below.
 
 The <code>--replace</code> option allows users to specify whether adding an
 element with the same name and extra identity but different version as an
-existing element append (false) or replace (true) the existing element.
+existing element, append (false) or replace (true) the existing element.
+
+The <code>--preserve-signature</code> option prohibits changes of signature
+relevant elements.
 
 
 All yaml/json defined resources can be templated.

diff --git a/docs/reference/ocm_add_sources.md b/docs/reference/ocm_add_sources.md
@@ -975,7 +975,10 @@ shown below.
 
 The <code>--replace</code> option allows users to specify whether adding an
 element with the same name and extra identity but different version as an
-existing element append (false) or replace (true) the existing element.
+existing element, append (false) or replace (true) the existing element.
+
+The <code>--preserve-signature</code> option prohibits changes of signature
+relevant elements.
 
 
 All yaml/json defined resources can be templated.