diff options
| author | Justin M. Keyes <justinkz@gmail.com> | 2017-07-29 00:28:41 +0200 |
|---|---|---|
| committer | Justin M. Keyes <justinkz@gmail.com> | 2017-07-29 14:21:58 +0200 |
| commit | 3c2640cce44e391e8ff5e748ee8bc2156b221806 (patch) | |
| tree | d01b562ae7757d75c5b9881e297e46331c3efdf1 | |
| parent | 5acda12419858da202ce7ea962fae75102a75b2b (diff) | |
| download | rneovim-3c2640cce44e391e8ff5e748ee8bc2156b221806.tar.gz rneovim-3c2640cce44e391e8ff5e748ee8bc2156b221806.tar.bz2 rneovim-3c2640cce44e391e8ff5e748ee8bc2156b221806.zip | |
doc
| -rw-r--r-- | CONTRIBUTING.md | 1 | ||||
| -rw-r--r-- | runtime/doc/eval.txt | 26 | ||||
| -rw-r--r-- | runtime/doc/vim_diff.txt | 7 |
3 files changed, 25 insertions, 9 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8580e8ef39..46e92a7329 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -27,6 +27,7 @@ Reporting problems - When reporting a crash, include a stacktrace. - [Bisect][git-bisect] to the cause of a regression, if you are able. This is _extremely_ helpful. - Check `$NVIM_LOG_FILE`, if it exists. +- Include `cmake --system-information` for **build** issues. Pull requests ("PRs") --------------------- diff --git a/runtime/doc/eval.txt b/runtime/doc/eval.txt index b68c70bf9f..7512cf78ba 100644 --- a/runtime/doc/eval.txt +++ b/runtime/doc/eval.txt @@ -6531,15 +6531,27 @@ serverlist() *serverlist()* nvim --cmd "echo serverlist()" --cmd "q" < serverstart([{address}]) *serverstart()* - Opens a TCP socket (IPv4/IPv6), Unix domain socket (Unix), - or named pipe (Windows) at {address} for clients to connect - to and returns {address}. + Opens a socket or named pipe at {address} and listens for + |RPC| messages. Clients can send |API| commands to the address + to control Nvim. Returns the address string. - If {address} contains `:`, a TCP socket is used. Everything in - front of the last occurrence of `:` is the IP or hostname, - everything after it the port. If the port is empty or `0`, - a random port will be assigned. + If {address} does not contain a colon ":" it is interpreted as + a named pipe or Unix domain socket path. + Example: > + if has('win32') + call serverstart('\\.\pipe\nvim-pipe-1234') + else + call serverstart('nvim.sock') + endif +< + If {address} contains a colon ":" it is interpreted as a TCP + address where the last ":" separates the host and port. + Assigns a random port if it is empty or 0. Supports IPv4/IPv6. + + Example: > + :call serverstart('::1:12345') +< If no address is given, it is equivalent to: > :call serverstart(tempname()) diff --git a/runtime/doc/vim_diff.txt b/runtime/doc/vim_diff.txt index 270e958609..23d597e333 100644 --- a/runtime/doc/vim_diff.txt +++ b/runtime/doc/vim_diff.txt @@ -79,8 +79,8 @@ Working intuitively and consistently is a major goal of Nvim. Examples: avoids features that cannot be provided on all platforms--instead that is delegated to external plugins/extensions. -- Test-only globals and functions such as test_autochdir(), test_settime(), - etc., are not exposed (because they don't exist). +- Vim's internal test functions (test_autochdir(), test_settime(), etc.) are + not exposed (nor implemented); instead Nvim has a robust API. ARCHITECTURE ~ @@ -89,6 +89,9 @@ stability and allows those plugins to work without blocking the editor. Even "legacy" Python and Ruby plugins which use the old Vim interfaces (|if_py| and |if_ruby|) run out-of-process. +Platform and I/O facilities are built upon libuv. Nvim benefits from libuv +features and bug fixes, and other projects benefit from improvements to libuv +by Nvim developers. FEATURES ~ |