diff options
author | dundargoc <33953936+dundargoc@users.noreply.github.com> | 2024-11-09 01:10:56 +0100 |
---|---|---|
committer | GitHub <noreply@github.com> | 2024-11-09 08:10:56 +0800 |
commit | 5a27d02584656f35d757c01f10a1d3c88910c519 (patch) | |
tree | e7c588b6c5c732d9462180f56d25c5df1be894be | |
parent | ad3472e291694b6c589d8a664459b03962eaac95 (diff) | |
download | rneovim-5a27d02584656f35d757c01f10a1d3c88910c519.tar.gz rneovim-5a27d02584656f35d757c01f10a1d3c88910c519.tar.bz2 rneovim-5a27d02584656f35d757c01f10a1d3c88910c519.zip |
docs: misc (#30914)
Co-authored-by: Ernie Rael <errael@raelity.com>
Co-authored-by: Famiu Haque <famiuhaque@proton.me>
Co-authored-by: Jade <spacey-sooty@proton.me>
Co-authored-by: glepnir <glephunter@gmail.com>
Co-authored-by: zeertzjq <zeertzjq@outlook.com>
-rw-r--r-- | BUILD.md | 1 | ||||
-rw-r--r-- | runtime/doc/api.txt | 4 | ||||
-rw-r--r-- | runtime/doc/builtin.txt | 6 | ||||
-rw-r--r-- | runtime/doc/intro.txt | 2 | ||||
-rw-r--r-- | runtime/doc/support.txt | 4 | ||||
-rw-r--r-- | runtime/doc/vvars.txt | 2 | ||||
-rw-r--r-- | runtime/lua/vim/_meta/api.lua | 4 | ||||
-rw-r--r-- | runtime/lua/vim/_meta/vimfn.lua | 6 | ||||
-rw-r--r-- | runtime/lua/vim/_meta/vvars.lua | 2 | ||||
-rw-r--r-- | src/nvim/api/vim.c | 4 | ||||
-rw-r--r-- | src/nvim/eval.lua | 6 | ||||
-rw-r--r-- | src/nvim/option.c | 2 | ||||
-rw-r--r-- | src/nvim/vvars.lua | 2 | ||||
-rw-r--r-- | test/unit/vterm_spec.lua | 20 |
14 files changed, 32 insertions, 33 deletions
@@ -12,6 +12,7 @@ - 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 `sudo make install`, you can try `cd build && cpack -G DEB && sudo dpkg -i nvim-linux64.deb` to build DEB-package and install it. This helps ensure clean removal of installed files. Note: This is an unsupported, "best-effort" feature of the Nvim build. **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`. diff --git a/runtime/doc/api.txt b/runtime/doc/api.txt index c77f38a693..c9b84f5238 100644 --- a/runtime/doc/api.txt +++ b/runtime/doc/api.txt @@ -662,8 +662,8 @@ nvim_echo({chunks}, {history}, {opts}) *nvim_echo()* be omitted for no highlight. • {history} if true, add to |message-history|. • {opts} Optional parameters. - • verbose: Message was printed as a result of 'verbose' - option if Nvim was invoked with -V3log_file, the message + • verbose: Message is printed as a result of 'verbose' + option. If Nvim was invoked with -V3log_file, the message will be redirected to the log_file and suppressed from direct output. diff --git a/runtime/doc/builtin.txt b/runtime/doc/builtin.txt index 19b4256fc5..ada3b7103c 100644 --- a/runtime/doc/builtin.txt +++ b/runtime/doc/builtin.txt @@ -959,7 +959,7 @@ charcol({expr} [, {winid}]) *charcol()* < Parameters: ~ - • {expr} (`string|integer[]`) + • {expr} (`string|any[]`) • {winid} (`integer?`) Return: ~ @@ -1100,7 +1100,7 @@ col({expr} [, {winid}]) *col()* < Parameters: ~ - • {expr} (`string|integer[]`) + • {expr} (`string|any[]`) • {winid} (`integer?`) Return: ~ @@ -11611,7 +11611,7 @@ virtcol({expr} [, {list} [, {winid}]]) *virtcol()* < Parameters: ~ - • {expr} (`string|integer[]`) + • {expr} (`string|any[]`) • {list} (`boolean?`) • {winid} (`integer?`) diff --git a/runtime/doc/intro.txt b/runtime/doc/intro.txt index 41846f8eed..d099c29bdb 100644 --- a/runtime/doc/intro.txt +++ b/runtime/doc/intro.txt @@ -536,7 +536,7 @@ CTRL-O in Insert mode you get a beep but you are still in Insert mode, type Select *5 ^O ^G *6 -- -- -- Insert <Esc> -- -- <Insert> -- -- Replace <Esc> -- -- <Insert> -- -- - Command-line `*3` -- -- :start -- -- + Command-line *3 -- -- :start -- -- Ex :vi -- -- -- -- -- -- not possible diff --git a/runtime/doc/support.txt b/runtime/doc/support.txt index 0ddf037fba..a2776fca0d 100644 --- a/runtime/doc/support.txt +++ b/runtime/doc/support.txt @@ -13,10 +13,10 @@ Supported platforms *supported-platforms* `System` `Tier` `Versions` `Tested versions` Linux 1 >= 2.6.32, glibc >= 2.12 Ubuntu 24.04 -macOS (Intel) 1 >= 11 macOS 12 +macOS (Intel) 1 >= 11 macOS 13 macOS (M1) 1 >= 11 macOS 15 Windows 64-bit 1 >= Windows 10 Version 1809 Windows Server 2022 -FreeBSD 1 >= 10 FreeBSD 13 +FreeBSD 1 >= 10 FreeBSD 14 OpenBSD 2 >= 7 MinGW 2 MinGW-w64 Windows 64-bit 3 < Windows 10 Version 1809 diff --git a/runtime/doc/vvars.txt b/runtime/doc/vvars.txt index 15d836a83d..a68f78d5d3 100644 --- a/runtime/doc/vvars.txt +++ b/runtime/doc/vvars.txt @@ -158,7 +158,7 @@ v:event inclusive Motion is |inclusive|, else exclusive. scope Event-specific scope name. operator Current |operator|. Also set for Ex - commands (unlike |v:operator|). For + commands (unlike |v:operator|). For example if |TextYankPost| is triggered by the |:yank| Ex command then `v:event.operator` is "y". diff --git a/runtime/lua/vim/_meta/api.lua b/runtime/lua/vim/_meta/api.lua index 8236cc7cf0..c28af7bbff 100644 --- a/runtime/lua/vim/_meta/api.lua +++ b/runtime/lua/vim/_meta/api.lua @@ -1110,8 +1110,8 @@ function vim.api.nvim_del_var(name) end --- can be omitted for no highlight. --- @param history boolean if true, add to `message-history`. --- @param opts vim.api.keyset.echo_opts Optional parameters. ---- - verbose: Message was printed as a result of 'verbose' option ---- if Nvim was invoked with -V3log_file, the message will be +--- - verbose: Message is printed as a result of 'verbose' option. +--- If Nvim was invoked with -V3log_file, the message will be --- redirected to the log_file and suppressed from direct output. function vim.api.nvim_echo(chunks, history, opts) end diff --git a/runtime/lua/vim/_meta/vimfn.lua b/runtime/lua/vim/_meta/vimfn.lua index 7548d1beb2..5eb15e1eee 100644 --- a/runtime/lua/vim/_meta/vimfn.lua +++ b/runtime/lua/vim/_meta/vimfn.lua @@ -828,7 +828,7 @@ function vim.fn.charclass(string) end --- echo col('.') " returns 7 --- < --- ---- @param expr string|integer[] +--- @param expr string|any[] --- @param winid? integer --- @return integer function vim.fn.charcol(expr, winid) end @@ -956,7 +956,7 @@ function vim.fn.clearmatches(win) end --- imap <F2> <Cmd>echo col(".").."\n"<CR> --- < --- ---- @param expr string|integer[] +--- @param expr string|any[] --- @param winid? integer --- @return integer function vim.fn.col(expr, winid) end @@ -10546,7 +10546,7 @@ function vim.fn.values(dict) end --- echo max(map(range(1, line('$')), "virtcol([v:val, '$'])")) --- < --- ---- @param expr string|integer[] +--- @param expr string|any[] --- @param list? boolean --- @param winid? integer --- @return any diff --git a/runtime/lua/vim/_meta/vvars.lua b/runtime/lua/vim/_meta/vvars.lua index e00402ab3f..733aa965a2 100644 --- a/runtime/lua/vim/_meta/vvars.lua +++ b/runtime/lua/vim/_meta/vvars.lua @@ -166,7 +166,7 @@ vim.v.errors = ... --- inclusive Motion is `inclusive`, else exclusive. --- scope Event-specific scope name. --- operator Current `operator`. Also set for Ex ---- commands (unlike `v:operator`). For +--- commands (unlike `v:operator`). For --- example if `TextYankPost` is triggered --- by the `:yank` Ex command then --- `v:event.operator` is "y". diff --git a/src/nvim/api/vim.c b/src/nvim/api/vim.c index 943c67ac8e..97cda49a22 100644 --- a/src/nvim/api/vim.c +++ b/src/nvim/api/vim.c @@ -781,8 +781,8 @@ void nvim_set_vvar(String name, Object value, Error *err) /// can be omitted for no highlight. /// @param history if true, add to |message-history|. /// @param opts Optional parameters. -/// - verbose: Message was printed as a result of 'verbose' option -/// if Nvim was invoked with -V3log_file, the message will be +/// - verbose: Message is printed as a result of 'verbose' option. +/// If Nvim was invoked with -V3log_file, the message will be /// redirected to the log_file and suppressed from direct output. void nvim_echo(Array chunks, Boolean history, Dict(echo_opts) *opts, Error *err) FUNC_API_SINCE(7) diff --git a/src/nvim/eval.lua b/src/nvim/eval.lua index 601c07cfab..a418b34909 100644 --- a/src/nvim/eval.lua +++ b/src/nvim/eval.lua @@ -1137,7 +1137,7 @@ M.funcs = { ]=], name = 'charcol', - params = { { 'expr', 'string|integer[]' }, { 'winid', 'integer' } }, + params = { { 'expr', 'string|any[]' }, { 'winid', 'integer' } }, returns = 'integer', signature = 'charcol({expr} [, {winid}])', }, @@ -1296,7 +1296,7 @@ M.funcs = { ]=], name = 'col', - params = { { 'expr', 'string|integer[]' }, { 'winid', 'integer' } }, + params = { { 'expr', 'string|any[]' }, { 'winid', 'integer' } }, returns = 'integer', signature = 'col({expr} [, {winid}])', }, @@ -12684,7 +12684,7 @@ M.funcs = { ]=], name = 'virtcol', - params = { { 'expr', 'string|integer[]' }, { 'list', 'boolean' }, { 'winid', 'integer' } }, + params = { { 'expr', 'string|any[]' }, { 'list', 'boolean' }, { 'winid', 'integer' } }, signature = 'virtcol({expr} [, {list} [, {winid}]])', }, virtcol2col = { diff --git a/src/nvim/option.c b/src/nvim/option.c index 0396f7740e..c7aaf7975d 100644 --- a/src/nvim/option.c +++ b/src/nvim/option.c @@ -3282,8 +3282,6 @@ static char *option_get_valid_types(OptIndex opt_idx) // Ensure that the string is NUL-terminated. kv_push(str, NUL); return str.items; - -#undef OPTION_ADD_TYPE } /// Check if option is hidden. diff --git a/src/nvim/vvars.lua b/src/nvim/vvars.lua index ad139bbbfe..4936f62e3e 100644 --- a/src/nvim/vvars.lua +++ b/src/nvim/vvars.lua @@ -177,7 +177,7 @@ M.vars = { inclusive Motion is |inclusive|, else exclusive. scope Event-specific scope name. operator Current |operator|. Also set for Ex - commands (unlike |v:operator|). For + commands (unlike |v:operator|). For example if |TextYankPost| is triggered by the |:yank| Ex command then `v:event.operator` is "y". diff --git a/test/unit/vterm_spec.lua b/test/unit/vterm_spec.lua index f0cf450e6c..4ea5d9c29a 100644 --- a/test/unit/vterm_spec.lua +++ b/test/unit/vterm_spec.lua @@ -2705,7 +2705,7 @@ describe('vterm', function() pen('font', 0, state) -- TODO(dundargoc): fix - -- -- Foreground + -- Foreground -- push "\x1b[31m" -- ?pen foreground = idx(1) -- push "\x1b[32m" @@ -2721,7 +2721,7 @@ describe('vterm', function() -- push "\x1b[39m" -- ?pen foreground = rgb(240,240,240,is_default_fg) -- - -- -- Background + -- Background -- push "\x1b[41m" -- ?pen background = idx(1) -- push "\x1b[42m" @@ -2737,7 +2737,7 @@ describe('vterm', function() -- push "\x1b[49m" -- ?pen background = rgb(0,0,0,is_default_bg) -- - -- -- Bold+ANSI colour == highbright + -- Bold+ANSI colour == highbright -- push "\x1b[m\x1b[1;37m" -- ?pen bold = on -- ?pen foreground = idx(15) @@ -2745,7 +2745,7 @@ describe('vterm', function() -- ?pen bold = on -- ?pen foreground = idx(15) -- - -- -- Super/Subscript + -- Super/Subscript -- push "\x1b[73m" -- ?pen small = on -- ?pen baseline = raise @@ -2756,7 +2756,7 @@ describe('vterm', function() -- ?pen small = off -- ?pen baseline = normal -- - -- -- DECSTR resets pen attributes + -- DECSTR resets pen attributes -- push "\x1b[1;4m" -- ?pen bold = on -- ?pen underline = 1 @@ -2896,25 +2896,25 @@ describe('vterm', function() expect('selection-query mask=0001') -- TODO(dundargoc): fix - -- -- Send clipboard; final chunk len 4 + -- Send clipboard; final chunk len 4 -- SELECTION 1 ["Hello,"] -- output "\x1b]52;c;" -- output "SGVsbG8s" -- output "\x1b\\" -- - -- -- Send clipboard; final chunk len 3 + -- Send clipboard; final chunk len 3 -- SELECTION 1 ["Hello, w"] -- output "\x1b]52;c;" -- output "SGVsbG8s" -- output "IHc=\x1b\\" -- - -- -- Send clipboard; final chunk len 2 + -- Send clipboard; final chunk len 2 -- SELECTION 1 ["Hello, world\n"] -- output "\x1b]52;c;" -- output "SGVsbG8sIHdvcmxk" -- output "Cg==\x1b\\" -- - -- -- Send clipboard; split between chunks + -- Send clipboard; split between chunks -- SELECTION 1 ["Hel" -- output "\x1b]52;c;" -- output "SGVs" @@ -2922,7 +2922,7 @@ describe('vterm', function() -- output "bG8s" -- output "\x1b\\" -- - -- -- Send clipboard; split within chunk + -- Send clipboard; split within chunk -- SELECTION 1 ["Hello" -- output "\x1b]52;c;" -- output "SGVs" |