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

doc: Add more details about debug buffers.

Browse Source 
From https://github.com/mawww/kakoune/issues/2739#issuecomment-464400235
This commit is contained in:
Tim Allen 2019-02-17 11:09:58 +11:00
parent abbf843763
commit d862556066
1 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/pages/buffers.asciidoc
View File

@ -21,8 +21,14 @@ A scratch buffer can be created by passing the `-scratch` switch to the
== Debug Buffers
Debug buffers are used to gather diagnostics. They are not accessible
while cycling over the buffers list.
Debug buffers are used to gather diagnostics. They have a number of
restrictions compared to regular buffers:
- They are skipped when cycling over the buffers list.
- Their content is not considered for word completions with `word=all`
completers
- Hooks are not always run (like the `BufCreate`/`BufClose` hooks)
- Display profiling is disabled
A specific *\*debug*\* buffer is used by Kakoune to write errors or
warnings. This is also where the ouput of the `:debug` and the `:echo