xenia/kakoune
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Document that json rpc requests will be written new-line separated

Browse Source 
Fixes #717
This commit is contained in:
Maxime Coste 2016-07-04 19:49:14 +01:00
parent 8270f9299f
commit 7f345db3cc
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doc/json_ui.asciidoc
View File

@ -4,8 +4,9 @@ Json-Rpc user interface
Kakoune user interfaces can be implemented through the json-rpc 2.0 protocol. Kakoune user interfaces can be implemented through the json-rpc 2.0 protocol.
By launching kakoune in client mode with the `-ui json` option, the launched By launching kakoune in client mode with the `-ui json` option, the launched
client will write json-rpc requests on stdout and read json-rpc requests client will write newline separated json-rpc requests on stdout and read
on stdin. Errors will be reported on stderr (not in json format). json-rpc requests on stdin. Errors will be reported on stderr (not in
json format).
Kakoune requests are always using positional parameters, never named, and Kakoune requests are always using positional parameters, never named, and
Kakoune wont be able to parse named parameters in requests. Kakoune wont be able to parse named parameters in requests.