Variable: vc-dir-async-header-values

vc-dir-async-header-values is a buffer-local variable defined in vc-dir.el.gz.

Documentation

List of specifications for asynchronously computed VC-Dir header values.

Each element is a pair (HEADER . FUN) where
- HEADER is a string label for the header in the VC-Dir buffer.
- FUN is a function of two arguments (BACKEND OVERLAY) that starts the
  asynchronous computation of the header's value. BACKEND is the VC
  backend. OVERLAY is an overlay in the target VC-Dir buffer.
  FUN should set
  - the text and bounds of the overlay to a temporary value indicating
    that an async computation is in progress, conventionally of the form
    "[%s ...]";
  - the timer property of the overlay to any idle timer it schedules
  - the proc property of the overlay to the asynchronous process it starts;
  - the text and bounds of the overlay to the computed header value
    after the asychronous computation completes, "<<unknown>>" if the
    information was not obtainable.
  See vc-dir--count-outgoing for an example.

VC backend dir-extra-headers implementations may push additional elements to this list.

Source Code

;; Defined in /usr/src/emacs/lisp/vc/vc-dir.el.gz
(defvar-local vc-dir-async-header-values
  '(("Outgoing" . vc-dir--count-outgoing))
  "List of specifications for asynchronously computed VC-Dir header values.
Each element is a pair (HEADER . FUN) where
- HEADER is a string label for the header in the VC-Dir buffer.
- FUN is a function of two arguments (BACKEND OVERLAY) that starts the
  asynchronous computation of the header's value.  BACKEND is the VC
  backend.  OVERLAY is an overlay in the target VC-Dir buffer.
  FUN should set
  - the text and bounds of the overlay to a temporary value indicating
    that an async computation is in progress, conventionally of the form
    \"[%s ...]\";
  - the `timer' property of the overlay to any idle timer it schedules
  - the `proc' property of the overlay to the asynchronous process it starts;
  - the text and bounds of the overlay to the computed header value
    after the asychronous computation completes, \"<<unknown>>\" if the
    information was not obtainable.
  See `vc-dir--count-outgoing' for an example.

VC backend `dir-extra-headers' implementations may push additional
elements to this list.")