docs: misc (#30177)

Co-authored-by: Christian Clason <c.clason@uni-graz.at>
Co-authored-by: Riley Bruins <ribru17@hotmail.com>
Co-authored-by: zeertzjq <zeertzjq@outlook.com>

BUILD.md

@@ -12,7 +12,6 @@
     - To build on Windows, see the [Building on Windows](#building-on-windows) section. _MSVC (Visual Studio) is recommended._
 4. `sudo make install`
     - Default install location is `/usr/local`
-    - On Debian/Ubuntu, instead of installing files directly with `sudo make install`, you can run `cd build && cpack -G DEB && sudo dpkg -i nvim-linux64.deb` to build DEB-package and install it. This should help ensuring the clean removal of installed files.
 
 **Notes**:
 - From the repository's root directory, running `make` will download and build all the needed dependencies and put the `nvim` executable in `build/bin`.
@@ -284,7 +283,8 @@ General requirements (see [#1469](https://github.com/neovim/neovim/issues/1469#i
 
 - Clang or GCC version 4.9+
 - CMake version 3.16+, built with TLS/SSL support
-  - Optional: Get the latest CMake from an [installer](https://github.com/Kitware/CMake/releases) or the [Python package](https://pypi.org/project/cmake/) (`pip install cmake`)
+  - Optional: Get the latest CMake from https://cmake.org/download/
+    - Provides a shell script which works on most Linux systems. After running it, ensure the resulting `cmake` binary is in your $PATH so the the Nvim build will find it.
 
 Platform-specific requirements are listed below.
 

runtime/doc/lua.txt

@@ -1709,7 +1709,7 @@ vim.paste({lines}, {phase})                                      *vim.paste()*
               -- Scrub ANSI color codes from paste input.
               lines[i] = line:gsub('\27%[[0-9;mK]+', '')
             end
-            overridden(lines, phase)
+            return overridden(lines, phase)
           end
         end)(vim.paste)
 <

runtime/doc/news.txt

@@ -223,7 +223,7 @@ CHANGED FEATURES                                                 *news-changed*
 
 These existing features changed their behavior.
 
-• 'scrollbind' now works properly with buffers that contain virutal lines.
+• 'scrollbind' now works properly with buffers that contain virtual lines.
 
   Scrollbind works by aligning to a target top line of each window in a tab
   page. Previously this was done by calculating the difference between the old

runtime/doc/pi_netrw.txt

@@ -3858,7 +3858,7 @@ netrw:
 				  netrw-safe guioptions
 		Nov 15, 2021	* removed netrw_localrm and netrw_localrmdir
 				  references
-		Aug 18, 2022	* (Miguel Barro) improving compatability with
+		Aug 18, 2022	* (Miguel Barro) improving compatibility with
 				  powershell
 	v171:	Oct 09, 2020	* included code in s:NetrwOptionsSafe()
 				  to allow |'bh'| to be set to delete when

runtime/doc/quickfix.txt

@@ -1310,7 +1310,7 @@ make, say :make html or :make pdf.
 Additional arguments can be passed to groff by setting them in
 `b:groff_compiler_args` or `g:groff_compiler_args`. The `language` argument
 passed to groff is set using 'spelllang'; it can be overridden by setting
-`b:groff_compiler_lang`. The default enconding is `UTF-8` and can be changed
+`b:groff_compiler_lang`. The default encoding is `UTF-8` and can be changed
 by setting `b:groff_compiler_encoding` or `g:groff_compiler_encoding`.
 
 PANDOC					*quickfix-pandoc* *compiler-pandoc*

runtime/doc/treesitter.txt

@@ -757,7 +757,7 @@ get_captures_at_pos({bufnr}, {row}, {col})
       • {col}    (`integer`) Position column
 
     Return: ~
-        (`{capture: string, lang: string, metadata: table}[]`)
+        (`{capture: string, lang: string, metadata: vim.treesitter.query.TSMetadata}[]`)
 
 get_node({opts})                                   *vim.treesitter.get_node()*
     Returns the smallest named node at the given position

runtime/doc/ui.txt

@@ -398,8 +398,8 @@ numerical highlight ids to the actual attributes.
 	`grid` will not be used anymore and the UI can free any data associated
 	with it.
 
-["grid_cursor_goto", grid, row, column] ~
+["grid_cursor_goto", grid, row, col] ~
-	Makes `grid` the current grid and `row, column` the cursor position on this
+	Makes `grid` the current grid and `row, col` the cursor position on this
 	grid.  This event will be sent at most once in a `redraw` batch and
 	indicates the visible cursor position.
 
@@ -610,7 +610,7 @@ tabs.
 	size). If the window was previously hidden, it should now be shown
 	again.
 
-["win_float_pos", grid, win, anchor, anchor_grid, anchor_row, anchor_col, focusable] ~
+["win_float_pos", grid, win, anchor, anchor_grid, anchor_row, anchor_col, focusable, zindex] ~
 	Display or reconfigure floating window `win`. The window should be
 	displayed above another grid `anchor_grid` at the specified position
 	`anchor_row` and `anchor_col`. For the meaning of `anchor` and more

runtime/lua/vim/_editor.lua

@@ -222,7 +222,7 @@ do
   ---       -- Scrub ANSI color codes from paste input.
   ---       lines[i] = line:gsub('\27%[[0-9;mK]+', '')
   ---     end
-  ---     overridden(lines, phase)
+  ---     return overridden(lines, phase)
   ---   end
   --- end)(vim.paste)
   --- ```

runtime/lua/vim/treesitter.lua

@@ -261,7 +261,7 @@ end
 ---@param row integer Position row
 ---@param col integer Position column
 ---
----@return {capture: string, lang: string, metadata: table}[]
+---@return {capture: string, lang: string, metadata: vim.treesitter.query.TSMetadata}[]
 function M.get_captures_at_pos(bufnr, row, col)
   if bufnr == 0 then
     bufnr = api.nvim_get_current_buf()

src/nvim/CMakeLists.txt

@@ -161,7 +161,6 @@ elseif(CMAKE_SYSTEM_NAME MATCHES "Darwin")
   # https://github.com/neovim/neovim/issues/25295
   target_link_options(nvim_bin PRIVATE "-Wl,-export_dynamic")
   # Apple Clang 16's new deduplication pass leads to lock-up on start
-  # TODO(clason): verify that problem remains after release or remove
   target_link_options(nvim_bin PRIVATE "-Wl,-no_deduplicate")
 elseif(CMAKE_SYSTEM_NAME MATCHES "OpenBSD")
   target_link_libraries(main_lib INTERFACE pthread c++abi)

src/nvim/option.c

@@ -246,7 +246,7 @@ static void set_init_default_backupskip(void)
       // note: the value (and therefore plen) may already include a path separator
       size_t itemsize = plen + (has_trailing_path_sep ? 0 : 1) + 2;
       char *item = xmalloc(itemsize);
-      // add a preceeding comma as a separator after the first item
+      // add a preceding comma as a separator after the first item
       size_t itemseplen = (ga.ga_len == 0) ? 0 : 1;
 
       size_t itemlen = (size_t)vim_snprintf(item, itemsize, "%s%s*", p,

test/README.md

@@ -263,7 +263,7 @@ by the semantic component they are testing.
 Lint
 ====
 
-`make lint` (and `make lualint`) runs [luacheck](https://github.com/mpeterv/luacheck)
+`make lint` (and `make lintlua`) runs [luacheck](https://github.com/mpeterv/luacheck)
 on the test code.
 
 If a luacheck warning must be ignored, specify the warning code. Example:

test/old/testdir/test_normal.vim

@@ -4284,7 +4284,7 @@ func Test_halfpage_longline()
 endfunc
 
 " Test for Ctrl-E with long line and very narrow window,
-" used to cause an inifite loop
+" used to cause an infinite loop
 func Test_scroll_longline_no_loop()
   4vnew
   setl smoothscroll number showbreak=> scrolloff=2

test/unit/mbyte_spec.lua

@@ -350,7 +350,7 @@ describe('mbyte', function()
 
   describe('utf_fold', function()
     itp('does not crash with surrogates #30527', function()
-      eq(0xDDFB, lib.utf_fold(0xDDFB))
+      eq(0xddfb, lib.utf_fold(0xddfb)) -- low surrogate, invalid as a character
       eq(0xd800, lib.utf_fold(0xd800)) -- high surrogate, invalid as a character
     end)
 

test/unit/termkey_spec.lua

@@ -332,7 +332,7 @@ describe('termkey', function()
     t.eq(termkey.termkey_get_buffer_remaining(tk), 511) -- buffer free 511 after push_bytes
     t.eq(termkey.termkey_get_buffer_size(tk), 512) -- buffer size 512 after push_bytes
 
-    t.eq(termkey.termkey_getkey(tk, key), termkey.TERMKEY_RES_KEY) -- buffered key still useable after resize
+    t.eq(termkey.termkey_getkey(tk, key), termkey.TERMKEY_RES_KEY) -- buffered key still usable after resize
 
     termkey.termkey_destroy(tk)
   end)