Skip to content

Commit 0c994bc

Browse files
committed
SPEC.md: remove {kind,name}Short references.
Signed-off-by: Krisztian Litkey <[email protected]>
1 parent a982224 commit 0c994bc

File tree

1 file changed

+1
-4
lines changed

1 file changed

+1
-4
lines changed

SPEC.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -70,13 +70,11 @@ The key words "must", "must not", "required", "shall", "shall not", "should", "s
7070
{
7171
"cdiVersion": "0.1.0",
7272
"kind": "<name>",
73-
"kindShort": ["<short-name>", ...],
7473
"containerRuntime": ["<container-runtime-name>"], (optional)
7574
7675
"devices": [
7776
{
7877
"name": "<name>",
79-
"nameShort": ["<short-name>", "<short-name>"], (optional)
8078
8179
// Same as the below containerSpec field.
8280
// This field should only be applied to the Container's OCI spec
@@ -138,7 +136,7 @@ The key words "must", "must not", "required", "shall", "shall not", "should", "s
138136

139137
* `kind` (string, REQUIRED) field specifies a label which uniquely identifies the device vendor.
140138
It can be used to disambiguate the vendor that matches a device, e.g: `docker/podman run --device vendor.com/device=foo ...`.
141-
* The `kind` and `kindShort` labels have two segments: a prefix and a name, separated by a slash (/).
139+
* The `kind` label has two segments: a prefix and a name, separated by a slash (/).
142140
* The name segment is required and must be 63 characters or less, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (\_), dots (.), and alphanumerics between.
143141
* The prefix must be a DNS subdomain: a series of DNS labels separated by dots (.), not longer than 253 characters in total, followed by a slash (/).
144142
* Examples (not an exhaustive list):
@@ -160,7 +158,6 @@ Note: For a CDI file to be valid, at least one entry must be specified in this a
160158
* `name` (string, REQUIRED), name of the device, can be used to refer to it when requesting a device.
161159
* Beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (\_), dots (.), and alphanumerics between.
162160
* e.g: `docker/podman run --device foo ...`
163-
* `nameShort` (array of strings, OPTIONAL), alternative names for the device. Can be used to reduce the CLI verbosity
164161
* Entries in the array MUST use the same schema as the entry for the `name` field
165162
* `containerEdits` (object, OPTIONAL) this field is described in the next section.
166163
* This field should only be merged in the OCI spec if the device has been requested by the container runtime user.

0 commit comments

Comments
 (0)