1 ;;; vc.el --- drive a version-control system from within Emacs
3 ;; Copyright (C) 1992, 93, 94, 95, 96, 97 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
100 "Version-control system in Emacs."
103 (defcustom vc-suppress-confirm nil
104 "*If non-nil, treat user as expert; suppress yes-no prompts on some things."
108 (defcustom vc-initial-comment nil
109 "*If non-nil, prompt for initial comment when a file is registered."
113 (defcustom vc-command-messages nil
114 "*If non-nil, display run messages from back-end commands."
118 (defcustom vc-checkin-switches nil
119 "*A string or list of strings specifying extra switches for checkin.
120 These are passed to the checkin program by \\[vc-checkin]."
121 :type
'(choice (const :tag
"None" nil
)
122 (string :tag
"Argument String")
123 (repeat :tag
"Argument List"
128 (defcustom vc-checkout-switches nil
129 "*A string or list of strings specifying extra switches for checkout.
130 These are passed to the checkout program by \\[vc-checkout]."
131 :type
'(choice (const :tag
"None" nil
)
132 (string :tag
"Argument String")
133 (repeat :tag
"Argument List"
138 (defcustom vc-register-switches nil
139 "*A string or list of strings; extra switches for registering a file.
140 These are passed to the checkin program by \\[vc-register]."
141 :type
'(choice (const :tag
"None" nil
)
142 (string :tag
"Argument String")
143 (repeat :tag
"Argument List"
148 (defcustom vc-directory-exclusion-list
'("SCCS" "RCS" "CVS")
149 "*List of directory names to be ignored while recursively walking file trees."
150 :type
'(repeat string
)
153 (defconst vc-maximum-comment-ring-size
32
154 "Maximum number of saved comments in the comment ring.")
156 ;;; This is duplicated in diff.el.
157 ;;; ...and customized.
158 (defvar diff-switches
"-c"
159 "*A string or list of strings specifying switches to be be passed to diff.")
162 (defcustom vc-checkin-hook nil
163 "*Normal hook (List of functions) run after a checkin is done.
169 (defcustom vc-before-checkin-hook nil
170 "*Normal hook (list of functions) run before a file gets checked in.
175 ;; Header-insertion hair
177 (defcustom vc-header-alist
178 '((SCCS "\%W\%") (RCS "\$Id\$") (CVS "\$Id\$"))
179 "*Header keywords to be inserted by `vc-insert-headers'.
180 Must be a list of two-element lists, the first element of each must
181 be `RCS', `CVS', or `SCCS'. The second element is the string to
182 be inserted for this particular backend."
183 :type
'(repeat (list :format
"%v"
184 (choice :tag
"System"
188 (string :tag
"Header")))
191 (defcustom vc-static-header-alist
193 "\n#ifndef lint\nstatic char vcid[] = \"\%s\";\n#endif /* lint */\n"))
194 "*Associate static header string templates with file types. A \%s in the
195 template is replaced with the first string associated with the file's
196 version-control type in `vc-header-alist'."
197 :type
'(repeat (cons :format
"%v"
198 (regexp :tag
"File Type")
199 (string :tag
"Header String")))
202 (defcustom vc-comment-alist
203 '((nroff-mode ".\\\"" ""))
204 "*Special comment delimiters to be used in generating vc headers only.
205 Add an entry in this list if you need to override the normal comment-start
206 and comment-end variables. This will only be necessary if the mode language
207 is sensitive to blank lines."
208 :type
'(repeat (list :format
"%v"
210 (string :tag
"Comment Start")
211 (string :tag
"Comment End")))
214 ;; Default is to be extra careful for super-user.
215 (defcustom vc-checkout-carefully
(= (user-uid) 0)
216 "*Non-nil means be extra-careful in checkout.
217 Verify that the file really is not locked
218 and that its contents match what the master file says."
222 (defcustom vc-rcs-release nil
223 "*The release number of your RCS installation, as a string.
224 If nil, VC itself computes this value when it is first needed."
225 :type
'(choice (const :tag
"Auto" nil
)
229 (defcustom vc-sccs-release nil
230 "*The release number of your SCCS installation, as a string.
231 If nil, VC itself computes this value when it is first needed."
232 :type
'(choice (const :tag
"Auto" nil
)
236 (defcustom vc-cvs-release nil
237 "*The release number of your CVS installation, as a string.
238 If nil, VC itself computes this value when it is first needed."
239 :type
'(choice (const :tag
"Auto" nil
)
243 ;; Variables the user doesn't need to know about.
244 (defvar vc-log-entry-mode nil
)
245 (defvar vc-log-operation nil
)
246 (defvar vc-log-after-operation-hook nil
)
247 (defvar vc-checkout-writable-buffer-hook
'vc-checkout-writable-buffer
)
248 ;; In a log entry buffer, this is a local variable
249 ;; that points to the buffer for which it was made
250 ;; (either a file, or a VC dired buffer).
251 (defvar vc-parent-buffer nil
)
252 (defvar vc-parent-buffer-name nil
)
255 (defvar vc-log-version
)
257 (defconst vc-name-assoc-file
"VC-names")
259 (defvar vc-dired-mode nil
)
260 (make-variable-buffer-local 'vc-dired-mode
)
262 (defvar vc-comment-ring
(make-ring vc-maximum-comment-ring-size
))
263 (defvar vc-comment-ring-index nil
)
264 (defvar vc-last-comment-match nil
)
266 ;; Back-portability to Emacs 18
268 (defun file-executable-p-18 (f)
269 (let ((modes (file-modes f
)))
270 (and modes
(not (zerop (logand 292))))))
272 (defun file-regular-p-18 (f)
273 (let ((attributes (file-attributes f
)))
274 (and attributes
(not (car attributes
)))))
276 ; Conditionally rebind some things for Emacs 18 compatibility
277 (if (not (boundp 'minor-mode-map-alist
))
279 (setq compilation-old-error-list nil
)
280 (fset 'file-executable-p
'file-executable-p-18
)
281 (fset 'shrink-window-if-larger-than-buffer
'beginning-of-buffer
)
284 (if (not (fboundp 'file-regular-p
))
285 (fset 'file-regular-p
'file-regular-p-18
))
287 ;;; Find and compare backend releases
289 (defun vc-backend-release (backend)
290 ;; Returns which backend release is installed on this system.
294 (and (zerop (vc-do-command nil nil
"rcs" nil nil
"-V"))
296 (set-buffer (get-buffer "*vc*"))
298 (car (vc-parse-buffer
299 '(("^RCS version \\([0-9.]+ *.*\\)" 1)))))))
300 (setq vc-rcs-release
'unknown
)))
303 (and (zerop (vc-do-command nil
1 "cvs" nil nil
"-v"))
305 (set-buffer (get-buffer "*vc*"))
307 (car (vc-parse-buffer
308 '(("^Concurrent Versions System (CVS) \\([0-9.]+\\)"
310 (setq vc-cvs-release
'unknown
)))
314 (defun vc-release-greater-or-equal (r1 r2
)
315 ;; Compare release numbers, represented as strings.
316 ;; Release components are assumed cardinal numbers, not decimal
317 ;; fractions (5.10 is a higher release than 5.9). Omitted fields
318 ;; are considered lower (5.6.7 is earlier than 5.6.7.1).
319 ;; Comparison runs till the end of the string is found, or a
320 ;; non-numeric component shows up (5.6.7 is earlier than "5.6.7 beta",
321 ;; which is probably not what you want in some cases).
322 ;; This code is suitable for existing RCS release numbers.
323 ;; CVS releases are handled reasonably, too (1.3 < 1.4* < 1.5).
326 (or (and (string-match "^\\.?\\([0-9]+\\)" r1
)
327 (setq i1
(match-end 0))
328 (setq v1
(string-to-number (match-string 1 r1
)))
329 (or (and (string-match "^\\.?\\([0-9]+\\)" r2
)
330 (setq i2
(match-end 0))
331 (setq v2
(string-to-number (match-string 1 r2
)))
332 (if (> v1 v2
) (throw 'done t
)
333 (if (< v1 v2
) (throw 'done nil
)
335 (vc-release-greater-or-equal
337 (substring r2 i2
)))))))
339 (or (and (string-match "^\\.?\\([0-9]+\\)" r2
)
343 (defun vc-backend-release-p (backend release
)
344 ;; Return t if we have RELEASE of BACKEND or better
345 (let (i r
(ri 0) (ii 0) is rs
(installation (vc-backend-release backend
)))
346 (if (not (eq installation
'unknown
))
348 ((or (eq backend
'RCS
) (eq backend
'CVS
))
349 (vc-release-greater-or-equal installation release
))))))
351 ;;; functions that operate on RCS revision numbers
353 (defun vc-trunk-p (rev)
354 ;; return t if REV is a revision on the trunk
355 (not (eq nil
(string-match "\\`[0-9]+\\.[0-9]+\\'" rev
))))
357 (defun vc-branch-part (rev)
358 ;; return the branch part of a revision number REV
359 (substring rev
0 (string-match "\\.[0-9]+\\'" rev
)))
361 ;; File property caching
363 (defun vc-clear-context ()
364 "Clear all cached file properties and the comment ring."
366 (fillarray vc-file-prop-obarray nil
)
367 ;; Note: there is potential for minor lossage here if there is an open
368 ;; log buffer with a nonzero local value of vc-comment-ring-index.
369 (setq vc-comment-ring
(make-ring vc-maximum-comment-ring-size
)))
371 (defun vc-file-clear-masterprops (file)
372 ;; clear all properties of FILE that were retrieved
373 ;; from the master file
374 (vc-file-setprop file
'vc-latest-version nil
)
375 (vc-file-setprop file
'vc-your-latest-version nil
)
376 (vc-backend-dispatch file
378 (vc-file-setprop file
'vc-master-locks nil
))
380 (vc-file-setprop file
'vc-default-branch nil
)
381 (vc-file-setprop file
'vc-head-version nil
)
382 (vc-file-setprop file
'vc-master-workfile-version nil
)
383 (vc-file-setprop file
'vc-master-locks nil
))
385 (vc-file-setprop file
'vc-cvs-status nil
))))
387 (defun vc-head-version (file)
388 ;; Return the RCS head version of FILE
389 (cond ((vc-file-getprop file
'vc-head-version
))
390 (t (vc-fetch-master-properties file
)
391 (vc-file-getprop file
'vc-head-version
))))
393 ;; Random helper functions
395 (defun vc-latest-on-branch-p (file)
396 ;; return t iff the current workfile version of FILE is
397 ;; the latest on its branch.
398 (vc-backend-dispatch file
400 (string= (vc-workfile-version file
) (vc-latest-version file
))
402 (let ((workfile-version (vc-workfile-version file
)) tip-version
)
403 (if (vc-trunk-p workfile-version
)
405 ;; Re-fetch the head version number. This is to make
406 ;; sure that no-one has checked in a new version behind
408 (vc-fetch-master-properties file
)
409 (string= (vc-file-getprop file
'vc-head-version
)
411 ;; If we are not on the trunk, we need to examine the
412 ;; whole current branch. (vc-master-workfile-version
413 ;; is not what we need.)
415 (set-buffer (get-buffer-create "*vc-info*"))
416 (vc-insert-file (vc-name file
) "^desc")
417 (setq tip-version
(car (vc-parse-buffer (list (list
418 (concat "^\\(" (regexp-quote (vc-branch-part workfile-version
))
419 "\\.[0-9]+\\)\ndate[ \t]+\\([0-9.]+\\);") 1 2)))))
420 (if (get-buffer "*vc-info*")
421 (kill-buffer (get-buffer "*vc-info*")))
422 (string= tip-version workfile-version
))))
426 (defun vc-registration-error (file)
428 (error "File %s is not under version control" file
)
429 (error "Buffer %s is not associated with a file" (buffer-name))))
431 (defvar vc-binary-assoc nil
)
433 (defun vc-find-binary (name)
434 "Look for a command anywhere on the subprocess-command search path."
435 (or (cdr (assoc name vc-binary-assoc
))
441 (let ((full (concat s
"/" name
)))
442 (if (file-executable-p full
)
444 (setq vc-binary-assoc
445 (cons (cons name full
) vc-binary-assoc
))
446 (throw 'found full
)))))))
450 (defun vc-do-command (buffer okstatus command file last
&rest flags
)
451 "Execute a version-control command, notifying user and checking for errors.
452 Output from COMMAND goes to BUFFER, or *vc* if BUFFER is nil.
453 The command is successful if its exit status does not exceed OKSTATUS.
454 (If OKSTATUS is nil, that means to ignore errors.)
455 The last argument of the command is the master name of FILE if LAST is
456 `MASTER', or the workfile of FILE if LAST is `WORKFILE'; this is appended
457 to an optional list of FLAGS."
458 (and file
(setq file
(expand-file-name file
)))
459 (if (not buffer
) (setq buffer
"*vc*"))
460 (if vc-command-messages
461 (message "Running %s on %s..." command file
))
462 (let ((obuf (current-buffer)) (camefrom (current-buffer))
464 (vc-file (and file
(vc-name file
)))
465 (olddir default-directory
)
467 (set-buffer (get-buffer-create buffer
))
468 (set (make-local-variable 'vc-parent-buffer
) camefrom
)
469 (set (make-local-variable 'vc-parent-buffer-name
)
470 (concat " from " (buffer-name camefrom
)))
471 (setq default-directory olddir
)
476 (function (lambda (s) (and s
(setq squeezed
(append squeezed
(list s
))))))
478 (if (and vc-file
(eq last
'MASTER
))
479 (setq squeezed
(append squeezed
(list vc-file
))))
480 (if (eq last
'WORKFILE
)
482 (let* ((pwd (expand-file-name default-directory
))
483 (preflen (length pwd
)))
484 (if (string= (substring file
0 preflen
) pwd
)
485 (setq file
(substring file preflen
))))
486 (setq squeezed
(append squeezed
(list file
)))))
487 (let ((exec-path (append vc-path exec-path
))
488 ;; Add vc-path to PATH for the execution of this command.
490 (cons (concat "PATH=" (getenv "PATH")
492 (mapconcat 'identity vc-path path-separator
))
493 process-environment
))
494 (w32-quote-process-args t
))
495 (setq status
(apply 'call-process command nil t nil squeezed
)))
496 (goto-char (point-max))
497 (set-buffer-modified-p nil
)
499 (if (or (not (integerp status
)) (and okstatus
(< okstatus status
)))
501 (pop-to-buffer buffer
)
502 (goto-char (point-min))
503 (shrink-window-if-larger-than-buffer)
504 (error "Running %s...FAILED (%s)" command
505 (if (integerp status
)
506 (format "status %d" status
)
509 (if vc-command-messages
510 (message "Running %s...OK" command
))
516 ;;; Save a bit of the text around POSN in the current buffer, to help
517 ;;; us find the corresponding position again later. This works even
518 ;;; if all markers are destroyed or corrupted.
519 ;;; A lot of this was shamelessly lifted from Sebastian Kremer's rcs.el mode.
520 (defun vc-position-context (posn)
523 (buffer-substring posn
524 (min (point-max) (+ posn
100)))))
526 ;;; Return the position of CONTEXT in the current buffer, or nil if we
527 ;;; couldn't find it.
528 (defun vc-find-position-by-context (context)
529 (let ((context-string (nth 2 context
)))
530 (if (equal "" context-string
)
533 (let ((diff (- (nth 1 context
) (buffer-size))))
534 (if (< diff
0) (setq diff
(- diff
)))
535 (goto-char (nth 0 context
))
536 (if (or (search-forward context-string nil t
)
537 ;; Can't use search-backward since the match may continue
539 (progn (goto-char (- (point) diff
(length context-string
)))
540 ;; goto-char doesn't signal an error at
541 ;; beginning of buffer like backward-char would
542 (search-forward context-string nil t
)))
543 ;; to beginning of OSTRING
544 (- (point) (length context-string
))))))))
546 (defun vc-buffer-context ()
547 ;; Return a list '(point-context mark-context reparse); from which
548 ;; vc-restore-buffer-context can later restore the context.
549 (let ((point-context (vc-position-context (point)))
550 ;; Use mark-marker to avoid confusion in transient-mark-mode.
551 (mark-context (if (eq (marker-buffer (mark-marker)) (current-buffer))
552 (vc-position-context (mark-marker))))
553 ;; Make the right thing happen in transient-mark-mode.
555 ;; We may want to reparse the compilation buffer after revert
556 (reparse (and (boundp 'compilation-error-list
) ;compile loaded
557 (let ((curbuf (current-buffer)))
558 ;; Construct a list; each elt is nil or a buffer
559 ;; iff that buffer is a compilation output buffer
560 ;; that contains markers into the current buffer.
566 compilation-old-error-list
567 compilation-error-list
))
568 (buffer-error-marked-p nil
))
569 (while (and (consp errors
)
570 (not buffer-error-marked-p
))
571 (and (markerp (cdr (car errors
)))
575 (setq buffer-error-marked-p t
))
576 (setq errors
(cdr errors
)))
577 (if buffer-error-marked-p buffer
))))
579 (list point-context mark-context reparse
)))
581 (defun vc-restore-buffer-context (context)
582 ;; Restore point/mark, and reparse any affected compilation buffers.
583 ;; CONTEXT is that which vc-buffer-context returns.
584 (let ((point-context (nth 0 context
))
585 (mark-context (nth 1 context
))
586 (reparse (nth 2 context
)))
587 ;; Reparse affected compilation buffers.
591 (set-buffer (car reparse
))
592 (let ((compilation-last-buffer (current-buffer)) ;select buffer
593 ;; Record the position in the compilation buffer of
594 ;; the last error next-error went to.
595 (error-pos (marker-position
596 (car (car-safe compilation-error-list
)))))
597 ;; Reparse the error messages as far as they were parsed before.
598 (compile-reinitialize-errors '(4) compilation-parsing-end
)
599 ;; Move the pointer up to find the error we were at before
600 ;; reparsing. Now next-error should properly go to the next one.
601 (while (and compilation-error-list
602 (/= error-pos
(car (car compilation-error-list
))))
603 (setq compilation-error-list
(cdr compilation-error-list
))))))
604 (setq reparse
(cdr reparse
)))
606 ;; Restore point and mark
607 (let ((new-point (vc-find-position-by-context point-context
)))
608 (if new-point
(goto-char new-point
)))
610 (let ((new-mark (vc-find-position-by-context mark-context
)))
611 (if new-mark
(set-mark new-mark
))))))
613 (defun vc-revert-buffer1 (&optional arg no-confirm
)
614 ;; Revert buffer, try to keep point and mark where user expects them in spite
615 ;; of changes because of expanded version-control key words.
616 ;; This is quite important since otherwise typeahead won't work as expected.
619 (let ((context (vc-buffer-context)))
620 ;; t means don't call normal-mode; that's to preserve various minor modes.
621 (revert-buffer arg no-confirm t
)
622 (vc-restore-buffer-context context
)))
625 (defun vc-buffer-sync (&optional not-urgent
)
626 ;; Make sure the current buffer and its working file are in sync
627 ;; NOT-URGENT means it is ok to continue if the user says not to save.
628 (if (buffer-modified-p)
629 (if (or vc-suppress-confirm
630 (y-or-n-p (format "Buffer %s modified; save it? " (buffer-name))))
634 (error "Aborted")))))
637 (defun vc-workfile-unchanged-p (file &optional want-differences-if-changed
)
638 ;; Has the given workfile changed since last checkout?
639 (let ((checkout-time (vc-file-getprop file
'vc-checkout-time
))
640 (lastmod (nth 5 (file-attributes file
))))
641 (or (equal checkout-time lastmod
)
642 (and (or (not checkout-time
) want-differences-if-changed
)
643 (let ((unchanged (zerop (vc-backend-diff file nil nil
644 (not want-differences-if-changed
)))))
645 ;; 0 stands for an unknown time; it can't match any mod time.
646 (vc-file-setprop file
'vc-checkout-time
(if unchanged lastmod
0))
649 (defun vc-next-action-on-file (file verbose
&optional comment
)
650 ;;; If comment is specified, it will be used as an admin or checkin comment.
651 (let ((vc-file (vc-name file
))
652 (vc-type (vc-backend file
))
653 owner version buffer
)
656 ;; if there is no master file corresponding, create one
658 (vc-register verbose comment
)
659 (if vc-initial-comment
660 (setq vc-log-after-operation-hook
661 'vc-checkout-writable-buffer-hook
)
662 (vc-checkout-writable-buffer file
)))
664 ;; CVS: changes to the master file need to be
665 ;; merged back into the working file
666 ((and (eq vc-type
'CVS
)
667 (or (eq (vc-cvs-status file
) 'needs-checkout
)
668 (eq (vc-cvs-status file
) 'needs-merge
)))
669 (if (or vc-dired-mode
671 (format "%s is not up-to-date. Merge in changes now? "
675 (and (setq buffer
(get-file-buffer file
))
676 (buffer-modified-p buffer
)
677 (switch-to-buffer-other-window buffer
)
679 (setq buffer
(current-buffer))
681 (if (and buffer
(buffer-modified-p buffer
)
684 "Buffer %s modified; merge file on disc anyhow? "
685 (buffer-name buffer
)))))
686 (error "Merge aborted"))
687 (if (not (zerop (vc-backend-merge-news file
)))
688 ;; Overlaps detected - what now? Should use some
689 ;; fancy RCS conflict resolving package, or maybe
690 ;; emerge, but for now, simply warn the user with a
692 (message "Conflicts detected!"))
694 (vc-resynch-buffer file t
(not (buffer-modified-p buffer
)))))
695 (error "%s needs update" (buffer-name))))
697 ;; If there is no lock on the file, assert one and get it.
698 ;; (With implicit checkout, make sure not to lose unsaved changes.)
699 ((progn (and (eq (vc-checkout-model file
) 'implicit
)
700 (buffer-modified-p buffer
)
702 (not (setq owner
(vc-locking-user file
))))
703 (if (and vc-checkout-carefully
704 (not (vc-workfile-unchanged-p file t
)))
705 (if (save-window-excursion
706 (pop-to-buffer "*vc-diff*")
707 (goto-char (point-min))
708 (insert-string (format "Changes to %s since last lock:\n\n"
712 (concat "File has unlocked changes, "
713 "claim lock retaining changes? ")))
714 (progn (vc-backend-steal file
)
716 (if (not (yes-or-no-p "Revert to checked-in version, instead? "))
717 (error "Checkout aborted")
718 (vc-revert-buffer1 t t
)
719 (vc-checkout-writable-buffer file
))
722 (if (not (eq vc-type
'SCCS
))
723 (vc-checkout file nil
724 (read-string "Branch or version to move to: "))
725 (error "Sorry, this is not implemented for SCCS"))
726 (if (vc-latest-on-branch-p file
)
727 (vc-checkout-writable-buffer file
)
729 "This is not the latest version. Really lock it? ")
730 (vc-checkout-writable-buffer file
)
731 (if (yes-or-no-p "Lock the latest version instead? ")
732 (vc-checkout-writable-buffer file
733 (if (vc-trunk-p (vc-workfile-version file
))
734 "" ;; this means check out latest on trunk
735 (vc-branch-part (vc-workfile-version file
)))))))
738 ;; a checked-out version exists, but the user may not own the lock
739 ((and (not (eq vc-type
'CVS
))
740 (not (string-equal owner
(vc-user-login-name))))
742 (error "Sorry, you can't steal the lock on %s this way" file
))
743 (and (eq vc-type
'RCS
)
744 (not (vc-backend-release-p 'RCS
"5.6.2"))
745 (error "File is locked by %s" owner
))
748 (if verbose
(read-string "Version to steal: ")
749 (vc-workfile-version file
))
752 ;; OK, user owns the lock on the file
755 (find-file-other-window file
)
758 ;; give luser a chance to save before checking in.
761 ;; Revert if file is unchanged and buffer is too.
762 ;; If buffer is modified, that means the user just said no
763 ;; to saving it; in that case, don't revert,
764 ;; because the user might intend to save
765 ;; after finishing the log entry.
766 (if (and (vc-workfile-unchanged-p file
)
767 (not (buffer-modified-p)))
768 ;; DO NOT revert the file without asking the user!
770 ((yes-or-no-p "Revert to master version? ")
771 (vc-backend-revert file
)
772 (vc-resynch-window file t t
)))
774 ;; user may want to set nonstandard parameters
776 (setq version
(read-string "New version level: ")))
778 ;; OK, let's do the checkin
779 (vc-checkin file version comment
)
782 (defun vc-next-action-dired (file rev comment
)
783 ;; Do a vc-next-action-on-file on all the marked files, possibly
784 ;; passing on the log comment we've just entered.
785 (let ((configuration (current-window-configuration))
786 (dired-buffer (current-buffer))
787 (dired-dir default-directory
))
788 (dired-map-over-marks
789 (let ((file (dired-get-filename)) p
790 (default-directory default-directory
))
791 (message "Processing %s..." file
)
792 ;; Adjust the default directory so that checkouts
793 ;; go to the right place.
794 (setq default-directory
(file-name-directory file
))
795 (vc-next-action-on-file file nil comment
)
796 (set-buffer dired-buffer
)
797 (setq default-directory dired-dir
)
798 (vc-dired-update-line file
)
799 (set-window-configuration configuration
)
800 (message "Processing %s...done" file
))
803 ;; Here's the major entry point.
806 (defun vc-next-action (verbose)
807 "Do the next logical checkin or checkout operation on the current file.
808 If you call this from within a VC dired buffer with no files marked,
809 it will operate on the file in the current line.
810 If you call this from within a VC dired buffer, and one or more
811 files are marked, it will accept a log message and then operate on
812 each one. The log message will be used as a comment for any register
813 or checkin operations, but ignored when doing checkouts. Attempted
814 lock steals will raise an error.
815 A prefix argument lets you specify the version number to use.
817 For RCS and SCCS files:
818 If the file is not already registered, this registers it for version
819 control and then retrieves a writable, locked copy for editing.
820 If the file is registered and not locked by anyone, this checks out
821 a writable and locked file ready for editing.
822 If the file is checked out and locked by the calling user, this
823 first checks to see if the file has changed since checkout. If not,
824 it performs a revert.
825 If the file has been changed, this pops up a buffer for entry
826 of a log message; when the message has been entered, it checks in the
827 resulting changes along with the log message as change commentary. If
828 the variable `vc-keep-workfiles' is non-nil (which is its default), a
829 read-only copy of the changed file is left in place afterwards.
830 If the file is registered and locked by someone else, you are given
831 the option to steal the lock.
834 If the file is not already registered, this registers it for version
835 control. This does a \"cvs add\", but no \"cvs commit\".
836 If the file is added but not committed, it is committed.
837 If your working file is changed, but the repository file is
838 unchanged, this pops up a buffer for entry of a log message; when the
839 message has been entered, it checks in the resulting changes along
840 with the logmessage as change commentary. A writable file is retained.
841 If the repository file is changed, you are asked if you want to
842 merge in the changes into your working copy."
847 (let ((files (dired-get-marked-files)))
850 (function (lambda (f)
851 (if (eq (vc-backend f
) 'CVS
)
852 (if (or (eq (vc-cvs-status f
) 'locally-modified
)
853 (eq (vc-cvs-status f
) 'locally-added
))
855 (if (vc-locking-user f
) "@" ""))))
857 (vc-next-action-dired nil nil
"dummy")
858 (vc-start-entry nil nil nil
859 "Enter a change comment for the marked files."
860 'vc-next-action-dired
))
862 (while vc-parent-buffer
863 (pop-to-buffer vc-parent-buffer
))
865 (vc-next-action-on-file buffer-file-name verbose
)
866 (vc-registration-error nil
))))
868 ;;; These functions help the vc-next-action entry point
870 (defun vc-checkout-writable-buffer (&optional file rev
)
871 "Retrieve a writable copy of the latest version of the current buffer's file."
872 (vc-checkout (or file
(buffer-file-name)) t rev
)
876 (defun vc-register (&optional override comment
)
877 "Register the current file into your version-control system."
880 (error "No visited file"))
881 (let ((master (vc-name buffer-file-name
)))
882 (and master
(file-exists-p master
)
883 (error "This file is already registered"))
885 (not (y-or-n-p "Previous master file has vanished. Make a new one? "))
886 (error "This file is already registered")))
887 ;; Watch out for new buffers of size 0: the corresponding file
888 ;; does not exist yet, even though buffer-modified-p is nil.
889 (if (and (not (buffer-modified-p))
890 (zerop (buffer-size))
891 (not (file-exists-p buffer-file-name
)))
892 (set-buffer-modified-p t
))
894 (cond ((not vc-make-backup-files
)
895 ;; inhibit backup for this buffer
896 (make-local-variable 'backup-inhibited
)
897 (setq backup-inhibited t
)))
902 (format "Initial version level for %s: " buffer-file-name
))))
905 (defun vc-resynch-window (file &optional keep noquery
)
906 ;; If the given file is in the current buffer,
907 ;; either revert on it so we see expanded keywords,
908 ;; or unvisit it (depending on vc-keep-workfiles)
909 ;; NOQUERY if non-nil inhibits confirmation for reverting.
910 ;; NOQUERY should be t *only* if it is known the only difference
911 ;; between the buffer and the file is due to RCS rather than user editing!
912 (and (string= buffer-file-name file
)
915 ;; temporarily remove vc-find-file-hook, so that
916 ;; we don't lose the properties
917 (remove-hook 'find-file-hooks
'vc-find-file-hook
)
918 (vc-revert-buffer1 t noquery
)
919 (add-hook 'find-file-hooks
'vc-find-file-hook
)
920 (vc-mode-line buffer-file-name
))
921 (kill-buffer (current-buffer)))))
923 (defun vc-resynch-buffer (file &optional keep noquery
)
924 ;; if FILE is currently visited, resynch its buffer
925 (let ((buffer (get-file-buffer file
)))
929 (vc-resynch-window file keep noquery
)))))
931 (defun vc-start-entry (file rev comment msg action
&optional after-hook
)
932 ;; Accept a comment for an operation on FILE revision REV. If COMMENT
933 ;; is nil, pop up a VC-log buffer, emit MSG, and set the
934 ;; action on close to ACTION; otherwise, do action immediately.
935 ;; Remember the file's buffer in vc-parent-buffer (current one if no file).
936 ;; AFTER-HOOK specifies the local value for vc-log-operation-hook.
937 (let ((parent (if file
(find-file-noselect file
) (current-buffer))))
938 (if vc-before-checkin-hook
942 (run-hooks 'vc-before-checkin-hook
))
943 (run-hooks 'vc-before-checkin-hook
)))
945 (set-buffer (get-buffer-create "*VC-log*"))
946 (pop-to-buffer (get-buffer-create "*VC-log*")))
947 (set (make-local-variable 'vc-parent-buffer
) parent
)
948 (set (make-local-variable 'vc-parent-buffer-name
)
949 (concat " from " (buffer-name vc-parent-buffer
)))
950 (if file
(vc-mode-line file
))
952 (make-local-variable 'vc-log-after-operation-hook
)
954 (setq vc-log-after-operation-hook after-hook
))
955 (setq vc-log-operation action
)
956 (setq vc-log-version rev
)
961 (vc-finish-logentry t
)
963 (vc-finish-logentry nil
)))
964 (message "%s Type C-c C-c when done." msg
))))
966 (defun vc-admin (file rev
&optional comment
)
967 "Check a file into your version-control system.
968 FILE is the unmodified name of the file. REV should be the base version
969 level to check it in under. COMMENT, if specified, is the checkin comment."
970 (vc-start-entry file rev
971 (or comment
(not vc-initial-comment
))
972 "Enter initial comment." 'vc-backend-admin
975 (defun vc-checkout (file &optional writable rev
)
976 "Retrieve a copy of the latest version of the given file."
977 ;; If ftp is on this system and the name matches the ange-ftp format
978 ;; for a remote file, the user is trying something that won't work.
979 (if (and (string-match "^/[^/:]+:" file
) (vc-find-binary "ftp"))
980 (error "Sorry, you can't check out files over FTP"))
981 (vc-backend-checkout file writable rev
)
982 (vc-resynch-buffer file t t
))
984 (defun vc-steal-lock (file rev
&optional owner
)
985 "Steal the lock on the current workfile."
986 (let (file-description)
988 (setq owner
(vc-locking-user file
)))
990 (setq file-description
(format "%s:%s" file rev
))
991 (setq file-description file
))
992 (if (not (y-or-n-p (format "Take the lock on %s from %s? "
993 file-description owner
)))
994 (error "Steal cancelled"))
995 (pop-to-buffer (get-buffer-create "*VC-mail*"))
996 (setq default-directory
(expand-file-name "~/"))
997 (auto-save-mode auto-save-default
)
1000 (mail-setup owner
(format "Stolen lock on %s" file-description
) nil nil nil
1001 (list (list 'vc-finish-steal file rev
)))
1002 (goto-char (point-max))
1004 (format "I stole the lock on %s, " file-description
)
1005 (current-time-string)
1007 (message "Please explain why you stole the lock. Type C-c C-c when done.")))
1009 ;; This is called when the notification has been sent.
1010 (defun vc-finish-steal (file version
)
1011 (vc-backend-steal file version
)
1012 (if (get-file-buffer file
)
1014 (set-buffer (get-file-buffer file
))
1015 (vc-resynch-window file t t
))))
1017 (defun vc-checkin (file &optional rev comment
)
1018 "Check in the file specified by FILE.
1019 The optional argument REV may be a string specifying the new version level
1020 \(if nil increment the current level). The file is either retained with write
1021 permissions zeroed, or deleted (according to the value of `vc-keep-workfiles').
1022 If the back-end is CVS, a writable workfile is always kept.
1023 COMMENT is a comment string; if omitted, a buffer is
1024 popped up to accept a comment."
1025 (vc-start-entry file rev comment
1026 "Enter a change comment." 'vc-backend-checkin
1029 ;;; Here is a checkin hook that may prove useful to sites using the
1030 ;;; ChangeLog facility supported by Emacs.
1031 (defun vc-comment-to-change-log (&optional whoami file-name
)
1032 "Enter last VC comment into change log file for current buffer's file.
1033 Optional arg (interactive prefix) non-nil means prompt for user name and site.
1034 Second arg is file name of change log. \
1035 If nil, uses `change-log-default-name'."
1036 (interactive (if current-prefix-arg
1037 (list current-prefix-arg
1038 (prompt-for-change-log-name))))
1039 ;; Make sure the defvar for add-log-current-defun-function has been executed
1040 ;; before binding it.
1042 (let (;; Extract the comment first so we get any error before doing anything.
1043 (comment (ring-ref vc-comment-ring
0))
1044 ;; Don't let add-change-log-entry insert a defun name.
1045 (add-log-current-defun-function 'ignore
)
1047 ;; Call add-log to do half the work.
1048 (add-change-log-entry whoami file-name t t
)
1049 ;; Insert the VC comment, leaving point before it.
1050 (setq end
(save-excursion (insert comment
) (point-marker)))
1051 (if (looking-at "\\s *\\s(")
1052 ;; It starts with an open-paren, as in "(foo): Frobbed."
1053 ;; So remove the ": " add-log inserted.
1055 ;; Canonicalize the white space between the file name and comment.
1057 ;; Indent rest of the text the same way add-log indented the first line.
1058 (let ((indentation (current-indentation)))
1060 (while (< (point) end
)
1062 (indent-to indentation
))
1063 (setq end
(point))))
1064 ;; Fill the inserted text, preserving open-parens at bol.
1065 (let ((paragraph-separate (concat paragraph-separate
"\\|\\s *\\s("))
1066 (paragraph-start (concat paragraph-start
"\\|\\s *\\s(")))
1068 (fill-region (point) end
))
1069 ;; Canonicalize the white space at the end of the entry so it is
1070 ;; separated from the next entry by a single blank line.
1071 (skip-syntax-forward " " end
)
1072 (delete-char (- (skip-syntax-backward " ")))
1073 (or (eobp) (looking-at "\n\n")
1077 (defun vc-finish-logentry (&optional nocomment
)
1078 "Complete the operation implied by the current log entry."
1080 ;; Check and record the comment, if any.
1083 (goto-char (point-max))
1086 ;; Comment too long?
1087 (vc-backend-logentry-check vc-log-file
)
1088 ;; Record the comment in the comment ring
1089 (ring-insert vc-comment-ring
(buffer-string))
1091 ;; Sync parent buffer in case the user modified it while editing the comment.
1092 ;; But not if it is a vc-dired buffer.
1094 (set-buffer vc-parent-buffer
)
1097 (if (not vc-log-operation
) (error "No log operation is pending"))
1098 ;; save the parameters held in buffer-local variables
1099 (let ((log-operation vc-log-operation
)
1100 (log-file vc-log-file
)
1101 (log-version vc-log-version
)
1102 (log-entry (buffer-string))
1103 (after-hook vc-log-after-operation-hook
))
1104 ;; Return to "parent" buffer of this checkin and remove checkin window
1105 (pop-to-buffer vc-parent-buffer
)
1106 (let ((logbuf (get-buffer "*VC-log*")))
1107 (delete-windows-on logbuf
)
1108 (kill-buffer logbuf
))
1111 (funcall log-operation
1115 ;; Now make sure we see the expanded headers
1116 (if buffer-file-name
1117 (vc-resynch-window buffer-file-name vc-keep-workfiles t
))
1118 (run-hooks after-hook
'vc-finish-logentry-hook
)))
1120 ;; Code for access to the comment ring
1122 (defun vc-previous-comment (arg)
1123 "Cycle backwards through comment history."
1125 (let ((len (ring-length vc-comment-ring
)))
1127 (message "Empty comment ring")
1131 ;; Initialize the index on the first use of this command
1132 ;; so that the first M-p gets index 0, and the first M-n gets
1134 (if (null vc-comment-ring-index
)
1135 (setq vc-comment-ring-index
1137 (if (< arg
0) 1 0))))
1138 (setq vc-comment-ring-index
1139 (mod (+ vc-comment-ring-index arg
) len
))
1140 (message "%d" (1+ vc-comment-ring-index
))
1141 (insert (ring-ref vc-comment-ring vc-comment-ring-index
))))))
1143 (defun vc-next-comment (arg)
1144 "Cycle forwards through comment history."
1146 (vc-previous-comment (- arg
)))
1148 (defun vc-comment-search-reverse (str)
1149 "Searches backwards through comment history for substring match."
1150 (interactive "sComment substring: ")
1151 (if (string= str
"")
1152 (setq str vc-last-comment-match
)
1153 (setq vc-last-comment-match str
))
1154 (if (null vc-comment-ring-index
)
1155 (setq vc-comment-ring-index -
1))
1156 (let ((str (regexp-quote str
))
1157 (len (ring-length vc-comment-ring
))
1158 (n (1+ vc-comment-ring-index
)))
1159 (while (and (< n len
) (not (string-match str
(ring-ref vc-comment-ring n
))))
1162 (vc-previous-comment (- n vc-comment-ring-index
)))
1163 (t (error "Not found")))))
1165 (defun vc-comment-search-forward (str)
1166 "Searches forwards through comment history for substring match."
1167 (interactive "sComment substring: ")
1168 (if (string= str
"")
1169 (setq str vc-last-comment-match
)
1170 (setq vc-last-comment-match str
))
1171 (if (null vc-comment-ring-index
)
1172 (setq vc-comment-ring-index
0))
1173 (let ((str (regexp-quote str
))
1174 (len (ring-length vc-comment-ring
))
1175 (n vc-comment-ring-index
))
1176 (while (and (>= n
0) (not (string-match str
(ring-ref vc-comment-ring n
))))
1179 (vc-next-comment (- n vc-comment-ring-index
)))
1180 (t (error "Not found")))))
1182 ;; Additional entry points for examining version histories
1185 (defun vc-diff (historic &optional not-urgent
)
1186 "Display diffs between file versions.
1187 Normally this compares the current file and buffer with the most recent
1188 checked in version of that file. This uses no arguments.
1189 With a prefix argument, it reads the file name to use
1190 and two version designators specifying which versions to compare."
1191 (interactive (list current-prefix-arg t
))
1193 (set-buffer (find-file-noselect (dired-get-filename))))
1194 (while vc-parent-buffer
1195 (pop-to-buffer vc-parent-buffer
))
1197 (call-interactively 'vc-version-diff
)
1198 (if (or (null buffer-file-name
) (null (vc-name buffer-file-name
)))
1200 "There is no version-control master associated with this buffer"))
1201 (let ((file buffer-file-name
)
1203 (or (and file
(vc-name file
))
1204 (vc-registration-error file
))
1205 (vc-buffer-sync not-urgent
)
1206 (setq unchanged
(vc-workfile-unchanged-p buffer-file-name
))
1208 (message "No changes to %s since latest version" file
)
1209 (vc-backend-diff file
)
1210 ;; Ideally, we'd like at this point to parse the diff so that
1211 ;; the buffer effectively goes into compilation mode and we
1212 ;; can visit the old and new change locations via next-error.
1213 ;; Unfortunately, this is just too painful to do. The basic
1214 ;; problem is that the `old' file doesn't exist to be
1215 ;; visited. This plays hell with numerous assumptions in
1216 ;; the diff.el and compile.el machinery.
1217 (set-buffer "*vc-diff*")
1218 (setq default-directory
(file-name-directory file
))
1219 (if (= 0 (buffer-size))
1222 (message "No changes to %s since latest version" file
))
1223 (pop-to-buffer "*vc-diff*")
1224 (goto-char (point-min))
1225 (shrink-window-if-larger-than-buffer)))
1228 (defun vc-version-diff (file rel1 rel2
)
1229 "For FILE, report diffs between two stored versions REL1 and REL2 of it.
1230 If FILE is a directory, generate diffs between versions for all registered
1231 files in or below it."
1232 (interactive "FFile or directory to diff: \nsOlder version: \nsNewer version: ")
1233 (if (string-equal rel1
"") (setq rel1 nil
))
1234 (if (string-equal rel2
"") (setq rel2 nil
))
1235 (if (file-directory-p file
)
1236 (let ((camefrom (current-buffer)))
1237 (set-buffer (get-buffer-create "*vc-status*"))
1238 (set (make-local-variable 'vc-parent-buffer
) camefrom
)
1239 (set (make-local-variable 'vc-parent-buffer-name
)
1240 (concat " from " (buffer-name camefrom
)))
1242 (insert "Diffs between "
1243 (or rel1
"last version checked in")
1245 (or rel2
"current workfile(s)")
1247 (set-buffer (get-buffer-create "*vc-diff*"))
1251 (function (lambda (f)
1252 (message "Looking at %s" f
)
1254 (not (file-directory-p f
))
1256 (vc-backend-diff f rel1 rel2
)
1257 (append-to-buffer "*vc-status*" (point-min) (point-max)))
1259 (pop-to-buffer "*vc-status*")
1260 (insert "\nEnd of diffs.\n")
1261 (goto-char (point-min))
1262 (set-buffer-modified-p nil
)
1264 (if (zerop (vc-backend-diff file rel1 rel2
))
1265 (message "No changes to %s between %s and %s." file rel1 rel2
)
1266 (pop-to-buffer "*vc-diff*"))))
1269 (defun vc-version-other-window (rev)
1270 "Visit version REV of the current buffer in another window.
1271 If the current buffer is named `F', the version is named `F.~REV~'.
1272 If `F.~REV~' already exists, it is used instead of being re-created."
1273 (interactive "sVersion to visit (default is latest version): ")
1275 (set-buffer (find-file-noselect (dired-get-filename))))
1276 (while vc-parent-buffer
1277 (pop-to-buffer vc-parent-buffer
))
1278 (if (and buffer-file-name
(vc-name buffer-file-name
))
1279 (let* ((version (if (string-equal rev
"")
1280 (vc-latest-version buffer-file-name
)
1282 (filename (concat buffer-file-name
".~" version
"~")))
1283 (or (file-exists-p filename
)
1284 (vc-backend-checkout buffer-file-name nil version filename
))
1285 (find-file-other-window filename
))
1286 (vc-registration-error buffer-file-name
)))
1288 ;; Header-insertion code
1291 (defun vc-insert-headers ()
1292 "Insert headers in a file for use with your version-control system.
1293 Headers desired are inserted at the start of the buffer, and are pulled from
1294 the variable `vc-header-alist'."
1297 (find-file-other-window (dired-get-filename)))
1298 (while vc-parent-buffer
1299 (pop-to-buffer vc-parent-buffer
))
1303 (if (or (not (vc-check-headers))
1304 (y-or-n-p "Version headers already exist. Insert another set? "))
1306 (let* ((delims (cdr (assq major-mode vc-comment-alist
)))
1307 (comment-start-vc (or (car delims
) comment-start
"#"))
1308 (comment-end-vc (or (car (cdr delims
)) comment-end
""))
1309 (hdstrings (cdr (assoc (vc-backend (buffer-file-name)) vc-header-alist
))))
1310 (mapcar (function (lambda (s)
1311 (insert comment-start-vc
"\t" s
"\t"
1312 comment-end-vc
"\n")))
1314 (if vc-static-header-alist
1315 (mapcar (function (lambda (f)
1316 (if (string-match (car f
) buffer-file-name
)
1317 (insert (format (cdr f
) (car hdstrings
))))))
1318 vc-static-header-alist
))
1322 (defun vc-clear-headers ()
1323 ;; Clear all version headers in the current buffer, i.e. reset them
1324 ;; to the nonexpanded form. Only implemented for RCS, yet.
1325 ;; Don't lose point and mark during this.
1326 (let ((context (vc-buffer-context)))
1327 (goto-char (point-min))
1328 (while (re-search-forward "\\$\\([A-Za-z]+\\): [^\\$]+\\$" nil t
)
1329 (replace-match "$\\1$"))
1330 (vc-restore-buffer-context context
)))
1332 ;; The VC directory major mode. Coopt Dired for this.
1333 ;; All VC commands get mapped into logical equivalents.
1335 (define-derived-mode vc-dired-mode dired-mode
"Dired under VC"
1336 "The major mode used in VC directory buffers. It is derived from Dired.
1337 All Dired commands operate normally. Users currently locking listed files
1338 are listed in place of the file's owner and group.
1339 Keystrokes bound to VC commands will execute as though they had been called
1340 on a buffer attached to the file named in the current Dired buffer line."
1341 (setq vc-dired-mode t
))
1343 (define-key vc-dired-mode-map
"\C-xv" vc-prefix-map
)
1344 (define-key vc-dired-mode-map
"g" 'vc-dired-update
)
1345 (define-key vc-dired-mode-map
"=" 'vc-diff
)
1347 (defun vc-dired-state-info (file)
1348 ;; Return the string that indicates the version control status
1349 ;; on a VC dired line.
1350 (let ((cvs-state (and (eq (vc-backend file
) 'CVS
)
1351 (vc-cvs-status file
))))
1353 (cond ((eq cvs-state
'up-to-date
) nil
)
1354 ((eq cvs-state
'needs-checkout
) "patch")
1355 ((eq cvs-state
'locally-modified
) "modified")
1356 ((eq cvs-state
'needs-merge
) "merge")
1357 ((eq cvs-state
'unresolved-conflict
) "conflict")
1358 ((eq cvs-state
'locally-added
) "added"))
1359 (vc-locking-user file
))))
1361 (defun vc-dired-reformat-line (x)
1362 ;; Hack a directory-listing line, plugging in locking-user info in
1363 ;; place of the user and group info. Should have the beneficial
1364 ;; side-effect of shortening the listing line. Each call starts with
1365 ;; point immediately following the dired mark area on the line to be
1368 ;; Simplest possible one:
1369 ;; (insert (concat x "\t")))
1371 ;; This code, like dired, assumes UNIX -l format.
1372 (let ((pos (point)) limit perm owner date-and-file
)
1374 (setq limit
(point))
1378 (re-search-forward ;; owner and group
1379 "\\([drwxlts-]+ \\) *[0-9]+ \\([^ ]+\\) +[^ ]+ +[0-9]+\\( [^ 0-9]+ [0-9 ][0-9] .*\\)"
1381 (re-search-forward ;; only owner displayed
1382 "\\([drwxlts-]+ \\) *[0-9]+ \\([^ ]+\\) +[0-9]+\\( [^ 0-9]+ [0-9 ][0-9] .*\\)"
1384 (setq perm
(match-string 1)
1385 owner
(match-string 2)
1386 date-and-file
(match-string 3)))
1387 ((re-search-forward ;; OS/2 -l format, no links, owner, group
1388 "\\([drwxlts-]+ \\) *[0-9]+\\( [^ 0-9]+ [0-9 ][0-9] .*\\)"
1390 (setq perm
(match-string 1)
1391 date-and-file
(match-string 2))))
1392 (if x
(setq x
(concat "(" x
")")))
1393 (let ((rep (substring (concat x
" ") 0 10)))
1394 (replace-match (concat perm rep date-and-file
)))))
1396 (defun vc-dired-update-line (file)
1397 ;; Update the vc-dired listing line of file -- it is assumed
1398 ;; that point is already on this line. Don't use dired-do-redisplay
1399 ;; for this, because it cannot handle the way vc-dired deals with
1403 (let ((start (point)))
1406 (delete-region start
(point))
1407 (insert-directory file dired-listing-switches
)
1410 (delete-char (- (length file
)))
1411 (insert (substring file
(length (expand-file-name default-directory
))))
1413 (vc-dired-reformat-line (vc-dired-state-info file
)))
1415 (defun vc-dired-update (verbose)
1417 (vc-directory default-directory verbose
))
1419 ;;; Note in Emacs 18 the following defun gets overridden
1420 ;;; with the symbol 'vc-directory-18. See below.
1422 (defun vc-directory (dirname verbose
)
1423 "Show version-control status of the current directory and subdirectories.
1424 Normally it creates a Dired buffer that lists only the locked files
1425 in all these directories. With a prefix argument, it lists all files."
1426 (interactive "DDired under VC (directory): \nP")
1428 (setq dirname
(expand-file-name dirname
))
1429 ;; force a trailing slash
1430 (if (not (eq (elt dirname
(1- (length dirname
))) ?
/))
1431 (setq dirname
(concat dirname
"/")))
1433 (dl (length dirname
))
1434 (filelist nil
) (statelist nil
)
1435 (old-dir default-directory
)
1437 dired-buf-mod-count
)
1442 (if (vc-registered f
)
1443 (let ((state (vc-dired-state-info f
)))
1444 (and (or verbose state
)
1445 (setq filelist
(cons (substring f dl
) filelist
))
1446 (setq statelist
(cons state statelist
))))))))
1447 (save-window-excursion
1449 ;; This uses a semi-documented feature of dired; giving a switch
1450 ;; argument forces the buffer to refresh each time.
1452 (dired-internal-noselect
1453 (cons dirname
(nreverse filelist
))
1454 dired-listing-switches
'vc-dired-mode
))
1455 (setq nonempty
(not (eq 0 (length filelist
))))))
1456 (switch-to-buffer dired-buf
)
1457 ;; Make a few modifications to the header
1458 (setq buffer-read-only nil
)
1459 (goto-char (point-min))
1460 (forward-line 1) ;; Skip header line
1461 (let ((start (point))) ;; Erase (but don't remove) the
1462 (end-of-line) ;; "wildcard" line.
1463 (delete-region start
(point)))
1467 ;; Plug the version information into the individual lines
1471 (forward-char 2) ;; skip dired's mark area
1472 (vc-dired-reformat-line x
)
1473 (forward-line 1))) ;; go to next line
1474 (nreverse statelist
))
1475 (setq buffer-read-only t
)
1476 (goto-char (point-min))
1481 (setq buffer-read-only t
)
1482 (message "No files are currently %s under %s"
1483 (if verbose
"registered" "locked") dirname
))
1487 (defun vc-directory-18 (verbose)
1488 "Show version-control status of all files under the current directory."
1490 (let (nonempty (dir default-directory
))
1492 (set-buffer (get-buffer-create "*vc-status*"))
1497 (function (lambda (f)
1498 (if (vc-registered f
)
1499 (let ((user (vc-locking-user f
)))
1500 (if (or user verbose
)
1503 (concat user
) f
))))))))
1504 (setq nonempty
(not (zerop (buffer-size)))))
1508 (pop-to-buffer "*vc-status*" t
)
1509 (goto-char (point-min))
1510 (shrink-window-if-larger-than-buffer)))
1511 (message "No files are currently %s under %s"
1512 (if verbose
"registered" "locked") default-directory
))
1515 (or (boundp 'minor-mode-map-alist
)
1516 (fset 'vc-directory
'vc-directory-18
))
1518 ;; Named-configuration support for SCCS
1520 (defun vc-add-triple (name file rev
)
1522 (find-file (expand-file-name
1524 (file-name-as-directory
1525 (expand-file-name (vc-backend-subdirectory-name file
)
1526 (file-name-directory file
)))))
1527 (goto-char (point-max))
1528 (insert name
"\t:\t" file
"\t" rev
"\n")
1530 (kill-buffer (current-buffer))
1533 (defun vc-record-rename (file newname
)
1538 (file-name-as-directory
1539 (expand-file-name (vc-backend-subdirectory-name file
)
1540 (file-name-directory file
)))))
1541 (goto-char (point-min))
1542 ;; (replace-regexp (concat ":" (regexp-quote file) "$") (concat ":" newname))
1543 (while (re-search-forward (concat ":" (regexp-quote file
) "$") nil t
)
1544 (replace-match (concat ":" newname
) nil nil
))
1546 (kill-buffer (current-buffer))
1549 (defun vc-lookup-triple (file name
)
1550 ;; Return the numeric version corresponding to a named snapshot of file
1551 ;; If name is nil or a version number string it's just passed through
1552 (cond ((null name
) name
)
1553 ((let ((firstchar (aref name
0)))
1554 (and (>= firstchar ?
0) (<= firstchar ?
9)))
1558 (set-buffer (get-buffer-create "*vc-info*"))
1562 (file-name-as-directory
1563 (expand-file-name (vc-backend-subdirectory-name file
)
1564 (file-name-directory file
)))))
1566 (car (vc-parse-buffer
1567 (list (list (concat name
"\t:\t" file
"\t\\(.+\\)") 1))))
1568 (kill-buffer "*vc-info*"))))
1571 ;; Named-configuration entry points
1573 (defun vc-snapshot-precondition ()
1574 ;; Scan the tree below the current directory.
1575 ;; If any files are locked, return the name of the first such file.
1576 ;; (This means, neither snapshot creation nor retrieval is allowed.)
1577 ;; If one or more of the files are currently visited, return `visited'.
1578 ;; Otherwise, return nil.
1580 (catch 'vc-locked-example
1583 (function (lambda (f)
1584 (and (vc-registered f
)
1585 (if (vc-locking-user f
) (throw 'vc-locked-example f
)
1586 (if (get-file-buffer f
) (setq status
'visited
)))))))
1590 (defun vc-create-snapshot (name)
1591 "Make a snapshot called NAME.
1592 The snapshot is made from all registered files at or below the current
1593 directory. For each file, the version level of its latest
1594 version becomes part of the named configuration."
1595 (interactive "sNew snapshot name: ")
1596 (let ((result (vc-snapshot-precondition)))
1597 (if (stringp result
)
1598 (error "File %s is locked" result
)
1601 (function (lambda (f) (and
1603 (vc-backend-assign-name f name
)))))
1607 (defun vc-retrieve-snapshot (name)
1608 "Retrieve the snapshot called NAME.
1609 This function fails if any files are locked at or below the current directory
1610 Otherwise, all registered files are checked out (unlocked) at their version
1611 levels in the snapshot."
1612 (interactive "sSnapshot name to retrieve: ")
1613 (let ((result (vc-snapshot-precondition))
1615 (if (stringp result
)
1616 (error "File %s is locked" result
)
1617 (if (eq result
'visited
)
1618 (setq update
(yes-or-no-p "Update the affected buffers? ")))
1621 (function (lambda (f) (and
1624 (vc-backend-checkout f nil name
)
1625 (if update
(vc-resynch-buffer f t t
)))))))
1628 ;; Miscellaneous other entry points
1631 (defun vc-print-log ()
1632 "List the change log of the current buffer in a window."
1635 (set-buffer (find-file-noselect (dired-get-filename))))
1636 (while vc-parent-buffer
1637 (pop-to-buffer vc-parent-buffer
))
1638 (if (and buffer-file-name
(vc-name buffer-file-name
))
1639 (let ((file buffer-file-name
))
1640 (vc-backend-print-log file
)
1641 (pop-to-buffer (get-buffer-create "*vc*"))
1642 (setq default-directory
(file-name-directory file
))
1643 (goto-char (point-max)) (forward-line -
1)
1644 (while (looking-at "=*\n")
1645 (delete-char (- (match-end 0) (match-beginning 0)))
1647 (goto-char (point-min))
1648 (if (looking-at "[\b\t\n\v\f\r ]+")
1649 (delete-char (- (match-end 0) (match-beginning 0))))
1650 (shrink-window-if-larger-than-buffer)
1651 ;; move point to the log entry for the current version
1652 (and (not (eq (vc-backend file
) 'SCCS
))
1654 ;; also match some context, for safety
1655 (concat "----\nrevision " (vc-workfile-version file
)
1656 "\\(\tlocked by:.*\n\\|\n\\)date: ") nil t
)
1657 ;; set the display window so that
1658 ;; the whole log entry is displayed
1659 (let (start end lines
)
1660 (beginning-of-line) (forward-line -
1) (setq start
(point))
1661 (if (not (re-search-forward "^----*\nrevision" nil t
))
1662 (setq end
(point-max))
1663 (beginning-of-line) (forward-line -
1) (setq end
(point)))
1664 (setq lines
(count-lines start end
))
1666 ;; if the global information and this log entry fit
1667 ;; into the window, display from the beginning
1668 ((< (count-lines (point-min) end
) (window-height))
1669 (goto-char (point-min))
1672 ;; if the whole entry fits into the window,
1673 ;; display it centered
1674 ((< (1+ lines
) (window-height))
1676 (recenter (1- (- (/ (window-height) 2) (/ lines
2)))))
1677 ;; otherwise (the entry is too large for the window),
1678 ;; display from the start
1683 (vc-registration-error buffer-file-name
)
1688 (defun vc-revert-buffer ()
1689 "Revert the current buffer's file back to the latest checked-in version.
1690 This asks for confirmation if the buffer contents are not identical
1692 If the back-end is CVS, this will give you the most recent revision of
1693 the file on the branch you are editing."
1696 (find-file-other-window (dired-get-filename)))
1697 (while vc-parent-buffer
1698 (pop-to-buffer vc-parent-buffer
))
1699 (let ((file buffer-file-name
)
1700 ;; This operation should always ask for confirmation.
1701 (vc-suppress-confirm nil
)
1702 (obuf (current-buffer)) (changed (vc-diff nil t
)))
1703 (if (and changed
(not (yes-or-no-p "Discard changes? ")))
1705 (if (and (window-dedicated-p (selected-window))
1706 (one-window-p t
'selected-frame
))
1707 (make-frame-invisible (selected-frame))
1709 (error "Revert cancelled"))
1712 (if (and (window-dedicated-p (selected-window))
1713 (one-window-p t
'selected-frame
))
1714 (make-frame-invisible (selected-frame))
1716 (vc-backend-revert file
)
1717 (vc-resynch-window file t t
)
1722 (defun vc-cancel-version (norevert)
1723 "Get rid of most recently checked in version of this file.
1724 A prefix argument means do not revert the buffer afterwards."
1727 (find-file-other-window (dired-get-filename)))
1728 (while vc-parent-buffer
1729 (pop-to-buffer vc-parent-buffer
))
1731 ((not (vc-registered (buffer-file-name)))
1732 (vc-registration-error (buffer-file-name)))
1733 ((eq (vc-backend (buffer-file-name)) 'CVS
)
1734 (error "Unchecking files under CVS is dangerous and not supported in VC"))
1735 ((vc-locking-user (buffer-file-name))
1736 (error "This version is locked; use vc-revert-buffer to discard changes"))
1737 ((not (vc-latest-on-branch-p (buffer-file-name)))
1738 (error "This is not the latest version--VC cannot cancel it")))
1739 (let* ((target (vc-workfile-version (buffer-file-name)))
1740 (recent (if (vc-trunk-p target
) "" (vc-branch-part target
)))
1741 (config (current-window-configuration)) done
)
1742 (if (null (yes-or-no-p (format "Remove version %s from master? " target
)))
1744 (setq norevert
(or norevert
(not
1745 (yes-or-no-p "Revert buffer to most recent remaining version? "))))
1746 (vc-backend-uncheck (buffer-file-name) target
)
1747 ;; Check out the most recent remaining version. If it fails, because
1748 ;; the whole branch got deleted, do a double-take and check out the
1749 ;; version where the branch started.
1754 ;; Check out locked, but only to disc, and keep
1755 ;; modifications in the buffer.
1756 (vc-backend-checkout (buffer-file-name) t recent
)
1757 ;; Check out unlocked, and revert buffer.
1758 (vc-checkout (buffer-file-name) nil recent
))
1760 ;; If the checkout fails, vc-do-command signals an error.
1761 ;; We catch this error, check the reason, correct the
1762 ;; version number, and try a second time.
1763 (error (set-buffer "*vc*")
1764 (goto-char (point-min))
1765 (if (search-forward "no side branches present for" nil t
)
1766 (progn (setq recent
(vc-branch-part recent
))
1767 ;; vc-do-command popped up a window with
1768 ;; the error message. Get rid of it, by
1769 ;; restoring the old window configuration.
1770 (set-window-configuration config
))
1771 ;; No, it was some other error: re-signal it.
1772 (signal (car err
) (cdr err
))))))
1773 ;; If norevert, clear version headers and mark the buffer modified.
1776 (set-visited-file-name (buffer-file-name))
1777 (if (not vc-make-backup-files
)
1778 ;; inhibit backup for this buffer
1779 (progn (make-local-variable 'backup-inhibited
)
1780 (setq backup-inhibited t
)))
1781 (if (eq (vc-backend (buffer-file-name)) 'RCS
)
1782 (progn (setq buffer-read-only nil
)
1783 (vc-clear-headers)))
1784 (vc-mode-line (buffer-file-name))))
1785 (message "Version %s has been removed from the master" target
)
1789 (defun vc-rename-file (old new
)
1790 "Rename file OLD to NEW, and rename its master file likewise."
1791 (interactive "fVC rename file: \nFRename to: ")
1792 ;; There are several ways of renaming files under CVS 1.3, but they all
1793 ;; have serious disadvantages. See the FAQ (available from think.com in
1794 ;; pub/cvs/). I'd rather send the user an error, than do something he might
1795 ;; consider to be wrong. When the famous, long-awaited rename database is
1796 ;; implemented things might change for the better. This is unlikely to occur
1797 ;; until CVS 2.0 is released. --ceder 1994-01-23 21:27:51
1798 (if (eq (vc-backend old
) 'CVS
)
1799 (error "Renaming files under CVS is dangerous and not supported in VC"))
1800 (let ((oldbuf (get-file-buffer old
)))
1801 (if (and oldbuf
(buffer-modified-p oldbuf
))
1802 (error "Please save files before moving them"))
1803 (if (get-file-buffer new
)
1804 (error "Already editing new file name"))
1805 (if (file-exists-p new
)
1806 (error "New file already exists"))
1807 (let ((oldmaster (vc-name old
)))
1810 (if (vc-locking-user old
)
1811 (error "Please check in files before moving them"))
1812 (if (or (file-symlink-p oldmaster
)
1813 ;; This had FILE, I changed it to OLD. -- rms.
1814 (file-symlink-p (vc-backend-subdirectory-name old
)))
1815 (error "This is not a safe thing to do in the presence of symbolic links"))
1818 (let ((backend (vc-backend old
))
1819 (newdir (or (file-name-directory new
) ""))
1820 (newbase (file-name-nondirectory new
)))
1825 (if (eq backend
(cdr s
))
1826 (let* ((newmaster (format (car s
) newdir newbase
))
1827 (newmasterdir (file-name-directory newmaster
)))
1828 (if (or (not newmasterdir
)
1829 (file-directory-p newmasterdir
))
1830 (throw 'found newmaster
))))))
1831 vc-master-templates
)
1832 (error "New file lacks a version control directory"))))))
1833 (if (or (not oldmaster
) (file-exists-p old
))
1834 (rename-file old new
)))
1835 ; ?? Renaming a file might change its contents due to keyword expansion.
1836 ; We should really check out a new copy if the old copy was precisely equal
1837 ; to some checked in version. However, testing for this is tricky....
1841 (let ((buffer-read-only buffer-read-only
))
1842 (set-visited-file-name new
))
1845 (set-buffer-modified-p nil
))))
1846 ;; This had FILE, I changed it to OLD. -- rms.
1847 (vc-backend-dispatch old
1848 (vc-record-rename old new
) ;SCCS
1855 (defun vc-update-change-log (&rest args
)
1856 "Find change log file and add entries from recent RCS/CVS logs.
1857 Normally, find log entries for all registered files in the default
1858 directory using `rcs2log', which finds CVS logs preferentially.
1859 The mark is left at the end of the text prepended to the change log.
1861 With prefix arg of C-u, only find log entries for the current buffer's file.
1863 With any numeric prefix arg, find log entries for all currently visited
1864 files that are under version control. This puts all the entries in the
1865 log for the default directory, which may not be appropriate.
1867 From a program, any arguments are assumed to be filenames and are
1868 passed to the `rcs2log' script after massaging to be relative to the
1871 (cond ((consp current-prefix-arg
) ;C-u
1872 (list buffer-file-name
))
1873 (current-prefix-arg ;Numeric argument.
1875 (buffers (buffer-list))
1878 (setq file
(buffer-file-name (car buffers
)))
1879 (and file
(vc-backend file
)
1880 (setq files
(cons file files
)))
1881 (setq buffers
(cdr buffers
)))
1884 ;; `rcs2log' will find the relevant RCS or CVS files
1885 ;; relative to the curent directory if none supplied.
1887 (let ((odefault default-directory
)
1888 (changelog (find-change-log))
1889 ;; Presumably not portable to non-Unixy systems, along with rcs2log:
1890 (tempfile (make-temp-name
1891 (concat (file-name-as-directory
1892 (directory-file-name (or (getenv "TMPDIR")
1897 (full-name (or add-log-full-name
1900 (format "uid%d" (number-to-string (user-uid)))))
1901 (mailing-address (or add-log-mailing-address
1902 user-mail-address
)))
1903 (find-file-other-window changelog
)
1904 (barf-if-buffer-read-only)
1907 (goto-char (point-min))
1909 (message "Computing change log entries...")
1910 (message "Computing change log entries... %s"
1914 (if (eq 0 (apply 'call-process
"rcs2log" nil
1915 (list t tempfile
) nil
1917 "-u" (concat (vc-user-login-name)
1919 "\t" mailing-address
)
1924 (if (file-name-absolute-p f
)
1926 (concat odefault f
)))))
1930 (set-buffer (get-buffer-create "*vc*")))
1932 (insert-file tempfile
)
1934 (cd (file-name-directory changelog
))
1935 (delete-file tempfile
)))))
1937 ;; Collect back-end-dependent stuff here
1939 (defun vc-backend-admin (file &optional rev comment
)
1940 ;; Register a file into the version-control system
1941 ;; Automatically retrieves a read-only version of the file with
1942 ;; keywords expanded if vc-keep-workfiles is non-nil, otherwise
1943 ;; it deletes the workfile.
1944 (vc-file-clearprops file
)
1945 (or vc-default-back-end
1946 (setq vc-default-back-end
(if (vc-find-binary "rcs") 'RCS
'SCCS
)))
1947 (message "Registering %s..." file
)
1949 (if (stringp vc-register-switches
)
1950 (list vc-register-switches
)
1951 vc-register-switches
))
1954 ((file-exists-p (vc-backend-subdirectory-name)) vc-default-back-end
)
1955 ((file-exists-p "RCS") 'RCS
)
1956 ((file-exists-p "SCCS") 'SCCS
)
1957 ((file-exists-p "CVS") 'CVS
)
1958 (t vc-default-back-end
))))
1959 (cond ((eq backend
'SCCS
)
1960 ;; If there is no SCCS subdirectory yet, create it.
1961 ;; (SCCS could do without it, but VC requires it to be there.)
1962 (if (not (file-exists-p "SCCS")) (make-directory "SCCS"))
1963 (apply 'vc-do-command nil
0 "admin" file
'MASTER
;; SCCS
1964 (and rev
(concat "-r" rev
))
1967 (and comment
(concat "-y" comment
))
1969 (car (rassq 'SCCS vc-master-templates
))
1970 (or (file-name-directory file
) "")
1971 (file-name-nondirectory file
))
1974 (if vc-keep-workfiles
1975 (vc-do-command nil
0 "get" file
'MASTER
)))
1977 (apply 'vc-do-command nil
0 "ci" file
'WORKFILE
;; RCS
1978 ;; if available, use the secure registering option
1979 (and (vc-backend-release-p 'RCS
"5.6.4") "-i")
1980 (concat (if vc-keep-workfiles
"-u" "-r") rev
)
1981 (and comment
(concat "-t-" comment
))
1984 (apply 'vc-do-command nil
0 "cvs" file
'WORKFILE
;; CVS
1986 (and comment
(string-match "[^\t\n ]" comment
)
1987 (concat "-m" comment
))
1990 (message "Registering %s...done" file
)
1993 (defun vc-backend-checkout (file &optional writable rev workfile
)
1994 ;; Retrieve a copy of a saved version into a workfile
1995 (let ((filename (or workfile file
))
1996 (file-buffer (get-file-buffer file
))
1998 (message "Checking out %s..." filename
)
2000 ;; Change buffers to get local value of vc-checkout-switches.
2001 (if file-buffer
(set-buffer file-buffer
))
2002 (setq switches
(if (stringp vc-checkout-switches
)
2003 (list vc-checkout-switches
)
2004 vc-checkout-switches
))
2005 ;; Save this buffer's default-directory
2006 ;; and use save-excursion to make sure it is restored
2007 ;; in the same buffer it was saved in.
2008 (let ((default-directory default-directory
))
2010 ;; Adjust the default-directory so that the check-out creates
2011 ;; the file in the right place.
2012 (setq default-directory
(file-name-directory filename
))
2013 (vc-backend-dispatch file
2015 (and rev
(string= rev
"") (setq rev nil
))
2017 ;; Some SCCS implementations allow checking out directly to a
2018 ;; file using the -G option, but then some don't so use the
2019 ;; least common denominator approach and use the -p option
2021 (let ((vc-modes (logior (file-modes (vc-name file
))
2022 (if writable
128 0)))
2026 (apply 'vc-do-command
2027 nil
0 "/bin/sh" file
'MASTER
"-c"
2028 ;; Some shells make the "" dummy argument into $0
2029 ;; while others use the shell's name as $0 and
2030 ;; use the "" as $1. The if-statement
2031 ;; converts the latter case to the former.
2032 (format "if [ x\"$1\" = x ]; then shift; fi; \
2033 umask %o; exec >\"$1\" || exit; \
2034 shift; umask %o; exec get \"$@\""
2035 (logand 511 (lognot vc-modes
))
2036 (logand 511 (lognot (default-file-modes))))
2037 "" ; dummy argument for shell's $0
2042 (concat "-r" (vc-lookup-triple file rev
)))
2045 (and failed
(file-exists-p filename
)
2046 (delete-file filename
))))
2047 (apply 'vc-do-command nil
0 "get" file
'MASTER
;; SCCS
2049 (and rev
(concat "-r" (vc-lookup-triple file rev
)))
2051 (vc-file-setprop file
'vc-workfile-version nil
)))
2053 ;; RCS doesn't let us check out into arbitrary file names directly.
2054 ;; Use `co -p' and make stdout point to the correct file.
2055 (let ((vc-modes (logior (file-modes (vc-name file
))
2056 (if writable
128 0)))
2060 (apply 'vc-do-command
2061 nil
0 "/bin/sh" file
'MASTER
"-c"
2062 ;; See the SCCS case, above, regarding the
2064 (format "if [ x\"$1\" = x ]; then shift; fi; \
2065 umask %o; exec >\"$1\" || exit; \
2066 shift; umask %o; exec co \"$@\""
2067 (logand 511 (lognot vc-modes
))
2068 (logand 511 (lognot (default-file-modes))))
2069 "" ; dummy argument for shell's $0
2075 (and failed
(file-exists-p filename
) (delete-file filename
))))
2077 ;; if we should go to the head of the trunk,
2078 ;; clear the default branch first
2079 (and rev
(string= rev
"")
2080 (vc-do-command nil
0 "rcs" file
'MASTER
"-b"))
2081 ;; now do the checkout
2082 (apply 'vc-do-command
2083 nil
0 "co" file
'MASTER
2084 ;; If locking is not strict, force to overwrite
2085 ;; the writable workfile.
2086 (if (eq (vc-checkout-model file
) 'implicit
) "-f")
2088 (if rev
(concat "-r" rev
)
2089 ;; if no explicit revision was specified,
2090 ;; check out that of the working file
2091 (let ((workrev (vc-workfile-version file
)))
2092 (if workrev
(concat "-r" workrev
)
2095 ;; determine the new workfile version
2098 (goto-char (point-min))
2100 (if (re-search-forward "^revision \\([0-9.]+\\).*\n" nil t
)
2101 (buffer-substring (match-beginning 1) (match-end 1)))))
2102 (vc-file-setprop file
'vc-workfile-version new-version
)
2103 ;; if necessary, adjust the default branch
2104 (and rev
(not (string= rev
""))
2105 (vc-do-command nil
0 "rcs" file
'MASTER
2106 (concat "-b" (if (vc-latest-on-branch-p file
)
2107 (if (vc-trunk-p new-version
) nil
2108 (vc-branch-part new-version
))
2111 ;; CVS is much like RCS
2115 (apply 'vc-do-command
2116 nil
0 "/bin/sh" file
'WORKFILE
"-c"
2117 "exec >\"$1\" || exit; shift; exec cvs update \"$@\""
2118 "" ; dummy argument for shell's $0
2124 (and failed
(file-exists-p filename
) (delete-file filename
))))
2125 ;; default for verbose checkout: clear the sticky tag
2126 ;; so that the actual update will get the head of the trunk
2127 (and rev
(string= rev
"")
2128 (vc-do-command nil
0 "cvs" file
'WORKFILE
"update" "-A"))
2129 ;; If a revision was specified, check that out.
2131 (apply 'vc-do-command nil
0 "cvs" file
'WORKFILE
2132 (and writable
(eq (vc-checkout-model file
) 'manual
) "-w")
2134 (and rev
(not (string= rev
""))
2137 ;; If no revision was specified, simply make the file writable.
2139 (or (eq (vc-checkout-model file
) 'manual
)
2140 (zerop (logand 128 (file-modes file
))))
2141 (set-file-modes file
(logior 128 (file-modes file
)))))
2142 (if rev
(vc-file-setprop file
'vc-workfile-version nil
))))
2145 (vc-file-clear-masterprops file
)
2147 (vc-file-setprop file
'vc-locking-user
(vc-user-login-name)))
2148 (vc-file-setprop file
2149 'vc-checkout-time
(nth 5 (file-attributes file
)))))
2150 (message "Checking out %s...done" filename
))))))
2152 (defun vc-backend-logentry-check (file)
2153 (vc-backend-dispatch file
2154 (if (>= (buffer-size) 512) ;; SCCS
2158 "Log must be less than 512 characters; point is now at pos 512")))
2163 (defun vc-backend-checkin (file rev comment
)
2164 ;; Register changes to FILE as level REV with explanatory COMMENT.
2165 ;; Automatically retrieves a read-only version of the file with
2166 ;; keywords expanded if vc-keep-workfiles is non-nil, otherwise
2167 ;; it deletes the workfile.
2168 ;; Adaptation for RCS branch support: if this is an explicit checkin,
2169 ;; or if the checkin creates a new branch, set the master file branch
2171 (message "Checking in %s..." file
)
2172 ;; "This log message intentionally left almost blank".
2173 ;; RCS 5.7 gripes about white-space-only comments too.
2174 (or (and comment
(string-match "[^\t\n ]" comment
))
2175 (setq comment
"*** empty log message ***"))
2177 ;; Change buffers to get local value of vc-checkin-switches.
2178 (set-buffer (or (get-file-buffer file
) (current-buffer)))
2180 (if (stringp vc-checkin-switches
)
2181 (list vc-checkin-switches
)
2182 vc-checkin-switches
)))
2183 ;; Clear the master-properties. Do that here, not at the
2184 ;; end, because if the check-in fails we want them to get
2185 ;; re-computed before the next try.
2186 (vc-file-clear-masterprops file
)
2187 (vc-backend-dispatch file
2190 (apply 'vc-do-command nil
0 "delta" file
'MASTER
2191 (if rev
(concat "-r" rev
))
2192 (concat "-y" comment
)
2194 (vc-file-setprop file
'vc-locking-user
'none
)
2195 (vc-file-setprop file
'vc-workfile-version nil
)
2196 (if vc-keep-workfiles
2197 (vc-do-command nil
0 "get" file
'MASTER
))
2200 (let ((old-version (vc-workfile-version file
)) new-version
)
2201 (apply 'vc-do-command nil
0 "ci" file
'MASTER
2202 ;; if available, use the secure check-in option
2203 (and (vc-backend-release-p 'RCS
"5.6.4") "-j")
2204 (concat (if vc-keep-workfiles
"-u" "-r") rev
)
2205 (concat "-m" comment
)
2207 (vc-file-setprop file
'vc-locking-user
'none
)
2208 (vc-file-setprop file
'vc-workfile-version nil
)
2210 ;; determine the new workfile version
2212 (goto-char (point-min))
2213 (if (or (re-search-forward
2214 "new revision: \\([0-9.]+\\);" nil t
)
2216 "reverting to previous revision \\([0-9.]+\\)" nil t
))
2217 (progn (setq new-version
(buffer-substring (match-beginning 1)
2219 (vc-file-setprop file
'vc-workfile-version new-version
)))
2221 ;; if we got to a different branch, adjust the default
2222 ;; branch accordingly
2224 ((and old-version new-version
2225 (not (string= (vc-branch-part old-version
)
2226 (vc-branch-part new-version
))))
2227 (vc-do-command nil
0 "rcs" file
'MASTER
2228 (if (vc-trunk-p new-version
) "-b"
2229 (concat "-b" (vc-branch-part new-version
))))
2230 ;; If this is an old RCS release, we might have
2231 ;; to remove a remaining lock.
2232 (if (not (vc-backend-release-p 'RCS
"5.6.2"))
2233 ;; exit status of 1 is also accepted.
2234 ;; It means that the lock was removed before.
2235 (vc-do-command nil
1 "rcs" file
'MASTER
2236 (concat "-u" old-version
))))))
2239 ;; explicit check-in to the trunk requires a
2240 ;; double check-in (first unexplicit) (CVS-1.3)
2243 (if (and rev
(vc-trunk-p rev
))
2244 (apply 'vc-do-command nil
0 "cvs" file
'WORKFILE
2245 "ci" "-m" "intermediate"
2247 (apply 'vc-do-command nil
0 "cvs" file
'WORKFILE
2248 "ci" (if rev
(concat "-r" rev
))
2249 (concat "-m" comment
)
2251 (error (if (eq (vc-cvs-status file
) 'needs-merge
)
2252 ;; The CVS output will be on top of this message.
2253 (error "Type C-x 0 C-x C-q to merge in changes")
2254 (error "Check-in failed"))))
2255 ;; determine and store the new workfile version
2257 (goto-char (point-min))
2258 (if (re-search-forward
2259 "^\\(new\\|initial\\) revision: \\([0-9.]+\\)" nil t
)
2260 (vc-file-setprop file
'vc-workfile-version
2261 (buffer-substring (match-beginning 2)
2263 (vc-file-setprop file
'vc-workfile-version nil
))
2264 ;; if this was an explicit check-in, remove the sticky tag
2266 (vc-do-command nil
0 "cvs" file
'WORKFILE
"update" "-A"))
2267 (vc-file-setprop file
'vc-locking-user
'none
)
2268 (vc-file-setprop file
'vc-checkout-time
2269 (nth 5 (file-attributes file
)))))))
2270 (message "Checking in %s...done" file
))
2272 (defun vc-backend-revert (file)
2273 ;; Revert file to latest checked-in version.
2274 ;; (for RCS, to workfile version)
2275 (message "Reverting %s..." file
)
2276 (vc-file-clear-masterprops file
)
2277 (vc-backend-dispatch
2281 (vc-do-command nil
0 "unget" file
'MASTER nil
)
2282 (vc-do-command nil
0 "get" file
'MASTER nil
))
2284 (vc-do-command nil
0 "co" file
'MASTER
2285 "-f" (concat "-u" (vc-workfile-version file
)))
2289 (vc-do-command nil
0 "cvs" file
'WORKFILE
"update")))
2290 (vc-file-setprop file
'vc-locking-user
'none
)
2291 (vc-file-setprop file
'vc-checkout-time
(nth 5 (file-attributes file
)))
2292 (message "Reverting %s...done" file
)
2295 (defun vc-backend-steal (file &optional rev
)
2296 ;; Steal the lock on the current workfile. Needs RCS 5.6.2 or later for -M.
2297 (message "Stealing lock on %s..." file
)
2298 (vc-backend-dispatch file
2300 (vc-do-command nil
0 "unget" file
'MASTER
"-n" (if rev
(concat "-r" rev
)))
2301 (vc-do-command nil
0 "get" file
'MASTER
"-g" (if rev
(concat "-r" rev
)))
2303 (vc-do-command nil
0 "rcs" file
'MASTER
;RCS
2304 "-M" (concat "-u" rev
) (concat "-l" rev
))
2305 (error "You cannot steal a CVS lock; there are no CVS locks to steal") ;CVS
2307 (vc-file-setprop file
'vc-locking-user
(vc-user-login-name))
2308 (message "Stealing lock on %s...done" file
)
2311 (defun vc-backend-uncheck (file target
)
2312 ;; Undo the latest checkin.
2313 (message "Removing last change from %s..." file
)
2314 (vc-backend-dispatch file
2315 (vc-do-command nil
0 "rmdel" file
'MASTER
(concat "-r" target
))
2316 (vc-do-command nil
0 "rcs" file
'MASTER
(concat "-o" target
))
2317 nil
;; this is never reached under CVS
2319 (message "Removing last change from %s...done" file
)
2322 (defun vc-backend-print-log (file)
2323 ;; Get change log associated with FILE.
2324 (vc-backend-dispatch
2326 (vc-do-command nil
0 "prs" file
'MASTER
)
2327 (vc-do-command nil
0 "rlog" file
'MASTER
)
2328 (vc-do-command nil
0 "cvs" file
'WORKFILE
"log")))
2330 (defun vc-backend-assign-name (file name
)
2331 ;; Assign to a FILE's latest version a given NAME.
2332 (vc-backend-dispatch file
2333 (vc-add-triple name file
(vc-latest-version file
)) ;; SCCS
2334 (vc-do-command nil
0 "rcs" file
'MASTER
(concat "-n" name
":")) ;; RCS
2335 (vc-do-command nil
0 "cvs" file
'WORKFILE
"tag" name
) ;; CVS
2339 (defun vc-backend-diff (file &optional oldvers newvers cmp
)
2340 ;; Get a difference report between two versions of FILE.
2341 ;; Get only a brief comparison report if CMP, a difference report otherwise.
2342 (let ((backend (vc-backend file
)) options status
2343 (diff-switches-list (if (listp diff-switches
)
2345 (list diff-switches
))))
2348 (setq oldvers
(vc-lookup-triple file oldvers
))
2349 (setq newvers
(vc-lookup-triple file newvers
))
2350 (setq options
(append (list (and cmp
"--brief") "-q"
2351 (and oldvers
(concat "-r" oldvers
))
2352 (and newvers
(concat "-r" newvers
)))
2353 (and (not cmp
) diff-switches-list
)))
2354 (apply 'vc-do-command
"*vc-diff*" 1 "vcdiff" file
'MASTER options
))
2356 (if (not oldvers
) (setq oldvers
(vc-workfile-version file
)))
2357 ;; If we know that --brief is not supported, don't try it.
2358 (setq cmp
(and cmp
(not (eq vc-rcsdiff-knows-brief
'no
))))
2359 (setq options
(append (list (and cmp
"--brief") "-q"
2360 (concat "-r" oldvers
)
2361 (and newvers
(concat "-r" newvers
)))
2362 (and (not cmp
) diff-switches-list
)))
2363 (setq status
(apply 'vc-do-command
"*vc-diff*" 2
2364 "rcsdiff" file
'WORKFILE options
))
2365 ;; If --brief didn't work, do a double-take and remember it
2369 (apply 'vc-do-command
"*vc-diff*" 1 "rcsdiff" file
'WORKFILE
2370 (if cmp
(cdr options
) options
))
2371 (if cmp
(setq vc-rcsdiff-knows-brief
'no
)))
2372 ;; If --brief DID work, remember that, too.
2373 (and cmp
(not vc-rcsdiff-knows-brief
)
2374 (setq vc-rcsdiff-knows-brief
'yes
))
2376 ;; CVS is different.
2378 (if (string= (vc-workfile-version file
) "0")
2379 ;; This file is added but not yet committed; there is no master file.
2380 (if (or oldvers newvers
)
2381 (error "No revisions of %s exist" file
)
2382 (if cmp
1 ;; file is added but not committed,
2383 ;; we regard this as "changed".
2384 ;; diff it against /dev/null.
2385 (apply 'vc-do-command
2386 "*vc-diff*" 1 "diff" file
'WORKFILE
2387 (append (if (listp diff-switches
)
2389 (list diff-switches
)) '("/dev/null")))))
2390 ;; cmp is not yet implemented -- we always do a full diff.
2391 (apply 'vc-do-command
2392 "*vc-diff*" 1 "cvs" file
'WORKFILE
"diff"
2393 (and oldvers
(concat "-r" oldvers
))
2394 (and newvers
(concat "-r" newvers
))
2395 (if (listp diff-switches
)
2397 (list diff-switches
)))))
2399 (vc-registration-error file
)))))
2401 (defun vc-backend-merge-news (file)
2402 ;; Merge in any new changes made to FILE.
2403 (message "Merging changes into %s..." file
)
2405 (vc-backend-dispatch
2407 (error "vc-backend-merge-news not meaningful for SCCS files") ;SCCS
2408 (error "vc-backend-merge-news not meaningful for RCS files") ;RCS
2409 (save-excursion ; CVS
2410 (vc-file-clear-masterprops file
)
2411 (vc-file-setprop file
'vc-workfile-version nil
)
2412 (vc-file-setprop file
'vc-locking-user nil
)
2413 (vc-do-command nil
0 "cvs" file
'WORKFILE
"update")
2414 ;; CVS doesn't return an error code if conflicts are detected.
2415 ;; Since we want to warn the user about it (and possibly start
2416 ;; emerge later), scan the output and see if this occurred.
2417 (set-buffer (get-buffer "*vc*"))
2418 (goto-char (point-min))
2419 (if (re-search-forward "^cvs update: conflicts found in .*" nil t
)
2420 1 ;; error code for caller
2421 0 ;; no conflict detected
2423 (message "Merging changes into %s...done" file
)))
2425 (defun vc-check-headers ()
2426 "Check if the current file has any headers in it."
2429 (goto-char (point-min))
2430 (vc-backend-dispatch buffer-file-name
2431 (re-search-forward "%[MIRLBSDHTEGUYFPQCZWA]%" nil t
) ;; SCCS
2432 (re-search-forward "\\$[A-Za-z\300-\326\330-\366\370-\377]+\\(: [\t -#%-\176\240-\377]*\\)?\\$" nil t
) ;; RCS
2433 'RCS
;; CVS works like RCS in this regard.
2437 ;; Back-end-dependent stuff ends here.
2439 ;; Set up key bindings for use while editing log messages
2441 (defun vc-log-mode (&optional file
)
2442 "Minor mode for driving version-control tools.
2443 These bindings are added to the global keymap when you enter this mode:
2444 \\[vc-next-action] perform next logical version-control operation on current file
2445 \\[vc-register] register current file
2446 \\[vc-toggle-read-only] like next-action, but won't register files
2447 \\[vc-insert-headers] insert version-control headers in current file
2448 \\[vc-print-log] display change history of current file
2449 \\[vc-revert-buffer] revert buffer to latest version
2450 \\[vc-cancel-version] undo latest checkin
2451 \\[vc-diff] show diffs between file versions
2452 \\[vc-version-other-window] visit old version in another window
2453 \\[vc-directory] show all files locked by any user in or below .
2454 \\[vc-update-change-log] add change log entry from recent checkins
2456 While you are entering a change log message for a version, the following
2457 additional bindings will be in effect.
2459 \\[vc-finish-logentry] proceed with check in, ending log message entry
2461 Whenever you do a checkin, your log comment is added to a ring of
2462 saved comments. These can be recalled as follows:
2464 \\[vc-next-comment] replace region with next message in comment ring
2465 \\[vc-previous-comment] replace region with previous message in comment ring
2466 \\[vc-comment-search-reverse] search backward for regexp in the comment ring
2467 \\[vc-comment-search-forward] search backward for regexp in the comment ring
2469 Entry to the change-log submode calls the value of text-mode-hook, then
2470 the value of vc-log-mode-hook.
2472 Global user options:
2473 vc-initial-comment If non-nil, require user to enter a change
2474 comment upon first checkin of the file.
2476 vc-keep-workfiles Non-nil value prevents workfiles from being
2477 deleted when changes are checked in
2479 vc-suppress-confirm Suppresses some confirmation prompts,
2480 notably for reversions.
2482 vc-header-alist Which keywords to insert when adding headers
2483 with \\[vc-insert-headers]. Defaults to
2484 '(\"\%\W\%\") under SCCS, '(\"\$Id\$\") under
2487 vc-static-header-alist By default, version headers inserted in C files
2488 get stuffed in a static string area so that
2489 ident(RCS/CVS) or what(SCCS) can see them in
2490 the compiled object code. You can override
2491 this by setting this variable to nil, or change
2492 the header template by changing it.
2494 vc-command-messages if non-nil, display run messages from the
2495 actual version-control utilities (this is
2496 intended primarily for people hacking vc
2500 (set-syntax-table text-mode-syntax-table
)
2501 (use-local-map vc-log-entry-mode
)
2502 (setq local-abbrev-table text-mode-abbrev-table
)
2503 (setq major-mode
'vc-log-mode
)
2504 (setq mode-name
"VC-Log")
2505 (make-local-variable 'vc-log-file
)
2506 (setq vc-log-file file
)
2507 (make-local-variable 'vc-log-version
)
2508 (make-local-variable 'vc-comment-ring-index
)
2509 (set-buffer-modified-p nil
)
2510 (setq buffer-file-name nil
)
2511 (run-hooks 'text-mode-hook
'vc-log-mode-hook
)
2514 ;; Initialization code, to be done just once at load-time
2515 (if vc-log-entry-mode
2517 (setq vc-log-entry-mode
(make-sparse-keymap))
2518 (define-key vc-log-entry-mode
"\M-n" 'vc-next-comment
)
2519 (define-key vc-log-entry-mode
"\M-p" 'vc-previous-comment
)
2520 (define-key vc-log-entry-mode
"\M-r" 'vc-comment-search-reverse
)
2521 (define-key vc-log-entry-mode
"\M-s" 'vc-comment-search-forward
)
2522 (define-key vc-log-entry-mode
"\C-c\C-c" 'vc-finish-logentry
)
2525 ;;; These things should probably be generally available
2527 (defun vc-file-tree-walk (dirname func
&rest args
)
2528 "Walk recursively through DIRNAME.
2529 Invoke FUNC f ARGS on each non-directory file f underneath it."
2530 (vc-file-tree-walk-internal (expand-file-name dirname
) func args
)
2531 (message "Traversing directory %s...done" dirname
))
2533 (defun vc-file-tree-walk-internal (file func args
)
2534 (if (not (file-directory-p file
))
2535 (apply func file args
)
2536 (message "Traversing directory %s..." (abbreviate-file-name file
))
2537 (let ((dir (file-name-as-directory file
)))
2541 (string-equal f
".")
2542 (string-equal f
"..")
2543 (member f vc-directory-exclusion-list
)
2544 (let ((dirf (concat dir f
)))
2546 (file-symlink-p dirf
) ;; Avoid possible loops
2547 (vc-file-tree-walk-internal dirf func args
))))))
2548 (directory-files dir
)))))
2552 ;;; DEVELOPER'S NOTES ON CONCURRENCY PROBLEMS IN THIS CODE
2554 ;;; These may be useful to anyone who has to debug or extend the package.
2555 ;;; (Note that this information corresponds to versions 5.x. Some of it
2556 ;;; might have been invalidated by the additions to support branching
2557 ;;; and RCS keyword lookup. AS, 1995/03/24)
2559 ;;; A fundamental problem in VC is that there are time windows between
2560 ;;; vc-next-action's computations of the file's version-control state and
2561 ;;; the actions that change it. This is a window open to lossage in a
2562 ;;; multi-user environment; someone else could nip in and change the state
2563 ;;; of the master during it.
2565 ;;; The performance problem is that rlog/prs calls are very expensive; we want
2566 ;;; to avoid them as much as possible.
2570 ;;; The performance problem, it turns out, simplifies in practice to the
2571 ;;; problem of making vc-locking-user fast. The two other functions that call
2572 ;;; prs/rlog will not be so commonly used that the slowdown is a problem; one
2573 ;;; makes snapshots, the other deletes the calling user's last change in the
2576 ;;; The race condition implies that we have to either (a) lock the master
2577 ;;; during the entire execution of vc-next-action, or (b) detect and
2578 ;;; recover from errors resulting from dispatch on an out-of-date state.
2580 ;;; Alternative (a) appears to be infeasible. The problem is that we can't
2581 ;;; guarantee that the lock will ever be removed. Suppose a user starts a
2582 ;;; checkin, the change message buffer pops up, and the user, having wandered
2583 ;;; off to do something else, simply forgets about it?
2585 ;;; Alternative (b), on the other hand, works well with a cheap way to speed up
2586 ;;; vc-locking-user. Usually, if a file is registered, we can read its locked/
2587 ;;; unlocked state and its current owner from its permissions.
2589 ;;; This shortcut will fail if someone has manually changed the workfile's
2590 ;;; permissions; also if developers are munging the workfile in several
2591 ;;; directories, with symlinks to a master (in this latter case, the
2592 ;;; permissions shortcut will fail to detect a lock asserted from another
2595 ;;; Note that these cases correspond exactly to the errors which could happen
2596 ;;; because of a competing checkin/checkout race in between two instances of
2599 ;;; For VC's purposes, a workfile/master pair may have the following states:
2601 ;;; A. Unregistered. There is a workfile, there is no master.
2603 ;;; B. Registered and not locked by anyone.
2605 ;;; C. Locked by calling user and unchanged.
2607 ;;; D. Locked by the calling user and changed.
2609 ;;; E. Locked by someone other than the calling user.
2611 ;;; This makes for 25 states and 20 error conditions. Here's the matrix:
2613 ;;; VC's idea of state
2615 ;;; V Actual state RCS action SCCS action Effect
2617 ;;; A . 1 2 3 4 ci -u -t- admin -fb -i<file> initial admin
2618 ;;; B 5 . 6 7 8 co -l get -e checkout
2619 ;;; C 9 10 . 11 12 co -u unget; get revert
2620 ;;; D 13 14 15 . 16 ci -u -m<comment> delta -y<comment>; get checkin
2621 ;;; E 17 18 19 20 . rcs -u -M -l unget -n ; get -g steal lock
2623 ;;; All commands take the master file name as a last argument (not shown).
2625 ;;; In the discussion below, a "self-race" is a pathological situation in
2626 ;;; which VC operations are being attempted simultaneously by two or more
2627 ;;; Emacsen running under the same username.
2629 ;;; The vc-next-action code has the following windows:
2632 ;;; Between the check for existence of a master file and the call to
2633 ;;; admin/checkin in vc-buffer-admin (apparent state A). This window may
2634 ;;; never close if the initial-comment feature is on.
2637 ;;; Between the call to vc-workfile-unchanged-p in and the immediately
2638 ;;; following revert (apparent state C).
2641 ;;; Between the call to vc-workfile-unchanged-p in and the following
2642 ;;; checkin (apparent state D). This window may never close.
2645 ;;; Between the unlock and the immediately following checkout during a
2646 ;;; revert operation (apparent state C). Included in window Q.
2649 ;;; Between vc-locking-user and the following checkout (apparent state B).
2652 ;;; Between vc-locking-user and the following revert (apparent state C).
2653 ;;; Includes windows Q and S.
2656 ;;; Between vc-locking-user and the following checkin (apparent state
2657 ;;; D). This window may never be closed if the user fails to complete the
2658 ;;; checkin message. Includes window R.
2661 ;;; Between vc-locking-user and the following steal-lock (apparent
2662 ;;; state E). This window may never close if the user fails to complete
2663 ;;; the steal-lock message. Includes window X.
2666 ;;; Between the unlock and the immediately following re-lock during a
2667 ;;; steal-lock operation (apparent state E). This window may never cloce
2668 ;;; if the user fails to complete the steal-lock message.
2672 ;;; Apparent state A ---
2674 ;;; 1. File looked unregistered but is actually registered and not locked.
2676 ;;; Potential cause: someone else's admin during window P, with
2677 ;;; caller's admin happening before their checkout.
2679 ;;; RCS: Prior to version 5.6.4, ci fails with message
2680 ;;; "no lock set by <user>". From 5.6.4 onwards, VC uses the new
2681 ;;; ci -i option and the message is "<file>,v: already exists".
2682 ;;; SCCS: admin will fail with error (ad19).
2684 ;;; We can let these errors be passed up to the user.
2686 ;;; 2. File looked unregistered but is actually locked by caller, unchanged.
2688 ;;; Potential cause: self-race during window P.
2690 ;;; RCS: Prior to version 5.6.4, reverts the file to the last saved
2691 ;;; version and unlocks it. From 5.6.4 onwards, VC uses the new
2692 ;;; ci -i option, failing with message "<file>,v: already exists".
2693 ;;; SCCS: will fail with error (ad19).
2695 ;;; Either of these consequences is acceptable.
2697 ;;; 3. File looked unregistered but is actually locked by caller, changed.
2699 ;;; Potential cause: self-race during window P.
2701 ;;; RCS: Prior to version 5.6.4, VC registers the caller's workfile as
2702 ;;; a delta with a null change comment (the -t- switch will be
2703 ;;; ignored). From 5.6.4 onwards, VC uses the new ci -i option,
2704 ;;; failing with message "<file>,v: already exists".
2705 ;;; SCCS: will fail with error (ad19).
2707 ;;; 4. File looked unregistered but is locked by someone else.
2709 ;;; Potential cause: someone else's admin during window P, with
2710 ;;; caller's admin happening *after* their checkout.
2712 ;;; RCS: Prior to version 5.6.4, ci fails with a
2713 ;;; "no lock set by <user>" message. From 5.6.4 onwards,
2714 ;;; VC uses the new ci -i option, failing with message
2715 ;;; "<file>,v: already exists".
2716 ;;; SCCS: will fail with error (ad19).
2718 ;;; We can let these errors be passed up to the user.
2720 ;;; Apparent state B ---
2722 ;;; 5. File looked registered and not locked, but is actually unregistered.
2724 ;;; Potential cause: master file got nuked during window P.
2726 ;;; RCS: will fail with "RCS/<file>: No such file or directory"
2727 ;;; SCCS: will fail with error ut4.
2729 ;;; We can let these errors be passed up to the user.
2731 ;;; 6. File looked registered and not locked, but is actually locked by the
2732 ;;; calling user and unchanged.
2734 ;;; Potential cause: self-race during window T.
2736 ;;; RCS: in the same directory as the previous workfile, co -l will fail
2737 ;;; with "co error: writable foo exists; checkout aborted". In any other
2738 ;;; directory, checkout will succeed.
2739 ;;; SCCS: will fail with ge17.
2741 ;;; Either of these consequences is acceptable.
2743 ;;; 7. File looked registered and not locked, but is actually locked by the
2744 ;;; calling user and changed.
2748 ;;; 8. File looked registered and not locked, but is actually locked by another
2751 ;;; Potential cause: someone else checks it out during window T.
2753 ;;; RCS: co error: revision 1.3 already locked by <user>
2754 ;;; SCCS: fails with ge4 (in directory) or ut7 (outside it).
2756 ;;; We can let these errors be passed up to the user.
2758 ;;; Apparent state C ---
2760 ;;; 9. File looks locked by calling user and unchanged, but is unregistered.
2764 ;;; 10. File looks locked by calling user and unchanged, but is actually not
2767 ;;; Potential cause: a self-race in window U, or by the revert's
2768 ;;; landing during window X of some other user's steal-lock or window S
2769 ;;; of another user's revert.
2771 ;;; RCS: succeeds, refreshing the file from the identical version in
2773 ;;; SCCS: fails with error ut4 (p file nonexistent).
2775 ;;; Either of these consequences is acceptable.
2777 ;;; 11. File is locked by calling user. It looks unchanged, but is actually
2780 ;;; Potential cause: the file would have to be touched by a self-race
2781 ;;; during window Q.
2783 ;;; The revert will succeed, removing whatever changes came with
2784 ;;; the touch. It is theoretically possible that work could be lost.
2786 ;;; 12. File looks like it's locked by the calling user and unchanged, but
2787 ;;; it's actually locked by someone else.
2789 ;;; Potential cause: a steal-lock in window V.
2791 ;;; RCS: co error: revision <rev> locked by <user>; use co -r or rcs -u
2792 ;;; SCCS: fails with error un2
2794 ;;; We can pass these errors up to the user.
2796 ;;; Apparent state D ---
2798 ;;; 13. File looks like it's locked by the calling user and changed, but it's
2799 ;;; actually unregistered.
2801 ;;; Potential cause: master file got nuked during window P.
2803 ;;; RCS: Prior to version 5.6.4, checks in the user's version as an
2804 ;;; initial delta. From 5.6.4 onwards, VC uses the new ci -j
2805 ;;; option, failing with message "no such file or directory".
2806 ;;; SCCS: will fail with error ut4.
2808 ;;; This case is kind of nasty. Under RCS prior to version 5.6.4,
2809 ;;; VC may fail to detect the loss of previous version information.
2811 ;;; 14. File looks like it's locked by the calling user and changed, but it's
2812 ;;; actually unlocked.
2814 ;;; Potential cause: self-race in window V, or the checkin happening
2815 ;;; during the window X of someone else's steal-lock or window S of
2816 ;;; someone else's revert.
2818 ;;; RCS: ci will fail with "no lock set by <user>".
2819 ;;; SCCS: delta will fail with error ut4.
2821 ;;; 15. File looks like it's locked by the calling user and changed, but it's
2822 ;;; actually locked by the calling user and unchanged.
2824 ;;; Potential cause: another self-race --- a whole checkin/checkout
2825 ;;; sequence by the calling user would have to land in window R.
2827 ;;; SCCS: checks in a redundant delta and leaves the file unlocked as usual.
2828 ;;; RCS: reverts to the file state as of the second user's checkin, leaving
2829 ;;; the file unlocked.
2831 ;;; It is theoretically possible that work could be lost under RCS.
2833 ;;; 16. File looks like it's locked by the calling user and changed, but it's
2834 ;;; actually locked by a different user.
2836 ;;; RCS: ci error: no lock set by <user>
2837 ;;; SCCS: unget will fail with error un2
2839 ;;; We can pass these errors up to the user.
2841 ;;; Apparent state E ---
2843 ;;; 17. File looks like it's locked by some other user, but it's actually
2848 ;;; 18. File looks like it's locked by some other user, but it's actually
2851 ;;; Potential cause: someone released a lock during window W.
2853 ;;; RCS: The calling user will get the lock on the file.
2854 ;;; SCCS: unget -n will fail with cm4.
2856 ;;; Either of these consequences will be OK.
2858 ;;; 19. File looks like it's locked by some other user, but it's actually
2859 ;;; locked by the calling user and unchanged.
2861 ;;; Potential cause: the other user relinquishing a lock followed by
2862 ;;; a self-race, both in window W.
2864 ;;; Under both RCS and SCCS, both unlock and lock will succeed, making
2865 ;;; the sequence a no-op.
2867 ;;; 20. File looks like it's locked by some other user, but it's actually
2868 ;;; locked by the calling user and changed.
2874 ;;; In order of decreasing severity:
2876 ;;; Cases 11 and 15 are the only ones that potentially lose work.
2877 ;;; They would require a self-race for this to happen.
2879 ;;; Case 13 in RCS loses information about previous deltas, retaining
2880 ;;; only the information in the current workfile. This can only happen
2881 ;;; if the master file gets nuked in window P.
2883 ;;; Case 3 in RCS and case 15 under SCCS insert a redundant delta with
2884 ;;; no change comment in the master. This would require a self-race in
2885 ;;; window P or R respectively.
2887 ;;; Cases 2, 10, 19 and 20 do extra work, but make no changes.
2889 ;;; Unfortunately, it appears to me that no recovery is possible in these
2890 ;;; cases. They don't yield error messages, so there's no way to tell that
2891 ;;; a race condition has occurred.
2893 ;;; All other cases don't change either the workfile or the master, and
2894 ;;; trigger command errors which the user will see.
2896 ;;; Thus, there is no explicit recovery code.