Skip to content

Commit

Permalink
fix typos and lint something
Browse files Browse the repository at this point in the history
  • Loading branch information
hilmarf committed Aug 15, 2024
1 parent caaadb4 commit 3fcb97e
Show file tree
Hide file tree
Showing 106 changed files with 195 additions and 195 deletions.
4 changes: 2 additions & 2 deletions docs/pluginreference/plugin.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ plugin <subcommand> <options> <args>

### Options

```
```text
-c, --config YAML plugin configuration
-h, --help help for plugin
--log-config YAML ocm logging configuration
Expand Down Expand Up @@ -49,7 +49,7 @@ Errors have to be reported on *stderr* as JSON document with the fields:

Any plugin, regardless of its functionality has to provide an [plugin info](plugin_info.md),
which prints JSON document containing a plugin descriptor that describes the
apabilities of the plugin.
capabilities of the plugin.

### SEE ALSO

Expand Down
2 changes: 1 addition & 1 deletion docs/pluginreference/plugin_accessmethod.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ plugin accessmethod [<options>] <sub command> ...

### Options

```
```text
-h, --help help for accessmethod
```

Expand Down
2 changes: 1 addition & 1 deletion docs/pluginreference/plugin_accessmethod_compose.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ plugin accessmethod compose <name> <options json> <base spec json> [<options>]

### Options

```
```text
-h, --help help for compose
```

Expand Down
2 changes: 1 addition & 1 deletion docs/pluginreference/plugin_accessmethod_get.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ plugin accessmethod get [<flags>] <access spec> [<options>]

### Options

```
```text
-C, --credential <name>=<value> dedicated credential value (default [])
-c, --credentials YAML credentials
-h, --help help for get
Expand Down
2 changes: 1 addition & 1 deletion docs/pluginreference/plugin_accessmethod_validate.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ plugin accessmethod validate <spec> [<options>]

### Options

```
```text
-h, --help help for validate
```

Expand Down
2 changes: 1 addition & 1 deletion docs/pluginreference/plugin_action.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ plugin action [<options>] <sub command> ...

### Options

```
```text
-h, --help help for action
```

Expand Down
2 changes: 1 addition & 1 deletion docs/pluginreference/plugin_action_execute.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ plugin action execute <spec> [<options>]

### Options

```
```text
-C, --credential <name>=<value> dedicated credential value (default [])
-c, --credentials YAML credentials
-h, --help help for execute
Expand Down
2 changes: 1 addition & 1 deletion docs/pluginreference/plugin_describe.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ plugin describe [<options>]

### Options

```
```text
-h, --help help for describe
```

Expand Down
6 changes: 3 additions & 3 deletions docs/pluginreference/plugin_descriptor.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ following fields:

The list of supported downloaders. Downloaders will be used by the
CLI download command to provide downloaded artifacts in a filesystem format
applicable to the type specific tools, regatdless of the format it is stored
applicable to the type specific tools, regardless of the format it is stored
as blob in a component version. Therefore, they can be registered for
combination of artifact type and optional mime type (describing the actually
used blob format).
Expand Down Expand Up @@ -242,7 +242,7 @@ The descriptor for an action has the following fields:
A list of selectors, for which this action implementation is automatically
be registered when the plugin is loaded. The selector syntax depends on
the action type. (For example, the hostname (pattern) for the action
<code>oci.repository.prepare</code>). The selectors are eiker directly matched
<code>oci.repository.prepare</code>). The selectors are either directly matched
with action requests or used as regular expression.

- **<code>consumerType</code>** *string* (optional)
Expand Down Expand Up @@ -295,7 +295,7 @@ The descriptor for a label merge specification has the following fields:

### Examples

```
```yaml
{
"version": "v1",
"pluginName": "test",
Expand Down
2 changes: 1 addition & 1 deletion docs/pluginreference/plugin_download.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ plugin download [<flags>] <name> <filepath> [<options>]

### Options

```
```text
-a, --artifactType string artifact type of input blob
-c, --config string registration config
-h, --help help for download
Expand Down
2 changes: 1 addition & 1 deletion docs/pluginreference/plugin_info.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ plugin info [<options>]

### Options

```
```text
-h, --help help for info
```

Expand Down
2 changes: 1 addition & 1 deletion docs/pluginreference/plugin_upload.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ plugin upload [<options>] <sub command> ...

### Options

```
```text
-h, --help help for upload
```

Expand Down
2 changes: 1 addition & 1 deletion docs/pluginreference/plugin_upload_put.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ plugin upload put [<flags>] <name> <repository specification> [<options>]

### Options

```
```text
-a, --artifactType string artifact type of input blob
-C, --credential <name>=<value> dedicated credential value (default [])
-c, --credentials YAML credentials
Expand Down
2 changes: 1 addition & 1 deletion docs/pluginreference/plugin_upload_validate.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ plugin upload validate [<flags>] <name> <spec> [<options>]

### Options

```
```text
-a, --artifactType string artifact type of input blob
-h, --help help for validate
-m, --mediaType string media type of input blob
Expand Down
2 changes: 1 addition & 1 deletion docs/pluginreference/plugin_valuemergehandler.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ plugin valuemergehandler [<options>] <sub command> ...

### Options

```
```text
-h, --help help for valuemergehandler
```

Expand Down
2 changes: 1 addition & 1 deletion docs/pluginreference/plugin_valuemergehandler_execute.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ plugin valuemergehandler execute <name> <spec> [<options>]

### Options

```
```text
-h, --help help for execute
```

Expand Down
2 changes: 1 addition & 1 deletion docs/pluginreference/plugin_valueset.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ plugin valueset [<options>] <sub command> ...

### Options

```
```text
-h, --help help for valueset
```

Expand Down
2 changes: 1 addition & 1 deletion docs/pluginreference/plugin_valueset_compose.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ plugin valueset compose <purpose> <name> <options json> <base spec json> [<optio

### Options

```
```text
-h, --help help for compose
```

Expand Down
2 changes: 1 addition & 1 deletion docs/pluginreference/plugin_valueset_validate.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ plugin valueset validate <spec> [<options>]

### Options

```
```text
-h, --help help for validate
```

Expand Down
12 changes: 6 additions & 6 deletions docs/reference/ocm.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ ocm [<options>] <sub command> ...

### Options

```
```text
-X, --attribute stringArray attribute setting
--ca-cert stringArray additional root certificate authorities (for signing certificates)
--config stringArray configuration file
Expand Down Expand Up @@ -59,7 +59,7 @@ The following configuration sources are used:


With the option <code>--cred</code> it is possible to specify arbitrary credentials
for various environments on the command line. Nevertheless it is always preferrable
for various environments on the command line. Nevertheless it is always preferable
to use the cli config file.
Every credential setting is related to a dedicated consumer and provides a set of
credential attributes. All this can be specified by a sequence of <code>--cred</code>
Expand Down Expand Up @@ -288,19 +288,19 @@ The value can be a simple type or a JSON/YAML string for complex values

- <code>github.com/mandelsoft/tempblobcache</code> [<code>blobcache</code>]: *string* Foldername for temporary blob cache

The temporary blob cache is used to accessing large blobs from remote sytems.
The temporary blob cache is used to accessing large blobs from remote systems.
The are temporarily stored in the filesystem, instead of the memory, to avoid
blowing up the memory consumption.

- <code>ocm.software/cliconfig</code> [<code>cliconfig</code>]: *cliconfigr* Configuration Object passed to command line pluging.
- <code>ocm.software/cliconfig</code> [<code>cliconfig</code>]: *cliconfig* Configuration Object passed to command line plugin.



- <code>ocm.software/compositionmode</code> [<code>compositionmode</code>]: *bool* (default: false

Composition mode decouples a component version provided by a repository
implemention from the backened persistence. Added local blobs will
and other changes witll not be forwarded to the backend repository until
implementation from the backend persistence. Added local blobs will
and other changes will not be forwarded to the backend repository until
an AddVersion is called on the component.
If composition mode is disabled blobs will directly be forwarded to
the backend and descriptor updated will be persisted on AddVersion
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/ocm_add.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ ocm add [<options>] <sub command> ...

### Options

```
```text
-h, --help help for add
```

Expand Down
4 changes: 2 additions & 2 deletions docs/reference/ocm_add_componentversions.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ componentversions, componentversion, cv, components, component, comps, comp, c

### Options

```
```text
--addenv access environment for templating
-C, --complete include all referenced component version
-L, --copy-local-resources transfer referenced local resources by-value
Expand Down Expand Up @@ -71,7 +71,7 @@ entry can be used to specify a dedicated serialization format to use for the
component descriptor. If given it overrides the <code>--schema</code> option
of the command. By default, v2 is used.

Various elements support to add arbirary information by using labels
Various elements support to add arbitrary information by using labels
(see [ocm ocm-labels](ocm_ocm-labels.md)).


Expand Down
8 changes: 4 additions & 4 deletions docs/reference/ocm_add_references.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ references, reference, refs

### Options

```
```text
--addenv access environment for templating
--dry-run evaluate and print reference specifications
-F, --file string target file/directory (default "component-archive")
Expand All @@ -28,7 +28,7 @@ references, reference, refs

#### Reference Meta Data Options

```
```text
--component string component name
--extra <name>=<value> reference extra identity (default [])
--label <name>=<YAML> reference label (leading * indicates signature relevant, optional version separated by @)
Expand Down Expand Up @@ -60,8 +60,8 @@ options <code>--name</code> and <code>--version</code>. With the option <code>--
it is possible to add extra identity attributes. Explicitly specified options
override values specified by the <code>--reference</code> option.
(Note: Go templates are not supported for YAML-based option values. Besides
this restriction, the finally composed element description is still processd
by the selected templater.)
this restriction, the finally composed element description is still processed
by the selected template engine.)

The component name can be specified with the option <code>--component</code>.
Therefore, basic references not requiring any additional labels or extra
Expand Down
16 changes: 8 additions & 8 deletions docs/reference/ocm_add_resource-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,15 @@ resource-configuration, resourceconfig, rsccfg, rcfg

### Options

```
```text
-h, --help help for resource-configuration
-s, --settings stringArray settings file with variable settings (yaml)
```


#### Access Specification Options

```
```text
--access YAML blob access specification (YAML)
--accessHostname string hostname used for access
--accessPackage string package or object name
Expand Down Expand Up @@ -53,7 +53,7 @@ resource-configuration, resourceconfig, rsccfg, rcfg

#### Input Specification Options

```
```text
--artifactId string maven artifact id
--body string body of a http request
--classifier string maven classifier
Expand Down Expand Up @@ -89,7 +89,7 @@ resource-configuration, resourceconfig, rsccfg, rcfg

#### Resource Meta Data Options

```
```text
--external flag non-local resource
--extra <name>=<value> resource extra identity (default [])
--label <name>=<YAML> resource label (leading * indicates signature relevant, optional version separated by @)
Expand All @@ -111,8 +111,8 @@ options <code>--name</code> and <code>--version</code>. With the option <code>--
it is possible to add extra identity attributes. Explicitly specified options
override values specified by the <code>--resource</code> option.
(Note: Go templates are not supported for YAML-based option values. Besides
this restriction, the finally composed element description is still processd
by the selected templater.)
this restriction, the finally composed element description is still processed
by the selected template engine.)

The resource type can be specified with the option <code>--type</code>. Therefore, the
minimal required meta data for elements can be completely specified by dedicated
Expand Down Expand Up @@ -471,7 +471,7 @@ with the field <code>type</code> in the <code>input</code> field:
This OPTIONAL property describes a list of spiff libraries to include in template
processing.

The variable settigs from the command line are available as binding, also. They are provided under the node
The variable settings from the command line are available as binding, also. They are provided under the node
<code>values</code>.

Options used to configure fields: <code>--inputCompress</code>, <code>--inputLibraries</code>, <code>--inputPath</code>, <code>--inputValues</code>, <code>--mediaType</code>
Expand Down Expand Up @@ -973,7 +973,7 @@ There are several templaters that can be selected by the <code>--templater</code

### Examples

```
```yaml
$ ocm add resource-configuration resources.yaml --name myresource --type PlainText --input '{ "type": "file", "path": "testdata/testcontent", "mediaType": "text/plain" }'
```
Expand Down
Loading

0 comments on commit 3fcb97e

Please sign in to comment.