commit 3fc72f4ef15a8a5f5c452548b73e094382631427
parent b7a670a6d2aa23e206941b475c0a463cbc64db0b
Author: Justin M. Keyes <justinkz@gmail.com>
Date: Sun, 23 Nov 2025 12:45:31 -0500
docs: misc
Close #36441
Close #36631
Close #36656
Co-authored-by: Maria José Solano <majosolano99@gmail.com>
Co-authored-by: glepnir <glephunter@gmail.com>
Co-authored-by: "Mike J. McGuirk" <mike.j.mcguirk@gmail.com>
Diffstat:
10 files changed, 32 insertions(+), 10 deletions(-)
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -21,8 +21,8 @@ env:
INSTALL_PREFIX: ${{ github.workspace }}/nvim-install
jobs:
+ # Test the minimum supported cmake.
old-cmake:
- name: Minimum cmake
runs-on: ubuntu-latest
timeout-minutes: 15
env:
@@ -54,8 +54,8 @@ jobs:
- name: Install
run: make install
+ # Offline build (USE_EXISTING_SRC_DIR=ON with no network access)
use-existing-src:
- name: Offline build (USE_EXISTING_SRC_DIR=ON with no network access)
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6
diff --git a/.github/workflows/build_dummy.yml b/.github/workflows/build_dummy.yml
@@ -19,15 +19,15 @@ concurrency:
cancel-in-progress: ${{ github.event_name == 'pull_request' }}
jobs:
+ # Test the minimum supported cmake.
old-cmake:
- name: Test oldest supported cmake
runs-on: ubuntu-latest
timeout-minutes: 15
steps:
- run: echo "success"
+ # Offline build (USE_EXISTING_SRC_DIR=ON with no network access)
use-existing-src:
- name: Test USE_EXISTING_SRC_DIR=ON builds with no network access
runs-on: ubuntu-latest
steps:
- run: echo "success"
diff --git a/BUILD.md b/BUILD.md
@@ -459,6 +459,13 @@ Similarly to develop on Neovim: `nix run github:nix-community/neovim-nightly-ove
To use a specific version of Neovim, you can pass `--override-input neovim-src .` to use your current directory,
or a specific SHA1 like `--override-input neovim-src github:neovim/neovim/89dc8f8f4e754e70cbe1624f030fb61bded41bc2`.
+### Haiku
+
+Some deps can be pulled from haiku repos, the rest need "bundled" deps:
+
+ cmake -DUSE_BUNDLED_LIBUV=OFF -DUSE_BUNDLED_UNIBILIUM=OFF -DUSE_BUNDLED_LUAJIT=OFF -B .deps ./cmake.deps
+ make -C .deps
+
### FreeBSD
```
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -55,6 +55,7 @@ Developer guidelines
Pull requests (PRs)
---------------------
+- Fork the repository first.
- To avoid duplicate work, create a draft pull request.
- Your PR must include [test coverage][run-tests].
- Avoid cosmetic changes to unrelated files in the same commit.
diff --git a/runtime/doc/plugins.txt b/runtime/doc/plugins.txt
@@ -255,6 +255,8 @@ open({opts}) *undotree.open()*
While in the window, moving the cursor changes the undo.
+ Closes the window if it is already open
+
Load the plugin with this command: >
packadd nvim.undotree
<
@@ -275,5 +277,9 @@ open({opts}) *undotree.open()*
the source buffer as its only argument and should return a
string.
+ Return: ~
+ (`boolean?`) Returns true if the window was already open, nil
+ otherwise
+
vim:tw=78:ts=8:sw=4:sts=4:et:ft=help:norl:
diff --git a/runtime/doc/vimfn.txt b/runtime/doc/vimfn.txt
@@ -9134,9 +9134,9 @@ setloclist({nr}, {list} [, {action} [, {what}]]) *setloclist()*
Parameters: ~
• {nr} (`integer`)
- • {list} (`any`)
+ • {list} (`vim.quickfix.entry[]`)
• {action} (`string?`)
- • {what} (`table?`)
+ • {what} (`vim.fn.setqflist.what?`)
Return: ~
(`any`)
diff --git a/runtime/lua/vim/_meta/builtin_types.lua b/runtime/lua/vim/_meta/builtin_types.lua
@@ -160,7 +160,7 @@
--- a function or a funcref or a lambda. Refer
--- to |quickfix-window-function| for an explanation
--- of how to write the function and an example.
---- @field quickfixtextfunc? function
+--- @field quickfixtextfunc? string|function
---
--- quickfix list title text. See |quickfix-title|
--- @field title? string
diff --git a/runtime/lua/vim/_meta/vimfn.lua b/runtime/lua/vim/_meta/vimfn.lua
@@ -8320,9 +8320,9 @@ function vim.fn.setline(lnum, text) end
--- for the list of supported keys in {what}.
---
--- @param nr integer
---- @param list any
+--- @param list vim.quickfix.entry[]
--- @param action? string
---- @param what? table
+--- @param what? vim.fn.setqflist.what
--- @return any
function vim.fn.setloclist(nr, list, action, what) end
diff --git a/runtime/pack/dist/opt/nvim.undotree/lua/undotree.lua b/runtime/pack/dist/opt/nvim.undotree/lua/undotree.lua
@@ -298,6 +298,8 @@ end
---
--- While in the window, moving the cursor changes the undo.
---
+--- Closes the window if it is already open
+---
--- Load the plugin with this command:
--- ```
--- packadd nvim.undotree
@@ -306,6 +308,7 @@ end
--- Can also be shown with `:Undotree`. [:Undotree]()
---
--- @param opts vim.undotree.opts?
+--- @return boolean? Returns true if the window was already open, nil otherwise
function M.open(opts)
-- The following lines of code was copied from
-- `vim.treesitter.dev.inspect_tree` and then modified to fit
diff --git a/src/nvim/eval.lua b/src/nvim/eval.lua
@@ -10091,7 +10091,12 @@ M.funcs = {
]=],
name = 'setloclist',
- params = { { 'nr', 'integer' }, { 'list', 'any' }, { 'action', 'string' }, { 'what', 'table' } },
+ params = {
+ { 'nr', 'integer' },
+ { 'list', 'vim.quickfix.entry[]' },
+ { 'action', 'string' },
+ { 'what', 'vim.fn.setqflist.what' },
+ },
signature = 'setloclist({nr}, {list} [, {action} [, {what}]])',
},
setmatches = {
