1 ;;; vc.el --- drive a version-control system from within Emacs
3 ;; Copyright (C) 1992, 93, 94, 95, 96 Free Software Foundation, Inc.
5 ;; Author: Eric S. Raymond <esr@snark.thyrsus.com>
6 ;; Maintainer: Andre Spiegel <spiegel@inf.fu-berlin.de>
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software; you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation; either version 2, or (at your option)
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs; see the file COPYING. If not, write to the
22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23 ;; Boston, MA 02111-1307, USA.
27 ;; This mode is fully documented in the Emacs user's manual.
29 ;; This was designed and implemented by Eric Raymond <esr@snark.thyrsus.com>.
30 ;; Paul Eggert <eggert@twinsun.com>, Sebastian Kremer <sk@thp.uni-koeln.de>,
31 ;; and Richard Stallman contributed valuable criticism, support, and testing.
32 ;; CVS support was added by Per Cederqvist <ceder@lysator.liu.se>
33 ;; in Jan-Feb 1994. Further enhancements came from ttn.netcom.com and
34 ;; Andre Spiegel <spiegel@inf.fu-berlin.de>.
36 ;; Supported version-control systems presently include SCCS, RCS, and CVS.
38 ;; Some features will not work with old RCS versions. Where
39 ;; appropriate, VC finds out which version you have, and allows or
40 ;; disallows those features (stealing locks, for example, works only
41 ;; from 5.6.2 onwards).
42 ;; Even initial checkins will fail if your RCS version is so old that ci
43 ;; doesn't understand -t-; this has been known to happen to people running
46 ;; You can support the RCS -x option by adding pairs to the
47 ;; vc-master-templates list.
49 ;; Proper function of the SCCS diff commands requires the shellscript vcdiff
50 ;; to be installed somewhere on Emacs's path for executables.
52 ;; If your site uses the ChangeLog convention supported by Emacs, the
53 ;; function vc-comment-to-change-log should prove a useful checkin hook.
55 ;; This code depends on call-process passing back the subprocess exit
56 ;; status. Thus, you need Emacs 18.58 or later to run it. For the
57 ;; vc-directory command to work properly as documented, you need 19.
58 ;; You also need Emacs 19's ring.el.
60 ;; The vc code maintains some internal state in order to reduce expensive
61 ;; version-control operations to a minimum. Some names are only computed
62 ;; once. If you perform version control operations with RCS/SCCS/CVS while
63 ;; vc's back is turned, or move/rename master files while vc is running,
64 ;; vc may get seriously confused. Don't do these things!
66 ;; Developer's notes on some concurrency issues are included at the end of
73 (eval-when-compile (require 'dired)) ; for dired-map-over-marks macro
75 (if (not (assoc 'vc-parent-buffer minor-mode-alist))
76 (setq minor-mode-alist
77 (cons '(vc-parent-buffer vc-parent-buffer-name)
80 ;; To implement support for a new version-control system, add another
81 ;; branch to the vc-backend-dispatch macro and fill it in in each
82 ;; call. The variable vc-master-templates in vc-hooks.el will also
85 (defmacro vc-backend-dispatch (f s r c)
86 "Execute FORM1, FORM2 or FORM3 for SCCS, RCS or CVS respectively.
87 If FORM3 is `RCS', use FORM2 for CVS as well as RCS.
88 \(CVS shares some code with RCS)."
89 (list 'let (list (list 'type (list 'vc-backend f)))
91 (list (list 'eq 'type (quote 'SCCS)) s) ;; SCCS
92 (list (list 'eq 'type (quote 'RCS)) r) ;; RCS
93 (list (list 'eq 'type (quote 'CVS)) ;; CVS
97 ;; General customization
99 (defvar vc-suppress-confirm nil
100 "*If non-nil, treat user as expert; suppress yes-no prompts on some things.")
101 (defvar vc-initial-comment nil
102 "*If non-nil, prompt for initial comment when a file is registered.")
103 (defvar vc-command-messages nil
104 "*If non-nil, display run messages from back-end commands.")
105 (defvar vc-register-switches nil
106 "*A string or list of strings specifying extra switches passed
107 to the register program by \\[vc-register].")
108 (defvar vc-checkin-switches nil
109 "*A string or list of strings specifying extra switches passed
110 to the checkin program by \\[vc-checkin].")
111 (defvar vc-checkout-switches nil
112 "*A string or list of strings specifying extra switches passed
113 to the checkout program by \\[vc-checkout].")
114 (defvar vc-directory-exclusion-list '("SCCS" "RCS" "CVS")
115 "*A list of directory names ignored by functions that recursively
118 (defconst vc-maximum-comment-ring-size 32
119 "Maximum number of saved comments in the comment ring.")
121 ;;; This is duplicated in diff.el.
122 (defvar diff-switches "-c"
123 "*A string or list of strings specifying switches to be be passed to diff.")
126 (defvar vc-checkin-hook nil
127 "*List of functions called after a checkin is done. See `run-hooks'.")
129 ;; Header-insertion hair
131 (defvar vc-header-alist
132 '((SCCS "\%W\%") (RCS "\$Id\$") (CVS "\$Id\$"))
133 "*Header keywords to be inserted by `vc-insert-headers'.
134 Must be a list of two-element lists, the first element of each must
135 be `RCS', `CVS', or `SCCS'. The second element is the string to
136 be inserted for this particular backend.")
137 (defvar vc-static-header-alist
139 "\n#ifndef lint\nstatic char vcid[] = \"\%s\";\n#endif /* lint */\n"))
140 "*Associate static header string templates with file types. A \%s in the
141 template is replaced with the first string associated with the file's
142 version-control type in `vc-header-alist'.")
144 (defvar vc-comment-alist
145 '((nroff-mode ".\\\"" ""))
146 "*Special comment delimiters to be used in generating vc headers only.
147 Add an entry in this list if you need to override the normal comment-start
148 and comment-end variables. This will only be necessary if the mode language
149 is sensitive to blank lines.")
151 ;; Default is to be extra careful for super-user.
152 (defvar vc-checkout-carefully (= (user-uid) 0)
153 "*Non-nil means be extra-careful in checkout.
154 Verify that the file really is not locked
155 and that its contents match what the master file says.")
157 (defvar vc-rcs-release nil
158 "*The release number of your RCS installation, as a string.
159 If nil, VC itself computes this value when it is first needed.")
161 (defvar vc-sccs-release nil
162 "*The release number of your SCCS installation, as a string.
163 If nil, VC itself computes this value when it is first needed.")
165 (defvar vc-cvs-release nil
166 "*The release number of your CVS installation, as a string.
167 If nil, VC itself computes this value when it is first needed.")
169 ;; Variables the user doesn't need to know about.
170 (defvar vc-log-entry-mode nil)
171 (defvar vc-log-operation nil)
172 (defvar vc-log-after-operation-hook nil)
173 (defvar vc-checkout-writable-buffer-hook 'vc-checkout-writable-buffer)
174 ;; In a log entry buffer, this is a local variable
175 ;; that points to the buffer for which it was made
176 ;; (either a file, or a VC dired buffer).
177 (defvar vc-parent-buffer nil)
178 (defvar vc-parent-buffer-name nil)
181 (defvar vc-log-version)
183 (defconst vc-name-assoc-file "VC-names")
185 (defvar vc-dired-mode nil)
186 (make-variable-buffer-local 'vc-dired-mode)
188 (defvar vc-comment-ring (make-ring vc-maximum-comment-ring-size))
189 (defvar vc-comment-ring-index nil)
190 (defvar vc-last-comment-match nil)
192 ;; Back-portability to Emacs 18
194 (defun file-executable-p-18 (f)
195 (let ((modes (file-modes f)))
196 (and modes (not (zerop (logand 292))))))
198 (defun file-regular-p-18 (f)
199 (let ((attributes (file-attributes f)))
200 (and attributes (not (car attributes)))))
202 ; Conditionally rebind some things for Emacs 18 compatibility
203 (if (not (boundp 'minor-mode-map-alist))
205 (setq compilation-old-error-list nil)
206 (fset 'file-executable-p 'file-executable-p-18)
207 (fset 'shrink-window-if-larger-than-buffer 'beginning-of-buffer)
210 (if (not (fboundp 'file-regular-p))
211 (fset 'file-regular-p 'file-regular-p-18))
213 ;;; Find and compare backend releases
215 (defun vc-backend-release (backend)
216 ;; Returns which backend release is installed on this system.
220 (and (zerop (vc-do-command nil nil "rcs" nil nil "-V"))
222 (set-buffer (get-buffer "*vc*"))
224 (car (vc-parse-buffer
225 '(("^RCS version \\([0-9.]+ *.*\\)" 1)))))))
226 (setq vc-rcs-release 'unknown)))
229 (and (zerop (vc-do-command nil 1 "cvs" nil nil "-v"))
231 (set-buffer (get-buffer "*vc*"))
233 (car (vc-parse-buffer
234 '(("^Concurrent Versions System (CVS) \\([0-9.]+\\)"
236 (setq vc-cvs-release 'unknown)))
240 (defun vc-release-greater-or-equal (r1 r2)
241 ;; Compare release numbers, represented as strings.
242 ;; Release components are assumed cardinal numbers, not decimal
243 ;; fractions (5.10 is a higher release than 5.9). Omitted fields
244 ;; are considered lower (5.6.7 is earlier than 5.6.7.1).
245 ;; Comparison runs till the end of the string is found, or a
246 ;; non-numeric component shows up (5.6.7 is earlier than "5.6.7 beta",
247 ;; which is probably not what you want in some cases).
248 ;; This code is suitable for existing RCS release numbers.
249 ;; CVS releases are handled reasonably, too (1.3 < 1.4* < 1.5).
252 (or (and (string-match "^\\.?\\([0-9]+\\)" r1)
253 (setq i1 (match-end 0))
254 (setq v1 (string-to-number (match-string 1 r1)))
255 (or (and (string-match "^\\.?\\([0-9]+\\)" r2)
256 (setq i2 (match-end 0))
257 (setq v2 (string-to-number (match-string 1 r2)))
258 (if (> v1 v2) (throw 'done t)
259 (if (< v1 v2) (throw 'done nil)
261 (vc-release-greater-or-equal
263 (substring r2 i2)))))))
265 (or (and (string-match "^\\.?\\([0-9]+\\)" r2)
269 (defun vc-backend-release-p (backend release)
270 ;; Return t if we have RELEASE of BACKEND or better
271 (let (i r (ri 0) (ii 0) is rs (installation (vc-backend-release backend)))
272 (if (not (eq installation 'unknown))
274 ((or (eq backend 'RCS) (eq backend 'CVS))
275 (vc-release-greater-or-equal installation release))))))
277 ;;; functions that operate on RCS revision numbers
279 (defun vc-trunk-p (rev)
280 ;; return t if REV is a revision on the trunk
281 (not (eq nil (string-match "\\`[0-9]+\\.[0-9]+\\'" rev))))
283 (defun vc-branch-part (rev)
284 ;; return the branch part of a revision number REV
285 (substring rev 0 (string-match "\\.[0-9]+\\'" rev)))
287 ;; File property caching
289 (defun vc-clear-context ()
290 "Clear all cached file properties and the comment ring."
292 (fillarray vc-file-prop-obarray nil)
293 ;; Note: there is potential for minor lossage here if there is an open
294 ;; log buffer with a nonzero local value of vc-comment-ring-index.
295 (setq vc-comment-ring (make-ring vc-maximum-comment-ring-size)))
297 (defun vc-file-clear-masterprops (file)
298 ;; clear all properties of FILE that were retrieved
299 ;; from the master file
300 (vc-file-setprop file 'vc-latest-version nil)
301 (vc-file-setprop file 'vc-your-latest-version nil)
302 (vc-backend-dispatch file
304 (vc-file-setprop file 'vc-master-locks nil))
306 (vc-file-setprop file 'vc-default-branch nil)
307 (vc-file-setprop file 'vc-head-version nil)
308 (vc-file-setprop file 'vc-master-workfile-version nil)
309 (vc-file-setprop file 'vc-master-locks nil))
311 (vc-file-setprop file 'vc-cvs-status nil))))
313 (defun vc-head-version (file)
314 ;; Return the RCS head version of FILE
315 (cond ((vc-file-getprop file 'vc-head-version))
316 (t (vc-fetch-master-properties file)
317 (vc-file-getprop file 'vc-head-version))))
319 ;; Random helper functions
321 (defun vc-latest-on-branch-p (file)
322 ;; return t iff the current workfile version of FILE is
323 ;; the latest on its branch.
324 (vc-backend-dispatch file
326 (string= (vc-workfile-version file) (vc-latest-version file))
328 (let ((workfile-version (vc-workfile-version file)) tip-version)
329 (if (vc-trunk-p workfile-version)
331 ;; Re-fetch the head version number. This is to make
332 ;; sure that no-one has checked in a new version behind
334 (vc-fetch-master-properties file)
335 (string= (vc-file-getprop file 'vc-head-version)
337 ;; If we are not on the trunk, we need to examine the
338 ;; whole current branch. (vc-master-workfile-version
339 ;; is not what we need.)
341 (set-buffer (get-buffer-create "*vc-info*"))
342 (vc-insert-file (vc-name file) "^desc")
343 (setq tip-version (car (vc-parse-buffer (list (list
344 (concat "^\\(" (regexp-quote (vc-branch-part workfile-version))
345 "\\.[0-9]+\\)\ndate[ \t]+\\([0-9.]+\\);") 1 2)))))
346 (if (get-buffer "*vc-info*")
347 (kill-buffer (get-buffer "*vc-info*")))
348 (string= tip-version workfile-version))))
352 (defun vc-registration-error (file)
354 (error "File %s is not under version control" file)
355 (error "Buffer %s is not associated with a file" (buffer-name))))
357 (defvar vc-binary-assoc nil)
359 (defun vc-find-binary (name)
360 "Look for a command anywhere on the subprocess-command search path."
361 (or (cdr (assoc name vc-binary-assoc))
367 (let ((full (concat s "/" name)))
368 (if (file-executable-p full)
370 (setq vc-binary-assoc
371 (cons (cons name full) vc-binary-assoc))
372 (throw 'found full)))))))
376 (defun vc-do-command (buffer okstatus command file last &rest flags)
377 "Execute a version-control command, notifying user and checking for errors.
378 Output from COMMAND goes to BUFFER, or *vc* if BUFFER is nil.
379 The command is successful if its exit status does not exceed OKSTATUS.
380 (If OKSTATUS is nil, that means to ignore errors.)
381 The last argument of the command is the master name of FILE if LAST is
382 `MASTER', or the workfile of FILE if LAST is `WORKFILE'; this is appended
383 to an optional list of FLAGS."
384 (and file (setq file (expand-file-name file)))
385 (if (not buffer) (setq buffer "*vc*"))
386 (if vc-command-messages
387 (message "Running %s on %s..." command file))
388 (let ((obuf (current-buffer)) (camefrom (current-buffer))
390 (vc-file (and file (vc-name file)))
391 (olddir default-directory)
393 (set-buffer (get-buffer-create buffer))
394 (set (make-local-variable 'vc-parent-buffer) camefrom)
395 (set (make-local-variable 'vc-parent-buffer-name)
396 (concat " from " (buffer-name camefrom)))
397 (setq default-directory olddir)
402 (function (lambda (s) (and s (setq squeezed (append squeezed (list s))))))
404 (if (and vc-file (eq last 'MASTER))
405 (setq squeezed (append squeezed (list vc-file))))
406 (if (eq last 'WORKFILE)
408 (let* ((pwd (expand-file-name default-directory))
409 (preflen (length pwd)))
410 (if (string= (substring file 0 preflen) pwd)
411 (setq file (substring file preflen))))
412 (setq squeezed (append squeezed (list file)))))
413 (let ((exec-path (append vc-path exec-path))
414 ;; Add vc-path to PATH for the execution of this command.
416 (cons (concat "PATH=" (getenv "PATH")
418 (mapconcat 'identity vc-path path-separator))
419 process-environment))
420 (w32-quote-process-args t))
421 (setq status (apply 'call-process command nil t nil squeezed)))
422 (goto-char (point-max))
423 (set-buffer-modified-p nil)
425 (if (or (not (integerp status)) (and okstatus (< okstatus status)))
427 (pop-to-buffer buffer)
428 (goto-char (point-min))
429 (shrink-window-if-larger-than-buffer)
430 (error "Running %s...FAILED (%s)" command
431 (if (integerp status)
432 (format "status %d" status)
435 (if vc-command-messages
436 (message "Running %s...OK" command))
442 ;;; Save a bit of the text around POSN in the current buffer, to help
443 ;;; us find the corresponding position again later. This works even
444 ;;; if all markers are destroyed or corrupted.
445 ;;; A lot of this was shamelessly lifted from Sebastian Kremer's rcs.el mode.
446 (defun vc-position-context (posn)
449 (buffer-substring posn
450 (min (point-max) (+ posn 100)))))
452 ;;; Return the position of CONTEXT in the current buffer, or nil if we
453 ;;; couldn't find it.
454 (defun vc-find-position-by-context (context)
455 (let ((context-string (nth 2 context)))
456 (if (equal "" context-string)
459 (let ((diff (- (nth 1 context) (buffer-size))))
460 (if (< diff 0) (setq diff (- diff)))
461 (goto-char (nth 0 context))
462 (if (or (search-forward context-string nil t)
463 ;; Can't use search-backward since the match may continue
465 (progn (goto-char (- (point) diff (length context-string)))
466 ;; goto-char doesn't signal an error at
467 ;; beginning of buffer like backward-char would
468 (search-forward context-string nil t)))
469 ;; to beginning of OSTRING
470 (- (point) (length context-string))))))))
472 (defun vc-buffer-context ()
473 ;; Return a list '(point-context mark-context reparse); from which
474 ;; vc-restore-buffer-context can later restore the context.
475 (let ((point-context (vc-position-context (point)))
476 ;; Use mark-marker to avoid confusion in transient-mark-mode.
477 (mark-context (if (eq (marker-buffer (mark-marker)) (current-buffer))
478 (vc-position-context (mark-marker))))
479 ;; Make the right thing happen in transient-mark-mode.
481 ;; We may want to reparse the compilation buffer after revert
482 (reparse (and (boundp 'compilation-error-list) ;compile loaded
483 (let ((curbuf (current-buffer)))
484 ;; Construct a list; each elt is nil or a buffer
485 ;; iff that buffer is a compilation output buffer
486 ;; that contains markers into the current buffer.
492 compilation-old-error-list
493 compilation-error-list))
494 (buffer-error-marked-p nil))
495 (while (and (consp errors)
496 (not buffer-error-marked-p))
497 (and (markerp (cdr (car errors)))
501 (setq buffer-error-marked-p t))
502 (setq errors (cdr errors)))
503 (if buffer-error-marked-p buffer))))
505 (list point-context mark-context reparse)))
507 (defun vc-restore-buffer-context (context)
508 ;; Restore point/mark, and reparse any affected compilation buffers.
509 ;; CONTEXT is that which vc-buffer-context returns.
510 (let ((point-context (nth 0 context))
511 (mark-context (nth 1 context))
512 (reparse (nth 2 context)))
513 ;; Reparse affected compilation buffers.
517 (set-buffer (car reparse))
518 (let ((compilation-last-buffer (current-buffer)) ;select buffer
519 ;; Record the position in the compilation buffer of
520 ;; the last error next-error went to.
521 (error-pos (marker-position
522 (car (car-safe compilation-error-list)))))
523 ;; Reparse the error messages as far as they were parsed before.
524 (compile-reinitialize-errors '(4) compilation-parsing-end)
525 ;; Move the pointer up to find the error we were at before
526 ;; reparsing. Now next-error should properly go to the next one.
527 (while (and compilation-error-list
528 (/= error-pos (car (car compilation-error-list))))
529 (setq compilation-error-list (cdr compilation-error-list))))))
530 (setq reparse (cdr reparse)))
532 ;; Restore point and mark
533 (let ((new-point (vc-find-position-by-context point-context)))
534 (if new-point (goto-char new-point)))
536 (let ((new-mark (vc-find-position-by-context mark-context)))
537 (if new-mark (set-mark new-mark))))))
539 (defun vc-revert-buffer1 (&optional arg no-confirm)
540 ;; Revert buffer, try to keep point and mark where user expects them in spite
541 ;; of changes because of expanded version-control key words.
542 ;; This is quite important since otherwise typeahead won't work as expected.
545 (let ((context (vc-buffer-context)))
546 ;; t means don't call normal-mode; that's to preserve various minor modes.
547 (revert-buffer arg no-confirm t)
548 (vc-restore-buffer-context context)))
551 (defun vc-buffer-sync (&optional not-urgent)
552 ;; Make sure the current buffer and its working file are in sync
553 ;; NOT-URGENT means it is ok to continue if the user says not to save.
554 (if (buffer-modified-p)
555 (if (or vc-suppress-confirm
556 (y-or-n-p (format "Buffer %s modified; save it? " (buffer-name))))
560 (error "Aborted")))))
563 (defun vc-workfile-unchanged-p (file &optional want-differences-if-changed)
564 ;; Has the given workfile changed since last checkout?
565 (let ((checkout-time (vc-file-getprop file 'vc-checkout-time))
566 (lastmod (nth 5 (file-attributes file))))
567 (or (equal checkout-time lastmod)
568 (and (or (not checkout-time) want-differences-if-changed)
569 (let ((unchanged (zerop (vc-backend-diff file nil nil
570 (not want-differences-if-changed)))))
571 ;; 0 stands for an unknown time; it can't match any mod time.
572 (vc-file-setprop file 'vc-checkout-time (if unchanged lastmod 0))
575 (defun vc-next-action-on-file (file verbose &optional comment)
576 ;;; If comment is specified, it will be used as an admin or checkin comment.
577 (let ((vc-file (vc-name file))
578 (vc-type (vc-backend file))
579 owner version buffer)
582 ;; if there is no master file corresponding, create one
584 (vc-register verbose comment)
585 (if vc-initial-comment
586 (setq vc-log-after-operation-hook
587 'vc-checkout-writable-buffer-hook)
588 (vc-checkout-writable-buffer file)))
590 ;; CVS: changes to the master file need to be
591 ;; merged back into the working file
592 ((and (eq vc-type 'CVS)
593 (or (eq (vc-cvs-status file) 'needs-checkout)
594 (eq (vc-cvs-status file) 'needs-merge)))
595 (if (or vc-dired-mode
597 (format "%s is not up-to-date. Merge in changes now? "
601 (and (setq buffer (get-file-buffer file))
602 (buffer-modified-p buffer)
603 (switch-to-buffer-other-window buffer)
605 (setq buffer (current-buffer))
607 (if (and buffer (buffer-modified-p buffer)
610 "Buffer %s modified; merge file on disc anyhow? "
611 (buffer-name buffer)))))
612 (error "Merge aborted"))
613 (if (not (zerop (vc-backend-merge-news file)))
614 ;; Overlaps detected - what now? Should use some
615 ;; fancy RCS conflict resolving package, or maybe
616 ;; emerge, but for now, simply warn the user with a
618 (message "Conflicts detected!"))
620 (vc-resynch-buffer file t (not (buffer-modified-p buffer)))))
621 (error "%s needs update" (buffer-name))))
623 ;; If there is no lock on the file, assert one and get it.
624 ;; (With implicit checkout, make sure not to lose unsaved changes.)
625 ((progn (and (eq (vc-checkout-model file) 'implicit)
626 (buffer-modified-p buffer)
628 (not (setq owner (vc-locking-user file))))
629 (if (and vc-checkout-carefully
630 (not (vc-workfile-unchanged-p file t)))
631 (if (save-window-excursion
632 (pop-to-buffer "*vc-diff*")
633 (goto-char (point-min))
634 (insert-string (format "Changes to %s since last lock:\n\n"
638 (concat "File has unlocked changes, "
639 "claim lock retaining changes? ")))
640 (progn (vc-backend-steal file)
642 (if (not (yes-or-no-p "Revert to checked-in version, instead? "))
643 (error "Checkout aborted")
644 (vc-revert-buffer1 t t)
645 (vc-checkout-writable-buffer file))
648 (if (not (eq vc-type 'SCCS))
649 (vc-checkout file nil
650 (read-string "Branch or version to move to: "))
651 (error "Sorry, this is not implemented for SCCS"))
652 (if (vc-latest-on-branch-p file)
653 (vc-checkout-writable-buffer file)
655 "This is not the latest version. Really lock it? ")
656 (vc-checkout-writable-buffer file)
657 (if (yes-or-no-p "Lock the latest version instead? ")
658 (vc-checkout-writable-buffer file
659 (if (vc-trunk-p (vc-workfile-version file))
660 "" ;; this means check out latest on trunk
661 (vc-branch-part (vc-workfile-version file)))))))
664 ;; a checked-out version exists, but the user may not own the lock
665 ((and (not (eq vc-type 'CVS))
666 (not (string-equal owner (vc-user-login-name))))
668 (error "Sorry, you can't steal the lock on %s this way" file))
669 (and (eq vc-type 'RCS)
670 (not (vc-backend-release-p 'RCS "5.6.2"))
671 (error "File is locked by %s" owner))
674 (if verbose (read-string "Version to steal: ")
675 (vc-workfile-version file))
678 ;; OK, user owns the lock on the file
681 (find-file-other-window file)
684 ;; give luser a chance to save before checking in.
687 ;; Revert if file is unchanged and buffer is too.
688 ;; If buffer is modified, that means the user just said no
689 ;; to saving it; in that case, don't revert,
690 ;; because the user might intend to save
691 ;; after finishing the log entry.
692 (if (and (vc-workfile-unchanged-p file)
693 (not (buffer-modified-p)))
694 ;; DO NOT revert the file without asking the user!
696 ((yes-or-no-p "Revert to master version? ")
697 (vc-backend-revert file)
698 (vc-resynch-window file t t)))
700 ;; user may want to set nonstandard parameters
702 (setq version (read-string "New version level: ")))
704 ;; OK, let's do the checkin
705 (vc-checkin file version comment)
708 (defun vc-next-action-dired (file rev comment)
709 ;; Do a vc-next-action-on-file on all the marked files, possibly
710 ;; passing on the log comment we've just entered.
711 (let ((configuration (current-window-configuration))
712 (dired-buffer (current-buffer))
713 (dired-dir default-directory))
714 (dired-map-over-marks
715 (let ((file (dired-get-filename)) p
716 (default-directory default-directory))
717 (message "Processing %s..." file)
718 ;; Adjust the default directory so that checkouts
719 ;; go to the right place.
720 (setq default-directory (file-name-directory file))
721 (vc-next-action-on-file file nil comment)
722 (set-buffer dired-buffer)
723 (setq default-directory dired-dir)
724 (vc-dired-update-line file)
725 (set-window-configuration configuration)
726 (message "Processing %s...done" file))
729 ;; Here's the major entry point.
732 (defun vc-next-action (verbose)
733 "Do the next logical checkin or checkout operation on the current file.
734 If you call this from within a VC dired buffer with no files marked,
735 it will operate on the file in the current line.
736 If you call this from within a VC dired buffer, and one or more
737 files are marked, it will accept a log message and then operate on
738 each one. The log message will be used as a comment for any register
739 or checkin operations, but ignored when doing checkouts. Attempted
740 lock steals will raise an error.
741 A prefix argument lets you specify the version number to use.
743 For RCS and SCCS files:
744 If the file is not already registered, this registers it for version
745 control and then retrieves a writable, locked copy for editing.
746 If the file is registered and not locked by anyone, this checks out
747 a writable and locked file ready for editing.
748 If the file is checked out and locked by the calling user, this
749 first checks to see if the file has changed since checkout. If not,
750 it performs a revert.
751 If the file has been changed, this pops up a buffer for entry
752 of a log message; when the message has been entered, it checks in the
753 resulting changes along with the log message as change commentary. If
754 the variable `vc-keep-workfiles' is non-nil (which is its default), a
755 read-only copy of the changed file is left in place afterwards.
756 If the file is registered and locked by someone else, you are given
757 the option to steal the lock.
760 If the file is not already registered, this registers it for version
761 control. This does a \"cvs add\", but no \"cvs commit\".
762 If the file is added but not committed, it is committed.
763 If your working file is changed, but the repository file is
764 unchanged, this pops up a buffer for entry of a log message; when the
765 message has been entered, it checks in the resulting changes along
766 with the logmessage as change commentary. A writable file is retained.
767 If the repository file is changed, you are asked if you want to
768 merge in the changes into your working copy."
773 (let ((files (dired-get-marked-files)))
776 (function (lambda (f)
777 (if (eq (vc-backend f) 'CVS)
778 (if (or (eq (vc-cvs-status f) 'locally-modified)
779 (eq (vc-cvs-status f) 'locally-added))
781 (if (vc-locking-user f) "@" ""))))
783 (vc-next-action-dired nil nil "dummy")
784 (vc-start-entry nil nil nil
785 "Enter a change comment for the marked files."
786 'vc-next-action-dired))
788 (while vc-parent-buffer
789 (pop-to-buffer vc-parent-buffer))
791 (vc-next-action-on-file buffer-file-name verbose)
792 (vc-registration-error nil))))
794 ;;; These functions help the vc-next-action entry point
796 (defun vc-checkout-writable-buffer (&optional file rev)
797 "Retrieve a writable copy of the latest version of the current buffer's file."
798 (vc-checkout (or file (buffer-file-name)) t rev)
802 (defun vc-register (&optional override comment)
803 "Register the current file into your version-control system."
806 (error "No visited file"))
807 (let ((master (vc-name buffer-file-name)))
808 (and master (file-exists-p master)
809 (error "This file is already registered"))
811 (not (y-or-n-p "Previous master file has vanished. Make a new one? "))
812 (error "This file is already registered")))
813 ;; Watch out for new buffers of size 0: the corresponding file
814 ;; does not exist yet, even though buffer-modified-p is nil.
815 (if (and (not (buffer-modified-p))
816 (zerop (buffer-size))
817 (not (file-exists-p buffer-file-name)))
818 (set-buffer-modified-p t))
820 (cond ((not vc-make-backup-files)
821 ;; inhibit backup for this buffer
822 (make-local-variable 'backup-inhibited)
823 (setq backup-inhibited t)))
828 (format "Initial version level for %s: " buffer-file-name))))
831 (defun vc-resynch-window (file &optional keep noquery)
832 ;; If the given file is in the current buffer,
833 ;; either revert on it so we see expanded keywords,
834 ;; or unvisit it (depending on vc-keep-workfiles)
835 ;; NOQUERY if non-nil inhibits confirmation for reverting.
836 ;; NOQUERY should be t *only* if it is known the only difference
837 ;; between the buffer and the file is due to RCS rather than user editing!
838 (and (string= buffer-file-name file)
841 ;; temporarily remove vc-find-file-hook, so that
842 ;; we don't lose the properties
843 (remove-hook 'find-file-hooks 'vc-find-file-hook)
844 (vc-revert-buffer1 t noquery)
845 (add-hook 'find-file-hooks 'vc-find-file-hook)
846 (vc-mode-line buffer-file-name))
847 (kill-buffer (current-buffer)))))
849 (defun vc-resynch-buffer (file &optional keep noquery)
850 ;; if FILE is currently visited, resynch its buffer
851 (let ((buffer (get-file-buffer file)))
855 (vc-resynch-window file keep noquery)))))
857 (defun vc-start-entry (file rev comment msg action &optional after-hook)
858 ;; Accept a comment for an operation on FILE revision REV. If COMMENT
859 ;; is nil, pop up a VC-log buffer, emit MSG, and set the
860 ;; action on close to ACTION; otherwise, do action immediately.
861 ;; Remember the file's buffer in vc-parent-buffer (current one if no file).
862 ;; AFTER-HOOK specifies the local value for vc-log-operation-hook.
863 (let ((parent (if file (find-file-noselect file) (current-buffer))))
865 (set-buffer (get-buffer-create "*VC-log*"))
866 (pop-to-buffer (get-buffer-create "*VC-log*")))
867 (set (make-local-variable 'vc-parent-buffer) parent)
868 (set (make-local-variable 'vc-parent-buffer-name)
869 (concat " from " (buffer-name vc-parent-buffer)))
870 (if file (vc-mode-line file))
872 (make-local-variable 'vc-log-after-operation-hook)
874 (setq vc-log-after-operation-hook after-hook))
875 (setq vc-log-operation action)
876 (setq vc-log-version rev)
881 (vc-finish-logentry t)
883 (vc-finish-logentry nil)))
884 (message "%s Type C-c C-c when done." msg))))
886 (defun vc-admin (file rev &optional comment)
887 "Check a file into your version-control system.
888 FILE is the unmodified name of the file. REV should be the base version
889 level to check it in under. COMMENT, if specified, is the checkin comment."
890 (vc-start-entry file rev
891 (or comment (not vc-initial-comment))
892 "Enter initial comment." 'vc-backend-admin
895 (defun vc-checkout (file &optional writable rev)
896 "Retrieve a copy of the latest version of the given file."
897 ;; If ftp is on this system and the name matches the ange-ftp format
898 ;; for a remote file, the user is trying something that won't work.
899 (if (and (string-match "^/[^/:]+:" file) (vc-find-binary "ftp"))
900 (error "Sorry, you can't check out files over FTP"))
901 (vc-backend-checkout file writable rev)
902 (vc-resynch-buffer file t t))
904 (defun vc-steal-lock (file rev &optional owner)
905 "Steal the lock on the current workfile."
906 (let (file-description)
908 (setq owner (vc-locking-user file)))
910 (setq file-description (format "%s:%s" file rev))
911 (setq file-description file))
912 (if (not (y-or-n-p (format "Take the lock on %s from %s? "
913 file-description owner)))
914 (error "Steal cancelled"))
915 (pop-to-buffer (get-buffer-create "*VC-mail*"))
916 (setq default-directory (expand-file-name "~/"))
917 (auto-save-mode auto-save-default)
920 (mail-setup owner (format "Stolen lock on %s" file-description) nil nil nil
921 (list (list 'vc-finish-steal file rev)))
922 (goto-char (point-max))
924 (format "I stole the lock on %s, " file-description)
925 (current-time-string)
927 (message "Please explain why you stole the lock. Type C-c C-c when done.")))
929 ;; This is called when the notification has been sent.
930 (defun vc-finish-steal (file version)
931 (vc-backend-steal file version)
932 (if (get-file-buffer file)
934 (set-buffer (get-file-buffer file))
935 (vc-resynch-window file t t))))
937 (defun vc-checkin (file &optional rev comment)
938 "Check in the file specified by FILE.
939 The optional argument REV may be a string specifying the new version level
940 \(if nil increment the current level). The file is either retained with write
941 permissions zeroed, or deleted (according to the value of `vc-keep-workfiles').
942 If the back-end is CVS, a writable workfile is always kept.
943 COMMENT is a comment string; if omitted, a buffer is
944 popped up to accept a comment."
945 (vc-start-entry file rev comment
946 "Enter a change comment." 'vc-backend-checkin
949 ;;; Here is a checkin hook that may prove useful to sites using the
950 ;;; ChangeLog facility supported by Emacs.
951 (defun vc-comment-to-change-log (&optional whoami file-name)
952 "Enter last VC comment into change log file for current buffer's file.
953 Optional arg (interactive prefix) non-nil means prompt for user name and site.
954 Second arg is file name of change log. \
955 If nil, uses `change-log-default-name'."
956 (interactive (if current-prefix-arg
957 (list current-prefix-arg
958 (prompt-for-change-log-name))))
959 ;; Make sure the defvar for add-log-current-defun-function has been executed
960 ;; before binding it.
962 (let (;; Extract the comment first so we get any error before doing anything.
963 (comment (ring-ref vc-comment-ring 0))
964 ;; Don't let add-change-log-entry insert a defun name.
965 (add-log-current-defun-function 'ignore)
967 ;; Call add-log to do half the work.
968 (add-change-log-entry whoami file-name t t)
969 ;; Insert the VC comment, leaving point before it.
970 (setq end (save-excursion (insert comment) (point-marker)))
971 (if (looking-at "\\s *\\s(")
972 ;; It starts with an open-paren, as in "(foo): Frobbed."
973 ;; So remove the ": " add-log inserted.
975 ;; Canonicalize the white space between the file name and comment.
977 ;; Indent rest of the text the same way add-log indented the first line.
978 (let ((indentation (current-indentation)))
980 (while (< (point) end)
982 (indent-to indentation))
984 ;; Fill the inserted text, preserving open-parens at bol.
985 (let ((paragraph-separate (concat paragraph-separate "\\|\\s *\\s("))
986 (paragraph-start (concat paragraph-start "\\|\\s *\\s(")))
988 (fill-region (point) end))
989 ;; Canonicalize the white space at the end of the entry so it is
990 ;; separated from the next entry by a single blank line.
991 (skip-syntax-forward " " end)
992 (delete-char (- (skip-syntax-backward " ")))
993 (or (eobp) (looking-at "\n\n")
997 (defun vc-finish-logentry (&optional nocomment)
998 "Complete the operation implied by the current log entry."
1000 ;; Check and record the comment, if any.
1003 (goto-char (point-max))
1006 ;; Comment too long?
1007 (vc-backend-logentry-check vc-log-file)
1008 ;; Record the comment in the comment ring
1009 (ring-insert vc-comment-ring (buffer-string))
1011 ;; Sync parent buffer in case the user modified it while editing the comment.
1012 ;; But not if it is a vc-dired buffer.
1014 (set-buffer vc-parent-buffer)
1017 (if (not vc-log-operation) (error "No log operation is pending"))
1018 ;; save the parameters held in buffer-local variables
1019 (let ((log-operation vc-log-operation)
1020 (log-file vc-log-file)
1021 (log-version vc-log-version)
1022 (log-entry (buffer-string))
1023 (after-hook vc-log-after-operation-hook))
1024 ;; Return to "parent" buffer of this checkin and remove checkin window
1025 (pop-to-buffer vc-parent-buffer)
1026 (let ((logbuf (get-buffer "*VC-log*")))
1027 (delete-windows-on logbuf)
1028 (kill-buffer logbuf))
1031 (funcall log-operation
1035 ;; Now make sure we see the expanded headers
1036 (if buffer-file-name
1037 (vc-resynch-window buffer-file-name vc-keep-workfiles t))
1038 (run-hooks after-hook 'vc-finish-logentry-hook)))
1040 ;; Code for access to the comment ring
1042 (defun vc-previous-comment (arg)
1043 "Cycle backwards through comment history."
1045 (let ((len (ring-length vc-comment-ring)))
1047 (message "Empty comment ring")
1051 ;; Initialize the index on the first use of this command
1052 ;; so that the first M-p gets index 0, and the first M-n gets
1054 (if (null vc-comment-ring-index)
1055 (setq vc-comment-ring-index
1057 (if (< arg 0) 1 0))))
1058 (setq vc-comment-ring-index
1059 (mod (+ vc-comment-ring-index arg) len))
1060 (message "%d" (1+ vc-comment-ring-index))
1061 (insert (ring-ref vc-comment-ring vc-comment-ring-index))))))
1063 (defun vc-next-comment (arg)
1064 "Cycle forwards through comment history."
1066 (vc-previous-comment (- arg)))
1068 (defun vc-comment-search-reverse (str)
1069 "Searches backwards through comment history for substring match."
1070 (interactive "sComment substring: ")
1071 (if (string= str "")
1072 (setq str vc-last-comment-match)
1073 (setq vc-last-comment-match str))
1074 (if (null vc-comment-ring-index)
1075 (setq vc-comment-ring-index -1))
1076 (let ((str (regexp-quote str))
1077 (len (ring-length vc-comment-ring))
1078 (n (1+ vc-comment-ring-index)))
1079 (while (and (< n len) (not (string-match str (ring-ref vc-comment-ring n))))
1082 (vc-previous-comment (- n vc-comment-ring-index)))
1083 (t (error "Not found")))))
1085 (defun vc-comment-search-forward (str)
1086 "Searches forwards through comment history for substring match."
1087 (interactive "sComment substring: ")
1088 (if (string= str "")
1089 (setq str vc-last-comment-match)
1090 (setq vc-last-comment-match str))
1091 (if (null vc-comment-ring-index)
1092 (setq vc-comment-ring-index 0))
1093 (let ((str (regexp-quote str))
1094 (len (ring-length vc-comment-ring))
1095 (n vc-comment-ring-index))
1096 (while (and (>= n 0) (not (string-match str (ring-ref vc-comment-ring n))))
1099 (vc-next-comment (- n vc-comment-ring-index)))
1100 (t (error "Not found")))))
1102 ;; Additional entry points for examining version histories
1105 (defun vc-diff (historic &optional not-urgent)
1106 "Display diffs between file versions.
1107 Normally this compares the current file and buffer with the most recent
1108 checked in version of that file. This uses no arguments.
1109 With a prefix argument, it reads the file name to use
1110 and two version designators specifying which versions to compare."
1111 (interactive (list current-prefix-arg t))
1113 (set-buffer (find-file-noselect (dired-get-filename))))
1114 (while vc-parent-buffer
1115 (pop-to-buffer vc-parent-buffer))
1117 (call-interactively 'vc-version-diff)
1118 (if (or (null buffer-file-name) (null (vc-name buffer-file-name)))
1120 "There is no version-control master associated with this buffer"))
1121 (let ((file buffer-file-name)
1123 (or (and file (vc-name file))
1124 (vc-registration-error file))
1125 (vc-buffer-sync not-urgent)
1126 (setq unchanged (vc-workfile-unchanged-p buffer-file-name))
1128 (message "No changes to %s since latest version" file)
1129 (vc-backend-diff file)
1130 ;; Ideally, we'd like at this point to parse the diff so that
1131 ;; the buffer effectively goes into compilation mode and we
1132 ;; can visit the old and new change locations via next-error.
1133 ;; Unfortunately, this is just too painful to do. The basic
1134 ;; problem is that the `old' file doesn't exist to be
1135 ;; visited. This plays hell with numerous assumptions in
1136 ;; the diff.el and compile.el machinery.
1137 (set-buffer "*vc-diff*")
1138 (setq default-directory (file-name-directory file))
1139 (if (= 0 (buffer-size))
1142 (message "No changes to %s since latest version" file))
1143 (pop-to-buffer "*vc-diff*")
1144 (goto-char (point-min))
1145 (shrink-window-if-larger-than-buffer)))
1148 (defun vc-version-diff (file rel1 rel2)
1149 "For FILE, report diffs between two stored versions REL1 and REL2 of it.
1150 If FILE is a directory, generate diffs between versions for all registered
1151 files in or below it."
1152 (interactive "FFile or directory to diff: \nsOlder version: \nsNewer version: ")
1153 (if (string-equal rel1 "") (setq rel1 nil))
1154 (if (string-equal rel2 "") (setq rel2 nil))
1155 (if (file-directory-p file)
1156 (let ((camefrom (current-buffer)))
1157 (set-buffer (get-buffer-create "*vc-status*"))
1158 (set (make-local-variable 'vc-parent-buffer) camefrom)
1159 (set (make-local-variable 'vc-parent-buffer-name)
1160 (concat " from " (buffer-name camefrom)))
1162 (insert "Diffs between "
1163 (or rel1 "last version checked in")
1165 (or rel2 "current workfile(s)")
1167 (set-buffer (get-buffer-create "*vc-diff*"))
1171 (function (lambda (f)
1172 (message "Looking at %s" f)
1174 (not (file-directory-p f))
1176 (vc-backend-diff f rel1 rel2)
1177 (append-to-buffer "*vc-status*" (point-min) (point-max)))
1179 (pop-to-buffer "*vc-status*")
1180 (insert "\nEnd of diffs.\n")
1181 (goto-char (point-min))
1182 (set-buffer-modified-p nil)
1184 (if (zerop (vc-backend-diff file rel1 rel2))
1185 (message "No changes to %s between %s and %s." file rel1 rel2)
1186 (pop-to-buffer "*vc-diff*"))))
1189 (defun vc-version-other-window (rev)
1190 "Visit version REV of the current buffer in another window.
1191 If the current buffer is named `F', the version is named `F.~REV~'.
1192 If `F.~REV~' already exists, it is used instead of being re-created."
1193 (interactive "sVersion to visit (default is latest version): ")
1195 (set-buffer (find-file-noselect (dired-get-filename))))
1196 (while vc-parent-buffer
1197 (pop-to-buffer vc-parent-buffer))
1198 (if (and buffer-file-name (vc-name buffer-file-name))
1199 (let* ((version (if (string-equal rev "")
1200 (vc-latest-version buffer-file-name)
1202 (filename (concat buffer-file-name ".~" version "~")))
1203 (or (file-exists-p filename)
1204 (vc-backend-checkout buffer-file-name nil version filename))
1205 (find-file-other-window filename))
1206 (vc-registration-error buffer-file-name)))
1208 ;; Header-insertion code
1211 (defun vc-insert-headers ()
1212 "Insert headers in a file for use with your version-control system.
1213 Headers desired are inserted at the start of the buffer, and are pulled from
1214 the variable `vc-header-alist'."
1217 (find-file-other-window (dired-get-filename)))
1218 (while vc-parent-buffer
1219 (pop-to-buffer vc-parent-buffer))
1223 (if (or (not (vc-check-headers))
1224 (y-or-n-p "Version headers already exist. Insert another set? "))
1226 (let* ((delims (cdr (assq major-mode vc-comment-alist)))
1227 (comment-start-vc (or (car delims) comment-start "#"))
1228 (comment-end-vc (or (car (cdr delims)) comment-end ""))
1229 (hdstrings (cdr (assoc (vc-backend (buffer-file-name)) vc-header-alist))))
1230 (mapcar (function (lambda (s)
1231 (insert comment-start-vc "\t" s "\t"
1232 comment-end-vc "\n")))
1234 (if vc-static-header-alist
1235 (mapcar (function (lambda (f)
1236 (if (string-match (car f) buffer-file-name)
1237 (insert (format (cdr f) (car hdstrings))))))
1238 vc-static-header-alist))
1242 (defun vc-clear-headers ()
1243 ;; Clear all version headers in the current buffer, i.e. reset them
1244 ;; to the nonexpanded form. Only implemented for RCS, yet.
1245 ;; Don't lose point and mark during this.
1246 (let ((context (vc-buffer-context)))
1247 (goto-char (point-min))
1248 (while (re-search-forward "\\$\\([A-Za-z]+\\): [^\\$]+\\$" nil t)
1249 (replace-match "$\\1$"))
1250 (vc-restore-buffer-context context)))
1252 ;; The VC directory major mode. Coopt Dired for this.
1253 ;; All VC commands get mapped into logical equivalents.
1255 (define-derived-mode vc-dired-mode dired-mode "Dired under VC"
1256 "The major mode used in VC directory buffers. It is derived from Dired.
1257 All Dired commands operate normally. Users currently locking listed files
1258 are listed in place of the file's owner and group.
1259 Keystrokes bound to VC commands will execute as though they had been called
1260 on a buffer attached to the file named in the current Dired buffer line."
1261 (setq vc-dired-mode t))
1263 (define-key vc-dired-mode-map "\C-xv" vc-prefix-map)
1264 (define-key vc-dired-mode-map "g" 'vc-dired-update)
1265 (define-key vc-dired-mode-map "=" 'vc-diff)
1267 (defun vc-dired-state-info (file)
1268 ;; Return the string that indicates the version control status
1269 ;; on a VC dired line.
1270 (let ((cvs-state (and (eq (vc-backend file) 'CVS)
1271 (vc-cvs-status file))))
1273 (cond ((eq cvs-state 'up-to-date) nil)
1274 ((eq cvs-state 'needs-checkout) "patch")
1275 ((eq cvs-state 'locally-modified) "modified")
1276 ((eq cvs-state 'needs-merge) "merge")
1277 ((eq cvs-state 'unresolved-conflict) "conflict")
1278 ((eq cvs-state 'locally-added) "added"))
1279 (vc-locking-user file))))
1281 (defun vc-dired-reformat-line (x)
1282 ;; Hack a directory-listing line, plugging in locking-user info in
1283 ;; place of the user and group info. Should have the beneficial
1284 ;; side-effect of shortening the listing line. Each call starts with
1285 ;; point immediately following the dired mark area on the line to be
1288 ;; Simplest possible one:
1289 ;; (insert (concat x "\t")))
1291 ;; This code, like dired, assumes UNIX -l format.
1292 (let ((pos (point)) limit perm owner date-and-file)
1294 (setq limit (point))
1298 (re-search-forward ;; owner and group
1299 "\\([drwxlts-]+ \\) *[0-9]+ \\([^ ]+\\) +[^ ]+ +[0-9]+\\( [^ 0-9]+ [0-9 ][0-9] .*\\)"
1301 (re-search-forward ;; only owner displayed
1302 "\\([drwxlts-]+ \\) *[0-9]+ \\([^ ]+\\) +[0-9]+\\( [^ 0-9]+ [0-9 ][0-9] .*\\)"
1304 (setq perm (match-string 1)
1305 owner (match-string 2)
1306 date-and-file (match-string 3)))
1307 ((re-search-forward ;; OS/2 -l format, no links, owner, group
1308 "\\([drwxlts-]+ \\) *[0-9]+\\( [^ 0-9]+ [0-9 ][0-9] .*\\)"
1310 (setq perm (match-string 1)
1311 date-and-file (match-string 2))))
1312 (if x (setq x (concat "(" x ")")))
1313 (let ((rep (substring (concat x " ") 0 10)))
1314 (replace-match (concat perm rep date-and-file)))))
1316 (defun vc-dired-update-line (file)
1317 ;; Update the vc-dired listing line of file -- it is assumed
1318 ;; that point is already on this line. Don't use dired-do-redisplay
1319 ;; for this, because it cannot handle the way vc-dired deals with
1323 (let ((start (point)))
1326 (delete-region start (point))
1327 (insert-directory file dired-listing-switches)
1330 (delete-char (- (length file)))
1331 (insert (substring file (length (expand-file-name default-directory))))
1333 (vc-dired-reformat-line (vc-dired-state-info file)))
1335 (defun vc-dired-update (verbose)
1337 (vc-directory default-directory verbose))
1339 ;;; Note in Emacs 18 the following defun gets overridden
1340 ;;; with the symbol 'vc-directory-18. See below.
1342 (defun vc-directory (dirname verbose)
1343 "Show version-control status of the current directory and subdirectories.
1344 Normally it creates a Dired buffer that lists only the locked files
1345 in all these directories. With a prefix argument, it lists all files."
1346 (interactive "DDired under VC (directory): \nP")
1348 (setq dirname (expand-file-name dirname))
1349 ;; force a trailing slash
1350 (if (not (eq (elt dirname (1- (length dirname))) ?/))
1351 (setq dirname (concat dirname "/")))
1353 (dl (length dirname))
1354 (filelist nil) (statelist nil)
1355 (old-dir default-directory)
1357 dired-buf-mod-count)
1362 (if (vc-registered f)
1363 (let ((state (vc-dired-state-info f)))
1364 (and (or verbose state)
1365 (setq filelist (cons (substring f dl) filelist))
1366 (setq statelist (cons state statelist))))))))
1367 (save-window-excursion
1369 ;; This uses a semi-documented feature of dired; giving a switch
1370 ;; argument forces the buffer to refresh each time.
1372 (dired-internal-noselect
1373 (cons dirname (nreverse filelist))
1374 dired-listing-switches 'vc-dired-mode))
1375 (setq nonempty (not (eq 0 (length filelist))))))
1376 (switch-to-buffer dired-buf)
1377 ;; Make a few modifications to the header
1378 (setq buffer-read-only nil)
1379 (goto-char (point-min))
1380 (forward-line 1) ;; Skip header line
1381 (let ((start (point))) ;; Erase (but don't remove) the
1382 (end-of-line) ;; "wildcard" line.
1383 (delete-region start (point)))
1387 ;; Plug the version information into the individual lines
1391 (forward-char 2) ;; skip dired's mark area
1392 (vc-dired-reformat-line x)
1393 (forward-line 1))) ;; go to next line
1394 (nreverse statelist))
1395 (setq buffer-read-only t)
1396 (goto-char (point-min))
1401 (setq buffer-read-only t)
1402 (message "No files are currently %s under %s"
1403 (if verbose "registered" "locked") dirname))
1407 (defun vc-directory-18 (verbose)
1408 "Show version-control status of all files under the current directory."
1410 (let (nonempty (dir default-directory))
1412 (set-buffer (get-buffer-create "*vc-status*"))
1417 (function (lambda (f)
1418 (if (vc-registered f)
1419 (let ((user (vc-locking-user f)))
1420 (if (or user verbose)
1423 (concat user) f))))))))
1424 (setq nonempty (not (zerop (buffer-size)))))
1428 (pop-to-buffer "*vc-status*" t)
1429 (goto-char (point-min))
1430 (shrink-window-if-larger-than-buffer)))
1431 (message "No files are currently %s under %s"
1432 (if verbose "registered" "locked") default-directory))
1435 (or (boundp 'minor-mode-map-alist)
1436 (fset 'vc-directory 'vc-directory-18))
1438 ;; Named-configuration support for SCCS
1440 (defun vc-add-triple (name file rev)
1442 (find-file (expand-file-name
1444 (file-name-as-directory
1445 (expand-file-name (vc-backend-subdirectory-name file)
1446 (file-name-directory file)))))
1447 (goto-char (point-max))
1448 (insert name "\t:\t" file "\t" rev "\n")
1450 (kill-buffer (current-buffer))
1453 (defun vc-record-rename (file newname)
1458 (file-name-as-directory
1459 (expand-file-name (vc-backend-subdirectory-name file)
1460 (file-name-directory file)))))
1461 (goto-char (point-min))
1462 ;; (replace-regexp (concat ":" (regexp-quote file) "$") (concat ":" newname))
1463 (while (re-search-forward (concat ":" (regexp-quote file) "$") nil t)
1464 (replace-match (concat ":" newname) nil nil))
1466 (kill-buffer (current-buffer))
1469 (defun vc-lookup-triple (file name)
1470 ;; Return the numeric version corresponding to a named snapshot of file
1471 ;; If name is nil or a version number string it's just passed through
1472 (cond ((null name) name)
1473 ((let ((firstchar (aref name 0)))
1474 (and (>= firstchar ?0) (<= firstchar ?9)))
1478 (set-buffer (get-buffer-create "*vc-info*"))
1482 (file-name-as-directory
1483 (expand-file-name (vc-backend-subdirectory-name file)
1484 (file-name-directory file)))))
1486 (car (vc-parse-buffer
1487 (list (list (concat name "\t:\t" file "\t\\(.+\\)") 1))))
1488 (kill-buffer "*vc-info*"))))
1491 ;; Named-configuration entry points
1493 (defun vc-snapshot-precondition ()
1494 ;; Scan the tree below the current directory.
1495 ;; If any files are locked, return the name of the first such file.
1496 ;; (This means, neither snapshot creation nor retrieval is allowed.)
1497 ;; If one or more of the files are currently visited, return `visited'.
1498 ;; Otherwise, return nil.
1500 (catch 'vc-locked-example
1503 (function (lambda (f)
1504 (and (vc-registered f)
1505 (if (vc-locking-user f) (throw 'vc-locked-example f)
1506 (if (get-file-buffer f) (setq status 'visited)))))))
1510 (defun vc-create-snapshot (name)
1511 "Make a snapshot called NAME.
1512 The snapshot is made from all registered files at or below the current
1513 directory. For each file, the version level of its latest
1514 version becomes part of the named configuration."
1515 (interactive "sNew snapshot name: ")
1516 (let ((result (vc-snapshot-precondition)))
1517 (if (stringp result)
1518 (error "File %s is locked" result)
1521 (function (lambda (f) (and
1523 (vc-backend-assign-name f name)))))
1527 (defun vc-retrieve-snapshot (name)
1528 "Retrieve the snapshot called NAME.
1529 This function fails if any files are locked at or below the current directory
1530 Otherwise, all registered files are checked out (unlocked) at their version
1531 levels in the snapshot."
1532 (interactive "sSnapshot name to retrieve: ")
1533 (let ((result (vc-snapshot-precondition))
1535 (if (stringp result)
1536 (error "File %s is locked" result)
1537 (if (eq result 'visited)
1538 (setq update (yes-or-no-p "Update the affected buffers? ")))
1541 (function (lambda (f) (and
1544 (vc-backend-checkout f nil name)
1545 (if update (vc-resynch-buffer f t t)))))))
1548 ;; Miscellaneous other entry points
1551 (defun vc-print-log ()
1552 "List the change log of the current buffer in a window."
1555 (set-buffer (find-file-noselect (dired-get-filename))))
1556 (while vc-parent-buffer
1557 (pop-to-buffer vc-parent-buffer))
1558 (if (and buffer-file-name (vc-name buffer-file-name))
1559 (let ((file buffer-file-name))
1560 (vc-backend-print-log file)
1561 (pop-to-buffer (get-buffer-create "*vc*"))
1562 (setq default-directory (file-name-directory file))
1563 (goto-char (point-max)) (forward-line -1)
1564 (while (looking-at "=*\n")
1565 (delete-char (- (match-end 0) (match-beginning 0)))
1567 (goto-char (point-min))
1568 (if (looking-at "[\b\t\n\v\f\r ]+")
1569 (delete-char (- (match-end 0) (match-beginning 0))))
1570 (shrink-window-if-larger-than-buffer)
1571 ;; move point to the log entry for the current version
1572 (and (not (eq (vc-backend file) 'SCCS))
1574 ;; also match some context, for safety
1575 (concat "----\nrevision " (vc-workfile-version file)
1576 "\\(\tlocked by:.*\n\\|\n\\)date: ") nil t)
1577 ;; set the display window so that
1578 ;; the whole log entry is displayed
1579 (let (start end lines)
1580 (beginning-of-line) (forward-line -1) (setq start (point))
1581 (if (not (re-search-forward "^----*\nrevision" nil t))
1582 (setq end (point-max))
1583 (beginning-of-line) (forward-line -1) (setq end (point)))
1584 (setq lines (count-lines start end))
1586 ;; if the global information and this log entry fit
1587 ;; into the window, display from the beginning
1588 ((< (count-lines (point-min) end) (window-height))
1589 (goto-char (point-min))
1592 ;; if the whole entry fits into the window,
1593 ;; display it centered
1594 ((< (1+ lines) (window-height))
1596 (recenter (1- (- (/ (window-height) 2) (/ lines 2)))))
1597 ;; otherwise (the entry is too large for the window),
1598 ;; display from the start
1603 (vc-registration-error buffer-file-name)
1608 (defun vc-revert-buffer ()
1609 "Revert the current buffer's file back to the latest checked-in version.
1610 This asks for confirmation if the buffer contents are not identical
1612 If the back-end is CVS, this will give you the most recent revision of
1613 the file on the branch you are editing."
1616 (find-file-other-window (dired-get-filename)))
1617 (while vc-parent-buffer
1618 (pop-to-buffer vc-parent-buffer))
1619 (let ((file buffer-file-name)
1620 ;; This operation should always ask for confirmation.
1621 (vc-suppress-confirm nil)
1622 (obuf (current-buffer)) (changed (vc-diff nil t)))
1623 (if (and changed (not (yes-or-no-p "Discard changes? ")))
1625 (if (and (window-dedicated-p (selected-window))
1626 (one-window-p t 'selected-frame))
1627 (make-frame-invisible (selected-frame))
1629 (error "Revert cancelled"))
1632 (if (and (window-dedicated-p (selected-window))
1633 (one-window-p t 'selected-frame))
1634 (make-frame-invisible (selected-frame))
1636 (vc-backend-revert file)
1637 (vc-resynch-window file t t)
1642 (defun vc-cancel-version (norevert)
1643 "Get rid of most recently checked in version of this file.
1644 A prefix argument means do not revert the buffer afterwards."
1647 (find-file-other-window (dired-get-filename)))
1648 (while vc-parent-buffer
1649 (pop-to-buffer vc-parent-buffer))
1651 ((not (vc-registered (buffer-file-name)))
1652 (vc-registration-error (buffer-file-name)))
1653 ((eq (vc-backend (buffer-file-name)) 'CVS)
1654 (error "Unchecking files under CVS is dangerous and not supported in VC"))
1655 ((vc-locking-user (buffer-file-name))
1656 (error "This version is locked; use vc-revert-buffer to discard changes"))
1657 ((not (vc-latest-on-branch-p (buffer-file-name)))
1658 (error "This is not the latest version--VC cannot cancel it")))
1659 (let* ((target (vc-workfile-version (buffer-file-name)))
1660 (recent (if (vc-trunk-p target) "" (vc-branch-part target)))
1661 (config (current-window-configuration)) done)
1662 (if (null (yes-or-no-p (format "Remove version %s from master? " target)))
1664 (setq norevert (or norevert (not
1665 (yes-or-no-p "Revert buffer to most recent remaining version? "))))
1666 (vc-backend-uncheck (buffer-file-name) target)
1667 ;; Check out the most recent remaining version. If it fails, because
1668 ;; the whole branch got deleted, do a double-take and check out the
1669 ;; version where the branch started.
1674 ;; Check out locked, but only to disc, and keep
1675 ;; modifications in the buffer.
1676 (vc-backend-checkout (buffer-file-name) t recent)
1677 ;; Check out unlocked, and revert buffer.
1678 (vc-checkout (buffer-file-name) nil recent))
1680 ;; If the checkout fails, vc-do-command signals an error.
1681 ;; We catch this error, check the reason, correct the
1682 ;; version number, and try a second time.
1683 (error (set-buffer "*vc*")
1684 (goto-char (point-min))
1685 (if (search-forward "no side branches present for" nil t)
1686 (progn (setq recent (vc-branch-part recent))
1687 ;; vc-do-command popped up a window with
1688 ;; the error message. Get rid of it, by
1689 ;; restoring the old window configuration.
1690 (set-window-configuration config))
1691 ;; No, it was some other error: re-signal it.
1692 (signal (car err) (cdr err))))))
1693 ;; If norevert, clear version headers and mark the buffer modified.
1696 (set-visited-file-name (buffer-file-name))
1697 (if (not vc-make-backup-files)
1698 ;; inhibit backup for this buffer
1699 (progn (make-local-variable 'backup-inhibited)
1700 (setq backup-inhibited t)))
1701 (if (eq (vc-backend (buffer-file-name)) 'RCS)
1702 (progn (setq buffer-read-only nil)
1703 (vc-clear-headers)))
1704 (vc-mode-line (buffer-file-name))))
1705 (message "Version %s has been removed from the master" target)
1709 (defun vc-rename-file (old new)
1710 "Rename file OLD to NEW, and rename its master file likewise."
1711 (interactive "fVC rename file: \nFRename to: ")
1712 ;; There are several ways of renaming files under CVS 1.3, but they all
1713 ;; have serious disadvantages. See the FAQ (available from think.com in
1714 ;; pub/cvs/). I'd rather send the user an error, than do something he might
1715 ;; consider to be wrong. When the famous, long-awaited rename database is
1716 ;; implemented things might change for the better. This is unlikely to occur
1717 ;; until CVS 2.0 is released. --ceder 1994-01-23 21:27:51
1718 (if (eq (vc-backend old) 'CVS)
1719 (error "Renaming files under CVS is dangerous and not supported in VC"))
1720 (let ((oldbuf (get-file-buffer old)))
1721 (if (and oldbuf (buffer-modified-p oldbuf))
1722 (error "Please save files before moving them"))
1723 (if (get-file-buffer new)
1724 (error "Already editing new file name"))
1725 (if (file-exists-p new)
1726 (error "New file already exists"))
1727 (let ((oldmaster (vc-name old)))
1730 (if (vc-locking-user old)
1731 (error "Please check in files before moving them"))
1732 (if (or (file-symlink-p oldmaster)
1733 ;; This had FILE, I changed it to OLD. -- rms.
1734 (file-symlink-p (vc-backend-subdirectory-name old)))
1735 (error "This is not a safe thing to do in the presence of symbolic links"))
1738 (let ((backend (vc-backend old))
1739 (newdir (or (file-name-directory new) ""))
1740 (newbase (file-name-nondirectory new)))
1745 (if (eq backend (cdr s))
1746 (let* ((newmaster (format (car s) newdir newbase))
1747 (newmasterdir (file-name-directory newmaster)))
1748 (if (or (not newmasterdir)
1749 (file-directory-p newmasterdir))
1750 (throw 'found newmaster))))))
1751 vc-master-templates)
1752 (error "New file lacks a version control directory"))))))
1753 (if (or (not oldmaster) (file-exists-p old))
1754 (rename-file old new)))
1755 ; ?? Renaming a file might change its contents due to keyword expansion.
1756 ; We should really check out a new copy if the old copy was precisely equal
1757 ; to some checked in version. However, testing for this is tricky....
1761 (let ((buffer-read-only buffer-read-only))
1762 (set-visited-file-name new))
1765 (set-buffer-modified-p nil))))
1766 ;; This had FILE, I changed it to OLD. -- rms.
1767 (vc-backend-dispatch old
1768 (vc-record-rename old new) ;SCCS
1775 (defun vc-update-change-log (&rest args)
1776 "Find change log file and add entries from recent RCS/CVS logs.
1777 Normally, find log entries for all registered files in the default
1778 directory using `rcs2log', which finds CVS logs preferentially.
1779 The mark is left at the end of the text prepended to the change log.
1781 With prefix arg of C-u, only find log entries for the current buffer's file.
1783 With any numeric prefix arg, find log entries for all currently visited
1784 files that are under version control. This puts all the entries in the
1785 log for the default directory, which may not be appropriate.
1787 From a program, any arguments are assumed to be filenames and are
1788 passed to the `rcs2log' script after massaging to be relative to the
1791 (cond ((consp current-prefix-arg) ;C-u
1792 (list buffer-file-name))
1793 (current-prefix-arg ;Numeric argument.
1795 (buffers (buffer-list))
1798 (setq file (buffer-file-name (car buffers)))
1799 (and file (vc-backend file)
1800 (setq files (cons file files)))
1801 (setq buffers (cdr buffers)))
1804 ;; `rcs2log' will find the relevant RCS or CVS files
1805 ;; relative to the curent directory if none supplied.
1807 (let ((odefault default-directory)
1808 (full-name (or add-log-full-name
1811 (format "uid%d" (number-to-string (user-uid)))))
1812 (mailing-address (or add-log-mailing-address
1813 user-mail-address)))
1814 (find-file-other-window (find-change-log))
1815 (barf-if-buffer-read-only)
1818 (goto-char (point-min))
1820 (message "Computing change log entries...")
1821 (message "Computing change log entries... %s"
1822 (if (eq 0 (apply 'call-process "rcs2log" nil '(t nil) nil
1824 (concat (vc-user-login-name)
1832 (if (file-name-absolute-p f)
1834 (concat odefault f)))))
1838 ;; Collect back-end-dependent stuff here
1840 (defun vc-backend-admin (file &optional rev comment)
1841 ;; Register a file into the version-control system
1842 ;; Automatically retrieves a read-only version of the file with
1843 ;; keywords expanded if vc-keep-workfiles is non-nil, otherwise
1844 ;; it deletes the workfile.
1845 (vc-file-clearprops file)
1846 (or vc-default-back-end
1847 (setq vc-default-back-end (if (vc-find-binary "rcs") 'RCS 'SCCS)))
1848 (message "Registering %s..." file)
1850 (if (stringp vc-register-switches)
1851 (list vc-register-switches)
1852 vc-register-switches))
1855 ((file-exists-p (vc-backend-subdirectory-name)) vc-default-back-end)
1856 ((file-exists-p "RCS") 'RCS)
1857 ((file-exists-p "SCCS") 'SCCS)
1858 ((file-exists-p "CVS") 'CVS)
1859 (t vc-default-back-end))))
1860 (cond ((eq backend 'SCCS)
1861 (apply 'vc-do-command nil 0 "admin" file 'MASTER ;; SCCS
1862 (and rev (concat "-r" rev))
1865 (and comment (concat "-y" comment))
1867 (car (rassq 'SCCS vc-master-templates))
1868 (or (file-name-directory file) "")
1869 (file-name-nondirectory file))
1872 (if vc-keep-workfiles
1873 (vc-do-command nil 0 "get" file 'MASTER)))
1875 (apply 'vc-do-command nil 0 "ci" file 'WORKFILE ;; RCS
1876 ;; if available, use the secure registering option
1877 (and (vc-backend-release-p 'RCS "5.6.4") "-i")
1878 (concat (if vc-keep-workfiles "-u" "-r") rev)
1879 (and comment (concat "-t-" comment))
1882 (apply 'vc-do-command nil 0 "cvs" file 'WORKFILE ;; CVS
1884 (and comment (string-match "[^\t\n ]" comment)
1885 (concat "-m" comment))
1888 (message "Registering %s...done" file)
1891 (defun vc-backend-checkout (file &optional writable rev workfile)
1892 ;; Retrieve a copy of a saved version into a workfile
1893 (let ((filename (or workfile file))
1894 (file-buffer (get-file-buffer file))
1896 (message "Checking out %s..." filename)
1898 ;; Change buffers to get local value of vc-checkout-switches.
1899 (if file-buffer (set-buffer file-buffer))
1900 (setq switches (if (stringp vc-checkout-switches)
1901 (list vc-checkout-switches)
1902 vc-checkout-switches))
1903 ;; Save this buffer's default-directory
1904 ;; and use save-excursion to make sure it is restored
1905 ;; in the same buffer it was saved in.
1906 (let ((default-directory default-directory))
1908 ;; Adjust the default-directory so that the check-out creates
1909 ;; the file in the right place.
1910 (setq default-directory (file-name-directory filename))
1911 (vc-backend-dispatch file
1913 (and rev (string= rev "") (setq rev nil))
1915 ;; Some SCCS implementations allow checking out directly to a
1916 ;; file using the -G option, but then some don't so use the
1917 ;; least common denominator approach and use the -p option
1919 (let ((vc-modes (logior (file-modes (vc-name file))
1920 (if writable 128 0)))
1924 (apply 'vc-do-command
1925 nil 0 "/bin/sh" file 'MASTER "-c"
1926 ;; Some shells make the "" dummy argument into $0
1927 ;; while others use the shell's name as $0 and
1928 ;; use the "" as $1. The if-statement
1929 ;; converts the latter case to the former.
1930 (format "if [ x\"$1\" = x ]; then shift; fi; \
1931 umask %o; exec >\"$1\" || exit; \
1932 shift; umask %o; exec get \"$@\""
1933 (logand 511 (lognot vc-modes))
1934 (logand 511 (lognot (default-file-modes))))
1935 "" ; dummy argument for shell's $0
1940 (concat "-r" (vc-lookup-triple file rev)))
1943 (and failed (file-exists-p filename)
1944 (delete-file filename))))
1945 (apply 'vc-do-command nil 0 "get" file 'MASTER ;; SCCS
1947 (and rev (concat "-r" (vc-lookup-triple file rev)))
1949 (vc-file-setprop file 'vc-workfile-version nil)))
1951 ;; RCS doesn't let us check out into arbitrary file names directly.
1952 ;; Use `co -p' and make stdout point to the correct file.
1953 (let ((vc-modes (logior (file-modes (vc-name file))
1954 (if writable 128 0)))
1958 (apply 'vc-do-command
1959 nil 0 "/bin/sh" file 'MASTER "-c"
1960 ;; See the SCCS case, above, regarding the
1962 (format "if [ x\"$1\" = x ]; then shift; fi; \
1963 umask %o; exec >\"$1\" || exit; \
1964 shift; umask %o; exec co \"$@\""
1965 (logand 511 (lognot vc-modes))
1966 (logand 511 (lognot (default-file-modes))))
1967 "" ; dummy argument for shell's $0
1973 (and failed (file-exists-p filename) (delete-file filename))))
1975 ;; if we should go to the head of the trunk,
1976 ;; clear the default branch first
1977 (and rev (string= rev "")
1978 (vc-do-command nil 0 "rcs" file 'MASTER "-b"))
1979 ;; now do the checkout
1980 (apply 'vc-do-command
1981 nil 0 "co" file 'MASTER
1982 ;; If locking is not strict, force to overwrite
1983 ;; the writable workfile.
1984 (if (eq (vc-checkout-model file) 'implicit) "-f")
1986 (if rev (concat "-r" rev)
1987 ;; if no explicit revision was specified,
1988 ;; check out that of the working file
1989 (let ((workrev (vc-workfile-version file)))
1990 (if workrev (concat "-r" workrev)
1993 ;; determine the new workfile version
1996 (goto-char (point-min))
1998 (if (re-search-forward "^revision \\([0-9.]+\\).*\n" nil t)
1999 (buffer-substring (match-beginning 1) (match-end 1)))))
2000 (vc-file-setprop file 'vc-workfile-version new-version)
2001 ;; if necessary, adjust the default branch
2002 (and rev (not (string= rev ""))
2003 (vc-do-command nil 0 "rcs" file 'MASTER
2004 (concat "-b" (if (vc-latest-on-branch-p file)
2005 (if (vc-trunk-p new-version) nil
2006 (vc-branch-part new-version))
2009 ;; CVS is much like RCS
2013 (apply 'vc-do-command
2014 nil 0 "/bin/sh" file 'WORKFILE "-c"
2015 "exec >\"$1\" || exit; shift; exec cvs update \"$@\""
2016 "" ; dummy argument for shell's $0
2022 (and failed (file-exists-p filename) (delete-file filename))))
2023 ;; default for verbose checkout: clear the sticky tag
2024 ;; so that the actual update will get the head of the trunk
2025 (and rev (string= rev "")
2026 (vc-do-command nil 0 "cvs" file 'WORKFILE "update" "-A"))
2027 ;; If a revision was specified, check that out.
2029 (apply 'vc-do-command nil 0 "cvs" file 'WORKFILE
2030 (and writable (eq (vc-checkout-model file) 'manual) "-w")
2032 (and rev (not (string= rev ""))
2035 ;; If no revision was specified, simply make the file writable.
2037 (or (eq (vc-checkout-model file) 'manual)
2038 (zerop (logand 128 (file-modes file))))
2039 (set-file-modes file (logior 128 (file-modes file)))))
2040 (if rev (vc-file-setprop file 'vc-workfile-version nil))))
2043 (vc-file-clear-masterprops file)
2045 (vc-file-setprop file 'vc-locking-user (vc-user-login-name)))
2046 (vc-file-setprop file
2047 'vc-checkout-time (nth 5 (file-attributes file)))))
2048 (message "Checking out %s...done" filename))))))
2050 (defun vc-backend-logentry-check (file)
2051 (vc-backend-dispatch file
2052 (if (>= (buffer-size) 512) ;; SCCS
2056 "Log must be less than 512 characters; point is now at pos 512")))
2061 (defun vc-backend-checkin (file rev comment)
2062 ;; Register changes to FILE as level REV with explanatory COMMENT.
2063 ;; Automatically retrieves a read-only version of the file with
2064 ;; keywords expanded if vc-keep-workfiles is non-nil, otherwise
2065 ;; it deletes the workfile.
2066 ;; Adaptation for RCS branch support: if this is an explicit checkin,
2067 ;; or if the checkin creates a new branch, set the master file branch
2069 (message "Checking in %s..." file)
2070 ;; "This log message intentionally left almost blank".
2071 ;; RCS 5.7 gripes about white-space-only comments too.
2072 (or (and comment (string-match "[^\t\n ]" comment))
2073 (setq comment "*** empty log message ***"))
2075 ;; Change buffers to get local value of vc-checkin-switches.
2076 (set-buffer (or (get-file-buffer file) (current-buffer)))
2078 (if (stringp vc-checkin-switches)
2079 (list vc-checkin-switches)
2080 vc-checkin-switches)))
2081 ;; Clear the master-properties. Do that here, not at the
2082 ;; end, because if the check-in fails we want them to get
2083 ;; re-computed before the next try.
2084 (vc-file-clear-masterprops file)
2085 (vc-backend-dispatch file
2088 (apply 'vc-do-command nil 0 "delta" file 'MASTER
2089 (if rev (concat "-r" rev))
2090 (concat "-y" comment)
2092 (vc-file-setprop file 'vc-locking-user 'none)
2093 (vc-file-setprop file 'vc-workfile-version nil)
2094 (if vc-keep-workfiles
2095 (vc-do-command nil 0 "get" file 'MASTER))
2098 (let ((old-version (vc-workfile-version file)) new-version)
2099 (apply 'vc-do-command nil 0 "ci" file 'MASTER
2100 ;; if available, use the secure check-in option
2101 (and (vc-backend-release-p 'RCS "5.6.4") "-j")
2102 (concat (if vc-keep-workfiles "-u" "-r") rev)
2103 (concat "-m" comment)
2105 (vc-file-setprop file 'vc-locking-user 'none)
2106 (vc-file-setprop file 'vc-workfile-version nil)
2108 ;; determine the new workfile version
2110 (goto-char (point-min))
2111 (if (or (re-search-forward
2112 "new revision: \\([0-9.]+\\);" nil t)
2114 "reverting to previous revision \\([0-9.]+\\)" nil t))
2115 (progn (setq new-version (buffer-substring (match-beginning 1)
2117 (vc-file-setprop file 'vc-workfile-version new-version)))
2119 ;; if we got to a different branch, adjust the default
2120 ;; branch accordingly
2122 ((and old-version new-version
2123 (not (string= (vc-branch-part old-version)
2124 (vc-branch-part new-version))))
2125 (vc-do-command nil 0 "rcs" file 'MASTER
2126 (if (vc-trunk-p new-version) "-b"
2127 (concat "-b" (vc-branch-part new-version))))
2128 ;; If this is an old RCS release, we might have
2129 ;; to remove a remaining lock.
2130 (if (not (vc-backend-release-p 'RCS "5.6.2"))
2131 ;; exit status of 1 is also accepted.
2132 ;; It means that the lock was removed before.
2133 (vc-do-command nil 1 "rcs" file 'MASTER
2134 (concat "-u" old-version))))))
2137 ;; explicit check-in to the trunk requires a
2138 ;; double check-in (first unexplicit) (CVS-1.3)
2141 (if (and rev (vc-trunk-p rev))
2142 (apply 'vc-do-command nil 0 "cvs" file 'WORKFILE
2143 "ci" "-m" "intermediate"
2145 (apply 'vc-do-command nil 0 "cvs" file 'WORKFILE
2146 "ci" (if rev (concat "-r" rev))
2147 (concat "-m" comment)
2149 (error (if (eq (vc-cvs-status file) 'needs-merge)
2150 ;; The CVS output will be on top of this message.
2151 (error "Type C-x 0 C-x C-q to merge in changes")
2152 (error "Check-in failed"))))
2153 ;; determine and store the new workfile version
2155 (goto-char (point-min))
2156 (if (re-search-forward
2157 "^\\(new\\|initial\\) revision: \\([0-9.]+\\)" nil t)
2158 (vc-file-setprop file 'vc-workfile-version
2159 (buffer-substring (match-beginning 2)
2161 (vc-file-setprop file 'vc-workfile-version nil))
2162 ;; if this was an explicit check-in, remove the sticky tag
2164 (vc-do-command nil 0 "cvs" file 'WORKFILE "update" "-A"))
2165 (vc-file-setprop file 'vc-locking-user 'none)
2166 (vc-file-setprop file 'vc-checkout-time
2167 (nth 5 (file-attributes file)))))))
2168 (message "Checking in %s...done" file))
2170 (defun vc-backend-revert (file)
2171 ;; Revert file to latest checked-in version.
2172 ;; (for RCS, to workfile version)
2173 (message "Reverting %s..." file)
2174 (vc-file-clear-masterprops file)
2175 (vc-backend-dispatch
2179 (vc-do-command nil 0 "unget" file 'MASTER nil)
2180 (vc-do-command nil 0 "get" file 'MASTER nil))
2182 (vc-do-command nil 0 "co" file 'MASTER
2183 "-f" (concat "-u" (vc-workfile-version file)))
2187 (vc-do-command nil 0 "cvs" file 'WORKFILE "update")))
2188 (vc-file-setprop file 'vc-locking-user 'none)
2189 (vc-file-setprop file 'vc-checkout-time (nth 5 (file-attributes file)))
2190 (message "Reverting %s...done" file)
2193 (defun vc-backend-steal (file &optional rev)
2194 ;; Steal the lock on the current workfile. Needs RCS 5.6.2 or later for -M.
2195 (message "Stealing lock on %s..." file)
2196 (vc-backend-dispatch file
2198 (vc-do-command nil 0 "unget" file 'MASTER "-n" (if rev (concat "-r" rev)))
2199 (vc-do-command nil 0 "get" file 'MASTER "-g" (if rev (concat "-r" rev)))
2201 (vc-do-command nil 0 "rcs" file 'MASTER ;RCS
2202 "-M" (concat "-u" rev) (concat "-l" rev))
2203 (error "You cannot steal a CVS lock; there are no CVS locks to steal") ;CVS
2205 (vc-file-setprop file 'vc-locking-user (vc-user-login-name))
2206 (message "Stealing lock on %s...done" file)
2209 (defun vc-backend-uncheck (file target)
2210 ;; Undo the latest checkin.
2211 (message "Removing last change from %s..." file)
2212 (vc-backend-dispatch file
2213 (vc-do-command nil 0 "rmdel" file 'MASTER (concat "-r" target))
2214 (vc-do-command nil 0 "rcs" file 'MASTER (concat "-o" target))
2215 nil ;; this is never reached under CVS
2217 (message "Removing last change from %s...done" file)
2220 (defun vc-backend-print-log (file)
2221 ;; Get change log associated with FILE.
2222 (vc-backend-dispatch
2224 (vc-do-command nil 0 "prs" file 'MASTER)
2225 (vc-do-command nil 0 "rlog" file 'MASTER)
2226 (vc-do-command nil 0 "cvs" file 'WORKFILE "log")))
2228 (defun vc-backend-assign-name (file name)
2229 ;; Assign to a FILE's latest version a given NAME.
2230 (vc-backend-dispatch file
2231 (vc-add-triple name file (vc-latest-version file)) ;; SCCS
2232 (vc-do-command nil 0 "rcs" file 'MASTER (concat "-n" name ":")) ;; RCS
2233 (vc-do-command nil 0 "cvs" file 'WORKFILE "tag" name) ;; CVS
2237 (defun vc-backend-diff (file &optional oldvers newvers cmp)
2238 ;; Get a difference report between two versions of FILE.
2239 ;; Get only a brief comparison report if CMP, a difference report otherwise.
2240 (let ((backend (vc-backend file)) options status
2241 (diff-switches-list (if (listp diff-switches)
2243 (list diff-switches))))
2246 (setq oldvers (vc-lookup-triple file oldvers))
2247 (setq newvers (vc-lookup-triple file newvers))
2248 (setq options (append (list (and cmp "--brief") "-q"
2249 (and oldvers (concat "-r" oldvers))
2250 (and newvers (concat "-r" newvers)))
2251 (and (not cmp) diff-switches-list)))
2252 (apply 'vc-do-command "*vc-diff*" 1 "vcdiff" file 'MASTER options))
2254 (if (not oldvers) (setq oldvers (vc-workfile-version file)))
2255 ;; If we know that --brief is not supported, don't try it.
2256 (setq cmp (and cmp (not (eq vc-rcsdiff-knows-brief 'no))))
2257 (setq options (append (list (and cmp "--brief") "-q"
2258 (concat "-r" oldvers)
2259 (and newvers (concat "-r" newvers)))
2260 (and (not cmp) diff-switches-list)))
2261 (setq status (apply 'vc-do-command "*vc-diff*" 2
2262 "rcsdiff" file 'WORKFILE options))
2263 ;; If --brief didn't work, do a double-take and remember it
2267 (apply 'vc-do-command "*vc-diff*" 1 "rcsdiff" file 'WORKFILE
2268 (if cmp (cdr options) options))
2269 (if cmp (setq vc-rcsdiff-knows-brief 'no)))
2270 ;; If --brief DID work, remember that, too.
2271 (and cmp (not vc-rcsdiff-knows-brief)
2272 (setq vc-rcsdiff-knows-brief 'yes))
2274 ;; CVS is different.
2276 (if (string= (vc-workfile-version file) "0")
2277 ;; This file is added but not yet committed; there is no master file.
2278 (if (or oldvers newvers)
2279 (error "No revisions of %s exist" file)
2280 (if cmp 1 ;; file is added but not committed,
2281 ;; we regard this as "changed".
2282 ;; diff it against /dev/null.
2283 (apply 'vc-do-command
2284 "*vc-diff*" 1 "diff" file 'WORKFILE
2285 (append (if (listp diff-switches)
2287 (list diff-switches)) '("/dev/null")))))
2288 ;; cmp is not yet implemented -- we always do a full diff.
2289 (apply 'vc-do-command
2290 "*vc-diff*" 1 "cvs" file 'WORKFILE "diff"
2291 (and oldvers (concat "-r" oldvers))
2292 (and newvers (concat "-r" newvers))
2293 (if (listp diff-switches)
2295 (list diff-switches)))))
2297 (vc-registration-error file)))))
2299 (defun vc-backend-merge-news (file)
2300 ;; Merge in any new changes made to FILE.
2301 (message "Merging changes into %s..." file)
2303 (vc-backend-dispatch
2305 (error "vc-backend-merge-news not meaningful for SCCS files") ;SCCS
2306 (error "vc-backend-merge-news not meaningful for RCS files") ;RCS
2307 (save-excursion ; CVS
2308 (vc-file-clear-masterprops file)
2309 (vc-file-setprop file 'vc-workfile-version nil)
2310 (vc-file-setprop file 'vc-locking-user nil)
2311 (vc-do-command nil 0 "cvs" file 'WORKFILE "update")
2312 ;; CVS doesn't return an error code if conflicts are detected.
2313 ;; Since we want to warn the user about it (and possibly start
2314 ;; emerge later), scan the output and see if this occurred.
2315 (set-buffer (get-buffer "*vc*"))
2316 (goto-char (point-min))
2317 (if (re-search-forward "^cvs update: conflicts found in .*" nil t)
2318 1 ;; error code for caller
2319 0 ;; no conflict detected
2321 (message "Merging changes into %s...done" file)))
2323 (defun vc-check-headers ()
2324 "Check if the current file has any headers in it."
2327 (goto-char (point-min))
2328 (vc-backend-dispatch buffer-file-name
2329 (re-search-forward "%[MIRLBSDHTEGUYFPQCZWA]%" nil t) ;; SCCS
2330 (re-search-forward "\\$[A-Za-z\300-\326\330-\366\370-\377]+\\(: [\t -#%-\176\240-\377]*\\)?\\$" nil t) ;; RCS
2331 'RCS ;; CVS works like RCS in this regard.
2335 ;; Back-end-dependent stuff ends here.
2337 ;; Set up key bindings for use while editing log messages
2339 (defun vc-log-mode (&optional file)
2340 "Minor mode for driving version-control tools.
2341 These bindings are added to the global keymap when you enter this mode:
2342 \\[vc-next-action] perform next logical version-control operation on current file
2343 \\[vc-register] register current file
2344 \\[vc-toggle-read-only] like next-action, but won't register files
2345 \\[vc-insert-headers] insert version-control headers in current file
2346 \\[vc-print-log] display change history of current file
2347 \\[vc-revert-buffer] revert buffer to latest version
2348 \\[vc-cancel-version] undo latest checkin
2349 \\[vc-diff] show diffs between file versions
2350 \\[vc-version-other-window] visit old version in another window
2351 \\[vc-directory] show all files locked by any user in or below .
2352 \\[vc-update-change-log] add change log entry from recent checkins
2354 While you are entering a change log message for a version, the following
2355 additional bindings will be in effect.
2357 \\[vc-finish-logentry] proceed with check in, ending log message entry
2359 Whenever you do a checkin, your log comment is added to a ring of
2360 saved comments. These can be recalled as follows:
2362 \\[vc-next-comment] replace region with next message in comment ring
2363 \\[vc-previous-comment] replace region with previous message in comment ring
2364 \\[vc-comment-search-reverse] search backward for regexp in the comment ring
2365 \\[vc-comment-search-forward] search backward for regexp in the comment ring
2367 Entry to the change-log submode calls the value of text-mode-hook, then
2368 the value of vc-log-mode-hook.
2370 Global user options:
2371 vc-initial-comment If non-nil, require user to enter a change
2372 comment upon first checkin of the file.
2374 vc-keep-workfiles Non-nil value prevents workfiles from being
2375 deleted when changes are checked in
2377 vc-suppress-confirm Suppresses some confirmation prompts,
2378 notably for reversions.
2380 vc-header-alist Which keywords to insert when adding headers
2381 with \\[vc-insert-headers]. Defaults to
2382 '(\"\%\W\%\") under SCCS, '(\"\$Id\$\") under
2385 vc-static-header-alist By default, version headers inserted in C files
2386 get stuffed in a static string area so that
2387 ident(RCS/CVS) or what(SCCS) can see them in
2388 the compiled object code. You can override
2389 this by setting this variable to nil, or change
2390 the header template by changing it.
2392 vc-command-messages if non-nil, display run messages from the
2393 actual version-control utilities (this is
2394 intended primarily for people hacking vc
2398 (set-syntax-table text-mode-syntax-table)
2399 (use-local-map vc-log-entry-mode)
2400 (setq local-abbrev-table text-mode-abbrev-table)
2401 (setq major-mode 'vc-log-mode)
2402 (setq mode-name "VC-Log")
2403 (make-local-variable 'vc-log-file)
2404 (setq vc-log-file file)
2405 (make-local-variable 'vc-log-version)
2406 (make-local-variable 'vc-comment-ring-index)
2407 (set-buffer-modified-p nil)
2408 (setq buffer-file-name nil)
2409 (run-hooks 'text-mode-hook 'vc-log-mode-hook)
2412 ;; Initialization code, to be done just once at load-time
2413 (if vc-log-entry-mode
2415 (setq vc-log-entry-mode (make-sparse-keymap))
2416 (define-key vc-log-entry-mode "\M-n" 'vc-next-comment)
2417 (define-key vc-log-entry-mode "\M-p" 'vc-previous-comment)
2418 (define-key vc-log-entry-mode "\M-r" 'vc-comment-search-reverse)
2419 (define-key vc-log-entry-mode "\M-s" 'vc-comment-search-forward)
2420 (define-key vc-log-entry-mode "\C-c\C-c" 'vc-finish-logentry)
2423 ;;; These things should probably be generally available
2425 (defun vc-file-tree-walk (dirname func &rest args)
2426 "Walk recursively through DIRNAME.
2427 Invoke FUNC f ARGS on each non-directory file f underneath it."
2428 (vc-file-tree-walk-internal (expand-file-name dirname) func args)
2429 (message "Traversing directory %s...done" dirname))
2431 (defun vc-file-tree-walk-internal (file func args)
2432 (if (not (file-directory-p file))
2433 (apply func file args)
2434 (message "Traversing directory %s..." (abbreviate-file-name file))
2435 (let ((dir (file-name-as-directory file)))
2439 (string-equal f ".")
2440 (string-equal f "..")
2441 (member f vc-directory-exclusion-list)
2442 (let ((dirf (concat dir f)))
2444 (file-symlink-p dirf) ;; Avoid possible loops
2445 (vc-file-tree-walk-internal dirf func args))))))
2446 (directory-files dir)))))
2450 ;;; DEVELOPER'S NOTES ON CONCURRENCY PROBLEMS IN THIS CODE
2452 ;;; These may be useful to anyone who has to debug or extend the package.
2453 ;;; (Note that this information corresponds to versions 5.x. Some of it
2454 ;;; might have been invalidated by the additions to support branching
2455 ;;; and RCS keyword lookup. AS, 1995/03/24)
2457 ;;; A fundamental problem in VC is that there are time windows between
2458 ;;; vc-next-action's computations of the file's version-control state and
2459 ;;; the actions that change it. This is a window open to lossage in a
2460 ;;; multi-user environment; someone else could nip in and change the state
2461 ;;; of the master during it.
2463 ;;; The performance problem is that rlog/prs calls are very expensive; we want
2464 ;;; to avoid them as much as possible.
2468 ;;; The performance problem, it turns out, simplifies in practice to the
2469 ;;; problem of making vc-locking-user fast. The two other functions that call
2470 ;;; prs/rlog will not be so commonly used that the slowdown is a problem; one
2471 ;;; makes snapshots, the other deletes the calling user's last change in the
2474 ;;; The race condition implies that we have to either (a) lock the master
2475 ;;; during the entire execution of vc-next-action, or (b) detect and
2476 ;;; recover from errors resulting from dispatch on an out-of-date state.
2478 ;;; Alternative (a) appears to be infeasible. The problem is that we can't
2479 ;;; guarantee that the lock will ever be removed. Suppose a user starts a
2480 ;;; checkin, the change message buffer pops up, and the user, having wandered
2481 ;;; off to do something else, simply forgets about it?
2483 ;;; Alternative (b), on the other hand, works well with a cheap way to speed up
2484 ;;; vc-locking-user. Usually, if a file is registered, we can read its locked/
2485 ;;; unlocked state and its current owner from its permissions.
2487 ;;; This shortcut will fail if someone has manually changed the workfile's
2488 ;;; permissions; also if developers are munging the workfile in several
2489 ;;; directories, with symlinks to a master (in this latter case, the
2490 ;;; permissions shortcut will fail to detect a lock asserted from another
2493 ;;; Note that these cases correspond exactly to the errors which could happen
2494 ;;; because of a competing checkin/checkout race in between two instances of
2497 ;;; For VC's purposes, a workfile/master pair may have the following states:
2499 ;;; A. Unregistered. There is a workfile, there is no master.
2501 ;;; B. Registered and not locked by anyone.
2503 ;;; C. Locked by calling user and unchanged.
2505 ;;; D. Locked by the calling user and changed.
2507 ;;; E. Locked by someone other than the calling user.
2509 ;;; This makes for 25 states and 20 error conditions. Here's the matrix:
2511 ;;; VC's idea of state
2513 ;;; V Actual state RCS action SCCS action Effect
2515 ;;; A . 1 2 3 4 ci -u -t- admin -fb -i<file> initial admin
2516 ;;; B 5 . 6 7 8 co -l get -e checkout
2517 ;;; C 9 10 . 11 12 co -u unget; get revert
2518 ;;; D 13 14 15 . 16 ci -u -m<comment> delta -y<comment>; get checkin
2519 ;;; E 17 18 19 20 . rcs -u -M -l unget -n ; get -g steal lock
2521 ;;; All commands take the master file name as a last argument (not shown).
2523 ;;; In the discussion below, a "self-race" is a pathological situation in
2524 ;;; which VC operations are being attempted simultaneously by two or more
2525 ;;; Emacsen running under the same username.
2527 ;;; The vc-next-action code has the following windows:
2530 ;;; Between the check for existence of a master file and the call to
2531 ;;; admin/checkin in vc-buffer-admin (apparent state A). This window may
2532 ;;; never close if the initial-comment feature is on.
2535 ;;; Between the call to vc-workfile-unchanged-p in and the immediately
2536 ;;; following revert (apparent state C).
2539 ;;; Between the call to vc-workfile-unchanged-p in and the following
2540 ;;; checkin (apparent state D). This window may never close.
2543 ;;; Between the unlock and the immediately following checkout during a
2544 ;;; revert operation (apparent state C). Included in window Q.
2547 ;;; Between vc-locking-user and the following checkout (apparent state B).
2550 ;;; Between vc-locking-user and the following revert (apparent state C).
2551 ;;; Includes windows Q and S.
2554 ;;; Between vc-locking-user and the following checkin (apparent state
2555 ;;; D). This window may never be closed if the user fails to complete the
2556 ;;; checkin message. Includes window R.
2559 ;;; Between vc-locking-user and the following steal-lock (apparent
2560 ;;; state E). This window may never close if the user fails to complete
2561 ;;; the steal-lock message. Includes window X.
2564 ;;; Between the unlock and the immediately following re-lock during a
2565 ;;; steal-lock operation (apparent state E). This window may never cloce
2566 ;;; if the user fails to complete the steal-lock message.
2570 ;;; Apparent state A ---
2572 ;;; 1. File looked unregistered but is actually registered and not locked.
2574 ;;; Potential cause: someone else's admin during window P, with
2575 ;;; caller's admin happening before their checkout.
2577 ;;; RCS: Prior to version 5.6.4, ci fails with message
2578 ;;; "no lock set by <user>". From 5.6.4 onwards, VC uses the new
2579 ;;; ci -i option and the message is "<file>,v: already exists".
2580 ;;; SCCS: admin will fail with error (ad19).
2582 ;;; We can let these errors be passed up to the user.
2584 ;;; 2. File looked unregistered but is actually locked by caller, unchanged.
2586 ;;; Potential cause: self-race during window P.
2588 ;;; RCS: Prior to version 5.6.4, reverts the file to the last saved
2589 ;;; version and unlocks it. From 5.6.4 onwards, VC uses the new
2590 ;;; ci -i option, failing with message "<file>,v: already exists".
2591 ;;; SCCS: will fail with error (ad19).
2593 ;;; Either of these consequences is acceptable.
2595 ;;; 3. File looked unregistered but is actually locked by caller, changed.
2597 ;;; Potential cause: self-race during window P.
2599 ;;; RCS: Prior to version 5.6.4, VC registers the caller's workfile as
2600 ;;; a delta with a null change comment (the -t- switch will be
2601 ;;; ignored). From 5.6.4 onwards, VC uses the new ci -i option,
2602 ;;; failing with message "<file>,v: already exists".
2603 ;;; SCCS: will fail with error (ad19).
2605 ;;; 4. File looked unregistered but is locked by someone else.
2607 ;;; Potential cause: someone else's admin during window P, with
2608 ;;; caller's admin happening *after* their checkout.
2610 ;;; RCS: Prior to version 5.6.4, ci fails with a
2611 ;;; "no lock set by <user>" message. From 5.6.4 onwards,
2612 ;;; VC uses the new ci -i option, failing with message
2613 ;;; "<file>,v: already exists".
2614 ;;; SCCS: will fail with error (ad19).
2616 ;;; We can let these errors be passed up to the user.
2618 ;;; Apparent state B ---
2620 ;;; 5. File looked registered and not locked, but is actually unregistered.
2622 ;;; Potential cause: master file got nuked during window P.
2624 ;;; RCS: will fail with "RCS/<file>: No such file or directory"
2625 ;;; SCCS: will fail with error ut4.
2627 ;;; We can let these errors be passed up to the user.
2629 ;;; 6. File looked registered and not locked, but is actually locked by the
2630 ;;; calling user and unchanged.
2632 ;;; Potential cause: self-race during window T.
2634 ;;; RCS: in the same directory as the previous workfile, co -l will fail
2635 ;;; with "co error: writable foo exists; checkout aborted". In any other
2636 ;;; directory, checkout will succeed.
2637 ;;; SCCS: will fail with ge17.
2639 ;;; Either of these consequences is acceptable.
2641 ;;; 7. File looked registered and not locked, but is actually locked by the
2642 ;;; calling user and changed.
2646 ;;; 8. File looked registered and not locked, but is actually locked by another
2649 ;;; Potential cause: someone else checks it out during window T.
2651 ;;; RCS: co error: revision 1.3 already locked by <user>
2652 ;;; SCCS: fails with ge4 (in directory) or ut7 (outside it).
2654 ;;; We can let these errors be passed up to the user.
2656 ;;; Apparent state C ---
2658 ;;; 9. File looks locked by calling user and unchanged, but is unregistered.
2662 ;;; 10. File looks locked by calling user and unchanged, but is actually not
2665 ;;; Potential cause: a self-race in window U, or by the revert's
2666 ;;; landing during window X of some other user's steal-lock or window S
2667 ;;; of another user's revert.
2669 ;;; RCS: succeeds, refreshing the file from the identical version in
2671 ;;; SCCS: fails with error ut4 (p file nonexistent).
2673 ;;; Either of these consequences is acceptable.
2675 ;;; 11. File is locked by calling user. It looks unchanged, but is actually
2678 ;;; Potential cause: the file would have to be touched by a self-race
2679 ;;; during window Q.
2681 ;;; The revert will succeed, removing whatever changes came with
2682 ;;; the touch. It is theoretically possible that work could be lost.
2684 ;;; 12. File looks like it's locked by the calling user and unchanged, but
2685 ;;; it's actually locked by someone else.
2687 ;;; Potential cause: a steal-lock in window V.
2689 ;;; RCS: co error: revision <rev> locked by <user>; use co -r or rcs -u
2690 ;;; SCCS: fails with error un2
2692 ;;; We can pass these errors up to the user.
2694 ;;; Apparent state D ---
2696 ;;; 13. File looks like it's locked by the calling user and changed, but it's
2697 ;;; actually unregistered.
2699 ;;; Potential cause: master file got nuked during window P.
2701 ;;; RCS: Prior to version 5.6.4, checks in the user's version as an
2702 ;;; initial delta. From 5.6.4 onwards, VC uses the new ci -j
2703 ;;; option, failing with message "no such file or directory".
2704 ;;; SCCS: will fail with error ut4.
2706 ;;; This case is kind of nasty. Under RCS prior to version 5.6.4,
2707 ;;; VC may fail to detect the loss of previous version information.
2709 ;;; 14. File looks like it's locked by the calling user and changed, but it's
2710 ;;; actually unlocked.
2712 ;;; Potential cause: self-race in window V, or the checkin happening
2713 ;;; during the window X of someone else's steal-lock or window S of
2714 ;;; someone else's revert.
2716 ;;; RCS: ci will fail with "no lock set by <user>".
2717 ;;; SCCS: delta will fail with error ut4.
2719 ;;; 15. File looks like it's locked by the calling user and changed, but it's
2720 ;;; actually locked by the calling user and unchanged.
2722 ;;; Potential cause: another self-race --- a whole checkin/checkout
2723 ;;; sequence by the calling user would have to land in window R.
2725 ;;; SCCS: checks in a redundant delta and leaves the file unlocked as usual.
2726 ;;; RCS: reverts to the file state as of the second user's checkin, leaving
2727 ;;; the file unlocked.
2729 ;;; It is theoretically possible that work could be lost under RCS.
2731 ;;; 16. File looks like it's locked by the calling user and changed, but it's
2732 ;;; actually locked by a different user.
2734 ;;; RCS: ci error: no lock set by <user>
2735 ;;; SCCS: unget will fail with error un2
2737 ;;; We can pass these errors up to the user.
2739 ;;; Apparent state E ---
2741 ;;; 17. File looks like it's locked by some other user, but it's actually
2746 ;;; 18. File looks like it's locked by some other user, but it's actually
2749 ;;; Potential cause: someone released a lock during window W.
2751 ;;; RCS: The calling user will get the lock on the file.
2752 ;;; SCCS: unget -n will fail with cm4.
2754 ;;; Either of these consequences will be OK.
2756 ;;; 19. File looks like it's locked by some other user, but it's actually
2757 ;;; locked by the calling user and unchanged.
2759 ;;; Potential cause: the other user relinquishing a lock followed by
2760 ;;; a self-race, both in window W.
2762 ;;; Under both RCS and SCCS, both unlock and lock will succeed, making
2763 ;;; the sequence a no-op.
2765 ;;; 20. File looks like it's locked by some other user, but it's actually
2766 ;;; locked by the calling user and changed.
2772 ;;; In order of decreasing severity:
2774 ;;; Cases 11 and 15 are the only ones that potentially lose work.
2775 ;;; They would require a self-race for this to happen.
2777 ;;; Case 13 in RCS loses information about previous deltas, retaining
2778 ;;; only the information in the current workfile. This can only happen
2779 ;;; if the master file gets nuked in window P.
2781 ;;; Case 3 in RCS and case 15 under SCCS insert a redundant delta with
2782 ;;; no change comment in the master. This would require a self-race in
2783 ;;; window P or R respectively.
2785 ;;; Cases 2, 10, 19 and 20 do extra work, but make no changes.
2787 ;;; Unfortunately, it appears to me that no recovery is possible in these
2788 ;;; cases. They don't yield error messages, so there's no way to tell that
2789 ;;; a race condition has occurred.
2791 ;;; All other cases don't change either the workfile or the master, and
2792 ;;; trigger command errors which the user will see.
2794 ;;; Thus, there is no explicit recovery code.