aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJustin M. Keyes <justinkz@gmail.com>2017-12-16 21:33:59 +0100
committerJustin M. Keyes <justinkz@gmail.com>2017-12-26 03:58:28 +0100
commitfe60fa9faafd90cfe756c80119abae6f8906fc4b (patch)
tree3d2dfa4e2e372f6e96e66d5508ad5549c1197a59
parent249bdb07dd3a9555972deff625d67e4ee0eddc86 (diff)
downloadrneovim-fe60fa9faafd90cfe756c80119abae6f8906fc4b.tar.gz
rneovim-fe60fa9faafd90cfe756c80119abae6f8906fc4b.tar.bz2
rneovim-fe60fa9faafd90cfe756c80119abae6f8906fc4b.zip
doc
vim-patch:8.0.1206: no autocmd for entering or leaving the command line (commit a4f6cec7a31ff8dbfa089b9e22227afbeb951e9b) NA patches: vim-patch:8.0.0320: warning for unused variable with small build
-rw-r--r--runtime/autoload/health/nvim.vim2
-rw-r--r--runtime/doc/api.txt44
-rw-r--r--runtime/doc/channel.txt4
-rw-r--r--runtime/doc/develop.txt6
-rw-r--r--runtime/doc/vim_diff.txt1
-rw-r--r--scripts/gen_api_vimdoc.py2
-rw-r--r--src/nvim/api/vim.c2
7 files changed, 31 insertions, 30 deletions
diff --git a/runtime/autoload/health/nvim.vim b/runtime/autoload/health/nvim.vim
index 58033f0405..017c047ef4 100644
--- a/runtime/autoload/health/nvim.vim
+++ b/runtime/autoload/health/nvim.vim
@@ -174,7 +174,7 @@ function! s:check_terminal() abort
\ .(empty(kbs_entry) ? '? (not found)' : kdch1_entry))
endif
for env_var in ['XTERM_VERSION', 'VTE_VERSION', 'TERM_PROGRAM', 'COLORTERM', 'SSH_TTY']
- if !exists('$'.env_var)
+ if exists('$'.env_var)
call health#report_info(printf("$%s='%s'", env_var, eval('$'.env_var)))
endif
endfor
diff --git a/runtime/doc/api.txt b/runtime/doc/api.txt
index 6c2a3a8632..fd6918de43 100644
--- a/runtime/doc/api.txt
+++ b/runtime/doc/api.txt
@@ -512,27 +512,27 @@ nvim_parse_expression({expr}, {flags}, {highlight})
[start_col, end_col)).
Return:~
- AST: top-level dictionary holds keys "error": Dictionary
- with error, present only if parser saw some error.
- Contains the following keys: "message": String, error
- message in printf format, translated. Must contain exactly
- one "%.*s". "arg": String, error message argument. "len":
- Amount of bytes successfully parsed. With flags equal to
- "" that should be equal to the length of expr string.
- @note: “Sucessfully parsed” here means “participated in
- AST creation”, not “till the first error”. "ast": AST,
- either nil or a dictionary with these keys: "type": node
- type, one of the value names from ExprASTNodeType
- stringified without "kExprNode" prefix. "start": a pair
- [line, column] describing where node is “started” where
- "line" is always 0 (will not be 0 if you will be using
- nvim_parse_viml() on e.g. ":let", but that is not present
- yet). Both elements are Integers. "len": “length” of the
- node. This and "start" are there for debugging purposes
- primary (debugging parser and providing debug
- information). "children": a list of nodes described in
- top/"ast". There always is zero, one or two children, key
- will not be present if node has no children. Maximum
+ AST: top-level dictionary with these keys: "error":
+ Dictionary with error, present only if parser saw some
+ error. Contains the following keys: "message": String,
+ error message in printf format, translated. Must contain
+ exactly one "%.*s". "arg": String, error message argument.
+ "len": Amount of bytes successfully parsed. With flags
+ equal to "" that should be equal to the length of expr
+ string. @note: “Sucessfully parsed” here means
+ “participated in AST creation”, not “till the first
+ error”. "ast": AST, either nil or a dictionary with these
+ keys: "type": node type, one of the value names from
+ ExprASTNodeType stringified without "kExprNode" prefix.
+ "start": a pair [line, column] describing where node is
+ “started” where "line" is always 0 (will not be 0 if you
+ will be using nvim_parse_viml() on e.g. ":let", but that
+ is not present yet). Both elements are Integers. "len":
+ “length” of the node. This and "start" are there for
+ debugging purposes primary (debugging parser and providing
+ debug information). "children": a list of nodes described
+ in top/"ast". There always is zero, one or two children,
+ key will not be present if node has no children. Maximum
number of children may be found in node_maxchildren array.
Local values (present only for certain nodes): "scope": a
single Integer, specifies scope for "Option" and
@@ -1047,4 +1047,4 @@ nvim_ui_try_resize({width}, {height}) *nvim_ui_try_resize()*
nvim_ui_set_option({name}, {value}) *nvim_ui_set_option()*
TODO: Documentation
- vim:tw=78:ts=8:ft=help:norl: \ No newline at end of file
+ vim:tw=78:ts=8:ft=help:norl:
diff --git a/runtime/doc/channel.txt b/runtime/doc/channel.txt
index c4f7eb1ff1..eb2bac6fce 100644
--- a/runtime/doc/channel.txt
+++ b/runtime/doc/channel.txt
@@ -4,9 +4,9 @@
NVIM REFERENCE MANUAL by Thiago de Arruda
-Nvim's facilities for async io *channel*
+Nvim asynchronous IO *channel*
- Type <M-]> to see the table of contents.
+ Type |gO| to see the table of contents.
==============================================================================
1. Introduction *channel-intro*
diff --git a/runtime/doc/develop.txt b/runtime/doc/develop.txt
index 36826e2479..4e77f40035 100644
--- a/runtime/doc/develop.txt
+++ b/runtime/doc/develop.txt
@@ -270,9 +270,9 @@ External UIs are expected to implement these common features:
- Send the "super" key (Windows key, Apple key) as a |<D-| chord.
Implementation ~
-- Options can be monitored for changes by the |OptionSet| autocmd. E.g. if the
- user sets the 'guifont' option, this autocmd notifies channel 42: >
- autocmd OptionSet guifont call rpcnotify(42, 'option-changed', 'guifont', &guifont)
+- UI-related options ('guifont', 'ambiwidth', …) are published in the
+ "option_set" |ui-global| event. The event is triggered when the UI first
+ connects to Nvim and whenever an option is changed by the user or a plugin.
vim:tw=78:ts=8:ft=help:norl:
diff --git a/runtime/doc/vim_diff.txt b/runtime/doc/vim_diff.txt
index 7061f01316..9643777975 100644
--- a/runtime/doc/vim_diff.txt
+++ b/runtime/doc/vim_diff.txt
@@ -70,6 +70,7 @@ Providers
Ruby plugins |provider-ruby|
Shared data |shada|
Embedded terminal |terminal|
+VimL parser |nvim_parse_expression()|
XDG base directories |xdg|
USER EXPERIENCE ~
diff --git a/scripts/gen_api_vimdoc.py b/scripts/gen_api_vimdoc.py
index 4ddf415f1a..69f70f6e2b 100644
--- a/scripts/gen_api_vimdoc.py
+++ b/scripts/gen_api_vimdoc.py
@@ -478,7 +478,7 @@ def gen_docs(config):
docs += '\n\n\n'
docs = docs.rstrip() + '\n\n'
- docs += ' vim:tw=78:ts=8:ft=help:norl:'
+ docs += ' vim:tw=78:ts=8:ft=help:norl:\n'
doc_file = os.path.join(base_dir, 'runtime/doc', doc_filename)
delete_lines_below(doc_file, section_start_token)
diff --git a/src/nvim/api/vim.c b/src/nvim/api/vim.c
index c0daac8085..172f2ce18e 100644
--- a/src/nvim/api/vim.c
+++ b/src/nvim/api/vim.c
@@ -929,7 +929,7 @@ typedef kvec_withinit_t(ExprASTConvStackItem, 16) ExprASTConvStack;
/// starting column and ending column (latter exclusive:
/// one should highlight region [start_col, end_col)).
///
-/// @return AST: top-level dictionary holds keys
+/// @return AST: top-level dictionary with these keys:
///
/// "error": Dictionary with error, present only if parser saw some
/// error. Contains the following keys: