Nvim :help pages, generated
from source
using the tree-sitter-vimdoc parser.
vim-patch.sh
https://github.com/neovim/neovim/blob/master/scripts/vim-patch.sh to see the
status of Vim patches:
./scripts/vim-patch.sh -lgit clone https://github.com/neovim/neovim.git./scripts/vim-patch.sh -l to see the list of missing Vim patches.8.0.0123../scripts/vim-patch.sh -p 8.0.0123git log --grep or git log -G to search the Nvim/Vim source history
(even deleted code). E.g. to find reset_option_was_set:git log -p -G reset_option_was_setgit log options like --grep and -G to ./scripts/vim-patch.sh -L
to filter unmerged Vim patches E.g. to find +quickfix patches:./scripts/vim-patch.sh -L --grep quickfix -- srcvim-patch:8.x.xxxx (no whitespace)
vim-patch:8.0.0123 (no whitespace)
runtime/ patches
https://github.com/neovim/neovim/pull/1744#issuecomment-68202876version.c: update pull requests, include NA patches in
a commit message in the following format:
vim-patch:<version-or-commit> vim-patch:<version-or-commit> ...
<version-or-commit> is a valid Vim version (like 8.0.0123) or
commit-id (SHA). Each patch is on a separate line../scripts/vim-patch -p <na-patch> ./scripts/vim-patch -p <na-patch> ... ./scripts/vim-patch -P <patch> git rebase -i master
:scriptversion. (Nvim
supports Vimscript version 1 only.) Be aware that patches labelled Vim9:
may still contain applicable fixes to other parts of the codebase, so these
patch need to be checked individually.
testdir/Makefile are usually NA because the Makefile implicitly
finds
https://github.com/neovim/neovim/commit/8a677f8a4bff6005fa39f090c14e970c3dfdbe6e#diff-b3c6ad6680a25a1b42095879e3a87104R52
all test_*.vim files.
*.proto changes: Nvim autogenerates function prototypes
#ifdef tweaking: For example, Vim decided to enable FEAT_VISUAL for all
platforms - but Nvim already does that. Adding new FEAT_ guards also isn't
relevant to Nvim.
src/Make_*, src/testdir/Make__*
if_*.c changes: if_python.c et. al. were removed.
term.c changes: the Nvim TUI uses libtermkey to read terminal sequences;
Vim's term.c was removed.
job patches: incompatible API and implementation
src/channel_*, src/job_*, src/testdir/test_channel_*,
src/testdir/test_job_*
:terminal patches that modify NA files: incompatible API and
implementation
src/terminal_*, src/testdir/test_terminal_*
defaults.vim patches
src/gui_*, src/gvim_*, src/GvimExt/*, src/testdir/test_gui*
balloon changes: Nvim does not support balloon feature
src/beval_*, src/testdir/test_balloon_*
src/.
test_popupwin.vim, test_popupwin_textprop.vim:
https://github.com/neovim/neovim/pull/12741#issuecomment-704677141
src/json*, src/testdir/test_json.vim
test_restricted.vim restricted mode is removed in
https://github.com/neovim/neovim/pull/11996
test_prompt_buffer.vim require incompatible Vim features
such as channel; they should still be included, but skipped
Filelist, README, INSTALL,
src/nvim/version.c is automatically updated
https://github.com/neovim/neovim/pull/7780 based on the presence of
vim-patch:xxx tokens in the Nvim git log.src/nvim/version.c yourself.
scripts/vim-patch.sh -p intentionally omits version.c to avoid merge
conflicts and save time when porting a patch.
scripts/vimpatch.lua) only recognizes tokens like
vim-patch:8.0.1206, not vim-patch:<hash>.
memory.c
https://github.com/neovim/neovim/blob/master/src/nvim/memory.c for more
information.
----------------------------------------------------------------------- Deprecated or removed Replacement ----------------------------------------------------------------------- vim_free xfree VIM_CLEAR(&foo) XFREE_CLEAR(foo) malloc alloc lalloc lalloc_id ALLOC_ONE xmalloc calloc lalloc_clear xcalloc realloc vim_realloc xrealloc mch_memmove memmove vim_memset copy_chars copy_spaces memset vim_strbyte strchr vim_strncpy strncpy xstrlcpy/xmemcpyz vim_strcat strncat xstrlcat VIM_ISWHITE ascii_iswhite IS_WHITE_OR_NUL ascii_iswhite_or_nul vim_isalpha mb_isalpha vim_isNormalIDc ascii_isident vim_islower vim_isupper mb_islower mb_isupper vim_tolower vim_toupper mb_tolower mb_toupper mb_ptr2len utfc_ptr2len mb_ptr2len_len utfc_ptr2len_len mb_char2len utf_char2len mb_char2bytes utf_char2bytes mb_ptr2cells utf_ptr2cells mb_ptr2cells_len utf_ptr2cells_len mb_char2cells utf_char2cells mb_off2cells utf_off2cells mb_ptr2char utf_ptr2char mb_head_off utf_head_off mb_tail_off utf_cp_bounds mb_lefthalve grid_lefthalve mb_fix_col grid_fix_col utf_off2cells grid_off2cells ml_get_curline get_cursor_line_ptr ml_get_cursor get_cursor_pos_ptr ml_get_curline_len get_cursor_line_len ml_get_cursor_len get_cursor_pos_len screen_char ui_line screen_line grid_put_linebuf screen_* (most functions) grid_* update_prepare, update_finish #9484 removed; use update_screen only ARRAY_LENGTH ARRAY_SIZE vim_strsave_escape_csi vim_strsave_escape_ks vim_unescape_csi vim_unescape_ks gettail path_tail mch_isFullName path_is_absolute script_do_profile profile_init -----------------------------------------------------------------------
utf_ and utfc_ when replacing
mb_ functions. Also indirect call syntax (*mb_ptr2len)(...) should be
replaced with an ordinary function call utfc_ptr2len(...).
----------------------------------------------------------------------- Data type Format (Vim source) Portable format (Nvim source) ------------ ----------------------- ---------------------------------- long long "%lld" "%" PRId64 size_t "%ld" "%zu" linenr_T "%ld" "%" PRIdLINENR -----------------------------------------------------------------------
ga_init2 was renamed to ga_init and the original ga_init is
gone.
src/testdir/*.in) should be converted to Lua tests
(see #1286 https://github.com/neovim/neovim/issues/1286 and #1328
https://github.com/neovim/neovim/pull/1328). See Checklist for migrating
legacy tests
https://github.com/neovim/neovim/blob/master/test/README.md#checklist-for-migrating-legacy-tests.
src/testdir/*.vim) to Lua. The "new style" Vim tests are faster than
the old ones, and converting them takes time and effort better spent
elsewhere. Just copy them to test/old/testdir/*.vim.
enc_utf8 or has_mbyte are obsolete (only the
"true" case is applicable).
CSI in typeahead buffer is only necessary in Vim with
FEAT_GUI. CSI does not have a special meaning in typeahead buffer in
Nvim. (also see https://github.com/neovim/neovim/pull/16936)
list_T and listitem_T from vim) was changed in
https://github.com/neovim/neovim/pull/7708/. There is a lint against the "old"
usage, but here are the most important changes.list_T list: a list
listitem_T li: an item of list
int val a value for lv_copyID
--------------------------------------------------------------------------------------
Old New Comment
------------------------------- ------------------------------------------------------
list->lv_first tv_list_first(list)
list->lv_last tv_list_last(list)
li->li_next TV_LIST_ITEM_NEXT(list, li) To be avoided if possible, must use list which li belongs to.
li->li_prev TV_LIST_ITEM_PREV(list, li) To be avoided if possible, must use list which li belongs to.
Suggestion by @ZyX-l: Use TV_LIST_ITER or indexing instead of the previous two calls.
list->lv_len tv_list_len(list)
list->lv_lock tv_list_locked(list)
&li->li_tv TV_LIST_ITEM_TV(li)
list->lv_refcount++ tv_list_ref(list)
val = list->lv_copyID val = tv_list_copyid(list)
list->lv_copyID = val tv_list_set_copyid(list, val)
for (li = list->lv_first; TV_LIST_ITER_CONST(list, li, Use TV_LIST_ITER(...) if you need to
li != NULL && another_cond; { if (another_cond) {break;} code}) modify list items (note: assigning copyID is also modification and this happens
li = li->li_next) code always when recursively traversing a list).
--------------------------------------------------------------------------------------typval.h and typval.c.{Only when compiled with ...}: the vast majority of features have been
made non-optional (see https://github.com/neovim/neovim/wiki/Introduction)