aboutsummaryrefslogtreecommitdiff
path: root/runtime/doc/develop.txt
Commit message (Collapse)AuthorAge
* docs: update dev-api to include "create"Gregory Anders2022-04-10
|
* docs(lua): reference runtime/lua/vim/_editor.luazeertzjq2022-03-06
|
* chore: fix typos (#16816)dundargoc2022-01-04
| | | | | | | Co-authored-by: Sean Dewar <seandewar@users.noreply.github.com> Co-authored-by: Gregory Anders <greg@gpanders.com> Co-authored-by: Sebastian Volland <seb@baunz.net> Co-authored-by: Lewis Russell <lewis6991@gmail.com> Co-authored-by: zeertzjq <zeertzjq@outlook.com>
* docs(develop.txt): nvim_open_win is now in win_config.c (#15909)zeertzjq2021-10-04
|
* docs: naming conventionsJustin M. Keyes2021-09-09
|
* feat(lua)!: register_keystroke_callback => on_keyJustin M. Keyes2021-09-09
| | | | | | | | | Analogous to nodejs's `on('data', …)` interface, here on_key is the "add listener" interface. ref 3ccdbc570d85 #12536 BREAKING_CHANGE: vim.register_keystroke_callback() is now an error.
* docs: make Lua docstrings consistent #15255Gregory Anders2021-08-22
| | | | | | | | | | | | The official developer documentation in in :h dev-lua-doc specifies to use "--@" for special/magic tokens. However, this format is not consistent with EmmyLua notation (used by some Lua language servers) nor with the C version of the magic docstring tokens which use three comment characters. Further, the code base is currently split between usage of "--@", "---@", and "--- @". In an effort to remain consistent, change all Lua magic tokens to use "---@" and update the developer documentation accordingly.
* docs #15447Justin M. Keyes2021-08-21
| | | | | - update ":help 'hidden'" #15410 - update ":help K" #15398 - try to capture some of the debug steps from #12036 (bpftrace, USDT probes)
* eval_call_provider(): free unused return value #12819Jacques Germishuys2020-09-01
| | | Caller can pass discard=true to free the unwanted return value.
* API: rename nvim_execute_lua => nvim_exec_luaJustin M. Keyes2019-12-02
| | | | | | - We already find ourselves renaming nvim_execute_lua in tests and scripts, which suggests "exec" is the verb we actually want. - Add "exec" verb to `:help dev-api`.
* UI: emit mouse_on/mouse_off on attach #11455Justin M. Keyes2019-11-25
| | | closes #11372
* doc: vim.fn, vim.call(), vim.api [ci skip]Justin M. Keyes2019-11-06
|
* doc: eliminate msgpack_rpc.txt [ci skip]Justin M. Keyes2019-09-09
| | | | | - Migrate msgpack_rpc.txt into api.txt, develop.txt. - fix #10740: Remove warning about "avoid hardcoding the type codes".
* provider: g:loaded_xx_provider=2 means "enabled and working"Justin M. Keyes2019-08-04
| | | | | Value of 1 cannot be used, because users might set that in their vimrc to _disable_ a provider, which would confuse :checkhealth and has().
* provider: decide status by g:loaded_xx_providerJustin M. Keyes2019-08-04
|
* provider: let providers decide their statusRui Abreu Ferreira2019-08-04
| | | | | | | | | | | | | | | | | | | | | | | | | | Instead of deciding provider status in eval_has_provider, move the decision to the provider Vim scripts. Previously, provider loading worked as follows: 1. eval_has_provider() verified provider availability by searching for the provider#providername#Call function and cached this verificaion as a static variable for some providers 2. providers short-circuited on loading to prevent the definition of the Call function (with the exception of the node provider that did not) This commit changes the expected interface between nvim and its providers to facilitate provider reloading, by splitting the verification of the provider from the availability of the Call function. eval_has_provider() now checks for a provider#providername#enabled variable. It is up to the provider script to set this to 0 or 1 accordingly. eval_call_provider() remains unchanged. All providers hosting a Call function were updated to respect this. The clipboard provider now has a Reload function to reload the provider.
* docJustin M. Keyes2019-05-11
|
* doc: rewrite *feature-list*Justin M. Keyes2019-04-08
|
* doc [ci skip] #9478Justin M. Keyes2019-01-26
| | | | | | | | | | | | - Lua - developer guidelines - MAINTAIN.md - TUI: cleanup - TUI: mention Windows terminfo builtins - cleanup if_pyth, redirect python-bindeval tag Helped-by: Björn Linse <bjorn.linse@gmail.com> Helped-by: erw7 <erw7.github@gmail.com>
* docJustin M. Keyes2018-12-30
| | | | - CMake features
* RPC: turn errors from async calls into notificationsBjörn Linse2018-12-03
| | | | | Previously, nvim sent a response with invalid request id (UINT64_MAX). In functionaltests, catch unexpected error notifications in after_each().
* docJustin M. Keyes2018-11-28
| | | | | | | | | | - develop.txt is for design/guidelines; architecture/concepts should live elsewhere (currently src/nvim/README.md) - move dev-jargon to intro.txt - replace https://neovim.io/community (deprecated) with https://neovim.io/#chat - <Cmd> avoids CmdlineEnter/Leave https://github.com/vim/vim/issues/2889
* vim-patch:91f84f6e11cdJustin M. Keyes2018-10-29
| | | | | Update runtime files. https://github.com/vim/vim/commit/91f84f6e11cd879d43d651c0903d85bff95f0716
* doc/develop.txt: brevityJustin M. Keyes2018-10-11
| | | | | | design-flexible and design-multi-platform sections are "obvious" by now (and covered in much of our other resources) and I've never seen it referenced in any discussion.
* doc: xdg, MAINTAIN.md, channel-id, job controlJustin M. Keyes2018-10-11
| | | | - tutor: emphasize K
* doc (#8652)Justin M. Keyes2018-06-28
|
* doc: job/channel, misc #7783Justin M. Keyes2018-06-11
| | | | | | | | | | | doc: termios defaults. ref #6992 doc: :help shell-powershell doc: provider: Python minimum version is 2.7, 3.4 doc: remove :!start special-case. #5844 doc: mention #7917 change which accepts empty Array for Dictionary parameter doc: <Cmd> pseudokey doc: lmap change #5658 doc: -s, -es
* docJustin M. Keyes2017-12-26
| | | | | | | | vim-patch:8.0.1206: no autocmd for entering or leaving the command line (commit a4f6cec7a31ff8dbfa089b9e22227afbeb951e9b) NA patches: vim-patch:8.0.0320: warning for unused variable with small build
* docJustin M. Keyes2017-11-06
|
* help, man.vim: change "outline" map to gO (#7405)Justin M. Keyes2017-10-21
|
* doc: "terminal" always means "embedded terminal emulator"Justin M. Keyes2017-08-03
| | | | | | | | | | | - Prefer "TUI" where possible to refer to the host terminal. - Remove obsolete tags and ancient TTY exposition. - Establish "terminal" to consistently mean "terminal emulator" in all Nvim documentation. This removes the need for verbose qualifiers in tags and prose. References #6280 References #6803
* doc: Replace hardcoded TOCs with <M-]> advice.Justin M. Keyes2017-05-01
|
* doc: api-contract, CONTRIBUTING.mdJustin M. Keyes2017-04-19
|
* doc: Update missing headers. (#6330)Justin M. Keyes2017-03-22
| | | | pi_* docs are considered standalone plugins so they don't follow this convention.
* doc/deprecated.txt (#5338)Justin M. Keyes2016-09-24
| | | | | | | | | | | `deprecated.txt` is a place for deprecated tags to live. - Encourages aggressive documentation of deprecations without cluttering the main help files. - Provides a single browsable reference of all deprecations. Other changes: - Move tags to doc/vim_diff.txt. - Remove doc/quotes.txt. It has little historical value, except maybe the Larry Wall quote.
* 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>
* docJustin M. Keyes2016-07-03
|
* doc: consolidate nvim.txtJustin M. Keyes2016-06-15
|
* doc: uppercase RPCJustin M. Keyes2016-06-15
|
* doc/provider: cleanupJustin M. Keyes2016-06-15
| | | | | - Move design/impl discussion to develop.txt - Move clipboard notes to provider.txt
* 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.
* doc: Move spell design discussion.Justin M. Keyes2016-06-15
| | | | | It is worth preserving, but let it live in spell.txt so we can dedicate develop.txt to nvim-specific discussion.
* vim-patch:5e9b2faJames McCoy2016-06-07
| | | | | | | | | | | | | | | Updated runtime files and translations. https://github.com/vim/vim/commit/5e9b2fa9bb0e6061cf18457c173cd141a5dc9c92 Ignore changes to * doc/tags: generated at build time * doc/develop.txt, doc/todo.txt, doc/netbeans.txt, doc/vim-ja.UTF-8.1, doc/xxd-ja.UTF-8.1, lang/menu_*: Not applicable to Neovim * doc/editing.txt: Crypt related * doc/change.txt, doc/insert.txt, doc/various.txt: Removal of ex_extra tags, which already happened in Neovim * doc/vim-ja.UTF-8.1, doc/xxd-ja.UTF-8.1
* vim-patch:13d5aeeJames McCoy2016-06-06
| | | | | | | | | | | | Update runtime files https://github.com/vim/vim/commit/13d5aeef56e3140a8eb8f40c7062aa1c5700f76e Ignored changes to * doc/develop.txt, since they were all in the "Coding Style" section, which is completely different between Vim and Neovim. * doc/tags, doc/todo.txt * syntax/vim.vim, generated at build time
* doc: Remove some Vi-compatibility stuffMichael Reed2015-11-24
| | | | | This stuff is no longer relevant, as we don't care about Vi compatibility just for the sake of it.
* doc/develop.txt: Remove "coding-style" sectionMichael Reed2015-11-24
| | | | | By and large, it's very outdated, and we already have a style guide available online (see CONTRIBUTING.md).
* doc/develop.txt: Mention src/nvim/README.mdMichael Reed2015-11-24
|
* doc/develop.txt: Remove "design-assumptions" sectionMichael Reed2015-11-24
| | | | | | | We don't make such assumptions; new code should use fixed-width integer types [1]. [1]: https://neovim.io/develop/style-guide.xml?showone=Integer_Types#Integer_Types
* docJustin M. Keyes2015-11-07
| | | | | | | | - design-not. Closes #2940 - :terminal - vim_diff: 'termencoding' footnote - 'shada'. Closes #3619 - eval.txt: job* functions list. Closes #3222