1 ;;; vc.el --- drive a version-control system from within Emacs
3 ;; Copyright (C) 1992, 93, 94, 95, 96 Free Software Foundation, Inc.
5 ;; Author: Eric S. Raymond <esr@snark.thyrsus.com>
6 ;; Maintainer: Andre Spiegel <spiegel@inf.fu-berlin.de>
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software; you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation; either version 2, or (at your option)
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs; see the file COPYING. If not, write to the
22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23 ;; Boston, MA 02111-1307, USA.
27 ;; This mode is fully documented in the Emacs user's manual.
29 ;; This was designed and implemented by Eric Raymond <esr@snark.thyrsus.com>.
30 ;; Paul Eggert <eggert@twinsun.com>, Sebastian Kremer <sk@thp.uni-koeln.de>,
31 ;; and Richard Stallman contributed valuable criticism, support, and testing.
32 ;; CVS support was added by Per Cederqvist <ceder@lysator.liu.se>
33 ;; in Jan-Feb 1994. Further enhancements came from ttn.netcom.com and
34 ;; Andre Spiegel <spiegel@inf.fu-berlin.de>.
36 ;; Supported version-control systems presently include SCCS, RCS, and CVS.
38 ;; Some features will not work with old RCS versions. Where
39 ;; appropriate, VC finds out which version you have, and allows or
40 ;; disallows those features (stealing locks, for example, works only
41 ;; from 5.6.2 onwards).
42 ;; Even initial checkins will fail if your RCS version is so old that ci
43 ;; doesn't understand -t-; this has been known to happen to people running
46 ;; You can support the RCS -x option by adding pairs to the
47 ;; vc-master-templates list.
49 ;; Proper function of the SCCS diff commands requires the shellscript vcdiff
50 ;; to be installed somewhere on Emacs's path for executables.
52 ;; If your site uses the ChangeLog convention supported by Emacs, the
53 ;; function vc-comment-to-change-log should prove a useful checkin hook.
55 ;; This code depends on call-process passing back the subprocess exit
56 ;; status. Thus, you need Emacs 18.58 or later to run it. For the
57 ;; vc-directory command to work properly as documented, you need 19.
58 ;; You also need Emacs 19's ring.el.
60 ;; The vc code maintains some internal state in order to reduce expensive
61 ;; version-control operations to a minimum. Some names are only computed
62 ;; once. If you perform version control operations with RCS/SCCS/CVS while
63 ;; vc's back is turned, or move/rename master files while vc is running,
64 ;; vc may get seriously confused. Don't do these things!
66 ;; Developer's notes on some concurrency issues are included at the end of
73 (eval-when-compile (require 'dired
)) ; for dired-map-over-marks macro
75 (if (not (assoc 'vc-parent-buffer minor-mode-alist
))
76 (setq minor-mode-alist
77 (cons '(vc-parent-buffer vc-parent-buffer-name
)
80 ;; To implement support for a new version-control system, add another
81 ;; branch to the vc-backend-dispatch macro and fill it in in each
82 ;; call. The variable vc-master-templates in vc-hooks.el will also
85 (defmacro vc-backend-dispatch
(f s r c
)
86 "Execute FORM1, FORM2 or FORM3 for SCCS, RCS or CVS respectively.
87 If FORM3 is `RCS', use FORM2 for CVS as well as RCS.
88 \(CVS shares some code with RCS)."
89 (list 'let
(list (list 'type
(list 'vc-backend f
)))
91 (list (list 'eq
'type
(quote 'SCCS
)) s
) ;; SCCS
92 (list (list 'eq
'type
(quote 'RCS
)) r
) ;; RCS
93 (list (list 'eq
'type
(quote 'CVS
)) ;; CVS
97 ;; General customization
99 (defvar vc-suppress-confirm nil
100 "*If non-nil, treat user as expert; suppress yes-no prompts on some things.")
101 (defvar vc-initial-comment nil
102 "*If non-nil, prompt for initial comment when a file is registered.")
103 (defvar vc-command-messages nil
104 "*If non-nil, display run messages from back-end commands.")
105 (defvar vc-register-switches nil
106 "*A string or list of strings specifying extra switches passed
107 to the register program by \\[vc-register].")
108 (defvar vc-checkin-switches nil
109 "*A string or list of strings specifying extra switches passed
110 to the checkin program by \\[vc-checkin].")
111 (defvar vc-checkout-switches nil
112 "*A string or list of strings specifying extra switches passed
113 to the checkout program by \\[vc-checkout].")
114 (defvar vc-directory-exclusion-list
'("SCCS" "RCS" "CVS")
115 "*A list of directory names ignored by functions that recursively
118 (defconst vc-maximum-comment-ring-size
32
119 "Maximum number of saved comments in the comment ring.")
121 ;;; This is duplicated in diff.el.
122 (defvar diff-switches
"-c"
123 "*A string or list of strings specifying switches to be be passed to diff.")
126 (defvar vc-checkin-hook nil
127 "*List of functions called after a checkin is done. See `run-hooks'.")
129 ;; Header-insertion hair
131 (defvar vc-header-alist
132 '((SCCS "\%W\%") (RCS "\$Id\$") (CVS "\$Id\$"))
133 "*Header keywords to be inserted by `vc-insert-headers'.
134 Must be a list of two-element lists, the first element of each must
135 be `RCS', `CVS', or `SCCS'. The second element is the string to
136 be inserted for this particular backend.")
137 (defvar vc-static-header-alist
139 "\n#ifndef lint\nstatic char vcid[] = \"\%s\";\n#endif /* lint */\n"))
140 "*Associate static header string templates with file types. A \%s in the
141 template is replaced with the first string associated with the file's
142 version-control type in `vc-header-alist'.")
144 (defvar vc-comment-alist
145 '((nroff-mode ".\\\"" ""))
146 "*Special comment delimiters to be used in generating vc headers only.
147 Add an entry in this list if you need to override the normal comment-start
148 and comment-end variables. This will only be necessary if the mode language
149 is sensitive to blank lines.")
151 ;; Default is to be extra careful for super-user.
152 (defvar vc-checkout-carefully
(= (user-uid) 0)
153 "*Non-nil means be extra-careful in checkout.
154 Verify that the file really is not locked
155 and that its contents match what the master file says.")
157 (defvar vc-rcs-release nil
158 "*The release number of your RCS installation, as a string.
159 If nil, VC itself computes this value when it is first needed.")
161 (defvar vc-sccs-release nil
162 "*The release number of your SCCS installation, as a string.
163 If nil, VC itself computes this value when it is first needed.")
165 (defvar vc-cvs-release nil
166 "*The release number of your CVS installation, as a string.
167 If nil, VC itself computes this value when it is first needed.")
169 ;; Variables the user doesn't need to know about.
170 (defvar vc-log-entry-mode nil
)
171 (defvar vc-log-operation nil
)
172 (defvar vc-log-after-operation-hook nil
)
173 (defvar vc-checkout-writable-buffer-hook
'vc-checkout-writable-buffer
)
174 ;; In a log entry buffer, this is a local variable
175 ;; that points to the buffer for which it was made
176 ;; (either a file, or a VC dired buffer).
177 (defvar vc-parent-buffer nil
)
178 (defvar vc-parent-buffer-name nil
)
181 (defvar vc-log-version
)
183 (defconst vc-name-assoc-file
"VC-names")
185 (defvar vc-dired-mode nil
)
186 (make-variable-buffer-local 'vc-dired-mode
)
188 (defvar vc-comment-ring
(make-ring vc-maximum-comment-ring-size
))
189 (defvar vc-comment-ring-index nil
)
190 (defvar vc-last-comment-match nil
)
192 ;; Back-portability to Emacs 18
194 (defun file-executable-p-18 (f)
195 (let ((modes (file-modes f
)))
196 (and modes
(not (zerop (logand 292))))))
198 (defun file-regular-p-18 (f)
199 (let ((attributes (file-attributes f
)))
200 (and attributes
(not (car attributes
)))))
202 ; Conditionally rebind some things for Emacs 18 compatibility
203 (if (not (boundp 'minor-mode-map-alist
))
205 (setq compilation-old-error-list nil
)
206 (fset 'file-executable-p
'file-executable-p-18
)
207 (fset 'shrink-window-if-larger-than-buffer
'beginning-of-buffer
)
210 (if (not (fboundp 'file-regular-p
))
211 (fset 'file-regular-p
'file-regular-p-18
))
213 ;;; Find and compare backend releases
215 (defun vc-backend-release (backend)
216 ;; Returns which backend release is installed on this system.
220 (and (zerop (vc-do-command nil
2 "rcs" nil nil
"-V"))
222 (set-buffer (get-buffer "*vc*"))
224 (car (vc-parse-buffer
225 '(("^RCS version \\([0-9.]+ *.*\\)" 1)))))))
226 (setq vc-rcs-release
'unknown
)))
229 (and (zerop (vc-do-command nil
1 "cvs" nil nil
"-v"))
231 (set-buffer (get-buffer "*vc*"))
233 (car (vc-parse-buffer
234 '(("^Concurrent Versions System (CVS) \\([0-9.]+\\)"
236 (setq vc-cvs-release
'unknown
)))
240 (defun vc-release-greater-or-equal (r1 r2
)
241 ;; Compare release numbers, represented as strings.
242 ;; Release components are assumed cardinal numbers, not decimal
243 ;; fractions (5.10 is a higher release than 5.9). Omitted fields
244 ;; are considered lower (5.6.7 is earlier than 5.6.7.1).
245 ;; Comparison runs till the end of the string is found, or a
246 ;; non-numeric component shows up (5.6.7 is earlier than "5.6.7 beta",
247 ;; which is probably not what you want in some cases).
248 ;; This code is suitable for existing RCS release numbers.
249 ;; CVS releases are handled reasonably, too (1.3 < 1.4* < 1.5).
252 (or (and (string-match "^\\.?\\([0-9]+\\)" r1
)
253 (setq i1
(match-end 0))
254 (setq v1
(string-to-number (match-string 1 r1
)))
255 (or (and (string-match "^\\.?\\([0-9]+\\)" r2
)
256 (setq i2
(match-end 0))
257 (setq v2
(string-to-number (match-string 1 r2
)))
258 (if (> v1 v2
) (throw 'done t
)
259 (if (< v1 v2
) (throw 'done nil
)
261 (vc-release-greater-or-equal
263 (substring r2 i2
)))))))
265 (or (and (string-match "^\\.?\\([0-9]+\\)" r2
)
269 (defun vc-backend-release-p (backend release
)
270 ;; Return t if we have RELEASE of BACKEND or better
271 (let (i r
(ri 0) (ii 0) is rs
(installation (vc-backend-release backend
)))
272 (if (not (eq installation
'unknown
))
274 ((or (eq backend
'RCS
) (eq backend
'CVS
))
275 (vc-release-greater-or-equal installation release
))))))
277 ;;; functions that operate on RCS revision numbers
279 (defun vc-trunk-p (rev)
280 ;; return t if REV is a revision on the trunk
281 (not (eq nil
(string-match "\\`[0-9]+\\.[0-9]+\\'" rev
))))
283 (defun vc-branch-part (rev)
284 ;; return the branch part of a revision number REV
285 (substring rev
0 (string-match "\\.[0-9]+\\'" rev
)))
287 ;; File property caching
289 (defun vc-clear-context ()
290 "Clear all cached file properties and the comment ring."
292 (fillarray vc-file-prop-obarray nil
)
293 ;; Note: there is potential for minor lossage here if there is an open
294 ;; log buffer with a nonzero local value of vc-comment-ring-index.
295 (setq vc-comment-ring
(make-ring vc-maximum-comment-ring-size
)))
297 (defun vc-file-clear-masterprops (file)
298 ;; clear all properties of FILE that were retrieved
299 ;; from the master file
300 (vc-file-setprop file
'vc-latest-version nil
)
301 (vc-file-setprop file
'vc-your-latest-version nil
)
302 (vc-backend-dispatch file
304 (vc-file-setprop file
'vc-master-locks nil
))
306 (vc-file-setprop file
'vc-default-branch nil
)
307 (vc-file-setprop file
'vc-head-version nil
)
308 (vc-file-setprop file
'vc-master-workfile-version nil
)
309 (vc-file-setprop file
'vc-master-locks nil
))
311 (vc-file-setprop file
'vc-cvs-status nil
))))
313 (defun vc-head-version (file)
314 ;; Return the RCS head version of FILE
315 (cond ((vc-file-getprop file
'vc-head-version
))
316 (t (vc-fetch-master-properties file
)
317 (vc-file-getprop file
'vc-head-version
))))
319 ;; Random helper functions
321 (defun vc-latest-on-branch-p (file)
322 ;; return t iff the current workfile version of FILE is
323 ;; the latest on its branch.
324 (vc-backend-dispatch file
326 (string= (vc-workfile-version file
) (vc-latest-version file
))
328 (let ((workfile-version (vc-workfile-version file
)) tip-version
)
329 (if (vc-trunk-p workfile-version
)
331 ;; Re-fetch the head version number. This is to make
332 ;; sure that no-one has checked in a new version behind
334 (vc-fetch-master-properties file
)
335 (string= (vc-file-getprop file
'vc-head-version
)
337 ;; If we are not on the trunk, we need to examine the
338 ;; whole current branch. (vc-master-workfile-version
339 ;; is not what we need.)
341 (set-buffer (get-buffer-create "*vc-info*"))
342 (vc-insert-file (vc-name file
) "^desc")
343 (setq tip-version
(car (vc-parse-buffer (list (list
344 (concat "^\\(" (regexp-quote (vc-branch-part workfile-version
))
345 "\\.[0-9]+\\)\ndate[ \t]+\\([0-9.]+\\);") 1 2)))))
346 (if (get-buffer "*vc-info*")
347 (kill-buffer (get-buffer "*vc-info*")))
348 (string= tip-version workfile-version
))))
352 (defun vc-registration-error (file)
354 (error "File %s is not under version control" file
)
355 (error "Buffer %s is not associated with a file" (buffer-name))))
357 (defvar vc-binary-assoc nil
)
359 (defun vc-find-binary (name)
360 "Look for a command anywhere on the subprocess-command search path."
361 (or (cdr (assoc name vc-binary-assoc
))
367 (let ((full (concat s
"/" name
)))
368 (if (file-executable-p full
)
370 (setq vc-binary-assoc
371 (cons (cons name full
) vc-binary-assoc
))
372 (throw 'found full
)))))))
376 (defun vc-do-command (buffer okstatus command file last
&rest flags
)
377 "Execute a version-control command, notifying user and checking for errors.
378 Output from COMMAND goes to BUFFER, or *vc* if BUFFER is nil.
379 The command is successful if its exit status does not exceed OKSTATUS.
380 The last argument of the command is the master name of FILE if LAST is
381 `MASTER', or the workfile of FILE if LAST is `WORKFILE'; this is appended
382 to an optional list of FLAGS."
383 (and file
(setq file
(expand-file-name file
)))
384 (if (not buffer
) (setq buffer
"*vc*"))
385 (if vc-command-messages
386 (message "Running %s on %s..." command file
))
387 (let ((obuf (current-buffer)) (camefrom (current-buffer))
389 (vc-file (and file
(vc-name file
)))
390 (olddir default-directory
)
392 (set-buffer (get-buffer-create buffer
))
393 (set (make-local-variable 'vc-parent-buffer
) camefrom
)
394 (set (make-local-variable 'vc-parent-buffer-name
)
395 (concat " from " (buffer-name camefrom
)))
396 (setq default-directory olddir
)
401 (function (lambda (s) (and s
(setq squeezed
(append squeezed
(list s
))))))
403 (if (and vc-file
(eq last
'MASTER
))
404 (setq squeezed
(append squeezed
(list vc-file
))))
405 (if (eq last
'WORKFILE
)
407 (let* ((pwd (expand-file-name default-directory
))
408 (preflen (length pwd
)))
409 (if (string= (substring file
0 preflen
) pwd
)
410 (setq file
(substring file preflen
))))
411 (setq squeezed
(append squeezed
(list file
)))))
412 (let ((exec-path (append vc-path exec-path
))
413 ;; Add vc-path to PATH for the execution of this command.
415 (cons (concat "PATH=" (getenv "PATH")
417 (mapconcat 'identity vc-path path-separator
))
418 process-environment
))
419 (w32-quote-process-args t
))
420 (setq status
(apply 'call-process command nil t nil squeezed
)))
421 (goto-char (point-max))
422 (set-buffer-modified-p nil
)
424 (if (or (not (integerp status
)) (< okstatus status
))
426 (pop-to-buffer buffer
)
427 (goto-char (point-min))
428 (shrink-window-if-larger-than-buffer)
429 (error "Running %s...FAILED (%s)" command
430 (if (integerp status
)
431 (format "status %d" status
)
434 (if vc-command-messages
435 (message "Running %s...OK" command
))
441 ;;; Save a bit of the text around POSN in the current buffer, to help
442 ;;; us find the corresponding position again later. This works even
443 ;;; if all markers are destroyed or corrupted.
444 ;;; A lot of this was shamelessly lifted from Sebastian Kremer's rcs.el mode.
445 (defun vc-position-context (posn)
448 (buffer-substring posn
449 (min (point-max) (+ posn
100)))))
451 ;;; Return the position of CONTEXT in the current buffer, or nil if we
452 ;;; couldn't find it.
453 (defun vc-find-position-by-context (context)
454 (let ((context-string (nth 2 context
)))
455 (if (equal "" context-string
)
458 (let ((diff (- (nth 1 context
) (buffer-size))))
459 (if (< diff
0) (setq diff
(- diff
)))
460 (goto-char (nth 0 context
))
461 (if (or (search-forward context-string nil t
)
462 ;; Can't use search-backward since the match may continue
464 (progn (goto-char (- (point) diff
(length context-string
)))
465 ;; goto-char doesn't signal an error at
466 ;; beginning of buffer like backward-char would
467 (search-forward context-string nil t
)))
468 ;; to beginning of OSTRING
469 (- (point) (length context-string
))))))))
471 (defun vc-buffer-context ()
472 ;; Return a list '(point-context mark-context reparse); from which
473 ;; vc-restore-buffer-context can later restore the context.
474 (let ((point-context (vc-position-context (point)))
475 ;; Use mark-marker to avoid confusion in transient-mark-mode.
476 (mark-context (if (eq (marker-buffer (mark-marker)) (current-buffer))
477 (vc-position-context (mark-marker))))
478 ;; Make the right thing happen in transient-mark-mode.
480 ;; We may want to reparse the compilation buffer after revert
481 (reparse (and (boundp 'compilation-error-list
) ;compile loaded
482 (let ((curbuf (current-buffer)))
483 ;; Construct a list; each elt is nil or a buffer
484 ;; iff that buffer is a compilation output buffer
485 ;; that contains markers into the current buffer.
491 compilation-old-error-list
492 compilation-error-list
))
493 (buffer-error-marked-p nil
))
494 (while (and (consp errors
)
495 (not buffer-error-marked-p
))
496 (and (markerp (cdr (car errors
)))
500 (setq buffer-error-marked-p t
))
501 (setq errors
(cdr errors
)))
502 (if buffer-error-marked-p buffer
))))
504 (list point-context mark-context reparse
)))
506 (defun vc-restore-buffer-context (context)
507 ;; Restore point/mark, and reparse any affected compilation buffers.
508 ;; CONTEXT is that which vc-buffer-context returns.
509 (let ((point-context (nth 0 context
))
510 (mark-context (nth 1 context
))
511 (reparse (nth 2 context
)))
512 ;; Reparse affected compilation buffers.
516 (set-buffer (car reparse
))
517 (let ((compilation-last-buffer (current-buffer)) ;select buffer
518 ;; Record the position in the compilation buffer of
519 ;; the last error next-error went to.
520 (error-pos (marker-position
521 (car (car-safe compilation-error-list
)))))
522 ;; Reparse the error messages as far as they were parsed before.
523 (compile-reinitialize-errors '(4) compilation-parsing-end
)
524 ;; Move the pointer up to find the error we were at before
525 ;; reparsing. Now next-error should properly go to the next one.
526 (while (and compilation-error-list
527 (/= error-pos
(car (car compilation-error-list
))))
528 (setq compilation-error-list
(cdr compilation-error-list
))))))
529 (setq reparse
(cdr reparse
)))
531 ;; Restore point and mark
532 (let ((new-point (vc-find-position-by-context point-context
)))
533 (if new-point
(goto-char new-point
)))
535 (let ((new-mark (vc-find-position-by-context mark-context
)))
536 (if new-mark
(set-mark new-mark
))))))
538 (defun vc-revert-buffer1 (&optional arg no-confirm
)
539 ;; Revert buffer, try to keep point and mark where user expects them in spite
540 ;; of changes because of expanded version-control key words.
541 ;; This is quite important since otherwise typeahead won't work as expected.
544 (let ((context (vc-buffer-context)))
545 ;; t means don't call normal-mode; that's to preserve various minor modes.
546 (revert-buffer arg no-confirm t
)
547 (vc-restore-buffer-context context
)))
550 (defun vc-buffer-sync (&optional not-urgent
)
551 ;; Make sure the current buffer and its working file are in sync
552 ;; NOT-URGENT means it is ok to continue if the user says not to save.
553 (if (buffer-modified-p)
554 (if (or vc-suppress-confirm
555 (y-or-n-p (format "Buffer %s modified; save it? " (buffer-name))))
559 (error "Aborted")))))
562 (defun vc-workfile-unchanged-p (file &optional want-differences-if-changed
)
563 ;; Has the given workfile changed since last checkout?
564 (let ((checkout-time (vc-file-getprop file
'vc-checkout-time
))
565 (lastmod (nth 5 (file-attributes file
))))
566 (or (equal checkout-time lastmod
)
567 (and (or (not checkout-time
) want-differences-if-changed
)
568 (let ((unchanged (zerop (vc-backend-diff file nil nil
569 (not want-differences-if-changed
)))))
570 ;; 0 stands for an unknown time; it can't match any mod time.
571 (vc-file-setprop file
'vc-checkout-time
(if unchanged lastmod
0))
574 (defun vc-next-action-on-file (file verbose
&optional comment
)
575 ;;; If comment is specified, it will be used as an admin or checkin comment.
576 (let ((vc-file (vc-name file
))
577 (vc-type (vc-backend file
))
578 owner version buffer
)
581 ;; if there is no master file corresponding, create one
583 (vc-register verbose comment
)
584 (if vc-initial-comment
585 (setq vc-log-after-operation-hook
586 'vc-checkout-writable-buffer-hook
)
587 (vc-checkout-writable-buffer file
)))
589 ;; CVS: changes to the master file need to be
590 ;; merged back into the working file
591 ((and (eq vc-type
'CVS
)
592 (or (eq (vc-cvs-status file
) 'needs-checkout
)
593 (eq (vc-cvs-status file
) 'needs-merge
)))
594 (if (or vc-dired-mode
596 (format "%s is not up-to-date. Merge in changes now? "
600 (and (setq buffer
(get-file-buffer file
))
601 (buffer-modified-p buffer
)
602 (switch-to-buffer-other-window buffer
)
604 (setq buffer
(current-buffer))
606 (if (and buffer
(buffer-modified-p buffer
)
609 "Buffer %s modified; merge file on disc anyhow? "
610 (buffer-name buffer
)))))
611 (error "Merge aborted"))
612 (if (not (zerop (vc-backend-merge-news file
)))
613 ;; Overlaps detected - what now? Should use some
614 ;; fancy RCS conflict resolving package, or maybe
615 ;; emerge, but for now, simply warn the user with a
617 (message "Conflicts detected!"))
619 (vc-resynch-buffer file t
(not (buffer-modified-p buffer
)))))
620 (error "%s needs update" (buffer-name))))
622 ;; if there is no lock on the file, assert one and get it
623 ((not (setq owner
(vc-locking-user file
)))
624 (if (and vc-checkout-carefully
625 (not (vc-workfile-unchanged-p file t
)))
626 (if (save-window-excursion
627 (pop-to-buffer "*vc-diff*")
628 (goto-char (point-min))
629 (insert-string (format "Changes to %s since last lock:\n\n"
633 (concat "File has unlocked changes, "
634 "claim lock retaining changes? ")))
635 (progn (vc-backend-steal file
)
637 (if (not (yes-or-no-p "Revert to checked-in version, instead? "))
638 (error "Checkout aborted")
639 (vc-revert-buffer1 t t
)
640 (vc-checkout-writable-buffer file
))
643 (if (not (eq vc-type
'SCCS
))
644 (vc-checkout file nil
645 (read-string "Branch or version to move to: "))
646 (error "Sorry, this is not implemented for SCCS"))
647 (if (vc-latest-on-branch-p file
)
648 (vc-checkout-writable-buffer file
)
650 "This is not the latest version. Really lock it? ")
651 (vc-checkout-writable-buffer file
)
652 (if (yes-or-no-p "Lock the latest version instead? ")
653 (vc-checkout-writable-buffer file
654 (if (vc-trunk-p (vc-workfile-version file
))
655 "" ;; this means check out latest on trunk
656 (vc-branch-part (vc-workfile-version file
)))))))
659 ;; a checked-out version exists, but the user may not own the lock
660 ((and (not (eq vc-type
'CVS
))
661 (not (string-equal owner
(vc-user-login-name))))
663 (error "Sorry, you can't steal the lock on %s this way" file
))
664 (and (eq vc-type
'RCS
)
665 (not (vc-backend-release-p 'RCS
"5.6.2"))
666 (error "File is locked by %s" owner
))
669 (if verbose
(read-string "Version to steal: ")
670 (vc-workfile-version file
))
673 ;; OK, user owns the lock on the file
676 (find-file-other-window file
)
679 ;; give luser a chance to save before checking in.
682 ;; Revert if file is unchanged and buffer is too.
683 ;; If buffer is modified, that means the user just said no
684 ;; to saving it; in that case, don't revert,
685 ;; because the user might intend to save
686 ;; after finishing the log entry.
687 (if (and (vc-workfile-unchanged-p file
)
688 (not (buffer-modified-p)))
689 ;; DO NOT revert the file without asking the user!
691 ((yes-or-no-p "Revert to master version? ")
692 (vc-backend-revert file
)
693 (vc-resynch-window file t t
)))
695 ;; user may want to set nonstandard parameters
697 (setq version
(read-string "New version level: ")))
699 ;; OK, let's do the checkin
700 (vc-checkin file version comment
)
703 (defun vc-next-action-dired (file rev comment
)
704 ;; Do a vc-next-action-on-file on all the marked files, possibly
705 ;; passing on the log comment we've just entered.
706 (let ((configuration (current-window-configuration))
707 (dired-buffer (current-buffer))
708 (dired-dir default-directory
))
709 (dired-map-over-marks
710 (let ((file (dired-get-filename)) p
711 (default-directory default-directory
))
712 (message "Processing %s..." file
)
713 ;; Adjust the default directory so that checkouts
714 ;; go to the right place.
715 (setq default-directory
(file-name-directory file
))
716 (vc-next-action-on-file file nil comment
)
717 (set-buffer dired-buffer
)
718 (setq default-directory dired-dir
)
719 (vc-dired-update-line file
)
720 (set-window-configuration configuration
)
721 (message "Processing %s...done" file
))
724 ;; Here's the major entry point.
727 (defun vc-next-action (verbose)
728 "Do the next logical checkin or checkout operation on the current file.
729 If you call this from within a VC dired buffer with no files marked,
730 it will operate on the file in the current line.
731 If you call this from within a VC dired buffer, and one or more
732 files are marked, it will accept a log message and then operate on
733 each one. The log message will be used as a comment for any register
734 or checkin operations, but ignored when doing checkouts. Attempted
735 lock steals will raise an error.
736 A prefix argument lets you specify the version number to use.
738 For RCS and SCCS files:
739 If the file is not already registered, this registers it for version
740 control and then retrieves a writable, locked copy for editing.
741 If the file is registered and not locked by anyone, this checks out
742 a writable and locked file ready for editing.
743 If the file is checked out and locked by the calling user, this
744 first checks to see if the file has changed since checkout. If not,
745 it performs a revert.
746 If the file has been changed, this pops up a buffer for entry
747 of a log message; when the message has been entered, it checks in the
748 resulting changes along with the log message as change commentary. If
749 the variable `vc-keep-workfiles' is non-nil (which is its default), a
750 read-only copy of the changed file is left in place afterwards.
751 If the file is registered and locked by someone else, you are given
752 the option to steal the lock.
755 If the file is not already registered, this registers it for version
756 control. This does a \"cvs add\", but no \"cvs commit\".
757 If the file is added but not committed, it is committed.
758 If your working file is changed, but the repository file is
759 unchanged, this pops up a buffer for entry of a log message; when the
760 message has been entered, it checks in the resulting changes along
761 with the logmessage as change commentary. A writable file is retained.
762 If the repository file is changed, you are asked if you want to
763 merge in the changes into your working copy."
768 (let ((files (dired-get-marked-files)))
771 (function (lambda (f)
772 (if (eq (vc-backend f
) 'CVS
)
773 (if (or (eq (vc-cvs-status f
) 'locally-modified
)
774 (eq (vc-cvs-status f
) 'locally-added
))
776 (if (vc-locking-user f
) "@" ""))))
778 (vc-next-action-dired nil nil
"dummy")
779 (vc-start-entry nil nil nil
780 "Enter a change comment for the marked files."
781 'vc-next-action-dired
))
783 (while vc-parent-buffer
784 (pop-to-buffer vc-parent-buffer
))
786 (vc-next-action-on-file buffer-file-name verbose
)
787 (vc-registration-error nil
))))
789 ;;; These functions help the vc-next-action entry point
791 (defun vc-checkout-writable-buffer (&optional file rev
)
792 "Retrieve a writable copy of the latest version of the current buffer's file."
793 (vc-checkout (or file
(buffer-file-name)) t rev
)
797 (defun vc-register (&optional override comment
)
798 "Register the current file into your version-control system."
801 (error "No visited file"))
802 (let ((master (vc-name buffer-file-name
)))
803 (and master
(file-exists-p master
)
804 (error "This file is already registered"))
806 (not (y-or-n-p "Previous master file has vanished. Make a new one? "))
807 (error "This file is already registered")))
808 ;; Watch out for new buffers of size 0: the corresponding file
809 ;; does not exist yet, even though buffer-modified-p is nil.
810 (if (and (not (buffer-modified-p))
811 (zerop (buffer-size))
812 (not (file-exists-p buffer-file-name
)))
813 (set-buffer-modified-p t
))
815 (cond ((not vc-make-backup-files
)
816 ;; inhibit backup for this buffer
817 (make-local-variable 'backup-inhibited
)
818 (setq backup-inhibited t
)))
823 (format "Initial version level for %s: " buffer-file-name
))))
826 (defun vc-resynch-window (file &optional keep noquery
)
827 ;; If the given file is in the current buffer,
828 ;; either revert on it so we see expanded keywords,
829 ;; or unvisit it (depending on vc-keep-workfiles)
830 ;; NOQUERY if non-nil inhibits confirmation for reverting.
831 ;; NOQUERY should be t *only* if it is known the only difference
832 ;; between the buffer and the file is due to RCS rather than user editing!
833 (and (string= buffer-file-name file
)
836 ;; temporarily remove vc-find-file-hook, so that
837 ;; we don't lose the properties
838 (remove-hook 'find-file-hooks
'vc-find-file-hook
)
839 (vc-revert-buffer1 t noquery
)
840 (add-hook 'find-file-hooks
'vc-find-file-hook
)
841 (vc-mode-line buffer-file-name
))
842 (kill-buffer (current-buffer)))))
844 (defun vc-resynch-buffer (file &optional keep noquery
)
845 ;; if FILE is currently visited, resynch its buffer
846 (let ((buffer (get-file-buffer file
)))
850 (vc-resynch-window file keep noquery
)))))
852 (defun vc-start-entry (file rev comment msg action
&optional after-hook
)
853 ;; Accept a comment for an operation on FILE revision REV. If COMMENT
854 ;; is nil, pop up a VC-log buffer, emit MSG, and set the
855 ;; action on close to ACTION; otherwise, do action immediately.
856 ;; Remember the file's buffer in vc-parent-buffer (current one if no file).
857 ;; AFTER-HOOK specifies the local value for vc-log-operation-hook.
858 (let ((parent (if file
(find-file-noselect file
) (current-buffer))))
860 (set-buffer (get-buffer-create "*VC-log*"))
861 (pop-to-buffer (get-buffer-create "*VC-log*")))
862 (set (make-local-variable 'vc-parent-buffer
) parent
)
863 (set (make-local-variable 'vc-parent-buffer-name
)
864 (concat " from " (buffer-name vc-parent-buffer
)))
865 (if file
(vc-mode-line file
))
867 (make-local-variable 'vc-log-after-operation-hook
)
869 (setq vc-log-after-operation-hook after-hook
))
870 (setq vc-log-operation action
)
871 (setq vc-log-file file
)
872 (setq vc-log-version rev
)
877 (vc-finish-logentry t
)
879 (vc-finish-logentry nil
)))
880 (message "%s Type C-c C-c when done." msg
))))
882 (defun vc-admin (file rev
&optional comment
)
883 "Check a file into your version-control system.
884 FILE is the unmodified name of the file. REV should be the base version
885 level to check it in under. COMMENT, if specified, is the checkin comment."
886 (vc-start-entry file rev
887 (or comment
(not vc-initial-comment
))
888 "Enter initial comment." 'vc-backend-admin
891 (defun vc-checkout (file &optional writable rev
)
892 "Retrieve a copy of the latest version of the given file."
893 ;; If ftp is on this system and the name matches the ange-ftp format
894 ;; for a remote file, the user is trying something that won't work.
895 (if (and (string-match "^/[^/:]+:" file
) (vc-find-binary "ftp"))
896 (error "Sorry, you can't check out files over FTP"))
897 (vc-backend-checkout file writable rev
)
898 (vc-resynch-buffer file t t
))
900 (defun vc-steal-lock (file rev
&optional owner
)
901 "Steal the lock on the current workfile."
902 (let (file-description)
904 (setq owner
(vc-locking-user file
)))
906 (setq file-description
(format "%s:%s" file rev
))
907 (setq file-description file
))
908 (if (not (y-or-n-p (format "Take the lock on %s from %s? "
909 file-description owner
)))
910 (error "Steal cancelled"))
911 (pop-to-buffer (get-buffer-create "*VC-mail*"))
912 (setq default-directory
(expand-file-name "~/"))
913 (auto-save-mode auto-save-default
)
916 (mail-setup owner
(format "Stolen lock on %s" file-description
) nil nil nil
917 (list (list 'vc-finish-steal file rev
)))
918 (goto-char (point-max))
920 (format "I stole the lock on %s, " file-description
)
921 (current-time-string)
923 (message "Please explain why you stole the lock. Type C-c C-c when done.")))
925 ;; This is called when the notification has been sent.
926 (defun vc-finish-steal (file version
)
927 (vc-backend-steal file version
)
928 (if (get-file-buffer file
)
930 (set-buffer (get-file-buffer file
))
931 (vc-resynch-window file t t
))))
933 (defun vc-checkin (file &optional rev comment
)
934 "Check in the file specified by FILE.
935 The optional argument REV may be a string specifying the new version level
936 \(if nil increment the current level). The file is either retained with write
937 permissions zeroed, or deleted (according to the value of `vc-keep-workfiles').
938 If the back-end is CVS, a writable workfile is always kept.
939 COMMENT is a comment string; if omitted, a buffer is
940 popped up to accept a comment."
941 (vc-start-entry file rev comment
942 "Enter a change comment." 'vc-backend-checkin
945 ;;; Here is a checkin hook that may prove useful to sites using the
946 ;;; ChangeLog facility supported by Emacs.
947 (defun vc-comment-to-change-log (&optional whoami file-name
)
948 "Enter last VC comment into change log file for current buffer's file.
949 Optional arg (interactive prefix) non-nil means prompt for user name and site.
950 Second arg is file name of change log. \
951 If nil, uses `change-log-default-name'."
952 (interactive (if current-prefix-arg
953 (list current-prefix-arg
954 (prompt-for-change-log-name))))
955 ;; Make sure the defvar for add-log-current-defun-function has been executed
956 ;; before binding it.
958 (let (;; Extract the comment first so we get any error before doing anything.
959 (comment (ring-ref vc-comment-ring
0))
960 ;; Don't let add-change-log-entry insert a defun name.
961 (add-log-current-defun-function 'ignore
)
963 ;; Call add-log to do half the work.
964 (add-change-log-entry whoami file-name t t
)
965 ;; Insert the VC comment, leaving point before it.
966 (setq end
(save-excursion (insert comment
) (point-marker)))
967 (if (looking-at "\\s *\\s(")
968 ;; It starts with an open-paren, as in "(foo): Frobbed."
969 ;; So remove the ": " add-log inserted.
971 ;; Canonicalize the white space between the file name and comment.
973 ;; Indent rest of the text the same way add-log indented the first line.
974 (let ((indentation (current-indentation)))
976 (while (< (point) end
)
978 (indent-to indentation
))
980 ;; Fill the inserted text, preserving open-parens at bol.
981 (let ((paragraph-separate (concat paragraph-separate
"\\|\\s *\\s("))
982 (paragraph-start (concat paragraph-start
"\\|\\s *\\s(")))
984 (fill-region (point) end
))
985 ;; Canonicalize the white space at the end of the entry so it is
986 ;; separated from the next entry by a single blank line.
987 (skip-syntax-forward " " end
)
988 (delete-char (- (skip-syntax-backward " ")))
989 (or (eobp) (looking-at "\n\n")
993 (defun vc-finish-logentry (&optional nocomment
)
994 "Complete the operation implied by the current log entry."
996 ;; Check and record the comment, if any.
999 (goto-char (point-max))
1002 ;; Comment too long?
1003 (vc-backend-logentry-check vc-log-file
)
1004 ;; Record the comment in the comment ring
1005 (ring-insert vc-comment-ring
(buffer-string))
1007 ;; Sync parent buffer in case the user modified it while editing the comment.
1008 ;; But not if it is a vc-dired buffer.
1010 (set-buffer vc-parent-buffer
)
1013 (if (not vc-log-operation
) (error "No log operation is pending"))
1014 ;; save the parameters held in buffer-local variables
1015 (let ((log-operation vc-log-operation
)
1016 (log-file vc-log-file
)
1017 (log-version vc-log-version
)
1018 (log-entry (buffer-string))
1019 (after-hook vc-log-after-operation-hook
))
1020 ;; Return to "parent" buffer of this checkin and remove checkin window
1021 (pop-to-buffer vc-parent-buffer
)
1022 (let ((logbuf (get-buffer "*VC-log*")))
1023 (delete-windows-on logbuf
)
1024 (kill-buffer logbuf
))
1027 (funcall log-operation
1031 ;; Now make sure we see the expanded headers
1032 (if buffer-file-name
1033 (vc-resynch-window buffer-file-name vc-keep-workfiles t
))
1034 (run-hooks after-hook
)))
1036 ;; Code for access to the comment ring
1038 (defun vc-previous-comment (arg)
1039 "Cycle backwards through comment history."
1041 (let ((len (ring-length vc-comment-ring
)))
1043 (message "Empty comment ring")
1047 ;; Initialize the index on the first use of this command
1048 ;; so that the first M-p gets index 0, and the first M-n gets
1050 (if (null vc-comment-ring-index
)
1051 (setq vc-comment-ring-index
1053 (if (< arg
0) 1 0))))
1054 (setq vc-comment-ring-index
1055 (mod (+ vc-comment-ring-index arg
) len
))
1056 (message "%d" (1+ vc-comment-ring-index
))
1057 (insert (ring-ref vc-comment-ring vc-comment-ring-index
))))))
1059 (defun vc-next-comment (arg)
1060 "Cycle forwards through comment history."
1062 (vc-previous-comment (- arg
)))
1064 (defun vc-comment-search-reverse (str)
1065 "Searches backwards through comment history for substring match."
1066 (interactive "sComment substring: ")
1067 (if (string= str
"")
1068 (setq str vc-last-comment-match
)
1069 (setq vc-last-comment-match str
))
1070 (if (null vc-comment-ring-index
)
1071 (setq vc-comment-ring-index -
1))
1072 (let ((str (regexp-quote str
))
1073 (len (ring-length vc-comment-ring
))
1074 (n (1+ vc-comment-ring-index
)))
1075 (while (and (< n len
) (not (string-match str
(ring-ref vc-comment-ring n
))))
1078 (vc-previous-comment (- n vc-comment-ring-index
)))
1079 (t (error "Not found")))))
1081 (defun vc-comment-search-forward (str)
1082 "Searches forwards through comment history for substring match."
1083 (interactive "sComment substring: ")
1084 (if (string= str
"")
1085 (setq str vc-last-comment-match
)
1086 (setq vc-last-comment-match str
))
1087 (if (null vc-comment-ring-index
)
1088 (setq vc-comment-ring-index
0))
1089 (let ((str (regexp-quote str
))
1090 (len (ring-length vc-comment-ring
))
1091 (n vc-comment-ring-index
))
1092 (while (and (>= n
0) (not (string-match str
(ring-ref vc-comment-ring n
))))
1095 (vc-next-comment (- n vc-comment-ring-index
)))
1096 (t (error "Not found")))))
1098 ;; Additional entry points for examining version histories
1101 (defun vc-diff (historic &optional not-urgent
)
1102 "Display diffs between file versions.
1103 Normally this compares the current file and buffer with the most recent
1104 checked in version of that file. This uses no arguments.
1105 With a prefix argument, it reads the file name to use
1106 and two version designators specifying which versions to compare."
1107 (interactive (list current-prefix-arg t
))
1109 (set-buffer (find-file-noselect (dired-get-filename))))
1110 (while vc-parent-buffer
1111 (pop-to-buffer vc-parent-buffer
))
1113 (call-interactively 'vc-version-diff
)
1114 (if (or (null buffer-file-name
) (null (vc-name buffer-file-name
)))
1116 "There is no version-control master associated with this buffer"))
1117 (let ((file buffer-file-name
)
1119 (or (and file
(vc-name file
))
1120 (vc-registration-error file
))
1121 (vc-buffer-sync not-urgent
)
1122 (setq unchanged
(vc-workfile-unchanged-p buffer-file-name
))
1124 (message "No changes to %s since latest version" file
)
1125 (vc-backend-diff file
)
1126 ;; Ideally, we'd like at this point to parse the diff so that
1127 ;; the buffer effectively goes into compilation mode and we
1128 ;; can visit the old and new change locations via next-error.
1129 ;; Unfortunately, this is just too painful to do. The basic
1130 ;; problem is that the `old' file doesn't exist to be
1131 ;; visited. This plays hell with numerous assumptions in
1132 ;; the diff.el and compile.el machinery.
1133 (set-buffer "*vc-diff*")
1134 (setq default-directory
(file-name-directory file
))
1135 (if (= 0 (buffer-size))
1138 (message "No changes to %s since latest version" file
))
1139 (pop-to-buffer "*vc-diff*")
1140 (goto-char (point-min))
1141 (shrink-window-if-larger-than-buffer)))
1144 (defun vc-version-diff (file rel1 rel2
)
1145 "For FILE, report diffs between two stored versions REL1 and REL2 of it.
1146 If FILE is a directory, generate diffs between versions for all registered
1147 files in or below it."
1148 (interactive "FFile or directory to diff: \nsOlder version: \nsNewer version: ")
1149 (if (string-equal rel1
"") (setq rel1 nil
))
1150 (if (string-equal rel2
"") (setq rel2 nil
))
1151 (if (file-directory-p file
)
1152 (let ((camefrom (current-buffer)))
1153 (set-buffer (get-buffer-create "*vc-status*"))
1154 (set (make-local-variable 'vc-parent-buffer
) camefrom
)
1155 (set (make-local-variable 'vc-parent-buffer-name
)
1156 (concat " from " (buffer-name camefrom
)))
1158 (insert "Diffs between "
1159 (or rel1
"last version checked in")
1161 (or rel2
"current workfile(s)")
1163 (set-buffer (get-buffer-create "*vc-diff*"))
1167 (function (lambda (f)
1168 (message "Looking at %s" f
)
1170 (not (file-directory-p f
))
1172 (vc-backend-diff f rel1 rel2
)
1173 (append-to-buffer "*vc-status*" (point-min) (point-max)))
1175 (pop-to-buffer "*vc-status*")
1176 (insert "\nEnd of diffs.\n")
1177 (goto-char (point-min))
1178 (set-buffer-modified-p nil
)
1180 (if (zerop (vc-backend-diff file rel1 rel2
))
1181 (message "No changes to %s between %s and %s." file rel1 rel2
)
1182 (pop-to-buffer "*vc-diff*"))))
1185 (defun vc-version-other-window (rev)
1186 "Visit version REV of the current buffer in another window.
1187 If the current buffer is named `F', the version is named `F.~REV~'.
1188 If `F.~REV~' already exists, it is used instead of being re-created."
1189 (interactive "sVersion to visit (default is latest version): ")
1191 (set-buffer (find-file-noselect (dired-get-filename))))
1192 (while vc-parent-buffer
1193 (pop-to-buffer vc-parent-buffer
))
1194 (if (and buffer-file-name
(vc-name buffer-file-name
))
1195 (let* ((version (if (string-equal rev
"")
1196 (vc-latest-version buffer-file-name
)
1198 (filename (concat buffer-file-name
".~" version
"~")))
1199 (or (file-exists-p filename
)
1200 (vc-backend-checkout buffer-file-name nil version filename
))
1201 (find-file-other-window filename
))
1202 (vc-registration-error buffer-file-name
)))
1204 ;; Header-insertion code
1207 (defun vc-insert-headers ()
1208 "Insert headers in a file for use with your version-control system.
1209 Headers desired are inserted at the start of the buffer, and are pulled from
1210 the variable `vc-header-alist'."
1213 (find-file-other-window (dired-get-filename)))
1214 (while vc-parent-buffer
1215 (pop-to-buffer vc-parent-buffer
))
1219 (if (or (not (vc-check-headers))
1220 (y-or-n-p "Version headers already exist. Insert another set? "))
1222 (let* ((delims (cdr (assq major-mode vc-comment-alist
)))
1223 (comment-start-vc (or (car delims
) comment-start
"#"))
1224 (comment-end-vc (or (car (cdr delims
)) comment-end
""))
1225 (hdstrings (cdr (assoc (vc-backend (buffer-file-name)) vc-header-alist
))))
1226 (mapcar (function (lambda (s)
1227 (insert comment-start-vc
"\t" s
"\t"
1228 comment-end-vc
"\n")))
1230 (if vc-static-header-alist
1231 (mapcar (function (lambda (f)
1232 (if (string-match (car f
) buffer-file-name
)
1233 (insert (format (cdr f
) (car hdstrings
))))))
1234 vc-static-header-alist
))
1238 (defun vc-clear-headers ()
1239 ;; Clear all version headers in the current buffer, i.e. reset them
1240 ;; to the nonexpanded form. Only implemented for RCS, yet.
1241 ;; Don't lose point and mark during this.
1242 (let ((context (vc-buffer-context)))
1243 (goto-char (point-min))
1244 (while (re-search-forward "\\$\\([A-Za-z]+\\): [^\\$]+\\$" nil t
)
1245 (replace-match "$\\1$"))
1246 (vc-restore-buffer-context context
)))
1248 ;; The VC directory major mode. Coopt Dired for this.
1249 ;; All VC commands get mapped into logical equivalents.
1251 (define-derived-mode vc-dired-mode dired-mode
"Dired under VC"
1252 "The major mode used in VC directory buffers. It is derived from Dired.
1253 All Dired commands operate normally. Users currently locking listed files
1254 are listed in place of the file's owner and group.
1255 Keystrokes bound to VC commands will execute as though they had been called
1256 on a buffer attached to the file named in the current Dired buffer line."
1257 (setq vc-dired-mode t
))
1259 (define-key vc-dired-mode-map
"\C-xv" vc-prefix-map
)
1260 (define-key vc-dired-mode-map
"g" 'vc-dired-update
)
1261 (define-key vc-dired-mode-map
"=" 'vc-diff
)
1263 (defun vc-dired-state-info (file)
1264 ;; Return the string that indicates the version control status
1265 ;; on a VC dired line.
1266 (let ((cvs-state (and (eq (vc-backend file
) 'CVS
)
1267 (vc-cvs-status file
))))
1269 (cond ((eq cvs-state
'up-to-date
) nil
)
1270 ((eq cvs-state
'needs-checkout
) "patch")
1271 ((eq cvs-state
'locally-modified
) "modified")
1272 ((eq cvs-state
'needs-merge
) "merge")
1273 ((eq cvs-state
'unresolved-conflict
) "conflict")
1274 ((eq cvs-state
'locally-added
) "added"))
1275 (vc-locking-user file
))))
1277 (defun vc-dired-reformat-line (x)
1278 ;; Hack a directory-listing line, plugging in locking-user info in
1279 ;; place of the user and group info. Should have the beneficial
1280 ;; side-effect of shortening the listing line. Each call starts with
1281 ;; point immediately following the dired mark area on the line to be
1284 ;; Simplest possible one:
1285 ;; (insert (concat x "\t")))
1287 ;; This code, like dired, assumes UNIX -l format.
1288 (let ((pos (point)) limit perm owner date-and-file
)
1290 (setq limit
(point))
1294 (re-search-forward ;; owner and group
1295 "\\([drwxlts-]+ \\) *[0-9]+ \\([^ ]+\\) +[^ ]+ +[0-9]+\\( [^ 0-9]+ [0-9 ][0-9] .*\\)"
1297 (re-search-forward ;; only owner displayed
1298 "\\([drwxlts-]+ \\) *[0-9]+ \\([^ ]+\\) +[0-9]+\\( [^ 0-9]+ [0-9 ][0-9] .*\\)"
1300 (setq perm
(match-string 1)
1301 owner
(match-string 2)
1302 date-and-file
(match-string 3)))
1303 ((re-search-forward ;; OS/2 -l format, no links, owner, group
1304 "\\([drwxlts-]+ \\) *[0-9]+\\( [^ 0-9]+ [0-9 ][0-9] .*\\)"
1306 (setq perm
(match-string 1)
1307 date-and-file
(match-string 2))))
1308 (if x
(setq x
(concat "(" x
")")))
1309 (let ((rep (substring (concat x
" ") 0 10)))
1310 (replace-match (concat perm rep date-and-file
)))))
1312 (defun vc-dired-update-line (file)
1313 ;; Update the vc-dired listing line of file -- it is assumed
1314 ;; that point is already on this line. Don't use dired-do-redisplay
1315 ;; for this, because it cannot handle the way vc-dired deals with
1319 (let ((start (point)))
1322 (delete-region start
(point))
1323 (insert-directory file dired-listing-switches
)
1326 (delete-char (- (length file
)))
1327 (insert (substring file
(length (expand-file-name default-directory
))))
1329 (vc-dired-reformat-line (vc-dired-state-info file
)))
1331 (defun vc-dired-update (verbose)
1333 (vc-directory default-directory verbose
))
1335 ;;; Note in Emacs 18 the following defun gets overridden
1336 ;;; with the symbol 'vc-directory-18. See below.
1338 (defun vc-directory (dirname verbose
)
1339 "Show version-control status of the current directory and subdirectories.
1340 Normally it creates a Dired buffer that lists only the locked files
1341 in all these directories. With a prefix argument, it lists all files."
1342 (interactive "DDired under VC (directory): \nP")
1344 (setq dirname
(expand-file-name dirname
))
1345 ;; force a trailing slash
1346 (if (not (eq (elt dirname
(1- (length dirname
))) ?
/))
1347 (setq dirname
(concat dirname
"/")))
1349 (dl (length dirname
))
1350 (filelist nil
) (statelist nil
)
1351 (old-dir default-directory
)
1353 dired-buf-mod-count
)
1358 (if (vc-registered f
)
1359 (let ((state (vc-dired-state-info f
)))
1360 (and (or verbose state
)
1361 (setq filelist
(cons (substring f dl
) filelist
))
1362 (setq statelist
(cons state statelist
))))))))
1363 (save-window-excursion
1365 ;; This uses a semi-documented feature of dired; giving a switch
1366 ;; argument forces the buffer to refresh each time.
1368 (dired-internal-noselect
1369 (cons dirname
(nreverse filelist
))
1370 dired-listing-switches
'vc-dired-mode
))
1371 (setq nonempty
(not (eq 0 (length filelist
))))))
1372 (switch-to-buffer dired-buf
)
1373 ;; Make a few modifications to the header
1374 (setq buffer-read-only nil
)
1375 (goto-char (point-min))
1376 (forward-line 1) ;; Skip header line
1377 (let ((start (point))) ;; Erase (but don't remove) the
1378 (end-of-line) ;; "wildcard" line.
1379 (delete-region start
(point)))
1383 ;; Plug the version information into the individual lines
1387 (forward-char 2) ;; skip dired's mark area
1388 (vc-dired-reformat-line x
)
1389 (forward-line 1))) ;; go to next line
1390 (nreverse statelist
))
1391 (setq buffer-read-only t
)
1392 (goto-char (point-min))
1397 (setq buffer-read-only t
)
1398 (message "No files are currently %s under %s"
1399 (if verbose
"registered" "locked") dirname
))
1403 (defun vc-directory-18 (verbose)
1404 "Show version-control status of all files under the current directory."
1406 (let (nonempty (dir default-directory
))
1408 (set-buffer (get-buffer-create "*vc-status*"))
1413 (function (lambda (f)
1414 (if (vc-registered f
)
1415 (let ((user (vc-locking-user f
)))
1416 (if (or user verbose
)
1419 (concat user
) f
))))))))
1420 (setq nonempty
(not (zerop (buffer-size)))))
1424 (pop-to-buffer "*vc-status*" t
)
1425 (goto-char (point-min))
1426 (shrink-window-if-larger-than-buffer)))
1427 (message "No files are currently %s under %s"
1428 (if verbose
"registered" "locked") default-directory
))
1431 (or (boundp 'minor-mode-map-alist
)
1432 (fset 'vc-directory
'vc-directory-18
))
1434 ;; Named-configuration support for SCCS
1436 (defun vc-add-triple (name file rev
)
1438 (find-file (expand-file-name
1440 (file-name-as-directory
1441 (expand-file-name (vc-backend-subdirectory-name file
)
1442 (file-name-directory file
)))))
1443 (goto-char (point-max))
1444 (insert name
"\t:\t" file
"\t" rev
"\n")
1446 (kill-buffer (current-buffer))
1449 (defun vc-record-rename (file newname
)
1454 (file-name-as-directory
1455 (expand-file-name (vc-backend-subdirectory-name file
)
1456 (file-name-directory file
)))))
1457 (goto-char (point-min))
1458 ;; (replace-regexp (concat ":" (regexp-quote file) "$") (concat ":" newname))
1459 (while (re-search-forward (concat ":" (regexp-quote file
) "$") nil t
)
1460 (replace-match (concat ":" newname
) nil nil
))
1462 (kill-buffer (current-buffer))
1465 (defun vc-lookup-triple (file name
)
1466 ;; Return the numeric version corresponding to a named snapshot of file
1467 ;; If name is nil or a version number string it's just passed through
1468 (cond ((null name
) name
)
1469 ((let ((firstchar (aref name
0)))
1470 (and (>= firstchar ?
0) (<= firstchar ?
9)))
1474 (set-buffer (get-buffer-create "*vc-info*"))
1478 (file-name-as-directory
1479 (expand-file-name (vc-backend-subdirectory-name file
)
1480 (file-name-directory file
)))))
1482 (car (vc-parse-buffer
1483 (list (list (concat name
"\t:\t" file
"\t\\(.+\\)") 1))))
1484 (kill-buffer "*vc-info*"))))
1487 ;; Named-configuration entry points
1489 (defun vc-snapshot-precondition ()
1490 ;; Scan the tree below the current directory.
1491 ;; If any files are locked, return the name of the first such file.
1492 ;; (This means, neither snapshot creation nor retrieval is allowed.)
1493 ;; If one or more of the files are currently visited, return `visited'.
1494 ;; Otherwise, return nil.
1496 (catch 'vc-locked-example
1499 (function (lambda (f)
1500 (and (vc-registered f
)
1501 (if (vc-locking-user f
) (throw 'vc-locked-example f
)
1502 (if (get-file-buffer f
) (setq status
'visited
)))))))
1506 (defun vc-create-snapshot (name)
1507 "Make a snapshot called NAME.
1508 The snapshot is made from all registered files at or below the current
1509 directory. For each file, the version level of its latest
1510 version becomes part of the named configuration."
1511 (interactive "sNew snapshot name: ")
1512 (let ((result (vc-snapshot-precondition)))
1513 (if (stringp result
)
1514 (error "File %s is locked" result
)
1517 (function (lambda (f) (and
1519 (vc-backend-assign-name f name
)))))
1523 (defun vc-retrieve-snapshot (name)
1524 "Retrieve the snapshot called NAME.
1525 This function fails if any files are locked at or below the current directory
1526 Otherwise, all registered files are checked out (unlocked) at their version
1527 levels in the snapshot."
1528 (interactive "sSnapshot name to retrieve: ")
1529 (let ((result (vc-snapshot-precondition))
1531 (if (stringp result
)
1532 (error "File %s is locked" result
)
1533 (if (eq result
'visited
)
1534 (setq update
(yes-or-no-p "Update the affected buffers? ")))
1537 (function (lambda (f) (and
1540 (vc-backend-checkout f nil name
)
1541 (if update
(vc-resynch-buffer f t t
)))))))
1544 ;; Miscellaneous other entry points
1547 (defun vc-print-log ()
1548 "List the change log of the current buffer in a window."
1551 (set-buffer (find-file-noselect (dired-get-filename))))
1552 (while vc-parent-buffer
1553 (pop-to-buffer vc-parent-buffer
))
1554 (if (and buffer-file-name
(vc-name buffer-file-name
))
1555 (let ((file buffer-file-name
))
1556 (vc-backend-print-log file
)
1557 (pop-to-buffer (get-buffer-create "*vc*"))
1558 (setq default-directory
(file-name-directory file
))
1559 (goto-char (point-max)) (forward-line -
1)
1560 (while (looking-at "=*\n")
1561 (delete-char (- (match-end 0) (match-beginning 0)))
1563 (goto-char (point-min))
1564 (if (looking-at "[\b\t\n\v\f\r ]+")
1565 (delete-char (- (match-end 0) (match-beginning 0))))
1566 (shrink-window-if-larger-than-buffer)
1567 ;; move point to the log entry for the current version
1568 (and (not (eq (vc-backend file
) 'SCCS
))
1570 ;; also match some context, for safety
1571 (concat "----\nrevision " (vc-workfile-version file
)
1572 "\\(\tlocked by:.*\n\\|\n\\)date: ") nil t
)
1573 ;; set the display window so that
1574 ;; the whole log entry is displayed
1575 (let (start end lines
)
1576 (beginning-of-line) (forward-line -
1) (setq start
(point))
1577 (if (not (re-search-forward "^----*\nrevision" nil t
))
1578 (setq end
(point-max))
1579 (beginning-of-line) (forward-line -
1) (setq end
(point)))
1580 (setq lines
(count-lines start end
))
1582 ;; if the global information and this log entry fit
1583 ;; into the window, display from the beginning
1584 ((< (count-lines (point-min) end
) (window-height))
1585 (goto-char (point-min))
1588 ;; if the whole entry fits into the window,
1589 ;; display it centered
1590 ((< (1+ lines
) (window-height))
1592 (recenter (1- (- (/ (window-height) 2) (/ lines
2)))))
1593 ;; otherwise (the entry is too large for the window),
1594 ;; display from the start
1599 (vc-registration-error buffer-file-name
)
1604 (defun vc-revert-buffer ()
1605 "Revert the current buffer's file back to the latest checked-in version.
1606 This asks for confirmation if the buffer contents are not identical
1608 If the back-end is CVS, this will give you the most recent revision of
1609 the file on the branch you are editing."
1612 (find-file-other-window (dired-get-filename)))
1613 (while vc-parent-buffer
1614 (pop-to-buffer vc-parent-buffer
))
1615 (let ((file buffer-file-name
)
1616 ;; This operation should always ask for confirmation.
1617 (vc-suppress-confirm nil
)
1618 (obuf (current-buffer)) (changed (vc-diff nil t
)))
1619 (if (and changed
(not (yes-or-no-p "Discard changes? ")))
1621 (if (and (window-dedicated-p (selected-window))
1622 (one-window-p t
'selected-frame
))
1623 (make-frame-invisible (selected-frame))
1625 (error "Revert cancelled"))
1628 (if (and (window-dedicated-p (selected-window))
1629 (one-window-p t
'selected-frame
))
1630 (make-frame-invisible (selected-frame))
1632 (vc-backend-revert file
)
1633 (vc-resynch-window file t t
)
1638 (defun vc-cancel-version (norevert)
1639 "Get rid of most recently checked in version of this file.
1640 A prefix argument means do not revert the buffer afterwards."
1643 (find-file-other-window (dired-get-filename)))
1644 (while vc-parent-buffer
1645 (pop-to-buffer vc-parent-buffer
))
1647 ((not (vc-registered (buffer-file-name)))
1648 (vc-registration-error (buffer-file-name)))
1649 ((eq (vc-backend (buffer-file-name)) 'CVS
)
1650 (error "Unchecking files under CVS is dangerous and not supported in VC"))
1651 ((vc-locking-user (buffer-file-name))
1652 (error "This version is locked; use vc-revert-buffer to discard changes"))
1653 ((not (vc-latest-on-branch-p (buffer-file-name)))
1654 (error "This is not the latest version--VC cannot cancel it")))
1655 (let* ((target (vc-workfile-version (buffer-file-name)))
1656 (recent (if (vc-trunk-p target
) "" (vc-branch-part target
)))
1657 (config (current-window-configuration)) done
)
1658 (if (null (yes-or-no-p (format "Remove version %s from master? " target
)))
1660 (setq norevert
(or norevert
(not
1661 (yes-or-no-p "Revert buffer to most recent remaining version? "))))
1662 (vc-backend-uncheck (buffer-file-name) target
)
1663 ;; Check out the most recent remaining version. If it fails, because
1664 ;; the whole branch got deleted, do a double-take and check out the
1665 ;; version where the branch started.
1670 ;; Check out locked, but only to disc, and keep
1671 ;; modifications in the buffer.
1672 (vc-backend-checkout (buffer-file-name) t recent
)
1673 ;; Check out unlocked, and revert buffer.
1674 (vc-checkout (buffer-file-name) nil recent
))
1676 ;; If the checkout fails, vc-do-command signals an error.
1677 ;; We catch this error, check the reason, correct the
1678 ;; version number, and try a second time.
1679 (error (set-buffer "*vc*")
1680 (goto-char (point-min))
1681 (if (search-forward "no side branches present for" nil t
)
1682 (progn (setq recent
(vc-branch-part recent
))
1683 ;; vc-do-command popped up a window with
1684 ;; the error message. Get rid of it, by
1685 ;; restoring the old window configuration.
1686 (set-window-configuration config
))
1687 ;; No, it was some other error: re-signal it.
1688 (signal (car err
) (cdr err
))))))
1689 ;; If norevert, clear version headers and mark the buffer modified.
1692 (set-visited-file-name (buffer-file-name))
1693 (if (not vc-make-backup-files
)
1694 ;; inhibit backup for this buffer
1695 (progn (make-local-variable 'backup-inhibited
)
1696 (setq backup-inhibited t
)))
1697 (if (eq (vc-backend (buffer-file-name)) 'RCS
)
1698 (progn (setq buffer-read-only nil
)
1699 (vc-clear-headers)))
1700 (vc-mode-line (buffer-file-name))))
1701 (message "Version %s has been removed from the master" target
)
1705 (defun vc-rename-file (old new
)
1706 "Rename file OLD to NEW, and rename its master file likewise."
1707 (interactive "fVC rename file: \nFRename to: ")
1708 ;; There are several ways of renaming files under CVS 1.3, but they all
1709 ;; have serious disadvantages. See the FAQ (available from think.com in
1710 ;; pub/cvs/). I'd rather send the user an error, than do something he might
1711 ;; consider to be wrong. When the famous, long-awaited rename database is
1712 ;; implemented things might change for the better. This is unlikely to occur
1713 ;; until CVS 2.0 is released. --ceder 1994-01-23 21:27:51
1714 (if (eq (vc-backend old
) 'CVS
)
1715 (error "Renaming files under CVS is dangerous and not supported in VC"))
1716 (let ((oldbuf (get-file-buffer old
)))
1717 (if (and oldbuf
(buffer-modified-p oldbuf
))
1718 (error "Please save files before moving them"))
1719 (if (get-file-buffer new
)
1720 (error "Already editing new file name"))
1721 (if (file-exists-p new
)
1722 (error "New file already exists"))
1723 (let ((oldmaster (vc-name old
)))
1726 (if (vc-locking-user old
)
1727 (error "Please check in files before moving them"))
1728 (if (or (file-symlink-p oldmaster
)
1729 ;; This had FILE, I changed it to OLD. -- rms.
1730 (file-symlink-p (vc-backend-subdirectory-name old
)))
1731 (error "This is not a safe thing to do in the presence of symbolic links"))
1734 (let ((backend (vc-backend old
))
1735 (newdir (or (file-name-directory new
) ""))
1736 (newbase (file-name-nondirectory new
)))
1741 (if (eq backend
(cdr s
))
1742 (let* ((newmaster (format (car s
) newdir newbase
))
1743 (newmasterdir (file-name-directory newmaster
)))
1744 (if (or (not newmasterdir
)
1745 (file-directory-p newmasterdir
))
1746 (throw 'found newmaster
))))))
1747 vc-master-templates
)
1748 (error "New file lacks a version control directory"))))))
1749 (if (or (not oldmaster
) (file-exists-p old
))
1750 (rename-file old new
)))
1751 ; ?? Renaming a file might change its contents due to keyword expansion.
1752 ; We should really check out a new copy if the old copy was precisely equal
1753 ; to some checked in version. However, testing for this is tricky....
1757 (let ((buffer-read-only buffer-read-only
))
1758 (set-visited-file-name new
))
1761 (set-buffer-modified-p nil
))))
1762 ;; This had FILE, I changed it to OLD. -- rms.
1763 (vc-backend-dispatch old
1764 (vc-record-rename old new
) ;SCCS
1771 (defun vc-update-change-log (&rest args
)
1772 "Find change log file and add entries from recent RCS/CVS logs.
1773 Normally, find log entries for all registered files in the default
1774 directory using `rcs2log', which finds CVS logs preferentially.
1775 The mark is left at the end of the text prepended to the change log.
1777 With prefix arg of C-u, only find log entries for the current buffer's file.
1779 With any numeric prefix arg, find log entries for all currently visited
1780 files that are under version control. This puts all the entries in the
1781 log for the default directory, which may not be appropriate.
1783 From a program, any arguments are assumed to be filenames and are
1784 passed to the `rcs2log' script after massaging to be relative to the
1787 (cond ((consp current-prefix-arg
) ;C-u
1788 (list buffer-file-name
))
1789 (current-prefix-arg ;Numeric argument.
1791 (buffers (buffer-list))
1794 (setq file
(buffer-file-name (car buffers
)))
1795 (and file
(vc-backend file
)
1796 (setq files
(cons file files
)))
1797 (setq buffers
(cdr buffers
)))
1800 ;; `rcs2log' will find the relevant RCS or CVS files
1801 ;; relative to the curent directory if none supplied.
1803 (let ((odefault default-directory
)
1804 (full-name (or add-log-full-name
1807 (format "uid%d" (number-to-string (user-uid)))))
1808 (mailing-address (or add-log-mailing-address
1809 user-mail-address
)))
1810 (find-file-other-window (find-change-log))
1811 (barf-if-buffer-read-only)
1814 (goto-char (point-min))
1816 (message "Computing change log entries...")
1817 (message "Computing change log entries... %s"
1818 (if (eq 0 (apply 'call-process
"rcs2log" nil
'(t nil
) nil
1820 (concat (vc-user-login-name)
1828 (if (file-name-absolute-p f
)
1830 (concat odefault f
)))))
1834 ;; Collect back-end-dependent stuff here
1836 (defun vc-backend-admin (file &optional rev comment
)
1837 ;; Register a file into the version-control system
1838 ;; Automatically retrieves a read-only version of the file with
1839 ;; keywords expanded if vc-keep-workfiles is non-nil, otherwise
1840 ;; it deletes the workfile.
1841 (vc-file-clearprops file
)
1842 (or vc-default-back-end
1843 (setq vc-default-back-end
(if (vc-find-binary "rcs") 'RCS
'SCCS
)))
1844 (message "Registering %s..." file
)
1846 (if (stringp vc-register-switches
)
1847 (list vc-register-switches
)
1848 vc-register-switches
))
1851 ((file-exists-p (vc-backend-subdirectory-name)) vc-default-back-end
)
1852 ((file-exists-p "RCS") 'RCS
)
1853 ((file-exists-p "SCCS") 'SCCS
)
1854 ((file-exists-p "CVS") 'CVS
)
1855 (t vc-default-back-end
))))
1856 (cond ((eq backend
'SCCS
)
1857 (apply 'vc-do-command nil
0 "admin" file
'MASTER
;; SCCS
1858 (and rev
(concat "-r" rev
))
1861 (and comment
(concat "-y" comment
))
1863 (car (rassq 'SCCS vc-master-templates
))
1864 (or (file-name-directory file
) "")
1865 (file-name-nondirectory file
))
1868 (if vc-keep-workfiles
1869 (vc-do-command nil
0 "get" file
'MASTER
)))
1871 (apply 'vc-do-command nil
0 "ci" file
'WORKFILE
;; RCS
1872 ;; if available, use the secure registering option
1873 (and (vc-backend-release-p 'RCS
"5.6.4") "-i")
1874 (concat (if vc-keep-workfiles
"-u" "-r") rev
)
1875 (and comment
(concat "-t-" comment
))
1878 (apply 'vc-do-command nil
0 "cvs" file
'WORKFILE
;; CVS
1880 (and comment
(string-match "[^\t\n ]" comment
)
1881 (concat "-m" comment
))
1884 (message "Registering %s...done" file
)
1887 (defun vc-backend-checkout (file &optional writable rev workfile
)
1888 ;; Retrieve a copy of a saved version into a workfile
1889 (let ((filename (or workfile file
))
1890 (file-buffer (get-file-buffer file
))
1892 (message "Checking out %s..." filename
)
1894 ;; Change buffers to get local value of vc-checkout-switches.
1895 (if file-buffer
(set-buffer file-buffer
))
1896 (setq switches
(if (stringp vc-checkout-switches
)
1897 (list vc-checkout-switches
)
1898 vc-checkout-switches
))
1899 ;; Save this buffer's default-directory
1900 ;; and use save-excursion to make sure it is restored
1901 ;; in the same buffer it was saved in.
1902 (let ((default-directory default-directory
))
1904 ;; Adjust the default-directory so that the check-out creates
1905 ;; the file in the right place.
1906 (setq default-directory
(file-name-directory filename
))
1907 (vc-backend-dispatch file
1909 (and rev
(string= rev
"") (setq rev nil
))
1911 ;; Some SCCS implementations allow checking out directly to a
1912 ;; file using the -G option, but then some don't so use the
1913 ;; least common denominator approach and use the -p option
1915 (let ((vc-modes (logior (file-modes (vc-name file
))
1916 (if writable
128 0)))
1920 (apply 'vc-do-command
1921 nil
0 "/bin/sh" file
'MASTER
"-c"
1922 ;; Some shells make the "" dummy argument into $0
1923 ;; while others use the shell's name as $0 and
1924 ;; use the "" as $1. The if-statement
1925 ;; converts the latter case to the former.
1926 (format "if [ x\"$1\" = x ]; then shift; fi; \
1927 umask %o; exec >\"$1\" || exit; \
1928 shift; umask %o; exec get \"$@\""
1929 (logand 511 (lognot vc-modes
))
1930 (logand 511 (lognot (default-file-modes))))
1931 "" ; dummy argument for shell's $0
1936 (concat "-r" (vc-lookup-triple file rev
)))
1939 (and failed
(file-exists-p filename
)
1940 (delete-file filename
))))
1941 (apply 'vc-do-command nil
0 "get" file
'MASTER
;; SCCS
1943 (and rev
(concat "-r" (vc-lookup-triple file rev
)))
1945 (vc-file-setprop file
'vc-workfile-version nil
)))
1947 ;; RCS doesn't let us check out into arbitrary file names directly.
1948 ;; Use `co -p' and make stdout point to the correct file.
1949 (let ((vc-modes (logior (file-modes (vc-name file
))
1950 (if writable
128 0)))
1954 (apply 'vc-do-command
1955 nil
0 "/bin/sh" file
'MASTER
"-c"
1956 ;; See the SCCS case, above, regarding the
1958 (format "if [ x\"$1\" = x ]; then shift; fi; \
1959 umask %o; exec >\"$1\" || exit; \
1960 shift; umask %o; exec co \"$@\""
1961 (logand 511 (lognot vc-modes
))
1962 (logand 511 (lognot (default-file-modes))))
1963 "" ; dummy argument for shell's $0
1969 (and failed
(file-exists-p filename
) (delete-file filename
))))
1971 ;; if we should go to the head of the trunk,
1972 ;; clear the default branch first
1973 (and rev
(string= rev
"")
1974 (vc-do-command nil
0 "rcs" file
'MASTER
"-b"))
1975 ;; now do the checkout
1976 (apply 'vc-do-command
1977 nil
0 "co" file
'MASTER
1978 ;; If locking is not strict, force to overwrite
1979 ;; the writable workfile.
1980 (if (eq (vc-checkout-model file
) 'implicit
) "-f")
1982 (if rev
(concat "-r" rev
)
1983 ;; if no explicit revision was specified,
1984 ;; check out that of the working file
1985 (let ((workrev (vc-workfile-version file
)))
1986 (if workrev
(concat "-r" workrev
)
1989 ;; determine the new workfile version
1992 (goto-char (point-min))
1994 (if (re-search-forward "^revision \\([0-9.]+\\).*\n" nil t
)
1995 (buffer-substring (match-beginning 1) (match-end 1)))))
1996 (vc-file-setprop file
'vc-workfile-version new-version
)
1997 ;; if necessary, adjust the default branch
1998 (and rev
(not (string= rev
""))
1999 (vc-do-command nil
0 "rcs" file
'MASTER
2000 (concat "-b" (if (vc-latest-on-branch-p file
)
2001 (if (vc-trunk-p new-version
) nil
2002 (vc-branch-part new-version
))
2005 ;; CVS is much like RCS
2009 (apply 'vc-do-command
2010 nil
0 "/bin/sh" file
'WORKFILE
"-c"
2011 "exec >\"$1\" || exit; shift; exec cvs update \"$@\""
2012 "" ; dummy argument for shell's $0
2018 (and failed
(file-exists-p filename
) (delete-file filename
))))
2019 ;; default for verbose checkout: clear the sticky tag
2020 ;; so that the actual update will get the head of the trunk
2021 (and rev
(string= rev
"")
2022 (vc-do-command nil
0 "cvs" file
'WORKFILE
"update" "-A"))
2023 ;; If a revision was specified, check that out.
2025 (apply 'vc-do-command nil
0 "cvs" file
'WORKFILE
2026 (and writable
(eq (vc-checkout-model file
) 'manual
) "-w")
2028 (and rev
(not (string= rev
""))
2031 ;; If no revision was specified, simply make the file writable.
2033 (or (eq (vc-checkout-model file
) 'manual
)
2034 (zerop (logand 128 (file-modes file
))))
2035 (set-file-modes file
(logior 128 (file-modes file
)))))
2036 (if rev
(vc-file-setprop file
'vc-workfile-version nil
))))
2039 (vc-file-clear-masterprops file
)
2041 (vc-file-setprop file
'vc-locking-user
(vc-user-login-name)))
2042 (vc-file-setprop file
2043 'vc-checkout-time
(nth 5 (file-attributes file
)))))
2044 (message "Checking out %s...done" filename
))))))
2046 (defun vc-backend-logentry-check (file)
2047 (vc-backend-dispatch file
2048 (if (>= (buffer-size) 512) ;; SCCS
2052 "Log must be less than 512 characters; point is now at pos 512")))
2057 (defun vc-backend-checkin (file rev comment
)
2058 ;; Register changes to FILE as level REV with explanatory COMMENT.
2059 ;; Automatically retrieves a read-only version of the file with
2060 ;; keywords expanded if vc-keep-workfiles is non-nil, otherwise
2061 ;; it deletes the workfile.
2062 ;; Adaptation for RCS branch support: if this is an explicit checkin,
2063 ;; or if the checkin creates a new branch, set the master file branch
2065 (message "Checking in %s..." file
)
2066 ;; "This log message intentionally left almost blank".
2067 ;; RCS 5.7 gripes about white-space-only comments too.
2068 (or (and comment
(string-match "[^\t\n ]" comment
))
2069 (setq comment
"*** empty log message ***"))
2071 ;; Change buffers to get local value of vc-checkin-switches.
2072 (set-buffer (or (get-file-buffer file
) (current-buffer)))
2074 (if (stringp vc-checkin-switches
)
2075 (list vc-checkin-switches
)
2076 vc-checkin-switches
)))
2077 ;; Clear the master-properties. Do that here, not at the
2078 ;; end, because if the check-in fails we want them to get
2079 ;; re-computed before the next try.
2080 (vc-file-clear-masterprops file
)
2081 (vc-backend-dispatch file
2084 (apply 'vc-do-command nil
0 "delta" file
'MASTER
2085 (if rev
(concat "-r" rev
))
2086 (concat "-y" comment
)
2088 (vc-file-setprop file
'vc-locking-user
'none
)
2089 (vc-file-setprop file
'vc-workfile-version nil
)
2090 (if vc-keep-workfiles
2091 (vc-do-command nil
0 "get" file
'MASTER
))
2094 (let ((old-version (vc-workfile-version file
)) new-version
)
2095 (apply 'vc-do-command nil
0 "ci" file
'MASTER
2096 ;; if available, use the secure check-in option
2097 (and (vc-backend-release-p 'RCS
"5.6.4") "-j")
2098 (concat (if vc-keep-workfiles
"-u" "-r") rev
)
2099 (concat "-m" comment
)
2101 (vc-file-setprop file
'vc-locking-user
'none
)
2102 (vc-file-setprop file
'vc-workfile-version nil
)
2104 ;; determine the new workfile version
2106 (goto-char (point-min))
2107 (if (or (re-search-forward
2108 "new revision: \\([0-9.]+\\);" nil t
)
2110 "reverting to previous revision \\([0-9.]+\\)" nil t
))
2111 (progn (setq new-version
(buffer-substring (match-beginning 1)
2113 (vc-file-setprop file
'vc-workfile-version new-version
)))
2115 ;; if we got to a different branch, adjust the default
2116 ;; branch accordingly
2118 ((and old-version new-version
2119 (not (string= (vc-branch-part old-version
)
2120 (vc-branch-part new-version
))))
2121 (vc-do-command nil
0 "rcs" file
'MASTER
2122 (if (vc-trunk-p new-version
) "-b"
2123 (concat "-b" (vc-branch-part new-version
))))
2124 ;; If this is an old RCS release, we might have
2125 ;; to remove a remaining lock.
2126 (if (not (vc-backend-release-p 'RCS
"5.6.2"))
2127 ;; exit status of 1 is also accepted.
2128 ;; It means that the lock was removed before.
2129 (vc-do-command nil
1 "rcs" file
'MASTER
2130 (concat "-u" old-version
))))))
2133 ;; explicit check-in to the trunk requires a
2134 ;; double check-in (first unexplicit) (CVS-1.3)
2137 (if (and rev
(vc-trunk-p rev
))
2138 (apply 'vc-do-command nil
0 "cvs" file
'WORKFILE
2139 "ci" "-m" "intermediate"
2141 (apply 'vc-do-command nil
0 "cvs" file
'WORKFILE
2142 "ci" (if rev
(concat "-r" rev
))
2143 (concat "-m" comment
)
2145 (error (if (eq (vc-cvs-status file
) 'needs-merge
)
2146 ;; The CVS output will be on top of this message.
2147 (error "Type C-x 0 C-x C-q to merge in changes")
2148 (error "Check-in failed"))))
2149 ;; determine and store the new workfile version
2151 (goto-char (point-min))
2152 (if (re-search-forward
2153 "^\\(new\\|initial\\) revision: \\([0-9.]+\\)" nil t
)
2154 (vc-file-setprop file
'vc-workfile-version
2155 (buffer-substring (match-beginning 2)
2157 (vc-file-setprop file
'vc-workfile-version nil
))
2158 ;; if this was an explicit check-in, remove the sticky tag
2160 (vc-do-command nil
0 "cvs" file
'WORKFILE
"update" "-A"))
2161 (vc-file-setprop file
'vc-locking-user
'none
)
2162 (vc-file-setprop file
'vc-checkout-time
2163 (nth 5 (file-attributes file
)))))))
2164 (message "Checking in %s...done" file
))
2166 (defun vc-backend-revert (file)
2167 ;; Revert file to latest checked-in version.
2168 ;; (for RCS, to workfile version)
2169 (message "Reverting %s..." file
)
2170 (vc-file-clear-masterprops file
)
2171 (vc-backend-dispatch
2175 (vc-do-command nil
0 "unget" file
'MASTER nil
)
2176 (vc-do-command nil
0 "get" file
'MASTER nil
))
2178 (vc-do-command nil
0 "co" file
'MASTER
2179 "-f" (concat "-u" (vc-workfile-version file
)))
2183 (vc-do-command nil
0 "cvs" file
'WORKFILE
"update")))
2184 (vc-file-setprop file
'vc-locking-user
'none
)
2185 (vc-file-setprop file
'vc-checkout-time
(nth 5 (file-attributes file
)))
2186 (message "Reverting %s...done" file
)
2189 (defun vc-backend-steal (file &optional rev
)
2190 ;; Steal the lock on the current workfile. Needs RCS 5.6.2 or later for -M.
2191 (message "Stealing lock on %s..." file
)
2192 (vc-backend-dispatch file
2194 (vc-do-command nil
0 "unget" file
'MASTER
"-n" (if rev
(concat "-r" rev
)))
2195 (vc-do-command nil
0 "get" file
'MASTER
"-g" (if rev
(concat "-r" rev
)))
2197 (vc-do-command nil
0 "rcs" file
'MASTER
;RCS
2198 "-M" (concat "-u" rev
) (concat "-l" rev
))
2199 (error "You cannot steal a CVS lock; there are no CVS locks to steal") ;CVS
2201 (vc-file-setprop file
'vc-locking-user
(vc-user-login-name))
2202 (message "Stealing lock on %s...done" file
)
2205 (defun vc-backend-uncheck (file target
)
2206 ;; Undo the latest checkin.
2207 (message "Removing last change from %s..." file
)
2208 (vc-backend-dispatch file
2209 (vc-do-command nil
0 "rmdel" file
'MASTER
(concat "-r" target
))
2210 (vc-do-command nil
0 "rcs" file
'MASTER
(concat "-o" target
))
2211 nil
;; this is never reached under CVS
2213 (message "Removing last change from %s...done" file
)
2216 (defun vc-backend-print-log (file)
2217 ;; Get change log associated with FILE.
2218 (vc-backend-dispatch
2220 (vc-do-command nil
0 "prs" file
'MASTER
)
2221 (vc-do-command nil
0 "rlog" file
'MASTER
)
2222 (vc-do-command nil
0 "cvs" file
'WORKFILE
"log")))
2224 (defun vc-backend-assign-name (file name
)
2225 ;; Assign to a FILE's latest version a given NAME.
2226 (vc-backend-dispatch file
2227 (vc-add-triple name file
(vc-latest-version file
)) ;; SCCS
2228 (vc-do-command nil
0 "rcs" file
'MASTER
(concat "-n" name
":")) ;; RCS
2229 (vc-do-command nil
0 "cvs" file
'WORKFILE
"tag" name
) ;; CVS
2233 (defun vc-backend-diff (file &optional oldvers newvers cmp
)
2234 ;; Get a difference report between two versions of FILE.
2235 ;; Get only a brief comparison report if CMP, a difference report otherwise.
2236 (let ((backend (vc-backend file
)))
2239 (setq oldvers
(vc-lookup-triple file oldvers
))
2240 (setq newvers
(vc-lookup-triple file newvers
)))
2242 (if (not oldvers
) (setq oldvers
(vc-workfile-version file
)))
2243 ;; If we know that --brief is not supported, don't try it.
2244 (setq cmp
(and cmp
(not (eq vc-rcsdiff-knows-brief
'no
))))))
2245 ;; SCCS and RCS shares a lot of code.
2247 ((or (eq backend
'SCCS
) (eq backend
'RCS
))
2248 (let* ((command (if (eq backend
'SCCS
) "vcdiff" "rcsdiff"))
2249 (mode (if (eq backend
'RCS
) 'WORKFILE
'MASTER
))
2250 (options (append (list (and cmp
"--brief")
2252 (and oldvers
(concat "-r" oldvers
))
2253 (and newvers
(concat "-r" newvers
)))
2255 (if (listp diff-switches
)
2257 (list diff-switches
)))))
2258 (status (apply 'vc-do-command
"*vc-diff*" 2
2259 command file mode options
)))
2260 ;; If --brief didn't work, do a double-take and remember it
2264 (apply 'vc-do-command
"*vc-diff*" 1 command file
'WORKFILE
2265 (if cmp
(cdr options
) options
))
2266 (if cmp
(setq vc-rcsdiff-knows-brief
'no
)))
2267 ;; If --brief DID work, remember that, too.
2268 (and cmp
(not vc-rcsdiff-knows-brief
)
2269 (setq vc-rcsdiff-knows-brief
'yes
))
2271 ;; CVS is different.
2273 (if (string= (vc-workfile-version file
) "0") ;CVS
2274 ;; This file is added but not yet committed; there is no master file.
2275 (if (or oldvers newvers
)
2276 (error "No revisions of %s exist" file
)
2277 (if cmp
1 ;; file is added but not committed,
2278 ;; we regard this as "changed".
2279 ;; diff it against /dev/null.
2280 (apply 'vc-do-command
2281 "*vc-diff*" 1 "diff" file
'WORKFILE
2282 (append (if (listp diff-switches
)
2284 (list diff-switches
)) '("/dev/null")))))
2285 ;; cmp is not yet implemented -- we always do a full diff.
2286 (apply 'vc-do-command
2287 "*vc-diff*" 1 "cvs" file
'WORKFILE
"diff"
2288 (and oldvers
(concat "-r" oldvers
))
2289 (and newvers
(concat "-r" newvers
))
2290 (if (listp diff-switches
)
2292 (list diff-switches
)))))
2294 (vc-registration-error file
)))))
2296 (defun vc-backend-merge-news (file)
2297 ;; Merge in any new changes made to FILE.
2298 (message "Merging changes into %s..." file
)
2300 (vc-backend-dispatch
2302 (error "vc-backend-merge-news not meaningful for SCCS files") ;SCCS
2303 (error "vc-backend-merge-news not meaningful for RCS files") ;RCS
2304 (save-excursion ; CVS
2305 (vc-file-clear-masterprops file
)
2306 (vc-file-setprop file
'vc-workfile-version nil
)
2307 (vc-file-setprop file
'vc-locking-user nil
)
2308 (vc-do-command nil
0 "cvs" file
'WORKFILE
"update")
2309 ;; CVS doesn't return an error code if conflicts are detected.
2310 ;; Since we want to warn the user about it (and possibly start
2311 ;; emerge later), scan the output and see if this occurred.
2312 (set-buffer (get-buffer "*vc*"))
2313 (goto-char (point-min))
2314 (if (re-search-forward "^cvs update: conflicts found in .*" nil t
)
2315 1 ;; error code for caller
2316 0 ;; no conflict detected
2318 (message "Merging changes into %s...done" file
)))
2320 (defun vc-check-headers ()
2321 "Check if the current file has any headers in it."
2324 (goto-char (point-min))
2325 (vc-backend-dispatch buffer-file-name
2326 (re-search-forward "%[MIRLBSDHTEGUYFPQCZWA]%" nil t
) ;; SCCS
2327 (re-search-forward "\\$[A-Za-z\300-\326\330-\366\370-\377]+\\(: [\t -#%-\176\240-\377]*\\)?\\$" nil t
) ;; RCS
2328 'RCS
;; CVS works like RCS in this regard.
2332 ;; Back-end-dependent stuff ends here.
2334 ;; Set up key bindings for use while editing log messages
2336 (defun vc-log-mode ()
2337 "Minor mode for driving version-control tools.
2338 These bindings are added to the global keymap when you enter this mode:
2339 \\[vc-next-action] perform next logical version-control operation on current file
2340 \\[vc-register] register current file
2341 \\[vc-toggle-read-only] like next-action, but won't register files
2342 \\[vc-insert-headers] insert version-control headers in current file
2343 \\[vc-print-log] display change history of current file
2344 \\[vc-revert-buffer] revert buffer to latest version
2345 \\[vc-cancel-version] undo latest checkin
2346 \\[vc-diff] show diffs between file versions
2347 \\[vc-version-other-window] visit old version in another window
2348 \\[vc-directory] show all files locked by any user in or below .
2349 \\[vc-update-change-log] add change log entry from recent checkins
2351 While you are entering a change log message for a version, the following
2352 additional bindings will be in effect.
2354 \\[vc-finish-logentry] proceed with check in, ending log message entry
2356 Whenever you do a checkin, your log comment is added to a ring of
2357 saved comments. These can be recalled as follows:
2359 \\[vc-next-comment] replace region with next message in comment ring
2360 \\[vc-previous-comment] replace region with previous message in comment ring
2361 \\[vc-comment-search-reverse] search backward for regexp in the comment ring
2362 \\[vc-comment-search-forward] search backward for regexp in the comment ring
2364 Entry to the change-log submode calls the value of text-mode-hook, then
2365 the value of vc-log-mode-hook.
2367 Global user options:
2368 vc-initial-comment If non-nil, require user to enter a change
2369 comment upon first checkin of the file.
2371 vc-keep-workfiles Non-nil value prevents workfiles from being
2372 deleted when changes are checked in
2374 vc-suppress-confirm Suppresses some confirmation prompts,
2375 notably for reversions.
2377 vc-header-alist Which keywords to insert when adding headers
2378 with \\[vc-insert-headers]. Defaults to
2379 '(\"\%\W\%\") under SCCS, '(\"\$Id\$\") under
2382 vc-static-header-alist By default, version headers inserted in C files
2383 get stuffed in a static string area so that
2384 ident(RCS/CVS) or what(SCCS) can see them in
2385 the compiled object code. You can override
2386 this by setting this variable to nil, or change
2387 the header template by changing it.
2389 vc-command-messages if non-nil, display run messages from the
2390 actual version-control utilities (this is
2391 intended primarily for people hacking vc
2395 (set-syntax-table text-mode-syntax-table
)
2396 (use-local-map vc-log-entry-mode
)
2397 (setq local-abbrev-table text-mode-abbrev-table
)
2398 (setq major-mode
'vc-log-mode
)
2399 (setq mode-name
"VC-Log")
2400 (make-local-variable 'vc-log-file
)
2401 (make-local-variable 'vc-log-version
)
2402 (make-local-variable 'vc-comment-ring-index
)
2403 (set-buffer-modified-p nil
)
2404 (setq buffer-file-name nil
)
2405 (run-hooks 'text-mode-hook
'vc-log-mode-hook
)
2408 ;; Initialization code, to be done just once at load-time
2409 (if vc-log-entry-mode
2411 (setq vc-log-entry-mode
(make-sparse-keymap))
2412 (define-key vc-log-entry-mode
"\M-n" 'vc-next-comment
)
2413 (define-key vc-log-entry-mode
"\M-p" 'vc-previous-comment
)
2414 (define-key vc-log-entry-mode
"\M-r" 'vc-comment-search-reverse
)
2415 (define-key vc-log-entry-mode
"\M-s" 'vc-comment-search-forward
)
2416 (define-key vc-log-entry-mode
"\C-c\C-c" 'vc-finish-logentry
)
2419 ;;; These things should probably be generally available
2421 (defun vc-file-tree-walk (dirname func
&rest args
)
2422 "Walk recursively through DIRNAME.
2423 Invoke FUNC f ARGS on each non-directory file f underneath it."
2424 (vc-file-tree-walk-internal (expand-file-name dirname
) func args
)
2425 (message "Traversing directory %s...done" dirname
))
2427 (defun vc-file-tree-walk-internal (file func args
)
2428 (if (not (file-directory-p file
))
2429 (apply func file args
)
2430 (message "Traversing directory %s..." (abbreviate-file-name file
))
2431 (let ((dir (file-name-as-directory file
)))
2435 (string-equal f
".")
2436 (string-equal f
"..")
2437 (member f vc-directory-exclusion-list
)
2438 (let ((dirf (concat dir f
)))
2440 (file-symlink-p dirf
) ;; Avoid possible loops
2441 (vc-file-tree-walk-internal dirf func args
))))))
2442 (directory-files dir
)))))
2446 ;;; DEVELOPER'S NOTES ON CONCURRENCY PROBLEMS IN THIS CODE
2448 ;;; These may be useful to anyone who has to debug or extend the package.
2449 ;;; (Note that this information corresponds to versions 5.x. Some of it
2450 ;;; might have been invalidated by the additions to support branching
2451 ;;; and RCS keyword lookup. AS, 1995/03/24)
2453 ;;; A fundamental problem in VC is that there are time windows between
2454 ;;; vc-next-action's computations of the file's version-control state and
2455 ;;; the actions that change it. This is a window open to lossage in a
2456 ;;; multi-user environment; someone else could nip in and change the state
2457 ;;; of the master during it.
2459 ;;; The performance problem is that rlog/prs calls are very expensive; we want
2460 ;;; to avoid them as much as possible.
2464 ;;; The performance problem, it turns out, simplifies in practice to the
2465 ;;; problem of making vc-locking-user fast. The two other functions that call
2466 ;;; prs/rlog will not be so commonly used that the slowdown is a problem; one
2467 ;;; makes snapshots, the other deletes the calling user's last change in the
2470 ;;; The race condition implies that we have to either (a) lock the master
2471 ;;; during the entire execution of vc-next-action, or (b) detect and
2472 ;;; recover from errors resulting from dispatch on an out-of-date state.
2474 ;;; Alternative (a) appears to be infeasible. The problem is that we can't
2475 ;;; guarantee that the lock will ever be removed. Suppose a user starts a
2476 ;;; checkin, the change message buffer pops up, and the user, having wandered
2477 ;;; off to do something else, simply forgets about it?
2479 ;;; Alternative (b), on the other hand, works well with a cheap way to speed up
2480 ;;; vc-locking-user. Usually, if a file is registered, we can read its locked/
2481 ;;; unlocked state and its current owner from its permissions.
2483 ;;; This shortcut will fail if someone has manually changed the workfile's
2484 ;;; permissions; also if developers are munging the workfile in several
2485 ;;; directories, with symlinks to a master (in this latter case, the
2486 ;;; permissions shortcut will fail to detect a lock asserted from another
2489 ;;; Note that these cases correspond exactly to the errors which could happen
2490 ;;; because of a competing checkin/checkout race in between two instances of
2493 ;;; For VC's purposes, a workfile/master pair may have the following states:
2495 ;;; A. Unregistered. There is a workfile, there is no master.
2497 ;;; B. Registered and not locked by anyone.
2499 ;;; C. Locked by calling user and unchanged.
2501 ;;; D. Locked by the calling user and changed.
2503 ;;; E. Locked by someone other than the calling user.
2505 ;;; This makes for 25 states and 20 error conditions. Here's the matrix:
2507 ;;; VC's idea of state
2509 ;;; V Actual state RCS action SCCS action Effect
2511 ;;; A . 1 2 3 4 ci -u -t- admin -fb -i<file> initial admin
2512 ;;; B 5 . 6 7 8 co -l get -e checkout
2513 ;;; C 9 10 . 11 12 co -u unget; get revert
2514 ;;; D 13 14 15 . 16 ci -u -m<comment> delta -y<comment>; get checkin
2515 ;;; E 17 18 19 20 . rcs -u -M -l unget -n ; get -g steal lock
2517 ;;; All commands take the master file name as a last argument (not shown).
2519 ;;; In the discussion below, a "self-race" is a pathological situation in
2520 ;;; which VC operations are being attempted simultaneously by two or more
2521 ;;; Emacsen running under the same username.
2523 ;;; The vc-next-action code has the following windows:
2526 ;;; Between the check for existence of a master file and the call to
2527 ;;; admin/checkin in vc-buffer-admin (apparent state A). This window may
2528 ;;; never close if the initial-comment feature is on.
2531 ;;; Between the call to vc-workfile-unchanged-p in and the immediately
2532 ;;; following revert (apparent state C).
2535 ;;; Between the call to vc-workfile-unchanged-p in and the following
2536 ;;; checkin (apparent state D). This window may never close.
2539 ;;; Between the unlock and the immediately following checkout during a
2540 ;;; revert operation (apparent state C). Included in window Q.
2543 ;;; Between vc-locking-user and the following checkout (apparent state B).
2546 ;;; Between vc-locking-user and the following revert (apparent state C).
2547 ;;; Includes windows Q and S.
2550 ;;; Between vc-locking-user and the following checkin (apparent state
2551 ;;; D). This window may never be closed if the user fails to complete the
2552 ;;; checkin message. Includes window R.
2555 ;;; Between vc-locking-user and the following steal-lock (apparent
2556 ;;; state E). This window may never close if the user fails to complete
2557 ;;; the steal-lock message. Includes window X.
2560 ;;; Between the unlock and the immediately following re-lock during a
2561 ;;; steal-lock operation (apparent state E). This window may never cloce
2562 ;;; if the user fails to complete the steal-lock message.
2566 ;;; Apparent state A ---
2568 ;;; 1. File looked unregistered but is actually registered and not locked.
2570 ;;; Potential cause: someone else's admin during window P, with
2571 ;;; caller's admin happening before their checkout.
2573 ;;; RCS: Prior to version 5.6.4, ci fails with message
2574 ;;; "no lock set by <user>". From 5.6.4 onwards, VC uses the new
2575 ;;; ci -i option and the message is "<file>,v: already exists".
2576 ;;; SCCS: admin will fail with error (ad19).
2578 ;;; We can let these errors be passed up to the user.
2580 ;;; 2. File looked unregistered but is actually locked by caller, unchanged.
2582 ;;; Potential cause: self-race during window P.
2584 ;;; RCS: Prior to version 5.6.4, reverts the file to the last saved
2585 ;;; version and unlocks it. From 5.6.4 onwards, VC uses the new
2586 ;;; ci -i option, failing with message "<file>,v: already exists".
2587 ;;; SCCS: will fail with error (ad19).
2589 ;;; Either of these consequences is acceptable.
2591 ;;; 3. File looked unregistered but is actually locked by caller, changed.
2593 ;;; Potential cause: self-race during window P.
2595 ;;; RCS: Prior to version 5.6.4, VC registers the caller's workfile as
2596 ;;; a delta with a null change comment (the -t- switch will be
2597 ;;; ignored). From 5.6.4 onwards, VC uses the new ci -i option,
2598 ;;; failing with message "<file>,v: already exists".
2599 ;;; SCCS: will fail with error (ad19).
2601 ;;; 4. File looked unregistered but is locked by someone else.
2603 ;;; Potential cause: someone else's admin during window P, with
2604 ;;; caller's admin happening *after* their checkout.
2606 ;;; RCS: Prior to version 5.6.4, ci fails with a
2607 ;;; "no lock set by <user>" message. From 5.6.4 onwards,
2608 ;;; VC uses the new ci -i option, failing with message
2609 ;;; "<file>,v: already exists".
2610 ;;; SCCS: will fail with error (ad19).
2612 ;;; We can let these errors be passed up to the user.
2614 ;;; Apparent state B ---
2616 ;;; 5. File looked registered and not locked, but is actually unregistered.
2618 ;;; Potential cause: master file got nuked during window P.
2620 ;;; RCS: will fail with "RCS/<file>: No such file or directory"
2621 ;;; SCCS: will fail with error ut4.
2623 ;;; We can let these errors be passed up to the user.
2625 ;;; 6. File looked registered and not locked, but is actually locked by the
2626 ;;; calling user and unchanged.
2628 ;;; Potential cause: self-race during window T.
2630 ;;; RCS: in the same directory as the previous workfile, co -l will fail
2631 ;;; with "co error: writable foo exists; checkout aborted". In any other
2632 ;;; directory, checkout will succeed.
2633 ;;; SCCS: will fail with ge17.
2635 ;;; Either of these consequences is acceptable.
2637 ;;; 7. File looked registered and not locked, but is actually locked by the
2638 ;;; calling user and changed.
2642 ;;; 8. File looked registered and not locked, but is actually locked by another
2645 ;;; Potential cause: someone else checks it out during window T.
2647 ;;; RCS: co error: revision 1.3 already locked by <user>
2648 ;;; SCCS: fails with ge4 (in directory) or ut7 (outside it).
2650 ;;; We can let these errors be passed up to the user.
2652 ;;; Apparent state C ---
2654 ;;; 9. File looks locked by calling user and unchanged, but is unregistered.
2658 ;;; 10. File looks locked by calling user and unchanged, but is actually not
2661 ;;; Potential cause: a self-race in window U, or by the revert's
2662 ;;; landing during window X of some other user's steal-lock or window S
2663 ;;; of another user's revert.
2665 ;;; RCS: succeeds, refreshing the file from the identical version in
2667 ;;; SCCS: fails with error ut4 (p file nonexistent).
2669 ;;; Either of these consequences is acceptable.
2671 ;;; 11. File is locked by calling user. It looks unchanged, but is actually
2674 ;;; Potential cause: the file would have to be touched by a self-race
2675 ;;; during window Q.
2677 ;;; The revert will succeed, removing whatever changes came with
2678 ;;; the touch. It is theoretically possible that work could be lost.
2680 ;;; 12. File looks like it's locked by the calling user and unchanged, but
2681 ;;; it's actually locked by someone else.
2683 ;;; Potential cause: a steal-lock in window V.
2685 ;;; RCS: co error: revision <rev> locked by <user>; use co -r or rcs -u
2686 ;;; SCCS: fails with error un2
2688 ;;; We can pass these errors up to the user.
2690 ;;; Apparent state D ---
2692 ;;; 13. File looks like it's locked by the calling user and changed, but it's
2693 ;;; actually unregistered.
2695 ;;; Potential cause: master file got nuked during window P.
2697 ;;; RCS: Prior to version 5.6.4, checks in the user's version as an
2698 ;;; initial delta. From 5.6.4 onwards, VC uses the new ci -j
2699 ;;; option, failing with message "no such file or directory".
2700 ;;; SCCS: will fail with error ut4.
2702 ;;; This case is kind of nasty. Under RCS prior to version 5.6.4,
2703 ;;; VC may fail to detect the loss of previous version information.
2705 ;;; 14. File looks like it's locked by the calling user and changed, but it's
2706 ;;; actually unlocked.
2708 ;;; Potential cause: self-race in window V, or the checkin happening
2709 ;;; during the window X of someone else's steal-lock or window S of
2710 ;;; someone else's revert.
2712 ;;; RCS: ci will fail with "no lock set by <user>".
2713 ;;; SCCS: delta will fail with error ut4.
2715 ;;; 15. File looks like it's locked by the calling user and changed, but it's
2716 ;;; actually locked by the calling user and unchanged.
2718 ;;; Potential cause: another self-race --- a whole checkin/checkout
2719 ;;; sequence by the calling user would have to land in window R.
2721 ;;; SCCS: checks in a redundant delta and leaves the file unlocked as usual.
2722 ;;; RCS: reverts to the file state as of the second user's checkin, leaving
2723 ;;; the file unlocked.
2725 ;;; It is theoretically possible that work could be lost under RCS.
2727 ;;; 16. File looks like it's locked by the calling user and changed, but it's
2728 ;;; actually locked by a different user.
2730 ;;; RCS: ci error: no lock set by <user>
2731 ;;; SCCS: unget will fail with error un2
2733 ;;; We can pass these errors up to the user.
2735 ;;; Apparent state E ---
2737 ;;; 17. File looks like it's locked by some other user, but it's actually
2742 ;;; 18. File looks like it's locked by some other user, but it's actually
2745 ;;; Potential cause: someone released a lock during window W.
2747 ;;; RCS: The calling user will get the lock on the file.
2748 ;;; SCCS: unget -n will fail with cm4.
2750 ;;; Either of these consequences will be OK.
2752 ;;; 19. File looks like it's locked by some other user, but it's actually
2753 ;;; locked by the calling user and unchanged.
2755 ;;; Potential cause: the other user relinquishing a lock followed by
2756 ;;; a self-race, both in window W.
2758 ;;; Under both RCS and SCCS, both unlock and lock will succeed, making
2759 ;;; the sequence a no-op.
2761 ;;; 20. File looks like it's locked by some other user, but it's actually
2762 ;;; locked by the calling user and changed.
2768 ;;; In order of decreasing severity:
2770 ;;; Cases 11 and 15 are the only ones that potentially lose work.
2771 ;;; They would require a self-race for this to happen.
2773 ;;; Case 13 in RCS loses information about previous deltas, retaining
2774 ;;; only the information in the current workfile. This can only happen
2775 ;;; if the master file gets nuked in window P.
2777 ;;; Case 3 in RCS and case 15 under SCCS insert a redundant delta with
2778 ;;; no change comment in the master. This would require a self-race in
2779 ;;; window P or R respectively.
2781 ;;; Cases 2, 10, 19 and 20 do extra work, but make no changes.
2783 ;;; Unfortunately, it appears to me that no recovery is possible in these
2784 ;;; cases. They don't yield error messages, so there's no way to tell that
2785 ;;; a race condition has occurred.
2787 ;;; All other cases don't change either the workfile or the master, and
2788 ;;; trigger command errors which the user will see.
2790 ;;; Thus, there is no explicit recovery code.