Add custom variables for worker and pipeline pause time

1 files changed, 13 insertions, 2 deletions

diff --git a/phpinspect-pipeline.el b/phpinspect-pipeline.el
index 021a730..3c3069d 100644
--- a/phpinspect-pipeline.el
+++ b/phpinspect-pipeline.el
@@ -28,9 +28,20 @@
 (define-error 'phpinspect-pipeline-incoming "Signal for incoming pipeline data")
 (define-error 'phpinspect-pipeline-error "Signal for pipeline errors")
 
-(defvar phpinspect-pipeline-pause-time 0.5
+(defcustom phpinspect-pipeline-pause-time 0.5
   "Number of seconds to pause a pipeline thread when emacs receives
-user input.")
+user input. This is similar to `phpinspect-worker-pause-time',
+but pipelines are meant to run in bursts. For that reason, the
+default pause time for pipelines is lower to be a little more
+aggressive in hogging cpu time.
+
+Set this variable to a higher value if you experience a lot of
+jitter when editing during pipeline operations.  At the time of
+writing, pipelines are used to refresh the project
+index/autoloader and for the indexation of \"include\"
+directories."
+  :type 'number
+  :group 'phpinspect)
 
 (cl-defstruct (phpinspect-pipeline-end (:constructor phpinspect-make-pipeline-end))
   (value nil