Skip to content

Commit 1738745

Browse files
committed
image-index: mark os.version, os.features and variant as "reserved"
These properties seems unclear and not suitable for standardization at the moment. Signed-off-by: Akihiro Suda <[email protected]>
1 parent a90602e commit 1738745

File tree

2 files changed

+8
-7
lines changed

2 files changed

+8
-7
lines changed

image-index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -55,15 +55,15 @@ For the media type(s) that this document is compatible with, see the [matrix][ma
5555

5656
- **`os.version`** *string*
5757

58-
This OPTIONAL property specifies the operating system version, for example `10.0.10586`.
58+
This OPTIONAL property is *reserved* for future versions of the specification and hence SHOULD NOT be used.
5959

6060
- **`os.features`** *array of strings*
6161

62-
This OPTIONAL property specifies an array of strings, each specifying a mandatory OS feature (for example on Windows `win32k`).
62+
This OPTIONAL property is *reserved* for future versions of the specification and hence SHOULD NOT be used.
6363

6464
- **`variant`** *string*
6565

66-
This OPTIONAL property specifies the variant of the CPU, for example `armv6l` to specify a particular CPU variant of the ARM CPU.
66+
This OPTIONAL property is *reserved* for future versions of the specification and hence SHOULD NOT be used.
6767

6868
- **`features`** *array of strings*
6969

specs-go/v1/descriptor.go

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -51,15 +51,16 @@ type Platform struct {
5151
OS string `json:"os"`
5252

5353
// OSVersion is an optional field specifying the operating system
54-
// version, for example `10.0.10586`.
54+
// version. This property is reserved and SHOULD NOT be used.
5555
OSVersion string `json:"os.version,omitempty"`
5656

5757
// OSFeatures is an optional field specifying an array of strings,
58-
// each listing a required OS feature (for example on Windows `win32k`).
58+
// each listing a required OS feature. This property is reserved and
59+
// SHOULD NOT be used.
5960
OSFeatures []string `json:"os.features,omitempty"`
6061

61-
// Variant is an optional field specifying a variant of the CPU, for
62-
// example `ppc64le` to specify a little-endian version of a PowerPC CPU.
62+
// Variant is an optional field specifying a variant of the CPU.
63+
// This property is reserved and SHOULD NOT be used.
6364
Variant string `json:"variant,omitempty"`
6465

6566
// Features is an optional field specifying an array of strings, each

0 commit comments

Comments
 (0)