opencontainers/runtime-spec
1
0
Fork 0
mirror of https://github.com/opencontainers/runtime-spec.git synced 2026-02-05 09:45:57 +01:00
Code Issues Wiki Activity

glossary: s/features document/Features structure/g

Browse Source 
Because "document" sounds like a human-readable document

Signed-off-by: Akihiro Suda <akihiro.suda.cz@hco.ntt.co.jp>
This commit is contained in:
Akihiro Suda
2023-05-16 19:48:03 +09:00
parent 0983f1d9e0
commit d89ef1e610
4 changed files with 13 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
features-linux.md
View File

@@ -1,6 +1,6 @@
# <a name="linuxFeatures" />Linux Features Document
# <a name="linuxFeatures" />Linux Features Structure
This document describes the [Linux-specific section](features.md#platform-specific-features) of the [features document](features.md).
This document describes the [Linux-specific section](features.md#platform-specific-features) of the [Features structure](features.md).
## <a name="linuxFeaturesNamespaces" />Namespaces

14
features.md
View File

@@ -1,12 +1,12 @@
# <a name="features" />Features Document
# <a name="features" />Features Structure
A [runtime](glossary.md#runtime) MAY provide a JSON document about its implemented features to [runtime callers](glossary.md#runtime-caller).
This JSON document is called ["features document"](glossary.md#features-document).
A [runtime](glossary.md#runtime) MAY provide a JSON structure about its implemented features to [runtime callers](glossary.md#runtime-caller).
This JSON structure is called ["Features structure"](glossary.md#features-structure).
The features document is irrelevant to the actual availability of the features in the host operating system.
Hence, the content of the feature document SHOULD be determined on the compilation time of the runtime, not on the execution time.
The Features structure is irrelevant to the actual availability of the features in the host operating system.
Hence, the content of the Features structure SHOULD be determined on the compilation time of the runtime, not on the execution time.
All properties in the features document except `ociVersionMin` and `ociVersionMax` MAY either be absent or have the `null` value.
All properties in the Features structure except `ociVersionMin` and `ociVersionMax` MAY either be absent or have the `null` value.
The `null` value MUST NOT be confused with an empty value such as `0`, `false`, `""`, `[]`, and `{}`.
## <a name="featuresSpecificationVersion" />Specification version
@@ -17,7 +17,7 @@ The `null` value MUST NOT be confused with an empty value such as `0`, `false`,
* **`ociVersionMax`** (string, REQUIRED) The maximum recognized version of the Open Container Initiative Runtime Specification.
The runtime MUST accept this value as the [`ociVersion` property of `config.json`](config.md#specification-version).
The value MUST NOT be less than the value of the `ociVersionMin` property.
The feature document MUST NOT contain properties that are not defined in this version of the Open Container Initiative Runtime Specification.
The Features structure MUST NOT contain properties that are not defined in this version of the Open Container Initiative Runtime Specification.
### Example
```json

4
glossary.md
View File

@@ -17,9 +17,9 @@ For example, namespaces, resource limits, and mounts are all part of the contain
On Linux,the [namespaces][namespaces.7] in which the [configured process](config.md#process) executes.
## <a name="glossaryFeaturesDocument" />Features Document
## <a name="glossaryFeaturesDocument" />Features Structure
A [JSON][] document that represents [the implemented features](#features.md) of the [runtime](#runtime).
A [JSON][] structure that represents [the implemented features](#features.md) of the [runtime](#runtime).
Irrelevant to the actual availability of the features in the host operating system.
## <a name="glossaryJson" />JSON

4
spec.md
View File

@@ -33,8 +33,8 @@ Platforms defined by this specification are:
- [Windows-specific Configuration](config-windows.md)
- [Virtual-Machine-specific Configuration](config-vm.md)
- [z/OS-specific Configuration](config-zos.md)
- [Features Document](features.md)
- [Linux-specific Features Document](features-linux.md)
- [Features Structure](features.md)
- [Linux-specific Features Structure](features-linux.md)
- [Glossary](glossary.md)
# <a name="ociRuntimeSpecNotationalConventions" />Notational Conventions