File: vc-hooks.el.html

This is the preloaded portion of VC. It takes care of VC-related activities that are done when you visit a file, so that vc.el itself is loaded only when you use a VC command. See commentary of vc.el.

The noninteractive hooks into the rest of Emacs are:
- vc-refresh-state in find-file-hook
- vc-kill-buffer-hook in kill-buffer-hook
- vc-after-save which is called by basic-save-buffer
- vc-after-revert in after-revert-hook.

Defined variables (14)

vc-auto-revert-modeNon-nil if Vc-Auto-Revert mode is enabled.
vc-auto-revert-mode-hookHook run after entering or leaving ‘vc-auto-revert-mode’.
vc-consult-headersIf non-nil, identify work files by searching for version headers.
vc-dir-buffersList of ‘vc-dir’ buffers.
vc-directory-exclusion-listList of directory names to be ignored when walking directory trees.
vc-display-statusIf non-nil, display revision number and lock status in mode line.
vc-file-prop-obarrayObarray for VC per-file and per-repository properties.
vc-follow-symlinksWhat to do if visiting a symbolic link to a file under version control.
vc-handled-backendsList of version control backends for which VC will be used.
vc-ignore-dir-regexpRegexp matching directory names that are not under VC’s control.
vc-make-backup-filesIf non-nil, backups of registered files are made as with other files.
vc-resolve-conflictsWhether to mark conflicted file as resolved upon saving.
vc-use-incoming-outgoing-prefixesWhether C-x v I and C-x v O are prefix commands.
vc-use-short-revisionIf non-nil, VC backend functions should return short revisions if possible.

Defined functions (48)

vc--repo-clearprops(BACKEND)
vc--repo-getprop(BACKEND PROPERTY)
vc--repo-setprop(BACKEND PROPERTY VALUE)
vc-after-revert()
vc-after-save()
vc-auto-revert-mode(&optional ARG)
vc-backend(FILE-OR-LIST)
vc-backend-subdirectory-name(FILE)
vc-before-save()
vc-call(FUN FILE &rest ARGS)
vc-call-backend(BACKEND FUNCTION-NAME &rest ARGS)
vc-check-master-templates(FILE TEMPLATES)
vc-checkout-model(BACKEND FILES)
vc-default-extra-menu(BACKEND)
vc-default-find-file-hook(BACKEND)
vc-default-make-version-backups-p(BACKEND FILE)
vc-default-mode-line-string(BACKEND FILE)
vc-default-registered(BACKEND FILE)
vc-delete-automatic-version-backups(FILE)
vc-error-occurred(&rest BODY)
vc-file-clearprops(FILE)
vc-file-getprop(FILE PROPERTY)
vc-file-setprop(FILE PROPERTY VALUE)
vc-find-backend-function(BACKEND FUN)
vc-find-file-hook()
vc-find-root(FILE WITNESS)
vc-follow-link()
vc-insert-file(FILE &optional LIMIT BLOCKSIZE)
vc-kill-buffer-hook()
vc-make-backend-sym(BACKEND SYM)
vc-make-version-backup(FILE)
vc-menu-map-filter(ORIG-BINDING)
vc-mode(&optional ARG)
vc-mode-line(FILE &optional BACKEND)
vc-mode-line-state(STATE)
vc-parse-buffer(PATTERN I)
vc-possible-master(S DIRNAME BASENAME)
vc-refresh-state()
vc-registered(FILE)
vc-short-revision(FILE &optional BACKEND)
vc-state(FILE &optional BACKEND)
vc-state-refresh(FILE BACKEND)
vc-symbolic-working-revision(FILE &optional BACKEND)
vc-turn-on-auto-revert-mode-for-tracked-files()
vc-up-to-date-p(FILE)
vc-user-login-name(FILE)
vc-version-backup-file-name(FILE &optional REV MANUAL REGEXP)
vc-working-revision(FILE &optional BACKEND)

Defined faces (10)

vc-conflict-stateFace for VC modeline state when the file contains merge conflicts.
vc-edited-stateFace for VC modeline state when the file is edited.
vc-ignored-stateFace for VC modeline state when the file is registered, but ignored.
vc-locally-added-stateFace for VC modeline state when the file is locally added.
vc-locked-stateFace for VC modeline state when the file locked.
vc-missing-stateFace for VC modeline state when the file is missing from the file system.
vc-needs-update-stateFace for VC modeline state when the file needs update.
vc-removed-stateFace for VC modeline state when the file was removed from the VC system.
vc-state-baseBase face for VC state indicator.
vc-up-to-date-stateFace for VC modeline state when the file is up to date.