aboutsummaryrefslogtreecommitdiff
path: root/runtime/doc
diff options
context:
space:
mode:
Diffstat (limited to 'runtime/doc')
-rw-r--r--runtime/doc/api.txt2
-rw-r--r--runtime/doc/change.txt17
-rw-r--r--runtime/doc/cmdline.txt3
-rw-r--r--runtime/doc/eval.txt3
-rw-r--r--runtime/doc/index.txt13
-rw-r--r--runtime/doc/lsp.txt15
-rw-r--r--runtime/doc/map.txt2
-rw-r--r--runtime/doc/options.txt12
-rw-r--r--runtime/doc/quickfix.txt5
-rw-r--r--runtime/doc/starting.txt8
-rw-r--r--runtime/doc/tips.txt2
-rw-r--r--runtime/doc/ui.txt14
-rw-r--r--runtime/doc/usr_41.txt13
-rw-r--r--runtime/doc/various.txt3
-rw-r--r--runtime/doc/vim_diff.txt3
15 files changed, 53 insertions, 62 deletions
diff --git a/runtime/doc/api.txt b/runtime/doc/api.txt
index 919417f3a0..07c45c9298 100644
--- a/runtime/doc/api.txt
+++ b/runtime/doc/api.txt
@@ -422,7 +422,7 @@ Buffer text can be highlighted by typical mechanisms (syntax highlighting,
options from the current window; specify `style=minimal` in |nvim_open_win()|
to disable various visual features such as the 'number' column.
-Currently, floating windows don't support widgets like border or scrollbar.
+Currently, floating windows don't support some widgets like scrollbar.
Example: create a float with scratch buffer: >
diff --git a/runtime/doc/change.txt b/runtime/doc/change.txt
index 49c6d06fbf..7a63a89986 100644
--- a/runtime/doc/change.txt
+++ b/runtime/doc/change.txt
@@ -913,22 +913,7 @@ This replaces an end-of-line with a new line containing the value of $HOME. >
This replaces each 'E' character with a euro sign. Read more in |<Char->|.
-4.3 Search and replace *search-replace*
-
- *:pro* *:promptfind*
-:promptf[ind] [string]
- Put up a Search dialog. When [string] is given, it is
- used as the initial search string.
- {only for Win32 GUI}
-
- *:promptr* *:promptrepl*
-:promptr[epl] [string]
- Put up a Search/Replace dialog. When [string] is
- given, it is used as the initial search string.
- {only for Win32 GUI}
-
-
-4.4 Changing tabs *change-tabs*
+4.3 Changing tabs *change-tabs*
*:ret* *:retab* *:retab!*
:[range]ret[ab][!] [new_tabstop]
Replace all sequences of white-space containing a
diff --git a/runtime/doc/cmdline.txt b/runtime/doc/cmdline.txt
index dcdc2384dc..2db694cf07 100644
--- a/runtime/doc/cmdline.txt
+++ b/runtime/doc/cmdline.txt
@@ -532,7 +532,6 @@ that see the '"' as part of their argument:
:normal
:ownsyntax
:popup
- :promptfind (and the like)
:registers
:return
:sort
@@ -571,8 +570,6 @@ followed by another Vim command:
:make
:normal
:perlfile
- :promptfind
- :promptrepl
:pyfile
:python
:registers
diff --git a/runtime/doc/eval.txt b/runtime/doc/eval.txt
index 9f44c016f0..bf7f2b21de 100644
--- a/runtime/doc/eval.txt
+++ b/runtime/doc/eval.txt
@@ -7879,7 +7879,8 @@ setqflist({list} [, {action}[, {what}]]) *setqflist()*
the last quickfix list.
quickfixtextfunc
function to get the text to display in the
- quickfix window. Refer to
+ quickfix window. The value can be the name of
+ 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.
title quickfix list title text. See |quickfix-title|
diff --git a/runtime/doc/index.txt b/runtime/doc/index.txt
index c54b588e6b..2aafc075a6 100644
--- a/runtime/doc/index.txt
+++ b/runtime/doc/index.txt
@@ -1201,6 +1201,7 @@ tag command action ~
|:cgetfile| :cg[etfile] read file with error messages
|:changes| :changes print the change list
|:chdir| :chd[ir] change directory
+|:checkhealth| :checkh[ealth] run healthchecks
|:checkpath| :che[ckpath] list included files
|:checktime| :checkt[ime] check timestamp of loaded buffers
|:chistory| :chi[story] list the error lists
@@ -1278,6 +1279,7 @@ tag command action ~
|:endtry| :endt[ry] end previous :try
|:endwhile| :endw[hile] end previous :while
|:enew| :ene[w] edit a new, unnamed buffer
+|:eval| :ev[al] evaluate an expression and discard the result
|:ex| :ex same as ":edit"
|:execute| :exe[cute] execute result of expressions
|:exit| :exi[t] same as ":xit"
@@ -1451,14 +1453,12 @@ tag command action ~
|:packloadall| :packl[oadall] load all packages under 'packpath'
|:pclose| :pc[lose] close preview window
|:pedit| :ped[it] edit file in the preview window
-|:perl| :perl execute perl command
-|:perldo| :perldo execute perl command for each line
-|:perfile| :perlfile execute perl script file
+|:perl| :pe[rl] execute perl command
+|:perldo| :perld[o] execute perl command for each line
+|:perlfile| :perlf[ile] execute perl script file
|:print| :p[rint] print lines
|:profdel| :profd[el] stop profiling a function or script
|:profile| :prof[ile] profiling functions and scripts
-|:promptfind| :pro[mptfind] open GUI dialog for searching
-|:promptrepl| :promptr[epl] open GUI dialog for search/replace
|:pop| :po[p] jump to older entry in tag stack
|:popup| :popu[p] popup a menu by name
|:ppop| :pp[op] ":pop" in preview window
@@ -1537,7 +1537,6 @@ tag command action ~
buffer list
|:scriptnames| :scr[iptnames] list names of all sourced Vim scripts
|:scriptencoding| :scripte[ncoding] encoding used in sourced Vim script
-|:scriptversion| :scriptv[ersion] version of Vim script used
|:scscope| :scs[cope] split window and execute cscope command
|:set| :se[t] show or set options
|:setfiletype| :setf[iletype] set 'filetype', unless it was set already
@@ -1549,8 +1548,6 @@ tag command action ~
|:sign| :sig[n] manipulate signs
|:silent| :sil[ent] run a command silently
|:sleep| :sl[eep] do nothing for a few seconds
-|:sleep!| :sl[eep]! do nothing for a few seconds, without the
- cursor visible
|:slast| :sla[st] split window and go to last file in the
argument list
|:smagic| :sm[agic] :substitute with 'magic'
diff --git a/runtime/doc/lsp.txt b/runtime/doc/lsp.txt
index aa95245bd0..d6ef761bcb 100644
--- a/runtime/doc/lsp.txt
+++ b/runtime/doc/lsp.txt
@@ -135,12 +135,6 @@ FAQ *lsp-faq*
autocmd BufWritePre *.rs lua vim.lsp.buf.formatting_sync(nil, 1000)
<
- *vim.lsp.callbacks*
-- Q: What happened to `vim.lsp.callbacks`?
- A: After better defining the interface of |lsp-handler|s, we thought it best
- to remove the generic usage of `callbacks` and transform to `handlers`.
- Due to this, `vim.lsp.callbacks` was renamed to |vim.lsp.handlers|.
-
*lsp-vs-treesitter*
- Q: How do LSP and Treesitter compare?
A: LSP requires a client and language server. The language server uses
@@ -525,6 +519,15 @@ LspDiagnosticsSignHint
Used for "Hint" signs in sign column.
See |vim.lsp.diagnostic.set_signs()|
+ *lsp-highlight-codelens*
+
+Highlight groups related to |lsp-codelens| functionality.
+
+ *hl-LspCodeLens*
+LspCodeLens
+ Used to color the virtual text of the codelens. See
+ |nvim_buf_set_virtual_text()|.
+
==============================================================================
AUTOCOMMANDS *lsp-autocommands*
diff --git a/runtime/doc/map.txt b/runtime/doc/map.txt
index 77cbf7d9b7..10d503e180 100644
--- a/runtime/doc/map.txt
+++ b/runtime/doc/map.txt
@@ -855,7 +855,7 @@ Here is an example that counts the number of spaces with <F4>: >
set clipboard= selection=inclusive
let commands = #{line: "'[V']y", char: "`[v`]y", block: "`[\<c-v>`]y"}
silent exe 'noautocmd keepjumps normal! ' .. get(commands, a:type, '')
- echom getreg('"')->count(' ')
+ echom count(getreg('"'), ' ')
finally
call setreg('"', reg_save)
call setpos("'<", visual_marks_save[0])
diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt
index cc9696e536..791fb8664e 100644
--- a/runtime/doc/options.txt
+++ b/runtime/doc/options.txt
@@ -4607,7 +4607,8 @@ A jump table for the options with a short description can be found at |Q_op|.
customize the information displayed in the quickfix or location window
for each entry in the corresponding quickfix or location list. See
|quickfix-window-function| for an explanation of how to write the
- function and an example.
+ function and an example. The value can be the name of a function or a
+ lambda.
This option cannot be set from a |modeline| or in the |sandbox|, for
security reasons.
@@ -5237,11 +5238,12 @@ A jump table for the options with a short description can be found at |Q_op|.
Note that such processing is done after |:set| did its own round of
unescaping, so to keep yourself sane use |:let-&| like shown above.
*shell-powershell*
- To use powershell: >
+ To use PowerShell: >
let &shell = has('win32') ? 'powershell' : 'pwsh'
- set shellquote= shellpipe=\| shellxquote=
- set shellcmdflag=-NoLogo\ -NoProfile\ -ExecutionPolicy\ RemoteSigned\ -Command
- set shellredir=\|\ Out-File\ -Encoding\ UTF8
+ let &shellcmdflag = '-NoLogo -NoProfile -ExecutionPolicy RemoteSigned -Command [Console]::InputEncoding=[Console]::OutputEncoding=[System.Text.Encoding]::UTF8;'
+ let &shellredir = '2>&1 | Out-File -Encoding UTF8 %s; exit $LastExitCode'
+ let &shellpipe = '2>&1 | Out-File -Encoding UTF8 %s; exit $LastExitCode'
+ set shellquote= shellxquote=
< This option cannot be set from a |modeline| or in the |sandbox|, for
security reasons.
diff --git a/runtime/doc/quickfix.txt b/runtime/doc/quickfix.txt
index ebc7e2a1b4..563fb0c962 100644
--- a/runtime/doc/quickfix.txt
+++ b/runtime/doc/quickfix.txt
@@ -1919,7 +1919,10 @@ The function should return a single line of text to display in the quickfix
window for each entry from start_idx to end_idx. The function can obtain
information about the entries using the |getqflist()| function and specifying
the quickfix list identifier "id". For a location list, getloclist() function
-can be used with the 'winid' argument.
+can be used with the 'winid' argument. If an empty list is returned, then the
+default format is used to display all the entries. If an item in the returned
+list is an empty string, then the default format is used to display the
+corresponding entry.
If a quickfix or location list specific customization is needed, then the
'quickfixtextfunc' attribute of the list can be set using the |setqflist()| or
diff --git a/runtime/doc/starting.txt b/runtime/doc/starting.txt
index 2110b88330..5431ce3bd8 100644
--- a/runtime/doc/starting.txt
+++ b/runtime/doc/starting.txt
@@ -416,11 +416,11 @@ accordingly. Vim proceeds in this order:
the same time. Each line in a "init.vim" is executed as an Ex command
line. See also |vimrc-intro| and |base-directories|.
- The Nvim config file is "init.vim", located at:
- Unix ~/.config/nvim/init.vim
- Windows ~/AppData/Local/nvim/init.vim
+ The config file is located at:
+ Unix ~/.config/nvim/init.vim (or init.lua)
+ Windows ~/AppData/Local/nvim/init.vim (or init.lua)
or if |$XDG_CONFIG_HOME| is defined:
- $XDG_CONFIG_HOME/nvim/init.vim
+ $XDG_CONFIG_HOME/nvim/init.vim (or init.lua)
If Nvim was started with "-u {file}" then {file} is used as the config
and all initializations until 5. are skipped. $MYVIMRC is not set.
diff --git a/runtime/doc/tips.txt b/runtime/doc/tips.txt
index bcb2e48cbf..27b6ca2885 100644
--- a/runtime/doc/tips.txt
+++ b/runtime/doc/tips.txt
@@ -462,7 +462,7 @@ the current window, try this custom `:HelpCurwin` command:
execute mods .. ' helpclose'
let s:did_open_help = v:true
endif
- if !getcompletion(a:subject, 'help')->empty()
+ if !empty(getcompletion(a:subject, 'help'))
execute mods .. ' edit ' .. &helpfile
endif
return 'help ' .. a:subject
diff --git a/runtime/doc/ui.txt b/runtime/doc/ui.txt
index 82406898c8..e7be14e732 100644
--- a/runtime/doc/ui.txt
+++ b/runtime/doc/ui.txt
@@ -219,8 +219,8 @@ the editor.
["busy_start"]
["busy_stop"]
- Nvim started or stopped being busy, and possibly not responsive to
- user input. This could be indicated to the user by hiding the cursor.
+ Indicates to the UI that it must stop rendering the cursor. This event
+ is misnamed and does not actually have anything to do with busyness.
["suspend"]
|:suspend| command or |CTRL-Z| mapping is used. A terminal client (or
@@ -631,11 +631,13 @@ Tabline Events *ui-tabline*
Activated by the `ext_tabline` |ui-option|.
-["tabline_update", curtab, tabs]
+["tabline_update", curtab, tabs, curbuf, buffers]
Tabline was updated. UIs should present this data in a custom tabline
- widget.
- curtab: Current Tabpage
- tabs: List of Dicts [{ "tab": Tabpage, "name": String }, ...]
+ widget. Note: options `curbuf` + `buffers` were added in API7.
+ curtab: Current Tabpage
+ tabs: List of Dicts [{ "tab": Tabpage, "name": String }, ...]
+ curbuf: Current buffer handle.
+ buffers: List of Dicts [{ "buffer": buffer handle, "name": String}, ...]
==============================================================================
Cmdline Events *ui-cmdline*
diff --git a/runtime/doc/usr_41.txt b/runtime/doc/usr_41.txt
index f92cb3c509..a190bf2f27 100644
--- a/runtime/doc/usr_41.txt
+++ b/runtime/doc/usr_41.txt
@@ -99,8 +99,6 @@ and the value of the variable i. Since i is one, this will print:
Then there is the ":let i += 1" command. This does the same thing as
":let i = i + 1". This adds one to the variable i and assigns the new value
to the same variable.
-Note: this is how it works in legacy Vim script, which is what we discuss in
-this file.
The example was given to explain the commands, but would you really want to
make such a loop, it can be written much more compact: >
@@ -120,24 +118,23 @@ Numbers can be decimal, hexadecimal, octal or binary.
A hexadecimal number starts with "0x" or "0X". For example "0x1f" is decimal
31.
-An octal number starts with "0o", "0O" or a zero and another digit. "0o17" is
-decimal 15. Using just a zero prefix is not supported in Vim9 script.
+An octal number starts with a zero and another digit. "017" is decimal 15.
A binary number starts with "0b" or "0B". For example "0b101" is decimal 5.
A decimal number is just digits. Careful: don't put a zero before a decimal
-number, it will be interpreted as an octal number in legacy script!
+number, it will be interpreted as an octal number!
The ":echo" command always prints decimal numbers. Example: >
- :echo 0x7f 0o36
+ :echo 0x7f 036
< 127 30 ~
A number is made negative with a minus sign. This also works for hexadecimal,
octal and binary numbers. A minus sign is also used for subtraction. Compare
this with the previous example: >
- :echo 0x7f -0o36
+ :echo 0x7f -036
< 97 ~
White space in an expression is ignored. However, it's recommended to use it
@@ -145,7 +142,7 @@ for separating items, to make the expression easier to read. For example, to
avoid the confusion with a negative number above, put a space between the
minus sign and the following number: >
- :echo 0x7f - 0o36
+ :echo 0x7f - 036
==============================================================================
*41.2* Variables
diff --git a/runtime/doc/various.txt b/runtime/doc/various.txt
index d5c07d9622..ec91b6e29a 100644
--- a/runtime/doc/various.txt
+++ b/runtime/doc/various.txt
@@ -506,7 +506,8 @@ gO Show a filetype-specific, navigable "outline" of the
Queued messages are processed during the sleep.
*:sl!* *:sleep!*
-:[N]sl[eep]! [N] [m] Same as above, but hide the cursor.
+:[N]sl[eep]! [N] [m] Same as above. Unlike Vim, it does not hide the
+ cursor. |vim-differences|
==============================================================================
2. Using Vim like less or more *less*
diff --git a/runtime/doc/vim_diff.txt b/runtime/doc/vim_diff.txt
index bb30495d77..27c4b82aca 100644
--- a/runtime/doc/vim_diff.txt
+++ b/runtime/doc/vim_diff.txt
@@ -421,7 +421,10 @@ Commands:
:mode (no longer accepts an argument)
:open
:Print
+ :promptfind
+ :promptrepl
:shell
+ :sleep! (does not hide the cursor; same as :sleep)
:smile
:tearoff