From e05931d7e958bf27ccdd312a1a21c84fdffe70a8 Mon Sep 17 00:00:00 2001 From: Akib Azmain Turja Date: Wed, 7 Dec 2022 12:00:41 +0600 Subject: [PATCH] Document annotation correction delay user option * eat.texi (Performance Tuning): Document the purpose and the use of 'eat-shell-prompt-annotation-correction-delay' user option. --- README.org | 2 +- eat.el | 3 +-- eat.texi | 22 +++++++++++++++++++--- 3 files changed, 21 insertions(+), 6 deletions(-) diff --git a/README.org b/README.org index 1c4d596..35b3327 100644 --- a/README.org +++ b/README.org @@ -10,7 +10,7 @@ comfortably run Emacs inside Eat, or even use your Emacs as a terminal multiplexer. It has many features that other Emacs terminal emulator still don't -have, for example complete mouse support. +have, for example complete mouse support, shell integration, etc. It flickers less than other Emacs terminal emulator, so you get more performance and a smooth experience. diff --git a/eat.el b/eat.el index e66f7f6..9068964 100644 --- a/eat.el +++ b/eat.el @@ -4848,8 +4848,7 @@ mouse-3: Switch to char mode" (when (and eat--terminal (not (string-empty-p (eat-term-title eat--terminal)))) - (format "(%s)" (eat-term-title - eat--terminal)))) + (format "(%s)" (eat-term-title eat--terminal)))) help-echo "Title")))))) (eat-emacs-mode) ;; Make sure glyphless character don't display a huge box glyph, diff --git a/eat.texi b/eat.texi index b5e492d..9c16407 100644 --- a/eat.texi +++ b/eat.texi @@ -806,7 +806,7 @@ an empty Bash prompt, the next prompt won't appear before this much time. You should set the time to something comfortable for you. You can -also set this to zero is disable waiting and showing the output +also set this to zero to disable waiting and showing the output instantly, but this would likely cause a lot of flickering. @end defopt @@ -826,11 +826,27 @@ of large burst of output, redisplay is never deferred more than this many seconds, and cause a latency of up to this many seconds. You should set the time to something comfortable for you. You can -also set this to zero is disable waiting and showing the output +also set this to zero to disable waiting and showing the output instantly, but this would likely cause a lot of flickering. @end defopt -The user option described in this chapter have reasonable default +Due to some limitations, shell prompt annotations +(@pxref{Shell Integration}) can get messed up sometimes. Eat +automatically corrects them after each terminal redisplay. However, +this can have some performance impact when the terminal scrollback and +display is large enough. So Eat defers the correction. + +@vindex eat-shell-prompt-annotation-delay +@defopt eat-shell-prompt-annotation-delay +The value is the time in seconds to wait for more output before +correcting shell prompt annotations. + +You should set the time to something comfortable for you. You can +also set this to zero to disable waiting and correct annotations +instantly, but this may cause the terminal to slow down in some cases. +@end defopt + +The user options described in this chapter have reasonable default values, but they may change anytime. @part Part IV:@* Recovering from Problems