From d862556066122d3c8adae76168b43f7fd66f9e72 Mon Sep 17 00:00:00 2001 From: Tim Allen Date: Sun, 17 Feb 2019 11:09:58 +1100 Subject: [PATCH] doc: Add more details about debug buffers. From https://github.com/mawww/kakoune/issues/2739#issuecomment-464400235 --- doc/pages/buffers.asciidoc | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/doc/pages/buffers.asciidoc b/doc/pages/buffers.asciidoc index b8106347d..fc750c7b9 100644 --- a/doc/pages/buffers.asciidoc +++ b/doc/pages/buffers.asciidoc @@ -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