aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKillTheMule <KillTheMule@users.noreply.github.com>2018-02-12 22:49:35 +0100
committerKillTheMule <KillTheMule@users.noreply.github.com>2018-05-23 22:07:27 +0200
commitde5d1e863c71c8da87422bdb94dc91749d4a8b61 (patch)
treee5e4b8514f1092a6ed048a50cc587c23b8bde7a1
parent5aa8af7cdb5a2a8ed2cef02e6d7a0b9a2c714140 (diff)
downloadrneovim-de5d1e863c71c8da87422bdb94dc91749d4a8b61.tar.gz
rneovim-de5d1e863c71c8da87422bdb94dc91749d4a8b61.tar.bz2
rneovim-de5d1e863c71c8da87422bdb94dc91749d4a8b61.zip
Try fixing that test on travis
-rw-r--r--runtime/doc/msgpack_rpc.txt42
-rw-r--r--test/functional/api/buffer_updates_spec.lua2
2 files changed, 12 insertions, 32 deletions
diff --git a/runtime/doc/msgpack_rpc.txt b/runtime/doc/msgpack_rpc.txt
index bf7c63710f..0b0e774d33 100644
--- a/runtime/doc/msgpack_rpc.txt
+++ b/runtime/doc/msgpack_rpc.txt
@@ -242,32 +242,12 @@ the type codes, because a client may be built against one Nvim version but
connect to another with different type codes.
==============================================================================
-6. Buffer Updates *buffer-updates* *rpc-buffer-updates*
+6. Buffer Updates *buffer-updates* *rpc-buffer-updates*
A dedicated API has been created to allow co-processes to be notified when a
buffer is changed in any way. It is difficult and error-prone to try and do
this with autocommands such as |TextChanged|.
- *buffer-updates-api*
-BufferUpdates Functions~
-
-nvim_buf_attach({send_buffer}) *nvim_buf_attach()*
- Register a plugin to receive notifications on buffer changes. An
- initial |nvim_buf_updates_start| notification will be sent as a
- confirmation. After that, |nvim_buf_update| notifications will be
- sent for buffer updates, and |nvim_buf_update_tick| notifications
- for a new changedtick without buffer change.
-
- Parameters:~
- {send_buffer} Bool. If `"True"`, the initial
- |nvim_buf_updates_start| notification will also send the full
- buffer's content. If `"False"`, the notification will contain
- an empty list instead.
-
-nvim_buf_detach() *nvim_buf_detach()*
- Unregister a plugin from buffer change notifications. A final
- |nvim_buf_updates_end| notification will be sent as confirmation.
-
*buffer-updates-events*
BufferUpdates Events~
@@ -372,41 +352,41 @@ the buffer contents are unloaded from memory:
- reloading the buffer after it is changed from outside neovim.
*buffer-updates-examples*
-Example Events~
+Examples~
-If buffer updates are activated a new empty buffer, the following
+If buffer updates are activated a new empty buffer (and sending the buffer's
+content on the initial notification has been requested), the following
|nvim_buf_updates_start| event will be sent: >
- rpcnotify({channel}, "nvim_buf_updates_start", [{buf}, [""], v:false])
+ nvim_buf_updates_start[{buf}, [""], v:false]
If the user adds 2 new lines to the start of a buffer, the following event
would be generated: >
- rpcnotify({channel}, "nvim_buf_update", [{buf}, 0, 0, ["line1", "line2"]])
+ nvim_buf_update[{buf}, 0, 0, ["line1", "line2"]]
If the puts the cursor on a line containing the text `"Hello world"` and adds
a `!` character to the end using insert mode, the following event would be
generated: >
- rpcnotify({channel}, "nvim_buf_update", [{buf}, {linenr}, {linenr} + 1, ["Hello
- world!"]])
+ nvim_buf_update[{buf}, {linenr}, {linenr} + 1, ["Hello world!"]]
If the user moves their cursor to line 3 of a buffer and deletes 20 lines
using `20dd`, the following event will be generated: >
- rpcnotify({channel}, "nvim_buf_update", [{buf}, 2, 20, []])
+ nvim_buf_update[{buf}, 2, 20, []]
If the user selects lines 3-5 of a buffer using |linewise-visual| mode and
then presses `p` to paste in a new block of 6 lines, then the following event
would be sent to the co-process: >
- rpcnotify({channel}, "nvim_buf_update", [{buf}, 2, 5, ['pasted line 1', 'pasted
+ nvim_buf_update[{buf}, 2, 5, ['pasted line 1', 'pasted
line 2', 'pasted line 3', 'pasted line 4', 'pasted line 5', 'pasted line
- 6']])
+ 6']]
If the user uses :edit to reload a buffer then the following event would be
generated: >
- rpcnotify({channel}, "nvim_buf_updates_end", [{buf}])
+ nvim_buf_updates_end[{buf}]
vim:tw=78:ts=8:ft=help:norl:
diff --git a/test/functional/api/buffer_updates_spec.lua b/test/functional/api/buffer_updates_spec.lua
index cb20184a50..b30d0805bd 100644
--- a/test/functional/api/buffer_updates_spec.lua
+++ b/test/functional/api/buffer_updates_spec.lua
@@ -242,7 +242,7 @@ describe('liveupdate', function()
-- modify multiple lines at once using visual block mode
tick = reopen(b, origlines)
command('normal! jjw')
- sendkeys('\x16jjllx')
+ sendkeys('<C-v>jjllx')
tick = tick + 1
expectn('nvim_buf_update',
{b, tick, 2, 5, {'original e 3', 'original e 4', 'original e 5'}})