| blob | f77ebb1dc1dc6b36d582796fc856331e7389174e |
1 ;;; vc.el --- drive a version-control system from within Emacs
3 ;; Copyright (C) 1992,93,94,95,96,97,98,2000 Free Software Foundation, Inc.
5 ;; Author: FSF (see below for full credits)
6 ;; Maintainer: Andre Spiegel <spiegel@gnu.org>
8 ;; $Id: vc.el,v 1.290 2000/11/16 18:28:11 monnier Exp $
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software; you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation; either version 2, or (at your option)
15 ;; any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
25 ;; Boston, MA 02111-1307, USA.
27 ;;; Credits:
29 ;; VC was initially designed and implemented by Eric S. Raymond
30 ;; <esr@snark.thyrsus.com>. Over the years, many people have
31 ;; contributed substantial amounts of work to VC. These include:
32 ;; Per Cederqvist <ceder@lysator.liu.se>
33 ;; Paul Eggert <eggert@twinsun.com>
34 ;; Sebastian Kremer <sk@thp.uni-koeln.de>
35 ;; Martin Lorentzson <martinl@gnu.org>
36 ;; Dave Love <fx@gnu.org>
37 ;; Stefan Monnier <monnier@cs.yale.edu>
38 ;; Andre Spiegel <spiegel@gnu.org>
39 ;; Richard Stallman <rms@gnu.org>
40 ;; ttn@netcom.com
42 ;;; Commentary:
44 ;; This mode is fully documented in the Emacs user's manual.
45 ;;
46 ;; Supported version-control systems presently include SCCS, RCS, and CVS.
47 ;;
48 ;; Some features will not work with old RCS versions. Where
49 ;; appropriate, VC finds out which version you have, and allows or
50 ;; disallows those features (stealing locks, for example, works only
51 ;; from 5.6.2 onwards).
52 ;; Even initial checkins will fail if your RCS version is so old that ci
53 ;; doesn't understand -t-; this has been known to happen to people running
54 ;; NExTSTEP 3.0.
55 ;;
56 ;; You can support the RCS -x option by customizing vc-rcs-master-templates.
57 ;;
58 ;; Proper function of the SCCS diff commands requires the shellscript vcdiff
59 ;; to be installed somewhere on Emacs's path for executables.
60 ;;
61 ;; If your site uses the ChangeLog convention supported by Emacs, the
62 ;; function vc-comment-to-change-log should prove a useful checkin hook.
63 ;;
64 ;; The vc code maintains some internal state in order to reduce expensive
65 ;; version-control operations to a minimum. Some names are only computed
66 ;; once. If you perform version control operations with RCS/SCCS/CVS while
67 ;; vc's back is turned, or move/rename master files while vc is running,
68 ;; vc may get seriously confused. Don't do these things!
69 ;;
70 ;; Developer's notes on some concurrency issues are included at the end of
71 ;; the file.
73 ;;; Code:
75 ;;;;;;;;;;;;;;;;; Backend-specific functions ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
76 ;;
77 ;; For each operation FUN, the backend should provide a function
78 ;; vc-BACKEND-FUN. Operations marked with a `-' instead of a `*'
79 ;; are optional.
81 ;;;
82 ;;; State-querying functions
83 ;;;
85 ;; * registered (file)
86 ;; * state (file)
87 ;; - state-heuristic (file)
88 ;; The default behavior delegates to `state'.
89 ;; - dir-state (dir)
90 ;; * workfile-version (file)
91 ;; * latest-on-branch-p (file)
92 ;; * checkout-model (file)
93 ;; - workfile-unchanged-p (file)
94 ;; Return non-nil if FILE is unchanged from its current workfile version.
95 ;; This function should do a brief comparison of FILE's contents
96 ;; with those of the master version. If the backend does not have
97 ;; such a brief-comparison feature, the default implementation of this
98 ;; function can be used, which delegates to a full vc-BACKEND-diff.
99 ;; - mode-line-string (file)
100 ;; - dired-state-info (file)
102 ;;;
103 ;;; State-changing functions
104 ;;;
106 ;; * register (file rev comment)
107 ;; - responsible-p (file)
108 ;; Should also work if FILE is a directory (ends with a slash).
109 ;; - could-register (file)
110 ;; - receive-file (file rev)
111 ;; - unregister (file backend)
112 ;; * checkin (file rev comment)
113 ;; * checkout (file writable &optional rev destfile)
114 ;; Checkout revision REV of FILE into DESTFILE.
115 ;; DESTFILE defaults to FILE.
116 ;; The file should be made writable if WRITABLE is non-nil.
117 ;; REV can be nil (BASE) or "" (HEAD) or any other revision.
118 ;; * revert (file)
119 ;; - cancel-version (file writable)
120 ;; - merge (file rev1 rev2)
121 ;; - merge-news (file)
122 ;; Only needed if state `needs-merge' is possible.
123 ;; - steal-lock (file &optional version)
124 ;; Only required if files can be locked by somebody else.
126 ;;;
127 ;;; History functions
128 ;;;
130 ;; * print-log (file)
131 ;; Insert the revision log of FILE into the current buffer.
132 ;; - show-log-entry (version)
133 ;; - wash-log (file)
134 ;; Remove all non-comment information from the output of print-log
135 ;; - logentry-check ()
136 ;; - comment-history (file)
137 ;; - update-changelog (files)
138 ;; Find changelog entries for FILES, or for all files at or below
139 ;; the default-directory if FILES is nil.
140 ;; * diff (file &optional rev1 rev2)
141 ;; Insert the diff for FILE into the current buffer.
142 ;; REV1 should default to workfile-version.
143 ;; REV2 should default to the current workfile
144 ;; Return a status of either 0 (i.e. no diff) or 1 (i.e. either non-empty
145 ;; diff or the diff is run asynchronously).
146 ;; - annotate-command (file buf rev)
147 ;; - annotate-difference (pos)
148 ;; Only required if `annotate-command' is defined for the backend.
150 ;;;
151 ;;; Snapshot system
152 ;;;
154 ;; - create-snapshot (dir name branchp)
155 ;; Take a snapshot of the current state of files under DIR and
156 ;; name it NAME. This should make sure that files are up-to-date
157 ;; before proceeding with the action. DIR can also be a file and
158 ;; if BRANCHP is specified, NAME should be created as a branch and
159 ;; DIR should be checked out under this new branch. The default
160 ;; behavior does not support branches but does a sanity check, a
161 ;; tree traversal and for each file calls `assign-name'.
162 ;; * assign-name (file name)
163 ;; Give name NAME to the current version of FILE, assuming it is
164 ;; up-to-date. Only used by the default version of `create-snapshot'.
165 ;; - retrieve-snapshot (dir name update)
166 ;; Retrieve a named snapshot of all registered files at or below DIR.
167 ;; If UPDATE is non-nil, then update buffers of any files in the snapshot
168 ;; that are currently visited.
170 ;;;
171 ;;; Miscellaneous
172 ;;;
174 ;; - make-version-backups-p (file)
175 ;; - check-headers ()
176 ;; - clear-headers ()
177 ;; - rename-file (old new)
180 ;;;;;;;;;;;;;;; End of backend-specific functions ;;;;;;;;;;;;;;;;;;;;;;;;;;;;
193 minor-mode-alist)))
195 ;; General customization
198 "Version-control system in Emacs."
202 "*If non-nil, treat user as expert; suppress yes-no prompts on some things."
207 "*If non-nil, delete the *VC-log* buffer and window after each logical action.
208 If nil, bury that buffer instead.
209 This is most useful if you have multiple windows on a frame and would like to
210 preserve the setting."
215 "*If non-nil, prompt for initial comment when a file is registered."
220 "*A string used as the default version number when a new file is registered.
227 "*If non-nil, display run messages from back-end commands."
232 "*A string or list of strings specifying extra switches for checkin.
238 string))
242 "*A string or list of strings specifying extra switches for checkout.
248 string))
252 "*A string or list of strings; extra switches for registering a file.
258 string))
262 "*Switches passed to `ls' for vc-dired. MUST contain the `l' option."
268 "*If non-nil, show directory trees recursively in VC Dired."
274 "*If non-nil, show only locked files in VC Dired."
280 "*List of directory names to be ignored while recursively walking file trees."
287 ;;; This is duplicated in diff.el.
291 ;;;###autoload
293 "*Normal hook (list of functions) run after a checkin is done.
294 See `run-hooks'."
299 ;;;###autoload
301 "*Normal hook (list of functions) run before a file gets checked in.
302 See `run-hooks'."
307 "*Normal hook run by `vc-backend-logentry-check'.
308 Use this to impose your own rules on the entry in addition to any the
309 version control backend imposes itself."
313 ;; Annotate customization
333 Ages are given in units of 2**-16 seconds.
334 Default is eighteen steps using a twenty day increment."
339 "*Color for lines older than CAR of last cons in `vc-annotate-color-map'."
345 Default color is used if nil."
350 "*Menu elements for the mode-specific menu of VC-Annotate mode.
351 List of factors, used to expand/compress the time scale. See `vc-annotate'."
355 ;; vc-annotate functionality (CVS only).
362 m)
368 ;; Header-insertion hair
373 "*Associate static header string templates with file types.
374 A \%s in the template is replaced with the first string associated with
375 the file's version control type in `vc-header-alist'."
383 "*Special comment delimiters to be used in generating vc headers only.
384 Add an entry in this list if you need to override the normal `comment-start'
385 and `comment-end' variables. This will only be necessary if the mode language
386 is sensitive to blank lines."
393 ;; Default is to be extra careful for super-user.
394 ;; TODO: This variable is no longer used; the corresponding checks
395 ;; are always done now. If that turns out to be fast enough,
396 ;; the variable can be obsoleted.
398 "*Non-nil means be extra-careful in checkout.
399 Verify that the file really is not locked
400 and that its contents match what the master file says."
404 \f
405 ;;; The main keymap
424 map))
427 ;; Initialization code, to be done just once at load-time
435 map))
436 ;; Compatibility with old name. Should we bother ?
439 \f
440 ;; Variables the user doesn't need to know about.
446 ;; In a log entry buffer, this is a local variable
447 ;; that points to the buffer for which it was made
448 ;; (either a file, or a VC dired buffer).
464 ;;; functions that operate on RCS revision numbers. This code should
465 ;;; also be moved into the backends. It stays for now, however, since
466 ;;; it is used in code below.
468 "Return t if REV is a revision on the trunk."
472 "Return t if REV is a branch revision."
476 "Return the branch part of a revision number REV."
480 "Return the minor version number of a revision number REV."
485 "Guess the version number immediately preceding REV."
489 ;; version does probably not start a branch or release
492 ;; we are at the beginning of the trunk --
493 ;; don't know anything to return here
494 ""
495 ;; we are at the beginning of a branch --
496 ;; return version of starting point
499 ;; File property caching
502 "Clear all cached file properties and the comment ring."
505 ;; Note: there is potential for minor lossage here if there is an open
506 ;; log buffer with a nonzero local value of vc-comment-ring-index.
510 "Execute FORM, then set per-file properties for FILE,
511 but only those that have not been set during the execution of FORM.
512 SETTINGS is a list of two-element lists, each of which has the
513 form (PROPERTY . VALUE)."
516 ,form
524 ;; Random helper functions
530 ;;; Two macros for elisp programming
531 ;;;###autoload
533 "Check out a writable copy of FILE if necessary and execute the body.
534 Check in FILE with COMMENT (a string) after BODY has been executed.
535 FILE is passed through `expand-file-name'; BODY executed within
536 `save-excursion'. If FILE is not under version control, or locked by
537 somebody else, signal error."
550 ;;;###autoload
552 "Edit FILE under version control, executing body.
553 Checkin with COMMENT after executing BODY.
554 This macro uses `with-vc-file', passing args to it.
555 However, before executing BODY, find FILE, and after BODY, save buffer."
559 ,@body
564 "Make sure that the current buffer visits a version-controlled file."
581 "An alternative output filter for async process P.
582 The only difference with the default filter is to insert S after markers."
591 "Prepare BUF for executing a VC command and make it the current buffer.
606 "Eval CODE when the current buffer's process is done.
607 If the current buffer has no process, just evaluate CODE.
608 Else, add CODE to the process' sentinel."
611 ;; If there's no background process, just execute the code.
613 ;; If the background process has exited, reap it and try again
617 ;; If a process is running, add CODE to the sentinel
625 ; (goto-char...)'
627 sentinel))))))
630 nil)
633 "Hook run at the end of `vc-do-command'.
634 Each function is called inside the buffer in which the command was run
638 "Execute a version control command, notifying user and checking for errors.
639 Output from COMMAND goes to BUFFER, or *vc* if BUFFER is nil or the current
640 buffer (which is assumed to be properly setup) if BUFFER is t. The
641 command is considered successful if its exit status does not exceed
642 OKSTATUS (if OKSTATUS is nil, that means to ignore errors, if it is 'async,
643 that means not to wait for termination of the subprocess). FILE is
644 the name of the working file (may also be nil, to execute commands
645 that don't expect a file name). If an optional list of FLAGS is present,
646 that is inserted into the command line before the filename."
657 ;; FIXME: file-relative-name can return a bogus result because
658 ;; it doesn't look at the actual file-system to see if symlinks
659 ;; come into play.
662 ;; Add vc-path to PATH for the execution of this command.
665 path-separator
667 process-environment))
671 squeezed)))
674 ;;(set-process-sentinel proc (lambda (p msg) (delete-process p)))
690 status)))
693 "Save a bit of the text around POSN in the current buffer.
694 Used to help us find the corresponding position again later
695 if markers are destroyed or corrupted."
696 ;; A lot of this was shamelessly lifted from Sebastian Kremer's
697 ;; rcs.el mode.
704 "Return the position of CONTEXT in the current buffer, or nil if not found."
713 ;; Can't use search-backward since the match may continue
714 ;; after point.
716 ;; goto-char doesn't signal an error at
717 ;; beginning of buffer like backward-char would
719 ;; to beginning of OSTRING
723 "Return t if POSN matches CONTEXT, nil otherwise."
728 nil
732 "Return a list (POINT-CONTEXT MARK-CONTEXT REPARSE).
733 Used by `vc-restore-buffer-context' to later restore the context."
735 ;; Use mark-marker to avoid confusion in transient-mark-mode.
738 ;; Make the right thing happen in transient-mark-mode.
740 ;; We may want to reparse the compilation buffer after revert
743 ;; Construct a list; each elt is nil or a buffer
744 ;; iff that buffer is a compilation output buffer
745 ;; that contains markers into the current buffer.
750 compilation-old-error-list
751 compilation-error-list))
766 "Restore point/mark, and reparse any affected compilation buffers.
767 CONTEXT is that which `vc-buffer-context' returns."
771 ;; Reparse affected compilation buffers.
776 ;; Record the position in the compilation buffer of
777 ;; the last error next-error went to.
780 ;; Reparse the error messages as far as they were parsed before.
782 ;; Move the pointer up to find the error we were at before
783 ;; reparsing. Now next-error should properly go to the next one.
789 ;; if necessary, restore point and mark
794 mark-context
800 "Revert buffer, trying to keep point and mark where user expects them.
801 Tries to be clever in the face of changes due to expanded version control
802 key words. This is important for typeahead to work as expected.
803 ARG and NO-CONFIRM are passed on to `revert-buffer'."
807 ;; Use save-excursion here, because it may be able to restore point
808 ;; and mark properly even in cases where vc-restore-buffer-context
809 ;; would fail. However, save-excursion might also get it wrong --
810 ;; in this case, vc-restore-buffer-context gives it a second try.
812 ;; t means don't call normal-mode;
813 ;; that's to preserve various minor modes.
819 "Make sure the current buffer and its working file are in sync.
820 NOT-URGENT means it is ok to continue if the user says not to save."
829 "Has FILE changed since last checkout?"
836 unchanged))))
839 "Default check whether FILE is unchanged: diff against master version."
843 "Force a recomputation of the version control state of FILE.
844 The state is computed using the exact, and possibly expensive
845 function `vc-BACKEND-state', not the heuristic."
849 "Do The Right Thing for a given version-controlled FILE.
850 If COMMENT is specified, it will be used as an admin or checkin comment.
851 If VERBOSE is non-nil, query the user rather than using default parameters."
853 state version)
855 ;; Check relation of buffer and file, and make sure
856 ;; user knows what he's doing. First, finding the file
857 ;; will check whether the file on disk is newer.
865 ;; Now, check if we have unsaved changes.
871 ;; Do the right thing
878 ;; up-to-date
883 ;; go to a different version
890 version))))
892 ;; check the file out
895 ;; do nothing
898 ;; Abnormal: edited but read-only
900 ;; Make the file+buffer read-write. If the user really wanted to
901 ;; commit, he'll get a chance to do that next time around, anyway.
907 ;; edited
910 ;; For files with locking, if the file does not contain
911 ;; any changes, just let go of the lock, i.e. revert.
914 ;; If buffer is modified, that means the user just
915 ;; said no to saving it; in that case, don't revert,
916 ;; because the user might intend to save after
917 ;; finishing the log entry.
919 ;; DO NOT revert the file without asking the user!
932 ;; locked by somebody else
940 state))
942 ;; needs-patch
945 "%s is not up-to-date. Get latest version? "
953 ;; needs-merge
956 "%s is not up-to-date. Merge in changes now? "
961 ;; unlocked-changes
974 ;; Must clear any headers here because they wouldn't
975 ;; show that the file is locked now.
987 "Call `vc-next-action-on-file' on all the marked files.
988 Ignores FILE and REV, but passes on COMMENT."
998 nil t))
1001 ;; Here's the major entry point.
1003 ;;;###autoload
1005 "Do the next logical checkin or checkout operation on the current file.
1007 If you call this from within a VC dired buffer with no files marked,
1008 it will operate on the file in the current line.
1010 If you call this from within a VC dired buffer, and one or more
1011 files are marked, it will accept a log message and then operate on
1012 each one. The log message will be used as a comment for any register
1013 or checkin operations, but ignored when doing checkouts. Attempted
1014 lock steals will raise an error.
1016 A prefix argument lets you specify the version number to use.
1018 For RCS and SCCS files:
1019 If the file is not already registered, this registers it for version
1020 control.
1021 If the file is registered and not locked by anyone, this checks out
1022 a writable and locked file ready for editing.
1023 If the file is checked out and locked by the calling user, this
1024 first checks to see if the file has changed since checkout. If not,
1025 it performs a revert.
1026 If the file has been changed, this pops up a buffer for entry
1027 of a log message; when the message has been entered, it checks in the
1028 resulting changes along with the log message as change commentary. If
1029 the variable `vc-keep-workfiles' is non-nil (which is its default), a
1030 read-only copy of the changed file is left in place afterwards.
1031 If the file is registered and locked by someone else, you are given
1032 the option to steal the lock.
1034 For CVS files:
1035 If the file is not already registered, this registers it for version
1037 If the file is added but not committed, it is committed.
1038 If your working file is changed, but the repository file is
1039 unchanged, this pops up a buffer for entry of a log message; when the
1040 message has been entered, it checks in the resulting changes along
1041 with the logmessage as change commentary. A writable file is retained.
1042 If the repository file is changed, you are asked if you want to
1043 merge in the changes into your working copy."
1058 "Enter a change comment for the marked files."
1067 ;;; These functions help the vc-next-action entry point
1069 ;;;###autoload
1071 "Register the current file into a version control system.
1072 With prefix argument SET-VERSION, allow user to specify initial version
1073 level. If COMMENT is present, use that as an initial comment.
1075 The version control system to use is found by cycling through the list
1076 `vc-handled-backends'. The first backend in that list which declares
1077 itself responsible for the file (usually because other files in that
1078 directory are already registered under that backend) will be used to
1079 register the file. If no backend declares itself responsible, the
1080 first backend that could register the file is used."
1088 ;; Watch out for new buffers of size 0: the corresponding file
1089 ;; does not exist yet, even though buffer-modified-p is nil.
1100 ;; TODO: Use backend-specific init version.
1101 vc-default-init-version)
1103 nil
1104 "Enter initial comment."
1118 "Return the name of a backend system that is responsible for FILE.
1119 The optional argument REGISTER means that a backend suitable for
1120 registration should be found.
1122 If REGISTER is nil, then if FILE is already registered, return the
1123 backend of FILE. If FILE is not registered, or a directory, then the
1124 first backend in `vc-handled-backends' that declares itself
1125 responsible for FILE is returned. If no backend declares itself
1126 responsible, return the first backend.
1128 If REGISTER is non-nil, return the first responsible backend under
1129 which FILE is not yet registered. If there is no such backend, return
1130 the first backend under which FILE is not yet registered, but could
1131 be registered."
1136 ;; First try: find a responsible backend. If this is for registration,
1137 ;; it must be a backend under which FILE is not yet registered.
1143 ;; no responsible backend
1145 ;; if this is not for registration, the first backend must do
1147 ;; for registration, we need to find a new backend that
1148 ;; could register FILE
1156 "Indicate whether BACKEND is reponsible for FILE.
1157 The default is to return nil always."
1158 nil)
1161 "Return non-nil if BACKEND could be used to register FILE.
1162 The default implementation returns t for all files."
1163 t)
1166 "If FILE is in the current buffer, either revert or unvisit it.
1167 The choice between revert (to see expanded keywords) and unvisit depends on
1168 `vc-keep-workfiles'. NOQUERY if non-nil inhibits confirmation for
1169 reverting. NOQUERY should be t *only* if it is known the only
1170 difference between the buffer and the file is due to version control
1171 rather than user editing!"
1176 ;; TODO: Adjusting view mode might no longer be necessary
1177 ;; after RMS change to files.el of 1999-08-08. Investigate
1178 ;; this when we install the new VC.
1191 "If FILE is currently visited, resynch its buffer."
1201 "Accept a comment for an operation on FILE revision REV.
1202 If COMMENT is nil, pop up a VC-log buffer, emit MSG, and set the
1203 action on close to ACTION. If COMMENT is a string and
1204 INITIAL-CONTENTS is non-nil, then COMMENT is used as the initial
1205 contents of the log entry buffer. If COMMENT is a string and
1206 INITIAL-CONTENTS is nil, do action immediately as if the user had
1207 entered COMMENT. If COMMENT is t, also do action immediately with an
1208 empty comment. Remember the file's buffer in `vc-parent-buffer'
1209 \(current one if no file). AFTER-HOOK specifies the local value
1210 for vc-log-operation-hook."
1238 "Retrieve a copy of the revision REV of FILE.
1239 If WRITABLE is non-nil, make sure the retrieved file is writable.
1240 REV defaults to the latest revision."
1247 file
1251 ;; Maybe the backend is not installed ;-(
1259 'up-to-date
1266 "Steal the lock on FILE."
1272 file-description owner)))
1275 nil nil nil nil
1286 ;; This is called when the notification has been sent.
1289 file
1296 "Check in FILE.
1297 The optional argument REV may be a string specifying the new version
1298 level (if nil increment the current level). COMMENT is a comment
1299 string; if omitted, a buffer is popped up to accept a comment. If
1300 INITIAL-CONTENTS is non-nil, then COMMENT is used as the initial contents
1301 of the log entry buffer.
1303 If `vc-keep-workfiles' is nil, FILE is deleted afterwards, provided
1304 that the version control system supports this mode of operation.
1306 Runs the normal hook `vc-checkin-hook'."
1308 file rev comment initial-contents
1309 "Enter a change comment."
1312 ;; "This log message intentionally left almost blank".
1313 ;; RCS 5.7 gripes about white-space-only comments too.
1317 file
1318 ;; Change buffers to get local value of vc-checkin-switches.
1330 "Enter last VC comment into change log file for current buffer's file.
1331 Optional arg (interactive prefix) non-nil means prompt for user name and site.
1332 Second arg is file name of change log. \
1333 If nil, uses `change-log-default-name'.
1335 May be useful as a `vc-checkin-hook' to update change logs automatically."
1339 ;; Make sure the defvar for add-log-current-defun-function has been executed
1340 ;; before binding it.
1344 ;; Don't let add-change-log-entry insert a defun name.
1346 end)
1347 ;; Call add-log to do half the work.
1349 ;; Insert the VC comment, leaving point before it.
1352 ;; It starts with an open-paren, as in "(foo): Frobbed."
1353 ;; So remove the ": " add-log inserted.
1355 ;; Canonicalize the white space between the file name and comment.
1357 ;; Indent rest of the text the same way add-log indented the first line.
1364 ;; Fill the inserted text, preserving open-parens at bol.
1369 ;; Canonicalize the white space at the end of the entry so it is
1370 ;; separated from the next entry by a single blank line.
1377 "Complete the operation implied by the current log entry."
1379 ;; Check and record the comment, if any.
1381 ;; Comment too long?
1386 ;; Record the comment in the comment ring
1392 ;; Sync parent buffer in case the user modified it while editing the comment.
1393 ;; But not if it is a vc-dired buffer.
1397 ;; save the parameters held in buffer-local variables
1405 ;; OK, do it to it
1408 log-file
1409 log-version
1410 log-entry))
1411 ;; Remove checkin window (after the checkin so that if that fails
1412 ;; we don't zap the *VC-log* buffer and the typing therein).
1416 ;; Kill buffer and delete any other dedicated windows/frames.
1421 ;; Now make sure we see the expanded headers
1428 ;; Code for access to the comment ring
1433 ;; Initialize the index on the first use of this command
1434 ;; so that the first M-p gets index 0, and the first M-n gets
1435 ;; index -1.
1438 len))
1441 "Cycle backwards through comment history."
1452 "Cycle forwards through comment history."
1457 "Search backwards through comment history for substring match."
1458 ;; Why substring rather than regexp ? -sm
1475 "Search forwards through comment history for substring match."
1480 ;; Additional entry points for examining version histories
1482 ;;;###autoload
1484 "Display diffs between file versions.
1485 Normally this compares the current file and buffer with the most recent
1486 checked in version of that file. This uses no arguments.
1487 With a prefix argument, it reads the file name to use
1488 and two version designators specifying which versions to compare."
1500 "For FILE, report diffs between two stored versions REL1 and REL2 of it.
1501 If FILE is a directory, generate diffs between versions for all registered
1502 files in or below it."
1506 "File or dir to diff: (default visited file) "
1508 default-directory buffer-file-name t)))
1510 ;; compute default versions based on the file state
1512 ;; if it's a directory, don't supply any version default
1514 nil)
1515 ;; if the file is not up-to-date, use current version as older version
1518 ;; if the file is not locked, use last and previous version as default
1523 ;; construct argument list
1529 nil nil rel1-default)
1534 nil nil rel2-default))))
1537 ;; recursive directory diff
1543 " and "
1547 ;; FIXME: this should do a single exec in CVS.
1549 default-directory
1557 ;; single file diff
1564 file
1569 diff-switches
1583 nil)
1585 ;; Gnus-5.8.5 sets up an autoload for diff-mode, even if it's
1586 ;; not available. Work around that.
1593 t))
1595 ;;;###autoload
1597 "Visit version REV of the current buffer in another window.
1598 If the current buffer is named `F', the version is named `F.~REV~'.
1599 If `F.~REV~' already exists, it is used instead of being re-created."
1605 rev))
1614 ;; Header-insertion code
1616 ;;;###autoload
1618 "Insert headers in a file for use with your version control system.
1619 Headers desired are inserted at point, and are pulled from
1620 the variable `vc-BACKEND-header'."
1638 hdstrings)
1643 vc-static-header-alist))
1644 )
1645 )))))
1648 "Clear all version headers in the current buffer (or FILE).
1649 I.e. reset them to the non-expanded form."
1656 ;; save-excursion may be able to relocate point and mark
1657 ;; properly. If it fails, vc-restore-buffer-context
1658 ;; will give it a second try.
1666 ;;;###autoload
1668 "Merge changes between two versions into the current buffer's file.
1669 This asks for two versions to merge from in the minibuffer. If the
1670 first version is a branch number, then merge all changes from that
1671 branch. If the first version is empty, merge news, i.e. recent changes
1672 from the current branch.
1674 See Info node `Merging'."
1681 first-version second-version status)
1703 ;; We want to merge an entire branch. Set versions
1704 ;; accordingly, so that vc-BACKEND-merge understands us.
1706 ;; first-version must be the starting point of the branch
1728 ;;;###autoload
1730 "Invoke ediff to resolve conflicts in the current buffer.
1731 The conflicts must be marked with rcsmerge conflict markers."
1780 ;; Fire up ediff.
1784 ;; Ediff is now set up, and we are in the control buffer.
1785 ;; Do a few further adjustments and take precautions for exit.
1809 nil))))
1811 ;; The VC directory major mode. Coopt Dired for this.
1812 ;; All VC commands get mapped into logical equivalents.
1821 ;; Emacs-20 has a lousy keymap inheritance that won't work here.
1822 ;; Emacs-21's is still lousy but just better enough that it'd work. -sm
1823 ;; (set-keymap-parent vmap vc-prefix-map)
1827 map))
1830 "The major mode used in VC directory buffers.
1832 It works like Dired, but lists only files under version control, with
1833 the current VC state of each file being indicated in the place of the
1834 file's link count, owner, group and size. Subdirectories are also
1835 listed, and you may insert them into the buffer as desired, like in
1836 Dired.
1838 All Dired commands operate normally, with the exception of `v', which
1839 is redefined as the version control prefix, so that you can type
1840 `vl', `v=' etc. to invoke `vc-print-log', `vc-diff', and the like on
1841 the file named in the current Dired buffer line. `vv' invokes
1842 `vc-next-action' on this file, or on all files currently marked.
1843 There is a special command, `*l', to mark all files currently locked."
1844 ;; define-derived-mode does it for us in Emacs-21, but not in Emacs-20.
1845 ;; We do it here because dired might not be loaded yet
1846 ;; when vc-dired-mode-map is initialized.
1850 ;; The following is slightly modified from dired.el,
1851 ;; because file lines look a bit different in vc-dired-mode.
1855 ;; In some locales, month abbreviations are as short as 2 letters,
1856 ;; and they can be padded on the right with spaces.
1858 ;; Recognize any non-ASCII character.
1859 ;; The purpose is to match a Kanji character.
1861 ;; (k "[^\x00-\x7f\x80-\xff]")
1870 ;; the .* below ensures that we find the last match on a line
1873 vc-dired-switches
1875 vc-dired-switches))
1880 "Toggle terse display in VC Dired."
1883 nil
1890 "Mark all files currently locked."
1910 "Reformat a directory-listing line.
1911 Replace various columns with version control information.
1912 This code, like dired, assumes UNIX -l format."
1922 limit t)
1925 limit t)
1928 limit t))
1935 "Reformat the listing according to version control.
1936 Called by dired after any portion of a vc-dired buffer has been read in."
1942 ;; subdir header line
1944 ;; if the backend supports it, get the state
1945 ;; of all files in this directory at once
1950 ;; erase (but don't remove) the "total" line
1954 ;; file line
1957 ;; subdir
1961 vc-directory-exclusion-list)
1967 ;; Don't show directories in terse mode. Don't use
1968 ;; dired-kill-line to remove it, because in recursive listings,
1969 ;; that would remove the directory contents as well.
1977 ;; ordinary file
1985 ;; any other line
1996 "Remove empty subdirs."
2007 ;; We cannot remove the top level directory.
2008 ;; Just make it look a little nicer.
2016 "Return a list of all vc-dired buffers that currently display DIR."
2018 ;; Check whether dired is loaded.
2025 result))
2028 "Update the entries for FILE in any VC Dired buffers that list it."
2034 ;; bind vc-dired-terse-mode to nil so that
2035 ;; files won't vanish when they are checked in
2038 buffers))))
2040 ;;;###autoload
2042 "Create a buffer in VC Dired Mode for directory DIR.
2044 See Info node `VC Dired Mode'.
2046 With prefix arg READ-SWITCHES, specify a value to override
2047 `dired-listing-switches' when generating the listing."
2054 vc-dired-switches)))
2059 vc-dired-switches
2063 ;; Named-configuration entry points
2066 "Scan the tree below DIR, looking for non-uptodate files.
2067 If any file is not up-to-date, return the name of the first such file.
2068 \(This means, neither snapshot creation nor retrieval is allowed.\)
2069 If one or more of the files are currently visited, return `visited'.
2070 Otherwise, return nil."
2074 dir
2078 status)))
2080 ;;;###autoload
2082 "Descending recursively from DIR, make a snapshot called NAME.
2083 For each registered file, the version level of its latest version
2084 becomes part of the named configuration. If the prefix argument
2085 BRANCHP is given, the snapshot is made as a new branch and the files
2086 are checked out in that new branch."
2090 current-prefix-arg))
2104 dir
2108 ;;;###autoload
2110 "Descending recursively from DIR, retrieve the snapshot called NAME.
2111 If NAME is empty, it refers to the latest versions.
2112 If locking is used for the files in DIR, then there must not be any
2113 locked files at or below DIR (but if NAME is empty, locked files are
2114 allowed and simply skipped)."
2132 dir
2143 dir
2149 ;; Miscellaneous other entry points
2151 ;;;###autoload
2153 "List the change log of the current buffer in a window."
2172 ;; move point to the log entry for the current version
2177 'show-log-entry
2181 "Return a string with all log entries that were made under BACKEND for FILE."
2189 "Remove all non-comment information from log output.
2190 This default implementation works for RCS logs; backends should override
2191 it if their logs are not in RCS format."
2208 ;;;###autoload
2210 "Revert the current buffer's file back to the version it was based on.
2211 This asks for confirmation if the buffer contents are not identical
2212 to that version. This function does not automatically pick up newer
2217 ;; This operation should always ask for confirmation.
2220 status)
2225 ;; vc-diff selects the new window, which is not what we want:
2226 ;; if the new window is on another frame, that'd require the user
2227 ;; moving her mouse to answer the yes-or-no-p question.
2241 ;; Do the reverting
2247 "Return name of backup file for revision REV of FILE.
2248 If version backups should be used for FILE, and there exists
2249 such a backup for REV or the current workfile version of file,
2250 return its name; otherwise return nil."
2254 backup-file
2255 ;; there is no automatic backup, but maybe the user made one manually
2258 backup-file)))))
2261 "Revert FILE back to the version it was based on."
2263 file
2273 ;;;###autoload
2275 "Get rid of most recently checked in version of this file.
2276 A prefix argument NOREVERT means do not revert the buffer afterwards."
2289 (error (substitute-command-keys "File is not up to date; use \\[vc-revert-buffer] to discard changes"))))
2297 file
2301 0
2310 ;; inhibit backup for this buffer
2321 ;;;autoload
2323 "Make BACKEND the current version control system for FILE.
2324 FILE must already be registered in BACKEND. The change is not
2325 permanent, only for the current session. This function only changes
2326 VC's perspective on FILE, it does not register or unregister it.
2327 By default, this command cycles through the registered backends.
2328 To get a prompt, use a prefix argument."
2331 buffer-file-name
2334 ;; Find the registered backends.
2338 ;; Find the next backend.
2354 ;; Force recomputation of the state
2360 ;;;autoload
2362 "Transfer FILE to another version control system NEW-BACKEND.
2363 If NEW-BACKEND has a higher precedence than FILE's current backend
2364 \(i.e. it comes earlier in `vc-handled-backends'), then register FILE in
2365 NEW-BACKEND, using the version number from the current backend as the
2366 base level. If NEW-BACKEND has a lower precedence than the current
2367 backend, then commit all changes that were made under the current
2368 backend to NEW-BACKEND, and unregister FILE from the current backend.
2369 \(If FILE is not yet registered under NEW-BACKEND, register it.)"
2375 ;; move if new-backend comes later in vc-handled-backends
2383 ;; `registered' might have switched under us.
2388 ;; Go back to the base unmodified file.
2393 ;; If we have a local copy of the unmodified file, handle that
2394 ;; here and not in vc-revert-file because we don't want to
2395 ;; delete that copy -- it is still useful for OLD-BACKEND.
2418 "Default implementation of `vc-unregister', signals an error."
2422 "Let BACKEND receive FILE from another version control system."
2426 "Rename OLDMASTER to be the master file for NEWFILE based on TEMPLATES."
2431 ;; List of potential master files for `newfile'
2434 templates)))
2439 oldmaster
2441 ;; If possible, keep the master file in the same directory.
2444 dir))
2446 masters)
2447 ;; If not, just use the first possible place.
2453 masters)
2456 ;;;###autoload
2458 "Rename file OLD to NEW, and rename its master file likewise."
2460 ;; There are several ways of renaming files under CVS 1.3, but they all
2461 ;; have serious disadvantages. See the FAQ (available from think.com in
2462 ;; pub/cvs/). I'd rather send the user an error, than do something he might
2463 ;; consider to be wrong. When the famous, long-awaited rename database is
2464 ;; implemented things might change for the better. This is unlikely to occur
2465 ;; until CVS 2.0 is released. --ceder 1994-01-23 21:27:51
2480 ;; Move the actual file (unless the backend did it already)
2483 ;; ?? Renaming a file might change its contents due to keyword expansion.
2484 ;; We should really check out a new copy if the old copy was precisely equal
2485 ;; to some checked in version. However, testing for this is tricky....
2494 ;; Only defined in very recent Emacsen
2497 ;;;###autoload
2499 "Find change log file and add entries from recent version control logs.
2500 Normally, find log entries for all registered files in the default
2501 directory.
2503 With prefix arg of \\[universal-argument], only find log entries for the current buffer's file.
2505 With any numeric prefix arg, find log entries for all currently visited
2506 files that are under version control. This puts all the entries in the
2507 log for the default directory, which may not be appropriate.
2509 From a program, any ARGS are assumed to be filenames for which
2510 log entries should be gathered."
2517 file)
2523 files))
2525 ;; Don't supply any filenames to backend; this means
2526 ;; it should find all relevant files relative to
2527 ;; the default-directory.
2528 nil)))
2533 "Default implementation of update-changelog.
2534 Uses `rcs2log' which only works for RCS and CVS."
2535 ;; FIXME: We (c|sh)ould add support for cvs2cl
2538 ;; Presumably not portable to non-Unixy systems, along with rcs2log:
2543 temporary-file-directory))))
2549 user-mail-address)))
2563 exec-directory)
2565 "-c" changelog
2573 f
2575 files)))
2576 "done"
2585 ;;; Annotate functionality
2587 ;; Declare globally instead of additional parameter to
2588 ;; temp-buffer-show-function (not possible to pass more than one
2589 ;; parameter).
2595 Return NIL if no match made. Associations are made based on
2596 `vc-annotate-buffers'."
2600 "Major mode for buffers displaying output from the `annotate' command.
2602 You can use the mode-specific menu to alter the time-span of the used
2603 colors. See variable `vc-annotate-menu-elements' for customizing the
2604 menu items."
2608 "Use the default color spectrum for VC Annotate mode."
2612 nil
2617 "Add the menu 'Annotate' to the menu bar in VC-Annotate mode."
2622 '("Default" . vc-annotate-display-default))
2623 (let ((menu-elements vc-annotate-menu-elements))
2624 (while menu-elements
2625 (let* ((element (car menu-elements))
2626 (days (round (* element
2627 (vc-annotate-car-last-cons vc-annotate-color-map)
2628 0.7585))))
2629 (setq menu-elements (cdr menu-elements))
2630 (define-key vc-annotate-mode-menu
2631 (vector days)
2632 (cons (format "Span %d days"
2633 days)
2634 `(lambda ()
2635 ,(format "Use colors spanning %d days" days)
2636 (interactive)
2637 (message "Redisplaying annotation...")
2638 (vc-annotate-display
2639 (get-buffer (buffer-name))
2640 (vc-annotate-time-span vc-annotate-color-map ,element)
2641 (vc-annotate-get-backend (current-buffer)))
2642 (message "Redisplaying annotation...done"))))))))
2645 ;;;; (defun vc-BACKEND-annotate-command (file buffer) ...)
2646 ;;;; Execute "annotate" on FILE by using `call-process' and insert
2647 ;;;; the contents in BUFFER.
2649 ;;;###autoload
2650 (defun vc-annotate (prefix)
2653 are displayed in red, old in blue. When given a prefix argument, asks
2654 for a version to annotate from, and a factor for stretching the time
2655 scale.
2657 `vc-annotate-menu-elements' customizes the menu elements of the
2658 mode-specific menu. `vc-annotate-color-map' and
2659 `vc-annotate-very-old-color' defines the mapping of time to
2660 colors. `vc-annotate-background' specifies the background color."
2661 (interactive "P")
2662 (vc-ensure-vc-buffer)
2663 (let ((temp-buffer-name (concat "*Annotate " (buffer-name) "*"))
2664 (temp-buffer-show-function 'vc-annotate-display)
2665 (vc-annotate-version
2666 (if prefix (read-string
2667 (format "Annotate from version: (default %s) "
2668 (vc-workfile-version (buffer-file-name)))
2669 nil nil (vc-workfile-version (buffer-file-name)))))
2670 (vc-annotate-ratio
2671 (if prefix (string-to-number
2672 (read-string "Annotate ratio: (default 1.0) "
2673 nil nil "1.0"))))
2674 (vc-annotate-backend (vc-backend (buffer-file-name))))
2675 (message "Annotating...")
2676 (if (not (vc-find-backend-function vc-annotate-backend 'annotate-command))
2677 (error "Sorry, annotating is not implemented for %s"
2678 vc-annotate-backend))
2679 (with-output-to-temp-buffer temp-buffer-name
2680 (vc-call-backend vc-annotate-backend 'annotate-command
2681 (file-name-nondirectory (buffer-file-name))
2682 (get-buffer temp-buffer-name)
2683 vc-annotate-version))
2684 ;; Don't use the temp-buffer-name until the buffer is created
2685 ;; (only after `with-output-to-temp-buffer'.)
2686 (setq vc-annotate-buffers
2687 (append vc-annotate-buffers
2688 (list (cons (get-buffer temp-buffer-name) vc-annotate-backend)))))
2689 (message "Annotating... done"))
2692 (defun vc-annotate-car-last-cons (a-list)
2693 "Return car of last cons in association list A-LIST."
2694 (if (not (eq nil (cdr a-list)))
2695 (vc-annotate-car-last-cons (cdr a-list))
2696 (car (car a-list))))
2698 (defun vc-annotate-time-span (a-list span &optional quantize)
2699 "Apply factor SPAN to the time-span of association list A-LIST.
2700 Return the new alist.
2701 Optionally quantize to the factor of QUANTIZE."
2702 ;; Apply span to each car of every cons
2703 (if (not (eq nil a-list))
2704 (append (list (cons (* (car (car a-list)) span)
2705 (cdr (car a-list))))
2706 (vc-annotate-time-span (nthcdr (or quantize ; optional
2707 1) ; Default to cdr
2708 a-list) span quantize))))
2710 (defun vc-annotate-compcar (threshold a-list)
2711 "Test successive cons cells of association list A-LIST against THRESHOLD.
2712 Return the first cons cell which car is not less than THRESHOLD,
2713 nil otherwise"
2714 (let ((i 1)
2715 (tmp-cons (car a-list)))
2716 (while (and tmp-cons (< (car tmp-cons) threshold))
2717 (setq tmp-cons (car (nthcdr i a-list)))
2718 (setq i (+ i 1)))
2719 tmp-cons)) ; Return the appropriate value
2722 ;;;; (defun vc-BACKEND-annotate-difference (point) ...)
2723 ;;;;
2724 ;;;; Return the difference between the age of the line at point and
2725 ;;;; the current time. Return NIL if there is no more comparison to
2726 ;;;; be made in the buffer. Return value as defined for
2727 ;;;; `current-time'. You can safely assume that point is placed at
2728 ;;;; the beginning of each line, starting at `point-min'. The buffer
2729 ;;;; that point is placed in is the Annotate output, as defined by
2730 ;;;; the relevant backend.
2732 (defun vc-annotate-display (buffer &optional color-map backend)
2733 "Do the VC-Annotate display in BUFFER using COLOR-MAP.
2734 The original annotating file is supposed to be handled by BACKEND.
2735 If BACKEND is NIL, variable VC-ANNOTATE-BACKEND is used instead.
2736 This function is destructive on VC-ANNOTATE-BACKEND when BACKEND is non-nil."
2738 ;; Handle the case of the global variable vc-annotate-ratio being
2739 ;; set. This variable is used to pass information from function
2740 ;; vc-annotate since it is not possible to use another parameter
2741 ;; (see temp-buffer-show-function).
2742 (if (and (not color-map) vc-annotate-ratio)
2743 ;; This will only be true if called from vc-annotate with ratio
2744 ;; being non-nil.
2745 (setq color-map (vc-annotate-time-span vc-annotate-color-map
2746 vc-annotate-ratio)))
2747 (set-buffer buffer)
2748 (display-buffer buffer)
2749 (if (not vc-annotate-mode) ; Turn on vc-annotate-mode if not done
2750 (vc-annotate-mode))
2751 (goto-char (point-min)) ; Position at the top of the buffer.
2752 ;; Delete old overlays
2753 (mapcar
2754 (lambda (overlay)
2755 (if (overlay-get overlay 'vc-annotation)
2756 (delete-overlay overlay)))
2757 (overlays-in (point-min) (point-max)))
2758 (goto-char (point-min)) ; Position at the top of the buffer.
2760 (if backend (setq vc-annotate-backend backend)) ; Destructive on `vc-annotate-backend'
2762 (let ((difference (vc-call-backend vc-annotate-backend 'annotate-difference (point))))
2763 (while difference
2764 (let*
2765 ((color (or (vc-annotate-compcar
2766 difference (or color-map vc-annotate-color-map))
2767 (cons nil vc-annotate-very-old-color)))
2768 ;; substring from index 1 to remove any leading `#' in the name
2769 (face-name (concat "vc-annotate-face-" (substring (cdr color) 1)))
2770 ;; Make the face if not done.
2771 (face (or (intern-soft face-name)
2772 (let ((tmp-face (make-face (intern face-name))))
2773 (set-face-foreground tmp-face (cdr color))
2774 (if vc-annotate-background
2775 (set-face-background tmp-face vc-annotate-background))
2776 tmp-face))) ; Return the face
2777 (point (point))
2778 overlay)
2779 (forward-line 1)
2780 (setq overlay (make-overlay point (point)))
2781 (overlay-put overlay 'face face)
2782 (overlay-put overlay 'vc-annotation t))
2783 (setq difference (vc-call-backend vc-annotate-backend 'annotate-difference (point))))))
2785 \f
2786 ;; Collect back-end-dependent stuff here
2788 (defalias 'vc-default-logentry-check 'ignore)
2790 (defun vc-check-headers ()
2791 "Check if the current file has any headers in it."
2792 (interactive)
2793 (vc-call-backend (vc-backend buffer-file-name) 'check-headers))
2795 (defun vc-default-check-headers (backend)
2796 "Default implementation of check-headers; always returns nil."
2797 nil)
2799 ;; Back-end-dependent stuff ends here.
2801 ;; Set up key bindings for use while editing log messages
2803 (define-derived-mode vc-log-mode text-mode "VC-Log"
2804 "Major mode for editing VC log entries.
2805 These bindings are added to the global keymap when you enter this mode:
2819 While you are entering a change log message for a version, the following
2820 additional bindings will be in effect.
2824 Whenever you do a checkin, your log comment is added to a ring of
2825 saved comments. These can be recalled as follows:
2832 Entry to the change-log submode calls the value of `text-mode-hook', then
2833 the value of `vc-log-mode-hook'.
2835 Global user options:
2836 `vc-initial-comment' If non-nil, require user to enter a change
2837 comment upon first checkin of the file.
2839 `vc-keep-workfiles' Non-nil value prevents workfiles from being
2840 deleted when changes are checked in
2842 `vc-suppress-confirm' Suppresses some confirmation prompts.
2844 vc-BACKEND-header Which keywords to insert when adding headers
2847 RCS and CVS.
2849 `vc-static-header-alist' By default, version headers inserted in C files
2850 get stuffed in a static string area so that
2851 ident(RCS/CVS) or what(SCCS) can see them in
2852 the compiled object code. You can override
2853 this by setting this variable to nil, or change
2854 the header template by changing it.
2856 `vc-command-messages' if non-nil, display run messages from the
2857 actual version-control utilities (this is
2858 intended primarily for people hacking vc
2859 itself)."
2860 (make-local-variable 'vc-comment-ring-index))
2862 (defun vc-log-edit (file)
2863 "Set up `log-edit' for use with VC on FILE.
2864 If `log-edit' is not available, resort to `vc-log-mode'."
2865 (setq default-directory
2866 (if file (file-name-directory file)
2867 (with-current-buffer vc-parent-buffer default-directory)))
2868 (if (fboundp 'log-edit)
2869 (log-edit 'vc-finish-logentry nil
2870 (if file `(lambda () ',(list (file-name-nondirectory file)))
2871 ;; If FILE is nil, we were called from vc-dired.
2872 (lambda ()
2873 (with-current-buffer vc-parent-buffer
2874 (dired-get-marked-files t)))))
2875 (vc-log-mode))
2876 (set (make-local-variable 'vc-log-file) file)
2877 (make-local-variable 'vc-log-version)
2878 (set-buffer-modified-p nil)
2879 (setq buffer-file-name nil))
2881 ;;; These things should probably be generally available
2883 (defun vc-file-tree-walk (dirname func &rest args)
2884 "Walk recursively through DIRNAME.
2885 Invoke FUNC f ARGS on each VC-managed file f underneath it."
2886 (vc-file-tree-walk-internal (expand-file-name dirname) func args)
2887 (message "Traversing directory %s...done" dirname))
2889 (defun vc-file-tree-walk-internal (file func args)
2890 (if (not (file-directory-p file))
2891 (if (vc-backend file) (apply func file args))
2892 (message "Traversing directory %s..." (abbreviate-file-name file))
2893 (let ((dir (file-name-as-directory file)))
2894 (mapcar
2895 (lambda (f) (or
2896 (string-equal f ".")
2897 (string-equal f "..")
2898 (member f vc-directory-exclusion-list)
2899 (let ((dirf (expand-file-name f dir)))
2900 (or
2901 (file-symlink-p dirf);; Avoid possible loops
2902 (vc-file-tree-walk-internal dirf func args)))))
2903 (directory-files dir)))))
2905 (provide 'vc)
2907 ;;; DEVELOPER'S NOTES ON CONCURRENCY PROBLEMS IN THIS CODE
2908 ;;;
2909 ;;; These may be useful to anyone who has to debug or extend the package.
2910 ;;; (Note that this information corresponds to versions 5.x. Some of it
2911 ;;; might have been invalidated by the additions to support branching
2912 ;;; and RCS keyword lookup. AS, 1995/03/24)
2913 ;;;
2914 ;;; A fundamental problem in VC is that there are time windows between
2915 ;;; vc-next-action's computations of the file's version-control state and
2916 ;;; the actions that change it. This is a window open to lossage in a
2917 ;;; multi-user environment; someone else could nip in and change the state
2918 ;;; of the master during it.
2919 ;;;
2920 ;;; The performance problem is that rlog/prs calls are very expensive; we want
2921 ;;; to avoid them as much as possible.
2922 ;;;
2923 ;;; ANALYSIS:
2924 ;;;
2925 ;;; The performance problem, it turns out, simplifies in practice to the
2926 ;;; problem of making vc-state fast. The two other functions that call
2927 ;;; prs/rlog will not be so commonly used that the slowdown is a problem; one
2928 ;;; makes snapshots, the other deletes the calling user's last change in the
2929 ;;; master.
2930 ;;;
2931 ;;; The race condition implies that we have to either (a) lock the master
2932 ;;; during the entire execution of vc-next-action, or (b) detect and
2933 ;;; recover from errors resulting from dispatch on an out-of-date state.
2934 ;;;
2935 ;;; Alternative (a) appears to be infeasible. The problem is that we can't
2936 ;;; guarantee that the lock will ever be removed. Suppose a user starts a
2937 ;;; checkin, the change message buffer pops up, and the user, having wandered
2938 ;;; off to do something else, simply forgets about it?
2939 ;;;
2940 ;;; Alternative (b), on the other hand, works well with a cheap way to speed up
2941 ;;; vc-state. Usually, if a file is registered, we can read its locked/
2942 ;;; unlocked state and its current owner from its permissions.
2943 ;;;
2944 ;;; This shortcut will fail if someone has manually changed the workfile's
2945 ;;; permissions; also if developers are munging the workfile in several
2946 ;;; directories, with symlinks to a master (in this latter case, the
2947 ;;; permissions shortcut will fail to detect a lock asserted from another
2948 ;;; directory).
2949 ;;;
2950 ;;; Note that these cases correspond exactly to the errors which could happen
2951 ;;; because of a competing checkin/checkout race in between two instances of
2952 ;;; vc-next-action.
2953 ;;;
2954 ;;; For VC's purposes, a workfile/master pair may have the following states:
2955 ;;;
2956 ;;; A. Unregistered. There is a workfile, there is no master.
2957 ;;;
2958 ;;; B. Registered and not locked by anyone.
2959 ;;;
2960 ;;; C. Locked by calling user and unchanged.
2961 ;;;
2962 ;;; D. Locked by the calling user and changed.
2963 ;;;
2964 ;;; E. Locked by someone other than the calling user.
2965 ;;;
2966 ;;; This makes for 25 states and 20 error conditions. Here's the matrix:
2967 ;;;
2968 ;;; VC's idea of state
2969 ;;; |
2970 ;;; V Actual state RCS action SCCS action Effect
2971 ;;; A B C D E
2972 ;;; A . 1 2 3 4 ci -u -t- admin -fb -i<file> initial admin
2973 ;;; B 5 . 6 7 8 co -l get -e checkout
2974 ;;; C 9 10 . 11 12 co -u unget; get revert
2975 ;;; D 13 14 15 . 16 ci -u -m<comment> delta -y<comment>; get checkin
2976 ;;; E 17 18 19 20 . rcs -u -M -l unget -n ; get -g steal lock
2977 ;;;
2978 ;;; All commands take the master file name as a last argument (not shown).
2979 ;;;
2980 ;;; In the discussion below, a "self-race" is a pathological situation in
2981 ;;; which VC operations are being attempted simultaneously by two or more
2982 ;;; Emacsen running under the same username.
2983 ;;;
2984 ;;; The vc-next-action code has the following windows:
2985 ;;;
2986 ;;; Window P:
2987 ;;; Between the check for existence of a master file and the call to
2988 ;;; admin/checkin in vc-buffer-admin (apparent state A). This window may
2989 ;;; never close if the initial-comment feature is on.
2990 ;;;
2991 ;;; Window Q:
2992 ;;; Between the call to vc-workfile-unchanged-p in and the immediately
2993 ;;; following revert (apparent state C).
2994 ;;;
2995 ;;; Window R:
2996 ;;; Between the call to vc-workfile-unchanged-p in and the following
2997 ;;; checkin (apparent state D). This window may never close.
2998 ;;;
2999 ;;; Window S:
3000 ;;; Between the unlock and the immediately following checkout during a
3001 ;;; revert operation (apparent state C). Included in window Q.
3002 ;;;
3003 ;;; Window T:
3004 ;;; Between vc-state and the following checkout (apparent state B).
3005 ;;;
3006 ;;; Window U:
3007 ;;; Between vc-state and the following revert (apparent state C).
3008 ;;; Includes windows Q and S.
3009 ;;;
3010 ;;; Window V:
3011 ;;; Between vc-state and the following checkin (apparent state
3012 ;;; D). This window may never be closed if the user fails to complete the
3013 ;;; checkin message. Includes window R.
3014 ;;;
3015 ;;; Window W:
3016 ;;; Between vc-state and the following steal-lock (apparent
3017 ;;; state E). This window may never close if the user fails to complete
3018 ;;; the steal-lock message. Includes window X.
3019 ;;;
3020 ;;; Window X:
3021 ;;; Between the unlock and the immediately following re-lock during a
3022 ;;; steal-lock operation (apparent state E). This window may never close
3023 ;;; if the user fails to complete the steal-lock message.
3024 ;;;
3025 ;;; Errors:
3026 ;;;
3027 ;;; Apparent state A ---
3028 ;;;
3029 ;;; 1. File looked unregistered but is actually registered and not locked.
3030 ;;;
3031 ;;; Potential cause: someone else's admin during window P, with
3032 ;;; caller's admin happening before their checkout.
3033 ;;;
3034 ;;; RCS: Prior to version 5.6.4, ci fails with message
3035 ;;; "no lock set by <user>". From 5.6.4 onwards, VC uses the new
3036 ;;; ci -i option and the message is "<file>,v: already exists".
3037 ;;; SCCS: admin will fail with error (ad19).
3038 ;;;
3039 ;;; We can let these errors be passed up to the user.
3040 ;;;
3041 ;;; 2. File looked unregistered but is actually locked by caller, unchanged.
3042 ;;;
3043 ;;; Potential cause: self-race during window P.
3044 ;;;
3045 ;;; RCS: Prior to version 5.6.4, reverts the file to the last saved
3046 ;;; version and unlocks it. From 5.6.4 onwards, VC uses the new
3047 ;;; ci -i option, failing with message "<file>,v: already exists".
3048 ;;; SCCS: will fail with error (ad19).
3049 ;;;
3050 ;;; Either of these consequences is acceptable.
3051 ;;;
3052 ;;; 3. File looked unregistered but is actually locked by caller, changed.
3053 ;;;
3054 ;;; Potential cause: self-race during window P.
3055 ;;;
3056 ;;; RCS: Prior to version 5.6.4, VC registers the caller's workfile as
3057 ;;; a delta with a null change comment (the -t- switch will be
3058 ;;; ignored). From 5.6.4 onwards, VC uses the new ci -i option,
3059 ;;; failing with message "<file>,v: already exists".
3060 ;;; SCCS: will fail with error (ad19).
3061 ;;;
3062 ;;; 4. File looked unregistered but is locked by someone else.
3063 ;;;
3064 ;;; Potential cause: someone else's admin during window P, with
3065 ;;; caller's admin happening *after* their checkout.
3066 ;;;
3067 ;;; RCS: Prior to version 5.6.4, ci fails with a
3068 ;;; "no lock set by <user>" message. From 5.6.4 onwards,
3069 ;;; VC uses the new ci -i option, failing with message
3070 ;;; "<file>,v: already exists".
3071 ;;; SCCS: will fail with error (ad19).
3072 ;;;
3073 ;;; We can let these errors be passed up to the user.
3074 ;;;
3075 ;;; Apparent state B ---
3076 ;;;
3077 ;;; 5. File looked registered and not locked, but is actually unregistered.
3078 ;;;
3079 ;;; Potential cause: master file got nuked during window P.
3080 ;;;
3081 ;;; RCS: will fail with "RCS/<file>: No such file or directory"
3082 ;;; SCCS: will fail with error ut4.
3083 ;;;
3084 ;;; We can let these errors be passed up to the user.
3085 ;;;
3086 ;;; 6. File looked registered and not locked, but is actually locked by the
3087 ;;; calling user and unchanged.
3088 ;;;
3089 ;;; Potential cause: self-race during window T.
3090 ;;;
3091 ;;; RCS: in the same directory as the previous workfile, co -l will fail
3092 ;;; with "co error: writable foo exists; checkout aborted". In any other
3093 ;;; directory, checkout will succeed.
3094 ;;; SCCS: will fail with ge17.
3095 ;;;
3096 ;;; Either of these consequences is acceptable.
3097 ;;;
3098 ;;; 7. File looked registered and not locked, but is actually locked by the
3099 ;;; calling user and changed.
3100 ;;;
3101 ;;; As case 6.
3102 ;;;
3103 ;;; 8. File looked registered and not locked, but is actually locked by another
3104 ;;; user.
3105 ;;;
3106 ;;; Potential cause: someone else checks it out during window T.
3107 ;;;
3108 ;;; RCS: co error: revision 1.3 already locked by <user>
3109 ;;; SCCS: fails with ge4 (in directory) or ut7 (outside it).
3110 ;;;
3111 ;;; We can let these errors be passed up to the user.
3112 ;;;
3113 ;;; Apparent state C ---
3114 ;;;
3115 ;;; 9. File looks locked by calling user and unchanged, but is unregistered.
3116 ;;;
3117 ;;; As case 5.
3118 ;;;
3119 ;;; 10. File looks locked by calling user and unchanged, but is actually not
3120 ;;; locked.
3121 ;;;
3122 ;;; Potential cause: a self-race in window U, or by the revert's
3123 ;;; landing during window X of some other user's steal-lock or window S
3124 ;;; of another user's revert.
3125 ;;;
3126 ;;; RCS: succeeds, refreshing the file from the identical version in
3127 ;;; the master.
3128 ;;; SCCS: fails with error ut4 (p file nonexistent).
3129 ;;;
3130 ;;; Either of these consequences is acceptable.
3131 ;;;
3132 ;;; 11. File is locked by calling user. It looks unchanged, but is actually
3133 ;;; changed.
3134 ;;;
3135 ;;; Potential cause: the file would have to be touched by a self-race
3136 ;;; during window Q.
3137 ;;;
3138 ;;; The revert will succeed, removing whatever changes came with
3139 ;;; the touch. It is theoretically possible that work could be lost.
3140 ;;;
3141 ;;; 12. File looks like it's locked by the calling user and unchanged, but
3142 ;;; it's actually locked by someone else.
3143 ;;;
3144 ;;; Potential cause: a steal-lock in window V.
3145 ;;;
3146 ;;; RCS: co error: revision <rev> locked by <user>; use co -r or rcs -u
3147 ;;; SCCS: fails with error un2
3148 ;;;
3149 ;;; We can pass these errors up to the user.
3150 ;;;
3151 ;;; Apparent state D ---
3152 ;;;
3153 ;;; 13. File looks like it's locked by the calling user and changed, but it's
3154 ;;; actually unregistered.
3155 ;;;
3156 ;;; Potential cause: master file got nuked during window P.
3157 ;;;
3158 ;;; RCS: Prior to version 5.6.4, checks in the user's version as an
3159 ;;; initial delta. From 5.6.4 onwards, VC uses the new ci -j
3160 ;;; option, failing with message "no such file or directory".
3161 ;;; SCCS: will fail with error ut4.
3162 ;;;
3163 ;;; This case is kind of nasty. Under RCS prior to version 5.6.4,
3164 ;;; VC may fail to detect the loss of previous version information.
3165 ;;;
3166 ;;; 14. File looks like it's locked by the calling user and changed, but it's
3167 ;;; actually unlocked.
3168 ;;;
3169 ;;; Potential cause: self-race in window V, or the checkin happening
3170 ;;; during the window X of someone else's steal-lock or window S of
3171 ;;; someone else's revert.
3172 ;;;
3173 ;;; RCS: ci will fail with "no lock set by <user>".
3174 ;;; SCCS: delta will fail with error ut4.
3175 ;;;
3176 ;;; 15. File looks like it's locked by the calling user and changed, but it's
3177 ;;; actually locked by the calling user and unchanged.
3178 ;;;
3179 ;;; Potential cause: another self-race --- a whole checkin/checkout
3180 ;;; sequence by the calling user would have to land in window R.
3181 ;;;
3182 ;;; SCCS: checks in a redundant delta and leaves the file unlocked as usual.
3183 ;;; RCS: reverts to the file state as of the second user's checkin, leaving
3184 ;;; the file unlocked.
3185 ;;;
3186 ;;; It is theoretically possible that work could be lost under RCS.
3187 ;;;
3188 ;;; 16. File looks like it's locked by the calling user and changed, but it's
3189 ;;; actually locked by a different user.
3190 ;;;
3191 ;;; RCS: ci error: no lock set by <user>
3192 ;;; SCCS: unget will fail with error un2
3193 ;;;
3194 ;;; We can pass these errors up to the user.
3195 ;;;
3196 ;;; Apparent state E ---
3197 ;;;
3198 ;;; 17. File looks like it's locked by some other user, but it's actually
3199 ;;; unregistered.
3200 ;;;
3201 ;;; As case 13.
3202 ;;;
3203 ;;; 18. File looks like it's locked by some other user, but it's actually
3204 ;;; unlocked.
3205 ;;;
3206 ;;; Potential cause: someone released a lock during window W.
3207 ;;;
3208 ;;; RCS: The calling user will get the lock on the file.
3209 ;;; SCCS: unget -n will fail with cm4.
3210 ;;;
3211 ;;; Either of these consequences will be OK.
3212 ;;;
3213 ;;; 19. File looks like it's locked by some other user, but it's actually
3214 ;;; locked by the calling user and unchanged.
3215 ;;;
3216 ;;; Potential cause: the other user relinquishing a lock followed by
3217 ;;; a self-race, both in window W.
3218 ;;;
3219 ;;; Under both RCS and SCCS, both unlock and lock will succeed, making
3220 ;;; the sequence a no-op.
3221 ;;;
3222 ;;; 20. File looks like it's locked by some other user, but it's actually
3223 ;;; locked by the calling user and changed.
3224 ;;;
3225 ;;; As case 19.
3226 ;;;
3227 ;;; PROBLEM CASES:
3228 ;;;
3229 ;;; In order of decreasing severity:
3230 ;;;
3231 ;;; Cases 11 and 15 are the only ones that potentially lose work.
3232 ;;; They would require a self-race for this to happen.
3233 ;;;
3234 ;;; Case 13 in RCS loses information about previous deltas, retaining
3235 ;;; only the information in the current workfile. This can only happen
3236 ;;; if the master file gets nuked in window P.
3237 ;;;
3238 ;;; Case 3 in RCS and case 15 under SCCS insert a redundant delta with
3239 ;;; no change comment in the master. This would require a self-race in
3240 ;;; window P or R respectively.
3241 ;;;
3242 ;;; Cases 2, 10, 19 and 20 do extra work, but make no changes.
3243 ;;;
3244 ;;; Unfortunately, it appears to me that no recovery is possible in these
3245 ;;; cases. They don't yield error messages, so there's no way to tell that
3246 ;;; a race condition has occurred.
3247 ;;;
3248 ;;; All other cases don't change either the workfile or the master, and
3249 ;;; trigger command errors which the user will see.
3250 ;;;
3251 ;;; Thus, there is no explicit recovery code.
3253 ;;; vc.el ends here