aboutsummaryrefslogtreecommitdiff
path: root/runtime/doc/api.txt
Commit message (Collapse)AuthorAge
* doc/api: Closes #1842Justin M. Keyes2016-10-31
|
* api: api_info()['version']Justin M. Keyes2016-10-28
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | API level is disconnected from NVIM version. The API metadata holds the current API level, and the lowest backwards-compatible level supported by this instance. Release 0.1.6 is the first release that reports the Nvim version and API level. metadata['version'] = { major: 0, minor: 1, patch: 6, api_level: 1, api_compatible: 0, api_prerelease: false, } The API level may remain unchanged across Nvim releases if the API has not changed. When changing the API, - set NVIM_API_PRERELEASE to true - increment NVIM_API_LEVEL (at most once per Nvim version) - adjust NVIM_API_LEVEL_COMPAT if backwards-compatibility was broken api_level_0.mpack was generated from Nvim 0.1.5 with: nvim --api-info
* api: Nvim version, API level #5386Rui Abreu Ferreira2016-10-26
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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.
* api: consistently use nvim_ prefix and update documentationBjörn Linse2016-08-31
|
* doc: remove "nvim-" qualfier from tagsJustin M. Keyes2016-06-15
| | | | | | | It is almost never necessary to qualify documentation as "Nvim specific". The main exception to this is vim_diff.txt.
* doc: msgpack_rpc: De-emphasize the transport protocol.Justin M. Keyes2016-06-15
| | | | | | | | | | | | Tighten our jargon, avoid mentioning "msgpack" everywhere we mention the RPC API. Prefer "RPC API" when speaking about the remote API. Though it's conceivable that we may one day support some protocol other than msgpack, that isn't relevant to most of our discussion of the API, including this document. The file name msgpack_rpc.txt is preserved to avoid totally breaking URLs.
* docs: start api docs and document highlight mechanismBjörn Linse2016-02-23