mirrors/neovim
1
0
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2025-12-05 14:13:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge #9335 from justinmk/doc

Browse Source
This commit is contained in:
Justin M. Keyes
2018-12-30 21:17:18 +01:00
committed by GitHub
parent fa5182489a a10fdc70aa
commit 1e8d2bdc48
14 changed files with 91 additions and 90 deletions
Download Patch File Download Diff File Expand all files Collapse all files

49
README.md
View File

@@ -44,6 +44,15 @@ Features
See [`:help nvim-features`][nvim-features] for the full list! See [`:help nvim-features`][nvim-features] for the full list!
Install from package
--------------------
Pre-built packages for Windows, macOS, and Linux are found on the
[Releases](https://github.com/neovim/neovim/releases/) page.
Managed packages are in [Homebrew], [Debian], [Ubuntu], [Fedora], [Arch Linux], [Gentoo],
and [more](https://github.com/neovim/neovim/wiki/Installing-Neovim)!
Install from source Install from source
------------------- -------------------
@@ -55,26 +64,36 @@ To install to a non-default location, set `CMAKE_INSTALL_PREFIX`:
make CMAKE_EXTRA_FLAGS="-DCMAKE_INSTALL_PREFIX=/full/path/" make CMAKE_EXTRA_FLAGS="-DCMAKE_INSTALL_PREFIX=/full/path/"
make install make install
To list all targets: To skip bundled (`third-party/*`) dependencies:
1. Install the dependencies using a package manager.
```
sudo apt install gperf luajit luarocks libuv1-dev libluajit-5.1-dev libunibilium-dev libmsgpack-dev libtermkey-dev libvterm-dev libjemalloc-dev
sudo luarocks build mpack
sudo luarocks build lpeg
sudo luarocks build inspect
```
2. Build with `USE_BUNDLED=OFF`:
```
make CMAKE_BUILD_TYPE=RelWithDebInfo USE_BUNDLED=OFF
sudo make install
```
CMake features:
- List all build targets:
```
cmake --build build --target help cmake --build build --target help
```
To skip "bundled" dependencies (`third-party/*`) define `USE_BUNDLED=NO`: - Print all variable definitions:
```
sudo apt install gperf libluajit-5.1-dev libunibilium-dev libmsgpack-dev libtermkey-dev libvterm-dev libjemalloc-dev cmake -LAH
make USE_BUNDLED=NO ```
- `build/CMakeCache.txt` contains the resolved values of all CMake variables.
- `build/compile_commands.json` shows the full compiler invocations for each translation unit.
See the [Building Neovim](https://github.com/neovim/neovim/wiki/Building-Neovim) wiki page for details. See the [Building Neovim](https://github.com/neovim/neovim/wiki/Building-Neovim) wiki page for details.
Install from package
--------------------
Pre-built packages for Windows, macOS, and Linux are found on the
[Releases](https://github.com/neovim/neovim/releases/) page.
Managed packages are in [Homebrew], [Debian], [Ubuntu], [Fedora], [Arch Linux], [Gentoo],
and [more](https://github.com/neovim/neovim/wiki/Installing-Neovim)!
Transitioning from Vim Transitioning from Vim
-------------------- --------------------

21
runtime/doc/api.txt
View File

@@ -546,25 +546,24 @@ nvim_set_current_tabpage({tabpage}) *nvim_set_current_tabpage()*
{tabpage} Tabpage handle {tabpage} Tabpage handle
nvim_create_namespace({name}) *nvim_create_namespace()* nvim_create_namespace({name}) *nvim_create_namespace()*
create a new namespace, or get one with an exisiting name Creates a new namespace, or gets an existing one
Namespaces are currently used for buffer highlighting and Namespaces are used for buffer highlights and virtual text,
virtual text, see |nvim_buf_add_highlight| and see |nvim_buf_add_highlight()| and
|nvim_buf_set_virtual_text|. |nvim_buf_set_virtual_text()|.
Namespaces can have a name of be anonymous. If `name` is a Namespaces can be named or anonymous. If `name` matches an
non-empty string, and a namespace already exists with that existing namespace, the associated id is returned. If `name`
name,the existing namespace id is returned. If an empty string is an empty string a new, anonymous namespace is created.
is used, a new anonymous namespace is returned.
Parameters: ~ Parameters: ~
{name} Name of the namespace or empty string {name} Namespace name or empty string
Return: ~ Return: ~
the namespace id Namespace id
nvim_get_namespaces() *nvim_get_namespaces()* nvim_get_namespaces() *nvim_get_namespaces()*
Get existing named namespaces Gets existing, non-anonymous namespaces
Return: ~ Return: ~
dict that maps from names to namespace ids. dict that maps from names to namespace ids.

7
runtime/doc/develop.txt
View File

@@ -137,6 +137,13 @@ DOCUMENTATION *dev-doc*
"the user host terminal". "the user host terminal".
- Use "tui-" to prefix help tags related to the host terminal, and "TUI" - Use "tui-" to prefix help tags related to the host terminal, and "TUI"
in prose if possible. in prose if possible.
- Docstrings: do not start parameter descriptions with "The" or "A" unless it
is critical to avoid ambiguity.
GOOD: >
/// @param dirname Path fragment before `pend`
< BAD: >
/// @param dirname The path fragment before `pend`
<
API *dev-api* API *dev-api*

27
runtime/doc/eval.txt
View File

@@ -1886,8 +1886,6 @@ v:termresponse The escape sequence returned by the terminal for the DA
*v:testing* *testing-variable* *v:testing* *testing-variable*
v:testing Must be set before using `test_garbagecollect_now()`. v:testing Must be set before using `test_garbagecollect_now()`.
Also, when set certain error messages won't be shown for 2
seconds. (e.g. "'dictionary' option is empty")
*v:this_session* *this_session-variable* *v:this_session* *this_session-variable*
v:this_session Full filename of the last loaded or saved session file. See v:this_session Full filename of the last loaded or saved session file. See
@@ -2781,7 +2779,7 @@ changenr() *changenr()*
redo it is the number of the redone change. After undo it is redo it is the number of the redone change. After undo it is
one less than the number of the undone change. one less than the number of the undone change.
chanclose({id}[, {stream}]) {Nvim} *chanclose()* chanclose({id}[, {stream}]) *chanclose()*
Close a channel or a specific stream associated with it. Close a channel or a specific stream associated with it.
For a job, {stream} can be one of "stdin", "stdout", For a job, {stream} can be one of "stdin", "stdout",
"stderr" or "rpc" (closes stdin/stdout for a job started "stderr" or "rpc" (closes stdin/stdout for a job started
@@ -2791,7 +2789,7 @@ chanclose({id}[, {stream}]) {Nvim} *chanclose()*
For a socket, there is only one stream, and {stream} should be For a socket, there is only one stream, and {stream} should be
ommited. ommited.
chansend({id}, {data}) {Nvim} *chansend()* chansend({id}, {data}) *chansend()*
Send data to channel {id}. For a job, it writes it to the Send data to channel {id}. For a job, it writes it to the
stdin of the process. For the stdio channel |channel-stdio|, stdin of the process. For the stdio channel |channel-stdio|,
it writes to Nvim's stdout. Returns the number of bytes it writes to Nvim's stdout. Returns the number of bytes
@@ -3822,8 +3820,7 @@ garbagecollect([{atexit}]) *garbagecollect()*
The garbage collection is not done immediately but only when The garbage collection is not done immediately but only when
it's safe to perform. This is when waiting for the user to it's safe to perform. This is when waiting for the user to
type a character. To force garbage collection immediately use type a character.
|test_garbagecollect_now()|.
get({list}, {idx} [, {default}]) *get()* get({list}, {idx} [, {default}]) *get()*
Get item {idx} from |List| {list}. When this item is not Get item {idx} from |List| {list}. When this item is not
@@ -5728,7 +5725,7 @@ mkdir({name} [, {path} [, {prot}]])
the new directory. The default is 0755 (rwxr-xr-x: r/w for the new directory. The default is 0755 (rwxr-xr-x: r/w for
the user readable for others). Use 0700 to make it unreadable the user readable for others). Use 0700 to make it unreadable
for others. for others.
{Nvim}
{prot} is applied for all parts of {name}. Thus if you create {prot} is applied for all parts of {name}. Thus if you create
/tmp/foo/bar then /tmp/foo will be created with 0700. Example: > /tmp/foo/bar then /tmp/foo will be created with 0700. Example: >
:call mkdir($HOME . "/tmp/foo/bar", "p", 0700) :call mkdir($HOME . "/tmp/foo/bar", "p", 0700)
@@ -5771,7 +5768,7 @@ mode([expr]) Return a string that indicates the current mode.
"c" or "n". "c" or "n".
Also see |visualmode()|. Also see |visualmode()|.
msgpackdump({list}) {Nvim} *msgpackdump()* msgpackdump({list}) *msgpackdump()*
Convert a list of VimL objects to msgpack. Returned value is Convert a list of VimL objects to msgpack. Returned value is
|readfile()|-style list. Example: > |readfile()|-style list. Example: >
call writefile(msgpackdump([{}]), 'fname.mpack', 'b') call writefile(msgpackdump([{}]), 'fname.mpack', 'b')
@@ -5786,7 +5783,7 @@ msgpackdump({list}) {Nvim} *msgpackdump()*
4. Other strings are always dumped as BIN strings. 4. Other strings are always dumped as BIN strings.
5. Points 3. and 4. do not apply to |msgpack-special-dict|s. 5. Points 3. and 4. do not apply to |msgpack-special-dict|s.
msgpackparse({list}) {Nvim} *msgpackparse()* msgpackparse({list}) *msgpackparse()*
Convert a |readfile()|-style list to a list of VimL objects. Convert a |readfile()|-style list to a list of VimL objects.
Example: > Example: >
let fname = expand('~/.config/nvim/shada/main.shada') let fname = expand('~/.config/nvim/shada/main.shada')
@@ -6404,25 +6401,25 @@ round({expr}) *round()*
echo round(-4.5) echo round(-4.5)
< -5.0 < -5.0
rpcnotify({channel}, {event}[, {args}...]) {Nvim} *rpcnotify()* rpcnotify({channel}, {event}[, {args}...]) *rpcnotify()*
Sends {event} to {channel} via |RPC| and returns immediately. Sends {event} to {channel} via |RPC| and returns immediately.
If {channel} is 0, the event is broadcast to all channels. If {channel} is 0, the event is broadcast to all channels.
Example: > Example: >
:au VimLeave call rpcnotify(0, "leaving") :au VimLeave call rpcnotify(0, "leaving")
rpcrequest({channel}, {method}[, {args}...]) {Nvim} *rpcrequest()* rpcrequest({channel}, {method}[, {args}...]) *rpcrequest()*
Sends a request to {channel} to invoke {method} via Sends a request to {channel} to invoke {method} via
|RPC| and blocks until a response is received. |RPC| and blocks until a response is received.
Example: > Example: >
:let result = rpcrequest(rpc_chan, "func", 1, 2, 3) :let result = rpcrequest(rpc_chan, "func", 1, 2, 3)
rpcstart({prog}[, {argv}]) {Nvim} *rpcstart()* rpcstart({prog}[, {argv}]) *rpcstart()*
Deprecated. Replace > Deprecated. Replace >
:let id = rpcstart('prog', ['arg1', 'arg2']) :let id = rpcstart('prog', ['arg1', 'arg2'])
< with > < with >
:let id = jobstart(['prog', 'arg1', 'arg2'], {'rpc': v:true}) :let id = jobstart(['prog', 'arg1', 'arg2'], {'rpc': v:true})
rpcstop({channel}) {Nvim} *rpcstop()* rpcstop({channel}) *rpcstop()*
Deprecated. Instead use |jobstop()| to stop any job, and Deprecated. Instead use |jobstop()| to stop any job, and
chanclose(id, "rpc") to close RPC communication without chanclose(id, "rpc") to close RPC communication without
stopping the job. Use chanclose(id) to close any socket. stopping the job. Use chanclose(id) to close any socket.
@@ -7889,7 +7886,7 @@ tempname() *tempname()* *temp-file-name*
For MS-Windows forward slashes are used when the 'shellslash' For MS-Windows forward slashes are used when the 'shellslash'
option is set or when 'shellcmdflag' starts with '-'. option is set or when 'shellcmdflag' starts with '-'.
termopen({cmd}[, {opts}]) {Nvim} *termopen()* termopen({cmd}[, {opts}]) *termopen()*
Spawns {cmd} in a new pseudo-terminal session connected Spawns {cmd} in a new pseudo-terminal session connected
to the current buffer. {cmd} is the same as the one passed to to the current buffer. {cmd} is the same as the one passed to
|jobstart()|. This function fails if the current buffer is |jobstart()|. This function fails if the current buffer is
@@ -7904,7 +7901,7 @@ termopen({cmd}[, {opts}]) {Nvim} *termopen()*
See |terminal| for more information. See |terminal| for more information.
test_garbagecollect_now() *test_garbagecollect_now()* test_garbagecollect_now() *test_garbagecollect_now()*
Like garbagecollect(), but executed right away. This must Like |garbagecollect()|, but executed right away. This must
only be called directly to avoid any structure to exist only be called directly to avoid any structure to exist
internally, and |v:testing| must have been set before calling internally, and |v:testing| must have been set before calling
any function. any function.

23
runtime/doc/if_pyth.txt
View File

@@ -6,7 +6,7 @@
The Python Interface to Vim *if_pyth* *python* *Python* The Python Interface to Vim *if_pyth* *python* *Python*
See |provider-python| for more information. {Nvim} See |provider-python| for more information.
Type |gO| to see the table of contents. Type |gO| to see the table of contents.
@@ -722,26 +722,5 @@ You can test what Python version is available with: >
echo 'there is Python 3.x' echo 'there is Python 3.x'
endif endif
Note however, that if Python 2 and 3 are both available, but not loaded,
these has() calls will try to load them.
To avoid loading the dynamic library, only check if Vim was compiled with
python support: >
if has('python_compiled')
echo 'compiled with Python 2.x support'
if has('python_dynamic')
echo 'Python 2.x dynamically loaded'
endif
endif
if has('python3_compiled')
echo 'compiled with Python 3.x support'
if has('python3_dynamic')
echo 'Python 3.x dynamically loaded'
endif
endif
This also tells you whether Python is dynamically loaded, which will fail if
the runtime library cannot be found.
============================================================================== ==============================================================================
vim:tw=78:ts=8:noet:ft=help:norl: vim:tw=78:ts=8:noet:ft=help:norl:

2
runtime/doc/insert.txt
View File

@@ -1429,7 +1429,7 @@ automatically switch to HTML/CSS/JavaScript completion. Note: contrary to
original HTML files completion of tags (and only tags) isn't context aware. original HTML files completion of tags (and only tags) isn't context aware.
RUBY *ft-ruby-omni* {Nvim} RUBY *ft-ruby-omni*
NOTE: |compl-omni| for Ruby code requires |provider-ruby| to be installed. NOTE: |compl-omni| for Ruby code requires |provider-ruby| to be installed.

14
runtime/doc/options.txt
View File

@@ -459,7 +459,7 @@ For example, to use a modeline only for Vim 7.0:
To use a modeline for Vim after version 7.2: To use a modeline for Vim after version 7.2:
/* vim>702: set cole=2: */ ~ /* vim>702: set cole=2: */ ~
There can be no blanks between "vim" and the ":". There can be no blanks between "vim" and the ":".
The modeline is ignored if {vers} does not fit in an integer. {Nvim} The modeline is ignored if {vers} does not fit in an integer.
The number of lines that are checked can be set with the 'modelines' option. The number of lines that are checked can be set with the 'modelines' option.
@@ -908,13 +908,13 @@ A jump table for the options with a short description can be found at |Q_op|.
the newly created file). Also see 'backupcopy' and |crontab|. the newly created file). Also see 'backupcopy' and |crontab|.
*'balloondelay'* *'bdlay'* *'balloondelay'* *'bdlay'*
'balloondelay' 'bdlay' Removed. {Nvim} 'balloondelay' 'bdlay' Removed.
*'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'* *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
'ballooneval' 'beval' Removed. {Nvim} 'ballooneval' 'beval' Removed.
*'balloonexpr'* *'bexpr'* *'balloonexpr'* *'bexpr'*
'balloonexpr' 'bexpr' Removed. {Nvim} 'balloonexpr' 'bexpr' Removed.
*'belloff'* *'bo'* *'belloff'* *'bo'*
'belloff' 'bo' string (default "all") 'belloff' 'bo' string (default "all")
@@ -3475,7 +3475,7 @@ A jump table for the options with a short description can be found at |Q_op|.
help. (Note that previously setting the global option to the empty help. (Note that previously setting the global option to the empty
value did this, which is now deprecated.) value did this, which is now deprecated.)
When the first character is ":", the command is invoked as a Vim When the first character is ":", the command is invoked as a Vim
command prefixed with [count]. {Nvim} command prefixed with [count].
When "man" or "man -s" is used, Vim will automatically translate When "man" or "man -s" is used, Vim will automatically translate
a [count] for the "K" command to a section number. a [count] for the "K" command to a section number.
See |option-backslash| about including spaces and backslashes. See |option-backslash| about including spaces and backslashes.
@@ -3795,7 +3795,7 @@ A jump table for the options with a short description can be found at |Q_op|.
set a time. This is to be compatible with Nvi. set a time. This is to be compatible with Nvi.
*'maxcombine'* *'mco'* *'maxcombine'* *'mco'*
'maxcombine' 'mco' Removed. |vim-differences| {Nvim} 'maxcombine' 'mco' Removed. |vim-differences|
Nvim always displays up to 6 combining characters. You can still edit Nvim always displays up to 6 combining characters. You can still edit
text with more than 6 combining characters, you just can't see them. text with more than 6 combining characters, you just can't see them.
Use |g8| or |ga|. See |mbyte-combining|. Use |g8| or |ga|. See |mbyte-combining|.
@@ -6219,7 +6219,7 @@ A jump table for the options with a short description can be found at |Q_op|.
to be garbled (e.g., when it contains a CR or NL character). to be garbled (e.g., when it contains a CR or NL character).
*'ttyfast'* *'tf'* *'nottyfast'* *'notf'* *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
'ttyfast' 'tf' Removed. |vim-differences| {Nvim} 'ttyfast' 'tf' Removed. |vim-differences|
*'undodir'* *'udir'* *E5003* *'undodir'* *'udir'* *E5003*
'undodir' 'udir' string (default "$XDG_DATA_HOME/nvim/undo") 'undodir' 'udir' string (default "$XDG_DATA_HOME/nvim/undo")

4
runtime/doc/starting.txt
View File

@@ -1025,7 +1025,7 @@ Use the "r" flag in 'shada' to specify for which files no marks should be
remembered. remembered.
MERGING *shada-merging* MERGING *shada-merging*
{Nvim}
When writing ShaDa files with |:wshada| without bang or at regular exit When writing ShaDa files with |:wshada| without bang or at regular exit
information in the existing ShaDa file is merged with information from current information in the existing ShaDa file is merged with information from current
Neovim instance. For this purpose ShaDa files store timestamps associated Neovim instance. For this purpose ShaDa files store timestamps associated
@@ -1055,7 +1055,7 @@ with ShaDa entries. Specifically the following is being done:
Neovim instance which was last writing the file. |shada-%| Neovim instance which was last writing the file. |shada-%|
COMPATIBILITY *shada-compatibility* COMPATIBILITY *shada-compatibility*
{Nvim}
ShaDa files are forward and backward compatible. This means that ShaDa files are forward and backward compatible. This means that
1. Entries which have unknown type (i.e. that hold unidentified data) are 1. Entries which have unknown type (i.e. that hold unidentified data) are

6
runtime/doc/syntax.txt
View File

@@ -4907,12 +4907,12 @@ DiffChange diff mode: Changed line |diff.txt|
DiffDelete diff mode: Deleted line |diff.txt| DiffDelete diff mode: Deleted line |diff.txt|
*hl-DiffText* *hl-DiffText*
DiffText diff mode: Changed text within a changed line |diff.txt| DiffText diff mode: Changed text within a changed line |diff.txt|
{Nvim} *hl-EndOfBuffer* *hl-EndOfBuffer*
EndOfBuffer filler lines (~) after the end of the buffer. EndOfBuffer filler lines (~) after the end of the buffer.
By default, this is highlighted like |hl-NonText|. By default, this is highlighted like |hl-NonText|.
{Nvim} *hl-TermCursor* *hl-TermCursor*
TermCursor cursor in a focused terminal TermCursor cursor in a focused terminal
{Nvim} *hl-TermCursorNC* *hl-TermCursorNC*
TermCursorNC cursor in an unfocused terminal TermCursorNC cursor in an unfocused terminal
*hl-ErrorMsg* *hl-ErrorMsg*
ErrorMsg error messages on the command line ErrorMsg error messages on the command line

7
runtime/doc/various.txt
View File

@@ -215,11 +215,12 @@ g8 Print the hex values of the bytes used in the
":normal" command without a range. ":normal" command without a range.
*:sh* *:shell* *E371* *E360* *:sh* *:shell* *E371* *E360*
:sh[ell] Removed. |vim-differences| {Nvim} :sh[ell] Removed. |vim-differences|
*:terminal* *:te* *:terminal* *:te*
:te[rminal][!] [{cmd}] Execute {cmd} with 'shell' in a new |terminal-emulator| :te[rminal][!] [{cmd}] Run {cmd} in a non-interactive 'shell' in a new
buffer. Without {cmd}, start an interactive 'shell'. |terminal-emulator| buffer. Without {cmd}, start an
interactive 'shell'.
Type |i| to enter |Terminal-mode|, then keys are sent to Type |i| to enter |Terminal-mode|, then keys are sent to
the job running in the terminal. Type <C-\><C-N> to the job running in the terminal. Type <C-\><C-N> to

1
runtime/syntax/help.vim
View File

@@ -36,7 +36,6 @@ syn match helpNormal "|||"
syn match helpNormal ":|vim:|" " for :help modeline syn match helpNormal ":|vim:|" " for :help modeline
syn match helpVim "\<Vim version [0-9][0-9.a-z]*" syn match helpVim "\<Vim version [0-9][0-9.a-z]*"
syn match helpVim "VIM REFERENCE.*" syn match helpVim "VIM REFERENCE.*"
syn match helpVim "\<Nvim\."
syn match helpVim "NVIM REFERENCE.*" syn match helpVim "NVIM REFERENCE.*"
syn match helpOption "'[a-z]\{2,\}'" syn match helpOption "'[a-z]\{2,\}'"
syn match helpOption "'t_..'" syn match helpOption "'t_..'"

2
runtime/syntax/vim.vim
View File

@@ -397,7 +397,7 @@ syn match vimMenuBang "!" contained skipwhite nextgroup=@vimMenuList
" Angle-Bracket Notation (tnx to Michael Geddes) {{{2 " Angle-Bracket Notation (tnx to Michael Geddes) {{{2
" ====================== " ======================
syn case ignore syn case ignore
syn match vimNotation "\%#=1\(\\\|<lt>\)\=<\([scamd]-\)\{0,4}x\=\(f\d\{1,2}\|[^ \t:]\|cr\|lf\|linefeed\|return\|k\=del\%[ete]\|bs\|backspace\|tab\|esc\|right\|left\|help\|undo\|insert\|ins\|mouse\|k\=home\|k\=end\|kplus\|kminus\|kdivide\|kmultiply\|kenter\|kpoint\|space\|k\=\(page\)\=\(\|down\|up\|k\d\>\)\)>" contains=vimBracket syn match vimNotation "\%#=1\(\\\|<lt>\)\=<\([scamd]-\)\{0,4}x\=\(f\d\{1,2}\|[^ \t:]\|cmd\|cr\|lf\|linefeed\|return\|k\=del\%[ete]\|bs\|backspace\|tab\|esc\|right\|left\|help\|undo\|insert\|ins\|mouse\|k\=home\|k\=end\|kplus\|kminus\|kdivide\|kmultiply\|kenter\|kpoint\|space\|k\=\(page\)\=\(\|down\|up\|k\d\>\)\)>" contains=vimBracket
syn match vimNotation "\%#=1\(\\\|<lt>\)\=<\([scam2-4]-\)\{0,4}\(right\|left\|middle\)\(mouse\)\=\(drag\|release\)\=>" contains=vimBracket syn match vimNotation "\%#=1\(\\\|<lt>\)\=<\([scam2-4]-\)\{0,4}\(right\|left\|middle\)\(mouse\)\=\(drag\|release\)\=>" contains=vimBracket
syn match vimNotation "\%#=1\(\\\|<lt>\)\=<\(bslash\|plug\|sid\|space\|bar\|nop\|nul\|lt\)>" contains=vimBracket syn match vimNotation "\%#=1\(\\\|<lt>\)\=<\(bslash\|plug\|sid\|space\|bar\|nop\|nul\|lt\)>" contains=vimBracket
syn match vimNotation '\(\\\|<lt>\)\=<C-R>[0-9a-z"%#:.\-=]'he=e-1 contains=vimBracket syn match vimNotation '\(\\\|<lt>\)\=<C-R>[0-9a-z"%#:.\-=]'he=e-1 contains=vimBracket

18
src/nvim/api/vim.c
View File

@@ -905,17 +905,17 @@ void nvim_set_current_tabpage(Tabpage tabpage, Error *err)
} }
} }
/// create a new namespace, or get one with an exisiting name /// Creates a new namespace, or gets an existing one
/// ///
/// Namespaces are currently used for buffer highlighting and virtual text, see /// Namespaces are used for buffer highlights and virtual text, see
/// |nvim_buf_add_highlight| and |nvim_buf_set_virtual_text|. /// |nvim_buf_add_highlight()| and |nvim_buf_set_virtual_text()|.
/// ///
/// Namespaces can have a name of be anonymous. If `name` is a non-empty string, /// Namespaces can be named or anonymous. If `name` matches an existing
/// and a namespace already exists with that name,the existing namespace id is /// namespace, the associated id is returned. If `name` is an empty string
/// returned. If an empty string is used, a new anonymous namespace is returned. /// a new, anonymous namespace is created.
/// ///
/// @param name Name of the namespace or empty string /// @param name Namespace name or empty string
/// @return the namespace id /// @return Namespace id
Integer nvim_create_namespace(String name) Integer nvim_create_namespace(String name)
FUNC_API_SINCE(5) FUNC_API_SINCE(5)
{ {
@@ -931,7 +931,7 @@ Integer nvim_create_namespace(String name)
return (Integer)id; return (Integer)id;
} }
/// Get existing named namespaces /// Gets existing, non-anonymous namespaces
/// ///
/// @return dict that maps from names to namespace ids. /// @return dict that maps from names to namespace ids.
Dictionary nvim_get_namespaces(void) Dictionary nvim_get_namespaces(void)