From 551cb8712f6b48985c403d0352b6a41e96302877 Mon Sep 17 00:00:00 2001 From: dundargoc Date: Sun, 24 Nov 2024 11:29:39 +0100 Subject: [PATCH] docs: misc Co-authored-by: Axel Co-authored-by: Colin Kennedy Co-authored-by: Juan Giordana Co-authored-by: Yochem van Rosmalen Co-authored-by: ifish --- BUILD.md | 15 ++++++++------- Makefile | 3 +++ runtime/doc/lsp.txt | 6 +++--- runtime/doc/options.txt | 4 ++-- runtime/doc/treesitter.txt | 2 +- runtime/lua/vim/_meta/options.lua | 4 ++-- runtime/lua/vim/lsp.lua | 2 +- runtime/lua/vim/lsp/diagnostic.lua | 2 +- src/nvim/options.lua | 4 ++-- src/nvim/window.c | 2 +- test/unit/mbyte_spec.lua | 6 +++--- test/unit/vterm_spec.lua | 4 ++-- 12 files changed, 29 insertions(+), 25 deletions(-) diff --git a/BUILD.md b/BUILD.md index f4596723fb..5ba41b250b 100644 --- a/BUILD.md +++ b/BUILD.md @@ -131,7 +131,8 @@ https://github.com/cascent/neovim-cygwin was built on Cygwin 2.9.0. Newer `libuv 1. From the MSYS2 shell, install these packages: ``` pacman -S \ - mingw-w64-ucrt-x86_64-{gcc,cmake,make,ninja,diffutils} + mingw-w64-ucrt-x86_64-gcc \ + mingw-w64-x86_64-{cmake,make,ninja,diffutils} ``` 2. From the Windows Command Prompt (`cmd.exe`), set up the `PATH` and build. @@ -292,13 +293,13 @@ Platform-specific requirements are listed below. ### Ubuntu / Debian ```sh -sudo apt-get install ninja-build gettext cmake unzip curl build-essential +sudo apt-get install ninja-build gettext cmake curl build-essential ``` ### RHEL / Fedora ``` -sudo dnf -y install ninja-build cmake gcc make unzip gettext curl glibc-gconv-extra +sudo dnf -y install ninja-build cmake gcc make gettext curl glibc-gconv-extra ``` ### openSUSE @@ -310,13 +311,13 @@ sudo zypper install ninja cmake gcc-c++ gettext-tools curl ### Arch Linux ``` -sudo pacman -S base-devel cmake unzip ninja curl +sudo pacman -S base-devel cmake ninja curl ``` ### Alpine Linux ``` -apk add build-base cmake coreutils curl unzip gettext-tiny-dev +apk add build-base cmake coreutils curl gettext-tiny-dev ``` ### Void Linux @@ -380,7 +381,7 @@ or a specific SHA1 like `--override-input neovim-src github:neovim/neovim/89dc8f ### FreeBSD ``` -sudo pkg install cmake gmake sha unzip wget gettext curl +sudo pkg install cmake gmake sha wget gettext curl ``` If you get an error regarding a `sha256sum` mismatch, where the actual SHA-256 hash is `e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855`, then this is your issue (that's the `sha256sum` of an empty file). @@ -388,7 +389,7 @@ If you get an error regarding a `sha256sum` mismatch, where the actual SHA-256 h ### OpenBSD ```sh -doas pkg_add gmake cmake unzip curl gettext-tools +doas pkg_add gmake cmake curl gettext-tools ``` Build can sometimes fail when using the top level `Makefile`, apparently due to some third-party component (see [#2445-comment](https://github.com/neovim/neovim/issues/2445#issuecomment-108124236)). The following instructions use CMake: diff --git a/Makefile b/Makefile index fe83f302e8..9154cd8782 100644 --- a/Makefile +++ b/Makefile @@ -133,6 +133,9 @@ generated-sources benchmark $(FORMAT) $(LINT) $(TEST) doc: | build/.ran-cmake test: $(TEST) +# iwyu-fix-includes can be downloaded from +# https://github.com/include-what-you-use/include-what-you-use/blob/master/fix_includes.py. +# Create a iwyu-fix-includes shell script in your $PATH that invokes the python script. iwyu: build/.ran-cmake $(CMAKE) --preset iwyu $(CMAKE) --build build > build/iwyu.log diff --git a/runtime/doc/lsp.txt b/runtime/doc/lsp.txt index 83d191ed48..6607a2b97f 100644 --- a/runtime/doc/lsp.txt +++ b/runtime/doc/lsp.txt @@ -32,7 +32,7 @@ Follow these steps to get LSP features: Example: >lua vim.lsp.config['luals'] = { -- Command and arguments to start the server. - cmd = { 'lua-language-server' } + cmd = { 'lua-language-server' }, -- Filetypes to automatically attach to. filetypes = { 'lua' }, @@ -97,7 +97,7 @@ Given: >lua multilineTokenSupport = true, } } - } + }, root_markers = { '.git' }, }) @@ -885,7 +885,7 @@ foldexpr({lnum}) *vim.lsp.foldexpr()* To use, check for the "textDocument/foldingRange" capability in an |LspAttach| autocommand. Example: >lua - vim.api.nvim_create_autocommand('LspAttach', { + vim.api.nvim_create_autocmd('LspAttach', { callback = function(args) local client = vim.lsp.get_client_by_id(args.data.client_id) if client:supports_method('textDocument/foldingRange') then diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt index 6fe208f506..d86acf39a3 100644 --- a/runtime/doc/options.txt +++ b/runtime/doc/options.txt @@ -1560,8 +1560,8 @@ A jump table for the options with a short description can be found at |Q_op|. "menu" or "menuone". No effect if "longest" is present. noselect Same as "noinsert", except that no menu item is - pre-selected. If both "noinsert" and "noselect" are present, - "noselect" has precedence. + pre-selected. If both "noinsert" and "noselect" are + present, "noselect" has precedence. fuzzy Enable |fuzzy-matching| for completion candidates. This allows for more flexible and intuitive matching, where diff --git a/runtime/doc/treesitter.txt b/runtime/doc/treesitter.txt index a0860c60a6..83b373c0d9 100644 --- a/runtime/doc/treesitter.txt +++ b/runtime/doc/treesitter.txt @@ -70,7 +70,7 @@ adds arbitrary metadata and conditional data to a match. Queries are written in a lisp-like language documented in https://tree-sitter.github.io/tree-sitter/using-parsers#query-syntax -Note: The predicates listed there page differ from those Nvim supports. See +Note: The predicates listed there differ from those Nvim supports. See |treesitter-predicates| for a complete list of predicates supported by Nvim. Nvim looks for queries as `*.scm` files in a `queries` directory under diff --git a/runtime/lua/vim/_meta/options.lua b/runtime/lua/vim/_meta/options.lua index fecbece655..18c3ad1431 100644 --- a/runtime/lua/vim/_meta/options.lua +++ b/runtime/lua/vim/_meta/options.lua @@ -1087,8 +1087,8 @@ vim.go.cia = vim.go.completeitemalign --- "menu" or "menuone". No effect if "longest" is present. --- --- noselect Same as "noinsert", except that no menu item is ---- pre-selected. If both "noinsert" and "noselect" are present, ---- "noselect" has precedence. +--- pre-selected. If both "noinsert" and "noselect" are +--- present, "noselect" has precedence. --- --- fuzzy Enable `fuzzy-matching` for completion candidates. This --- allows for more flexible and intuitive matching, where diff --git a/runtime/lua/vim/lsp.lua b/runtime/lua/vim/lsp.lua index 596e1b609b..20f4f02689 100644 --- a/runtime/lua/vim/lsp.lua +++ b/runtime/lua/vim/lsp.lua @@ -1374,7 +1374,7 @@ end --- |LspAttach| autocommand. Example: --- --- ```lua ---- vim.api.nvim_create_autocommand('LspAttach', { +--- vim.api.nvim_create_autocmd('LspAttach', { --- callback = function(args) --- local client = vim.lsp.get_client_by_id(args.data.client_id) --- if client:supports_method('textDocument/foldingRange') then diff --git a/runtime/lua/vim/lsp/diagnostic.lua b/runtime/lua/vim/lsp/diagnostic.lua index 9a879d9f38..8c1f3f10d4 100644 --- a/runtime/lua/vim/lsp/diagnostic.lua +++ b/runtime/lua/vim/lsp/diagnostic.lua @@ -208,7 +208,7 @@ end --- @param uri string --- @param client_id? integer ---- @param diagnostics vim.Diagnostic[] +--- @param diagnostics lsp.Diagnostic[] --- @param is_pull boolean local function handle_diagnostics(uri, client_id, diagnostics, is_pull) local fname = vim.uri_to_fname(uri) diff --git a/src/nvim/options.lua b/src/nvim/options.lua index de152fb315..141e9ca9dc 100644 --- a/src/nvim/options.lua +++ b/src/nvim/options.lua @@ -1531,8 +1531,8 @@ return { "menu" or "menuone". No effect if "longest" is present. noselect Same as "noinsert", except that no menu item is - pre-selected. If both "noinsert" and "noselect" are present, - "noselect" has precedence. + pre-selected. If both "noinsert" and "noselect" are + present, "noselect" has precedence. fuzzy Enable |fuzzy-matching| for completion candidates. This allows for more flexible and intuitive matching, where diff --git a/src/nvim/window.c b/src/nvim/window.c index 938d9d7618..81208e130f 100644 --- a/src/nvim/window.c +++ b/src/nvim/window.c @@ -6396,7 +6396,7 @@ void win_drag_vsep_line(win_T *dragwin, int offset) fr = curfr; // put fr at window that grows } - // If not enough room thn move as far as we can + // If not enough room then move as far as we can offset = MIN(offset, room); // No room at all, quit. diff --git a/test/unit/mbyte_spec.lua b/test/unit/mbyte_spec.lua index bdc111de2c..2c52aa9217 100644 --- a/test/unit/mbyte_spec.lua +++ b/test/unit/mbyte_spec.lua @@ -58,11 +58,11 @@ describe('mbyte', function() lib.schar_get(buf, lib.utfc_ptr2schar(to_string(seq), firstc)) local str = ffi.string(buf) if 1 > 2 then -- for debugging - local tabel = {} + local tbl = {} for i = 1, #str do - table.insert(tabel, string.format('0x%02x', string.byte(str, i))) + table.insert(tbl, string.format('0x%02x', string.byte(str, i))) end - print('{ ' .. table.concat(tabel, ', ') .. ' }') + print('{ ' .. table.concat(tbl, ', ') .. ' }') io.stdout:flush() end return { str, firstc[0] } diff --git a/test/unit/vterm_spec.lua b/test/unit/vterm_spec.lua index a05579b4ff..adb3ccc1c7 100644 --- a/test/unit/vterm_spec.lua +++ b/test/unit/vterm_spec.lua @@ -1094,7 +1094,7 @@ describe('vterm', function() push('\x1b[0F', vt) cursor(0, 0, state) - -- Cursor Horizonal Absolute + -- Cursor Horizontal Absolute push('\n', vt) cursor(1, 0, state) push('\x1b[20G', vt) @@ -3067,7 +3067,7 @@ describe('vterm', function() screen ) - -- Outputing CJK doublewidth in 80th column should wraparound to next line and not crash" + -- Outputting CJK doublewidth in 80th column should wraparound to next line and not crash" reset(nil, screen) push('\x1b[80G\xEF\xBC\x90', vt) screen_cell(0, 79, '{} width=1 attrs={} fg=rgb(240,240,240) bg=rgb(0,0,0)', screen)