diff options
| author | Rui Abreu Ferreira <rap-ep@gmx.com> | 2016-09-25 18:46:37 +0100 |
|---|---|---|
| committer | Justin M. Keyes <justinkz@gmail.com> | 2016-10-26 14:23:50 +0200 |
| commit | f25797f86976cbccf697d6df953154c5e59656e6 (patch) | |
| tree | f8f979f07c99e9d5e5db66af1b4ff6b5695dcc2c /runtime | |
| parent | 90bf31c7421f6bc32703dd8d8a19cd29f06cc63d (diff) | |
| download | rneovim-f25797f86976cbccf697d6df953154c5e59656e6.tar.gz rneovim-f25797f86976cbccf697d6df953154c5e59656e6.tar.bz2 rneovim-f25797f86976cbccf697d6df953154c5e59656e6.zip | |
api: Nvim version, API level #5386
The API level is disconnected from the NVIM version. The API metadata
holds the current API level, and the lowest backwards-compatible level
supported by this instance.
Release 0.1.6 will be the first release reporting the Nvim version and
API level.
metadata['version'] = {
major: 0,
minor: 1,
patch: 6,
prerelease: true,
api_level: 1,
api_compatible: 0,
}
The API level may remain unchanged across Neovim releases if the API has
not changed.
When changing the API the CMake variable NVIM_API_PRERELEASE is set to
true, and NVIM_API_CURRENT/NVIM_API_COMPATIBILITY are incremented
accordingly.
The functional tests check the API table against fixtures of past
versions of Neovim. It compares all the functions in the old table with
the new one, it does ignore some metadata attributes that do not alter
the function signature or were removed since 0.1.5. Currently the only
fixture is 0.mpack, generated from Neovim 0.1.5 with nvim --api-info.
Diffstat (limited to 'runtime')
| -rw-r--r-- | runtime/doc/api.txt | 1 | ||||
| -rw-r--r-- | runtime/doc/msgpack_rpc.txt | 3 |
2 files changed, 4 insertions, 0 deletions
diff --git a/runtime/doc/api.txt b/runtime/doc/api.txt index c3d7fdb35b..dd48a0c2a5 100644 --- a/runtime/doc/api.txt +++ b/runtime/doc/api.txt @@ -51,6 +51,7 @@ Tabpage -> enum value kObjectTypeTabpage Nvim exposes metadata about the API as a Dictionary with the following keys: +api_level API version compatibility information functions calling signature of the API functions types The custom handle types defined by Nvim error_types The possible kinds of errors an API function can exit with. diff --git a/runtime/doc/msgpack_rpc.txt b/runtime/doc/msgpack_rpc.txt index b3fed9e756..bfd4100f15 100644 --- a/runtime/doc/msgpack_rpc.txt +++ b/runtime/doc/msgpack_rpc.txt @@ -168,6 +168,9 @@ API metadata object ~ API clients exist to hide msgpack-rpc details. The API metadata object contains information that makes this task easier (see also |rpc-types|): + - The "api_level" key contais API compatibility information. The "current" + key holds the API version supported Neovim. The "compatibility" key holds + the oldest supported API version. - The "functions" key contains a list of metadata objects for individual functions. - Each function metadata object has |rpc-types| information about the return |