Skip to content

Commit

Permalink
docs/runtime-compliance-testing: Document list of supported APIs
Browse files Browse the repository at this point in the history
Currently just the command line API, but the test suite might add
support for more APIs in the future.  The command line API itself is
independent of whether the test suite supports additional APIs, so I
put the list of supported APIs in a new file.

Signed-off-by: W. Trevor King <wking@tremily.us>
  • Loading branch information
wking committed Feb 15, 2017
1 parent b5deac1 commit afdf059
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/command-line-interface.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# OCI Runtime Command Line Interface

This file defines the OCI Runtime Command Line Interface version 1.0.0.
It is one of potentially several [runtime APIs supported by the runtime compliance test suite](runtime-compliance-testing.md#supported-apis).

## Notation

Expand Down
9 changes: 9 additions & 0 deletions docs/runtime-compliance-testing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Runtime compliance testing

## Supported APIs

In order to be tested for [compliance][], runtimes MUST support at least one of the following APIs:

* Version 1.0.0 of the [OCI Runtime Command Line Interface](command-line-interface.md).

[compliance]: /~https://github.com/opencontainers/runtime-spec/blob/v1.0.0-rc4/spec.md#notational-conventions

0 comments on commit afdf059

Please sign in to comment.