aboutsummaryrefslogtreecommitdiff
path: root/runtime/doc/msgpack_rpc.txt
Commit message (Collapse)AuthorAge
* add cmdline mode to modechange of RPC and testschemzqm2016-11-30
| | | | | | | | use set_cursor_shape_bar for cmdline mode fix test of screen_basic_spec.lua & screen.lua comment fix
* 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: Establish API naming convention. (#5344)Justin M. Keyes2016-09-17
| | | | | | | | | | | | | | | | | | | | | old name: new name: -------------------------------------------------- nvim_name_to_color nvim_get_color_by_name nvim_get_current_buffer nvim_get_current_buf nvim_get_current_window nvim_get_current_win nvim_get_buffers nvim_list_bufs nvim_get_tabpages nvim_list_tabpages nvim_get_windows nvim_list_wins nvim_set_current_buffer nvim_set_current_buf nvim_set_current_window nvim_set_current_win nvim_change_directory nvim_set_current_dir nvim_tabpage_get_window nvim_tabpage_get_win nvim_tabpage_get_windows nvim_tabpage_list_wins nvim_win_get_buffer nvim_win_get_buf nvim_report_error nvim_err_writeln Helped-by: Björn Linse <bjorn.linse@gmail.com> Helped-by: ZyX <kp-pav@yandex.ru> Helped-by: James McCoy <jamessan@jamessan.com>
* api: consistently use nvim_ prefix and update documentationBjörn Linse2016-08-31
|
* api/ui: add documentation for remote ui redraw eventsBjörn Linse2016-08-29
|
* job control: reuse common job code for rpc jobsBjörn Linse2016-08-20
| | | | This makes stderr and exit callbacks work for rpc jobs
* doc: api_infoJustin M. Keyes2016-06-18
|
* eval: add api_info()Björn Linse2016-06-17
| | | | | Previously, the api metadata was only accessible frow within nvim as msgpackparse(systemlist('nvim --api-info'))[0]
* doc: uppercase RPCJustin M. Keyes2016-06-15
|
* 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
|
* api: represent api type String as msgpack type STR. closes #1250Björn Linse2015-10-08
|
* doc: Revise for flow and consistency #2831alecbrooks2015-06-24
| | | | | | In general, attempt to make things more concise. Reviewed-by: Michael Reed <m.reed@mykolab.com>
* doc: v:servername, serverstart()Justin M. Keyes2015-05-17
|
* docs: update for rpcstart('nvim', ['--embed'])Scott Prager2015-04-13
| | | | | Also, edit the reference to the non-existent api function, vim_list_buffers, to vim_get_buffers.
* doc: Misc. cleanupJustin M. Keyes2015-03-24
| | | | | | | | | | Add missing parentheses and whatnot, move dangling comment, etc. Some specific items worth mentioning: Fixed some references to non-existent tags, found via `make html` msgpack_rpc/channel.c: ELOG already prefixes each line with "error @ ..."
* docs: Clean up python, provider, remote_plugin #2056Geoff Harcourt2015-03-08
| | | | | | | * "Python" is a proper noun and should be capitalized in prose * Corrected use of "its/it's" * Used better preposition to describe something "in" legacy Vim * Combine fragments into complete sentence
* docs: Misc. improvements to job_control/msgpackMichael Reed2015-01-11
| | | | | | | | | | | | | | | | | - Rewrote a few sentences for clarity/brevity - Various spelling/grammar fixes - Mention exact time before SIGKILL (mentioned in /src/nvim/os/job.c) - Reflowed all changed paragraphs accordingly - Standardize indentation level - Remove trailing whitespace - Job control example: - Don't buffer output (echo -n); just print a new line for every update. - Use single quotes around jobsend() arguments to allow for proper interpretation of newline characters. - Sleep 1 second between updates instead of 2; 10 seconds is plenty of time for such a simple example.
* Fix outdated msgpack-rpc doc.Eliseo Martínez2014-11-26
| | | | Needed after neovim/python-client#58.
* Fix warnings: Fix outdated doc: Connecting to nvim through python REPL.Eliseo Martínez2014-11-21
| | | | | After neovim/python-client@b8b48bbe8fe9ee41ad73c9bd5a45e808504399e2, docs were no longer relevant.
* doc: update msgpack_rpc documentation to use nvim as variable name #1470James Baumgarten2014-11-17
|
* Fix api metadata function name in docsAlex Genco2014-11-13
| | | The documentation mentions `vim_get_api_metadata`, but the actual function is `vim_get_api_info`
* runtime/docs/msgpack-rpc: Misc. fixesMichael Reed2014-11-03
| | | | | | | | | | | | - Correct apostrophe usage, primarily with it's/its - Correct usage of 'e.g.' - Capitalize acronyms - Prepend NVIM_LISTEN_ADDRESS with '$' to match previous instance - Avoid awkward phrasing - Make lists with an explicitly stated number of points numbered to match other such lists - Added space before parentheses - rm trailing whitespace
* doc: cleanupStefan Hoffmann2014-10-06
| | | | | | | * fix some links * typo * remove reference to hangul_input * remove unused vim2html.pl
* runtime: Some nvim documentation fixes pointed by @oni-linkThiago de Arruda2014-09-15
|
* runtime: Initial msgpack-rpc documentationThiago de Arruda2014-09-13