1 ;;; vc.el --- drive a version-control system from within Emacs
3 ;; Copyright (C) 1992, 1993, 1994, 1995 Free Software Foundation, Inc.
5 ;; Author: Eric S. Raymond <esr@snark.thyrsus.com>
6 ;; Maintainer: ttn@netcom.com
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation; either version 2, or (at your option)
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; see the file COPYING. If not, write to
23 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, 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>
35 ;; Supported version-control systems presently include SCCS, RCS, and CVS.
36 ;; The RCS lock-stealing code doesn't work right unless you use RCS 5.6.2
37 ;; or newer. Currently (January 1994) that is only a beta test release.
38 ;; Even initial checkins will fail if your RCS version is so old that ci
39 ;; doesn't understand -t-; this has been known to happen to people running
42 ;; The RCS code assumes strict locking. You can support the RCS -x option
43 ;; by adding pairs to the vc-master-templates list.
45 ;; Proper function of the SCCS diff commands requires the shellscript vcdiff
46 ;; to be installed somewhere on Emacs's path for executables.
48 ;; If your site uses the ChangeLog convention supported by Emacs, the
49 ;; function vc-comment-to-change-log should prove a useful checkin hook.
51 ;; This code depends on call-process passing back the subprocess exit
52 ;; status. Thus, you need Emacs 18.58 or later to run it. For the
53 ;; vc-directory command to work properly as documented, you need 19.
54 ;; You also need Emacs 19's ring.el.
56 ;; The vc code maintains some internal state in order to reduce expensive
57 ;; version-control operations to a minimum. Some names are only computed
58 ;; once. If you perform version control operations with RCS/SCCS/CVS while
59 ;; vc's back is turned, or move/rename master files while vc is running,
60 ;; vc may get seriously confused. Don't do these things!
62 ;; Developer's notes on some concurrency issues are included at the end of
69 (eval-when-compile (require 'dired
)) ; for dired-map-over-marks macro
71 (if (not (assoc 'vc-parent-buffer minor-mode-alist
))
72 (setq minor-mode-alist
73 (cons '(vc-parent-buffer vc-parent-buffer-name
)
76 ;; General customization
78 (defvar vc-default-back-end nil
79 "*Back-end actually used by this interface; may be SCCS or RCS.
80 The value is only computed when needed to avoid an expensive search.")
81 (defvar vc-suppress-confirm nil
82 "*If non-nil, treat user as expert; suppress yes-no prompts on some things.")
83 (defvar vc-keep-workfiles t
84 "*If non-nil, don't delete working files after registering changes.
85 If the back-end is CVS, workfiles are always kept, regardless of the
87 (defvar vc-initial-comment nil
88 "*Prompt for initial comment when a file is registered.")
89 (defvar vc-command-messages nil
90 "*Display run messages from back-end commands.")
91 (defvar vc-mistrust-permissions
'file-symlink-p
92 "*Don't assume that permissions and ownership track version-control status.")
93 (defvar vc-checkin-switches nil
94 "*Extra switches passed to the checkin program by \\[vc-checkin].")
95 (defvar vc-checkout-switches nil
96 "*Extra switches passed to the checkout program by \\[vc-checkout].")
98 (if (file-exists-p "/usr/sccs")
100 "*List of extra directories to search for version control commands.")
101 (defvar vc-directory-exclusion-list
'("SCCS" "RCS")
102 "*Directory names ignored by functions that recursively walk file trees.")
104 (defconst vc-maximum-comment-ring-size
32
105 "Maximum number of saved comments in the comment ring.")
107 ;;; This is duplicated in diff.el.
108 (defvar diff-switches
"-c"
109 "*A string or list of strings specifying switches to be be passed to diff.")
112 (defvar vc-checkin-hook nil
113 "*List of functions called after a checkin is done. See `run-hooks'.")
115 (defvar vc-make-buffer-writable-hook nil
116 "*List of functions called when a buffer is made writable. See `run-hooks.'
117 This hook is only used when the version control system is CVS. It
118 might be useful for sites who uses locking with CVS, or who uses link
119 farms to gold trees.")
121 ;; Header-insertion hair
123 (defvar vc-header-alist
124 '((SCCS "\%W\%") (RCS "\$Id\$") (CVS "\$Id\$"))
125 "*Header keywords to be inserted when `vc-insert-headers' is executed.")
126 (defvar vc-static-header-alist
128 "\n#ifndef lint\nstatic char vcid[] = \"\%s\";\n#endif /* lint */\n"))
129 "*Associate static header string templates with file types. A \%s in the
130 template is replaced with the first string associated with the file's
131 version-control type in `vc-header-alist'.")
133 (defvar vc-comment-alist
134 '((nroff-mode ".\\\"" ""))
135 "*Special comment delimiters to be used in generating vc headers only.
136 Add an entry in this list if you need to override the normal comment-start
137 and comment-end variables. This will only be necessary if the mode language
138 is sensitive to blank lines.")
140 ;; Default is to be extra careful for super-user.
141 (defvar vc-checkout-carefully
(= (user-uid) 0)
142 "*Non-nil means be extra-careful in checkout.
143 Verify that the file really is not locked
144 and that its contents match what the master file says.")
146 ;; Variables the user doesn't need to know about.
147 (defvar vc-log-entry-mode nil
)
148 (defvar vc-log-operation nil
)
149 (defvar vc-log-after-operation-hook nil
)
150 (defvar vc-checkout-writable-buffer-hook
'vc-checkout-writable-buffer
)
151 ;; In a log entry buffer, this is a local variable
152 ;; that points to the buffer for which it was made
153 ;; (either a file, or a VC dired buffer).
154 (defvar vc-parent-buffer nil
)
155 (defvar vc-parent-buffer-name nil
)
158 (defvar vc-log-version
)
160 (defconst vc-name-assoc-file
"VC-names")
162 (defvar vc-dired-mode nil
)
163 (make-variable-buffer-local 'vc-dired-mode
)
165 (defvar vc-comment-ring nil
)
166 (defvar vc-comment-ring-index nil
)
167 (defvar vc-last-comment-match nil
)
169 ;; Back-portability to Emacs 18
171 (defun file-executable-p-18 (f)
172 (let ((modes (file-modes f
)))
173 (and modes
(not (zerop (logand 292))))))
175 (defun file-regular-p-18 (f)
176 (let ((attributes (file-attributes f
)))
177 (and attributes
(not (car attributes
)))))
179 ; Conditionally rebind some things for Emacs 18 compatibility
180 (if (not (boundp 'minor-mode-map-alist
))
182 (setq compilation-old-error-list nil
)
183 (fset 'file-executable-p
'file-executable-p-18
)
184 (fset 'shrink-window-if-larger-than-buffer
'beginning-of-buffer
)
187 (if (not (boundp 'file-regular-p
))
188 (fset 'file-regular-p
'file-regular-p-18
))
190 ;; File property caching
192 (defun vc-file-clearprops (file)
193 ;; clear all properties of a given file
194 (setplist (intern file vc-file-prop-obarray
) nil
))
196 (defun vc-clear-context ()
197 "Clear all cached file properties and the comment ring."
199 (fillarray vc-file-prop-obarray nil
)
200 ;; Note: there is potential for minor lossage here if there is an open
201 ;; log buffer with a nonzero local value of vc-comment-ring-index.
202 (setq vc-comment-ring nil
))
204 ;; Random helper functions
206 (defun vc-registration-error (file)
208 (error "File %s is not under version control" file
)
209 (error "Buffer %s is not associated with a file" (buffer-name))))
211 (defvar vc-binary-assoc nil
)
213 (defun vc-find-binary (name)
214 "Look for a command anywhere on the subprocess-command search path."
215 (or (cdr (assoc name vc-binary-assoc
))
221 (let ((full (concat s
"/" name
)))
222 (if (file-executable-p full
)
224 (setq vc-binary-assoc
225 (cons (cons name full
) vc-binary-assoc
))
226 (throw 'found full
)))))))
230 (defun vc-do-command (okstatus command file last
&rest flags
)
231 "Execute a version-control command, notifying user and checking for errors.
232 The command is successful if its exit status does not exceed OKSTATUS.
233 Output from COMMAND goes to buffer *vc*. The last argument of the command is
234 the master name of FILE if LAST is 'MASTER, or the workfile of FILE if LAST is
235 'WORKFILE; this is appended to an optional list of FLAGS."
236 (setq file
(expand-file-name file
))
237 (if vc-command-messages
238 (message "Running %s on %s..." command file
))
239 (let ((obuf (current-buffer)) (camefrom (current-buffer))
241 (vc-file (and file
(vc-name file
)))
242 (olddir default-directory
)
244 (set-buffer (get-buffer-create "*vc*"))
245 (set (make-local-variable 'vc-parent-buffer
) camefrom
)
246 (set (make-local-variable 'vc-parent-buffer-name
)
247 (concat " from " (buffer-name camefrom
)))
248 (setq default-directory olddir
)
253 (function (lambda (s) (and s
(setq squeezed
(append squeezed
(list s
))))))
255 (if (and vc-file
(eq last
'MASTER
))
256 (setq squeezed
(append squeezed
(list vc-file
))))
257 (if (eq last
'WORKFILE
)
259 (let* ((pwd (expand-file-name default-directory
))
260 (preflen (length pwd
)))
261 (if (string= (substring file
0 preflen
) pwd
)
262 (setq file
(substring file preflen
))))
263 (setq squeezed
(append squeezed
(list file
)))))
264 (let ((exec-path (if vc-path
(append exec-path vc-path
) exec-path
))
265 ;; Add vc-path to PATH for the execution of this command.
267 (cons (concat "PATH=" (getenv "PATH")
268 ":" (mapconcat 'identity vc-path
":"))
269 process-environment
)))
270 (setq status
(apply 'call-process command nil t nil squeezed
)))
271 (goto-char (point-max))
272 (set-buffer-modified-p nil
)
274 (if (or (not (integerp status
)) (< okstatus status
))
276 (pop-to-buffer "*vc*")
277 (goto-char (point-min))
278 (shrink-window-if-larger-than-buffer)
279 (error "Running %s...FAILED (%s)" command
280 (if (integerp status
)
281 (format "status %d" status
)
284 (if vc-command-messages
285 (message "Running %s...OK" command
))
291 ;;; Save a bit of the text around POSN in the current buffer, to help
292 ;;; us find the corresponding position again later. This works even
293 ;;; if all markers are destroyed or corrupted.
294 (defun vc-position-context (posn)
297 (buffer-substring posn
298 (min (point-max) (+ posn
100)))))
300 ;;; Return the position of CONTEXT in the current buffer, or nil if we
301 ;;; couldn't find it.
302 (defun vc-find-position-by-context (context)
303 (let ((context-string (nth 2 context
)))
304 (if (equal "" context-string
)
307 (let ((diff (- (nth 1 context
) (buffer-size))))
308 (if (< diff
0) (setq diff
(- diff
)))
309 (goto-char (nth 0 context
))
310 (if (or (search-forward context-string nil t
)
311 ;; Can't use search-backward since the match may continue
313 (progn (goto-char (- (point) diff
(length context-string
)))
314 ;; goto-char doesn't signal an error at
315 ;; beginning of buffer like backward-char would
316 (search-forward context-string nil t
)))
317 ;; to beginning of OSTRING
318 (- (point) (length context-string
))))))))
320 (defun vc-revert-buffer1 (&optional arg no-confirm
)
321 ;; Most of this was shamelessly lifted from Sebastian Kremer's rcs.el mode.
322 ;; Revert buffer, try to keep point and mark where user expects them in spite
323 ;; of changes because of expanded version-control key words.
324 ;; This is quite important since otherwise typeahead won't work as expected.
327 (let ((point-context (vc-position-context (point)))
328 ;; Use mark-marker to avoid confusion in transient-mark-mode.
329 (mark-context (if (eq (marker-buffer (mark-marker)) (current-buffer))
330 (vc-position-context (mark-marker))))
331 ;; Make the right thing happen in transient-mark-mode.
333 ;; We may want to reparse the compilation buffer after revert
334 (reparse (and (boundp 'compilation-error-list
) ;compile loaded
335 (let ((curbuf (current-buffer)))
336 ;; Construct a list; each elt is nil or a buffer
337 ;; iff that buffer is a compilation output buffer
338 ;; that contains markers into the current buffer.
344 compilation-old-error-list
345 compilation-error-list
))
346 (buffer-error-marked-p nil
))
347 (while (and (consp errors
)
348 (not buffer-error-marked-p
))
349 (and (markerp (cdr (car errors
)))
353 (setq buffer-error-marked-p t
))
354 (setq errors
(cdr errors
)))
355 (if buffer-error-marked-p buffer
))))
358 (let ((in-font-lock-mode (and (boundp 'font-lock-fontified
)
359 font-lock-fontified
)))
360 (if in-font-lock-mode
363 ;; the actual revisit
364 (revert-buffer arg no-confirm
)
366 (if in-font-lock-mode
369 ;; Reparse affected compilation buffers.
373 (set-buffer (car reparse
))
374 (let ((compilation-last-buffer (current-buffer)) ;select buffer
375 ;; Record the position in the compilation buffer of
376 ;; the last error next-error went to.
377 (error-pos (marker-position
378 (car (car-safe compilation-error-list
)))))
379 ;; Reparse the error messages as far as they were parsed before.
380 (compile-reinitialize-errors '(4) compilation-parsing-end
)
381 ;; Move the pointer up to find the error we were at before
382 ;; reparsing. Now next-error should properly go to the next one.
383 (while (and compilation-error-list
384 (/= error-pos
(car (car compilation-error-list
))))
385 (setq compilation-error-list
(cdr compilation-error-list
))))))
386 (setq reparse
(cdr reparse
)))
388 ;; Restore point and mark
389 (let ((new-point (vc-find-position-by-context point-context
)))
390 (if new-point
(goto-char new-point
)))
392 (let ((new-mark (vc-find-position-by-context mark-context
)))
393 (if new-mark
(set-mark new-mark
))))))
396 (defun vc-buffer-sync (&optional not-urgent
)
397 ;; Make sure the current buffer and its working file are in sync
398 ;; NOT-URGENT means it is ok to continue if the user says not to save.
399 (if (buffer-modified-p)
400 (if (or vc-suppress-confirm
401 (y-or-n-p (format "Buffer %s modified; save it? " (buffer-name))))
405 (error "Aborted")))))
408 (defun vc-workfile-unchanged-p (file &optional want-differences-if-changed
)
409 ;; Has the given workfile changed since last checkout?
410 (let ((checkout-time (vc-file-getprop file
'vc-checkout-time
))
411 (lastmod (nth 5 (file-attributes file
))))
412 (or (equal checkout-time lastmod
)
413 (and (or (not checkout-time
) want-differences-if-changed
)
414 (let ((unchanged (zerop (vc-backend-diff file nil nil
415 (not want-differences-if-changed
)))))
416 ;; 0 stands for an unknown time; it can't match any mod time.
417 (vc-file-setprop file
'vc-checkout-time
(if unchanged lastmod
0))
420 (defun vc-next-action-on-file (file verbose
&optional comment
)
421 ;;; If comment is specified, it will be used as an admin or checkin comment.
422 (let ((vc-file (vc-name file
))
423 (vc-type (vc-backend-deduce file
))
427 ;; if there is no master file corresponding, create one
429 (vc-register verbose comment
)
430 (if vc-initial-comment
431 (setq vc-log-after-operation-hook
432 'vc-checkout-writable-buffer-hook
)
433 (vc-checkout-writable-buffer file
)))
435 ;; if there is no lock on the file, assert one and get it
436 ((and (not (eq vc-type
'CVS
)) ;There are no locks in CVS.
437 (not (setq owner
(vc-locking-user file
))))
438 (if (and vc-checkout-carefully
439 (not (vc-workfile-unchanged-p file t
)))
440 (if (save-window-excursion
441 (pop-to-buffer "*vc*")
442 (goto-char (point-min))
443 (insert-string (format "Changes to %s since last lock:\n\n"
447 (concat "File has unlocked changes, "
448 "claim lock retaining changes? ")))
449 (progn (vc-backend-steal file
)
451 (if (not (yes-or-no-p "Revert to checked-in version, instead? "))
452 (error "Checkout aborted.")
453 (vc-revert-buffer1 t t
)
454 (vc-checkout-writable-buffer file
))
456 (vc-checkout-writable-buffer file
)))
458 ;; a checked-out version exists, but the user may not own the lock
459 ((and (not (eq vc-type
'CVS
)) ;There are no locks in CVS.
460 (not (string-equal owner
(user-login-name))))
462 (error "Sorry, you can't steal the lock on %s this way" file
))
465 (and verbose
(read-string "Version to steal: "))
468 ;; changes to the master file needs to be merged back into the
470 ((and (eq vc-type
'CVS
)
471 ;; "0" means "added, but not yet committed"
472 (not (string= (vc-file-getprop file
'vc-your-latest-version
) "0"))
474 (vc-fetch-properties file
)
475 (not (string= (vc-file-getprop file
'vc-your-latest-version
)
476 (vc-file-getprop file
'vc-latest-version
)))))
478 (if (yes-or-no-p (format "%s is not up-to-date. Merge in changes now? "
481 (if (and (buffer-modified-p)
483 "Buffer %s modified; merge file on disc anyhow? "
485 (error "Merge aborted"))
486 (if (not (zerop (vc-backend-merge-news file
)))
487 ;; Overlaps detected - what now? Should use some
488 ;; fancy RCS conflict resolving package, or maybe
489 ;; emerge, but for now, simply warn the user with a
491 (message "Conflicts detected!"))
492 (vc-resynch-window file t
(not (buffer-modified-p))))
494 (error "%s needs update" (buffer-name))))
496 ((and buffer-read-only
(eq vc-type
'CVS
))
498 ;; Sites who make link farms to a read-only gold tree (or
499 ;; something similar) can use the hook below to break the
501 (run-hooks 'vc-make-buffer-writable-hook
))
503 ;; OK, user owns the lock on the file (or we are running CVS)
507 ;; give luser a chance to save before checking in.
510 ;; Revert if file is unchanged and buffer is too.
511 ;; If buffer is modified, that means the user just said no
512 ;; to saving it; in that case, don't revert,
513 ;; because the user might intend to save
514 ;; after finishing the log entry.
515 (if (and (vc-workfile-unchanged-p file
)
516 (not (buffer-modified-p)))
518 (if (eq vc-type
'CVS
)
519 (message "No changes to %s" file
)
521 (vc-backend-revert file
)
522 ;; DO NOT revert the file without asking the user!
523 (vc-resynch-window file t nil
)))
525 ;; user may want to set nonstandard parameters
527 (setq version
(read-string "New version level: ")))
529 ;; OK, let's do the checkin
530 (vc-checkin file version comment
)
533 (defun vc-next-action-dired (file rev comment
)
534 ;; We've accepted a log comment, now do a vc-next-action using it on all
536 (set-buffer vc-parent-buffer
)
537 (let ((configuration (current-window-configuration)))
538 (dired-map-over-marks
539 (save-window-excursion
540 (let ((file (dired-get-filename)))
541 (message "Processing %s..." file
)
542 (vc-next-action-on-file file nil comment
)
543 (message "Processing %s...done" file
)))
545 (set-window-configuration configuration
))
548 ;; Here's the major entry point.
551 (defun vc-next-action (verbose)
552 "Do the next logical checkin or checkout operation on the current file.
554 For RCS and SCCS files:
555 If the file is not already registered, this registers it for version
556 control and then retrieves a writable, locked copy for editing.
557 If the file is registered and not locked by anyone, this checks out
558 a writable and locked file ready for editing.
559 If the file is checked out and locked by the calling user, this
560 first checks to see if the file has changed since checkout. If not,
561 it performs a revert.
562 If the file has been changed, this pops up a buffer for entry
563 of a log message; when the message has been entered, it checks in the
564 resulting changes along with the log message as change commentary. If
565 the variable `vc-keep-workfiles' is non-nil (which is its default), a
566 read-only copy of the changed file is left in place afterwards.
567 If the file is registered and locked by someone else, you are given
568 the option to steal the lock.
571 If the file is not already registered, this registers it for version
572 control. This does a \"cvs add\", but no \"cvs commit\".
573 If the file is added but not committed, it is committed.
574 If the file has not been changed, neither in your working area or
575 in the repository, a message is printed and nothing is done.
576 If your working file is changed, but the repository file is
577 unchanged, this pops up a buffer for entry of a log message; when the
578 message has been entered, it checks in the resulting changes along
579 with the logmessage as change commentary. A writable file is retained.
580 If the repository file is changed, you are asked if you want to
581 merge in the changes into your working copy.
583 The following is true regardless of which version control system you
586 If you call this from within a VC dired buffer with no files marked,
587 it will operate on the file in the current line.
588 If you call this from within a VC dired buffer, and one or more
589 files are marked, it will accept a log message and then operate on
590 each one. The log message will be used as a comment for any register
591 or checkin operations, but ignored when doing checkouts. Attempted
592 lock steals will raise an error.
594 For checkin, a prefix argument lets you specify the version number to use."
598 (let ((files (dired-get-marked-files)))
599 (if (= (length files
) 1)
600 (find-file-other-window (car files
))
601 (vc-start-entry nil nil nil
602 "Enter a change comment for the marked files."
603 'vc-next-action-dired
)
605 (while vc-parent-buffer
606 (pop-to-buffer vc-parent-buffer
))
608 (vc-next-action-on-file buffer-file-name verbose
)
609 (vc-registration-error nil
))))
611 ;;; These functions help the vc-next-action entry point
613 (defun vc-checkout-writable-buffer (&optional file
)
614 "Retrieve a writable copy of the latest version of the current buffer's file."
615 (vc-checkout (or file
(buffer-file-name)) t
)
619 (defun vc-register (&optional override comment
)
620 "Register the current file into your version-control system."
622 (let ((master (vc-name buffer-file-name
)))
623 (and master
(file-exists-p master
)
624 (error "This file is already registered"))
626 (not (y-or-n-p "Previous master file has vanished. Make a new one? "))
627 (error "This file is already registered")))
628 ;; Watch out for new buffers of size 0: the corresponding file
629 ;; does not exist yet, even though buffer-modified-p is nil.
630 (if (and (not (buffer-modified-p))
631 (zerop (buffer-size))
632 (not (file-exists-p buffer-file-name
)))
633 (set-buffer-modified-p t
))
639 (format "Initial version level for %s: " buffer-file-name
))))
642 (defun vc-resynch-window (file &optional keep noquery
)
643 ;; If the given file is in the current buffer,
644 ;; either revert on it so we see expanded keyworks,
645 ;; or unvisit it (depending on vc-keep-workfiles)
646 ;; NOQUERY if non-nil inhibits confirmation for reverting.
647 ;; NOQUERY should be t *only* if it is known the only difference
648 ;; between the buffer and the file is due to RCS rather than user editing!
649 (and (string= buffer-file-name file
)
652 (vc-revert-buffer1 t noquery
)
653 (vc-mode-line buffer-file-name
))
656 (kill-buffer (current-buffer))))))
658 (defun vc-start-entry (file rev comment msg action
&optional after-hook
)
659 ;; Accept a comment for an operation on FILE revision REV. If COMMENT
660 ;; is nil, pop up a VC-log buffer, emit MSG, and set the
661 ;; action on close to ACTION; otherwise, do action immediately.
662 ;; Remember the file's buffer in vc-parent-buffer (current one if no file).
663 ;; AFTER-HOOK specifies the local value for vc-log-operation-hook.
664 (let ((parent (if file
(find-file-noselect file
) (current-buffer))))
666 (set-buffer (get-buffer-create "*VC-log*"))
667 (pop-to-buffer (get-buffer-create "*VC-log*")))
668 (set (make-local-variable 'vc-parent-buffer
) parent
)
669 (set (make-local-variable 'vc-parent-buffer-name
)
670 (concat " from " (buffer-name vc-parent-buffer
)))
671 (vc-mode-line (or file
" (no file)"))
673 (make-local-variable 'vc-log-after-operation-hook
)
675 (setq vc-log-after-operation-hook after-hook
))
676 (setq vc-log-operation action
)
677 (setq vc-log-file file
)
678 (setq vc-log-version rev
)
683 (vc-finish-logentry t
)
685 (vc-finish-logentry nil
)))
686 (message "%s Type C-c C-c when done." msg
))))
688 (defun vc-admin (file rev
&optional comment
)
689 "Check a file into your version-control system.
690 FILE is the unmodified name of the file. REV should be the base version
691 level to check it in under. COMMENT, if specified, is the checkin comment."
692 (vc-start-entry file rev
693 (or comment
(not vc-initial-comment
))
694 "Enter initial comment." 'vc-backend-admin
697 (defun vc-checkout (file &optional writable
)
698 "Retrieve a copy of the latest version of the given file."
699 ;; If ftp is on this system and the name matches the ange-ftp format
700 ;; for a remote file, the user is trying something that won't work.
701 (if (and (string-match "^/[^/:]+:" file
) (vc-find-binary "ftp"))
702 (error "Sorry, you can't check out files over FTP"))
703 (vc-backend-checkout file writable
)
704 (if (string-equal file buffer-file-name
)
705 (vc-resynch-window file t t
))
708 (defun vc-steal-lock (file rev
&optional owner
)
709 "Steal the lock on the current workfile."
710 (let (file-description)
712 (setq owner
(vc-locking-user file
)))
714 (setq file-description
(format "%s:%s" file rev
))
715 (setq file-description file
))
716 (if (not (y-or-n-p (format "Take the lock on %s from %s? "
717 file-description owner
)))
718 (error "Steal cancelled"))
719 (pop-to-buffer (get-buffer-create "*VC-mail*"))
720 (setq default-directory
(expand-file-name "~/"))
721 (auto-save-mode auto-save-default
)
724 (mail-setup owner
(format "Stolen lock on %s" file-description
) nil nil nil
725 (list (list 'vc-finish-steal file rev
)))
726 (goto-char (point-max))
728 (format "I stole the lock on %s, " file-description
)
729 (current-time-string)
731 (message "Please explain why you stole the lock. Type C-c C-c when done.")))
733 ;; This is called when the notification has been sent.
734 (defun vc-finish-steal (file version
)
735 (vc-backend-steal file version
)
736 (if (get-file-buffer file
)
738 (set-buffer (get-file-buffer file
))
739 (vc-resynch-window file t t
))))
741 (defun vc-checkin (file &optional rev comment
)
742 "Check in the file specified by FILE.
743 The optional argument REV may be a string specifying the new version level
744 \(if nil increment the current level). The file is either retained with write
745 permissions zeroed, or deleted (according to the value of `vc-keep-workfiles').
746 If the back-end is CVS, a writable workfile is always kept.
747 COMMENT is a comment string; if omitted, a buffer is
748 popped up to accept a comment."
749 (vc-start-entry file rev comment
750 "Enter a change comment." 'vc-backend-checkin
753 ;;; Here is a checkin hook that may prove useful to sites using the
754 ;;; ChangeLog facility supported by Emacs.
755 (defun vc-comment-to-change-log (&optional whoami file-name
)
756 "Enter last VC comment into change log file for current buffer's file.
757 Optional arg (interactive prefix) non-nil means prompt for user name and site.
758 Second arg is file name of change log. \
759 If nil, uses `change-log-default-name'."
760 (interactive (if current-prefix-arg
761 (list current-prefix-arg
762 (prompt-for-change-log-name))))
763 ;; Make sure the defvar for add-log-current-defun-function has been executed
764 ;; before binding it.
766 (let (;; Extract the comment first so we get any error before doing anything.
767 (comment (ring-ref vc-comment-ring
0))
768 ;; Don't let add-change-log-entry insert a defun name.
769 (add-log-current-defun-function 'ignore
)
771 ;; Call add-log to do half the work.
772 (add-change-log-entry whoami file-name t t
)
773 ;; Insert the VC comment, leaving point before it.
774 (setq end
(save-excursion (insert comment
) (point-marker)))
775 (if (looking-at "\\s *\\s(")
776 ;; It starts with an open-paren, as in "(foo): Frobbed."
777 ;; So remove the ": " add-log inserted.
779 ;; Canonicalize the white space between the file name and comment.
781 ;; Indent rest of the text the same way add-log indented the first line.
782 (let ((indentation (current-indentation)))
784 (while (< (point) end
)
786 (indent-to indentation
))
788 ;; Fill the inserted text, preserving open-parens at bol.
789 (let ((paragraph-separate (concat paragraph-separate
"\\|^\\s *\\s("))
790 (paragraph-start (concat paragraph-start
"\\|^\\s *\\s(")))
792 (fill-region (point) end
))
793 ;; Canonicalize the white space at the end of the entry so it is
794 ;; separated from the next entry by a single blank line.
795 (skip-syntax-forward " " end
)
796 (delete-char (- (skip-syntax-backward " ")))
797 (or (eobp) (looking-at "\n\n")
801 (defun vc-finish-logentry (&optional nocomment
)
802 "Complete the operation implied by the current log entry."
804 ;; Check and record the comment, if any.
807 (goto-char (point-max))
811 (vc-backend-logentry-check vc-log-file
)
812 ;; Record the comment in the comment ring
813 (if (null vc-comment-ring
)
814 (setq vc-comment-ring
(make-ring vc-maximum-comment-ring-size
)))
815 (ring-insert vc-comment-ring
(buffer-string))
817 ;; Sync parent buffer in case the user modified it while editing the comment.
818 ;; But not if it is a vc-dired buffer.
820 (set-buffer vc-parent-buffer
)
826 (funcall vc-log-operation
830 (error "No log operation is pending"))
831 ;; save the vc-log-after-operation-hook of log buffer
832 (let ((after-hook vc-log-after-operation-hook
))
833 ;; Return to "parent" buffer of this checkin and remove checkin window
834 (pop-to-buffer vc-parent-buffer
)
835 (let ((logbuf (get-buffer "*VC-log*")))
836 (delete-windows-on logbuf
)
837 (kill-buffer logbuf
))
838 ;; Now make sure we see the expanded headers
840 (vc-resynch-window buffer-file-name vc-keep-workfiles t
))
841 (run-hooks after-hook
)))
843 ;; Code for access to the comment ring
845 (defun vc-previous-comment (arg)
846 "Cycle backwards through comment history."
848 (let ((len (ring-length vc-comment-ring
)))
850 (message "Empty comment ring")
854 ;; Initialize the index on the first use of this command
855 ;; so that the first M-p gets index 0, and the first M-n gets
857 (if (null vc-comment-ring-index
)
858 (setq vc-comment-ring-index
860 (if (< arg
0) 1 0))))
861 (setq vc-comment-ring-index
862 (mod (+ vc-comment-ring-index arg
) len
))
863 (message "%d" (1+ vc-comment-ring-index
))
864 (insert (ring-ref vc-comment-ring vc-comment-ring-index
))))))
866 (defun vc-next-comment (arg)
867 "Cycle forwards through comment history."
869 (vc-previous-comment (- arg
)))
871 (defun vc-comment-search-reverse (str)
872 "Searches backwards through comment history for substring match."
873 (interactive "sComment substring: ")
875 (setq str vc-last-comment-match
)
876 (setq vc-last-comment-match str
))
877 (if (null vc-comment-ring-index
)
878 (setq vc-comment-ring-index -
1))
879 (let ((str (regexp-quote str
))
880 (len (ring-length vc-comment-ring
))
881 (n (1+ vc-comment-ring-index
)))
882 (while (and (< n len
) (not (string-match str
(ring-ref vc-comment-ring n
))))
885 (vc-previous-comment (- n vc-comment-ring-index
)))
886 (t (error "Not found")))))
888 (defun vc-comment-search-forward (str)
889 "Searches forwards through comment history for substring match."
890 (interactive "sComment substring: ")
892 (setq str vc-last-comment-match
)
893 (setq vc-last-comment-match str
))
894 (if (null vc-comment-ring-index
)
895 (setq vc-comment-ring-index
0))
896 (let ((str (regexp-quote str
))
897 (len (ring-length vc-comment-ring
))
898 (n vc-comment-ring-index
))
899 (while (and (>= n
0) (not (string-match str
(ring-ref vc-comment-ring n
))))
902 (vc-next-comment (- n vc-comment-ring-index
)))
903 (t (error "Not found")))))
905 ;; Additional entry points for examining version histories
908 (defun vc-diff (historic &optional not-urgent
)
909 "Display diffs between file versions.
910 Normally this compares the current file and buffer with the most recent
911 checked in version of that file. This uses no arguments.
912 With a prefix argument, it reads the file name to use
913 and two version designators specifying which versions to compare."
916 (set-buffer (find-file-noselect (dired-get-filename))))
917 (while vc-parent-buffer
918 (pop-to-buffer vc-parent-buffer
))
920 (call-interactively 'vc-version-diff
)
921 (if (or (null buffer-file-name
) (null (vc-name buffer-file-name
)))
923 "There is no version-control master associated with this buffer"))
924 (let ((file buffer-file-name
)
926 (or (and file
(vc-name file
))
927 (vc-registration-error file
))
928 (vc-buffer-sync not-urgent
)
929 (setq unchanged
(vc-workfile-unchanged-p buffer-file-name
))
931 (message "No changes to %s since latest version." file
)
932 (vc-backend-diff file
)
933 ;; Ideally, we'd like at this point to parse the diff so that
934 ;; the buffer effectively goes into compilation mode and we
935 ;; can visit the old and new change locations via next-error.
936 ;; Unfortunately, this is just too painful to do. The basic
937 ;; problem is that the `old' file doesn't exist to be
938 ;; visited. This plays hell with numerous assumptions in
939 ;; the diff.el and compile.el machinery.
940 (pop-to-buffer "*vc*")
941 (setq default-directory
(file-name-directory file
))
942 (if (= 0 (buffer-size))
945 (message "No changes to %s since latest version." file
))
946 (goto-char (point-min))
947 (shrink-window-if-larger-than-buffer)))
950 (defun vc-version-diff (file rel1 rel2
)
951 "For FILE, report diffs between two stored versions REL1 and REL2 of it.
952 If FILE is a directory, generate diffs between versions for all registered
953 files in or below it."
954 (interactive "FFile or directory to diff: \nsOlder version: \nsNewer version: ")
955 (if (string-equal rel1
"") (setq rel1 nil
))
956 (if (string-equal rel2
"") (setq rel2 nil
))
957 (if (file-directory-p file
)
958 (let ((camefrom (current-buffer)))
959 (set-buffer (get-buffer-create "*vc-status*"))
960 (set (make-local-variable 'vc-parent-buffer
) camefrom
)
961 (set (make-local-variable 'vc-parent-buffer-name
)
962 (concat " from " (buffer-name camefrom
)))
964 (insert "Diffs between "
965 (or rel1
"last version checked in")
967 (or rel2
"current workfile(s)")
969 (set-buffer (get-buffer-create "*vc*"))
972 (function (lambda (f)
973 (message "Looking at %s" f
)
975 (not (file-directory-p f
))
977 (vc-backend-diff f rel1 rel2
)
978 (append-to-buffer "*vc-status*" (point-min) (point-max)))
980 (pop-to-buffer "*vc-status*")
981 (insert "\nEnd of diffs.\n")
982 (goto-char (point-min))
983 (set-buffer-modified-p nil
)
985 (if (zerop (vc-backend-diff file rel1 rel2
))
986 (message "No changes to %s between %s and %s." file rel1 rel2
)
987 (pop-to-buffer "*vc*"))))
990 (defun vc-version-other-window (rev)
991 "Visit version REV of the current buffer in another window.
992 If the current buffer is named `F', the version is named `F.~REV~'.
993 If `F.~REV~' already exists, it is used instead of being re-created."
994 (interactive "sVersion to visit (default is latest version): ")
996 (set-buffer (find-file-noselect (dired-get-filename))))
997 (while vc-parent-buffer
998 (pop-to-buffer vc-parent-buffer
))
999 (if (and buffer-file-name
(vc-name buffer-file-name
))
1000 (let* ((version (if (string-equal rev
"")
1001 (vc-latest-version buffer-file-name
)
1003 (filename (concat buffer-file-name
".~" version
"~")))
1004 (or (file-exists-p filename
)
1005 (vc-backend-checkout buffer-file-name nil version filename
))
1006 (find-file-other-window filename
))
1007 (vc-registration-error buffer-file-name
)))
1009 ;; Header-insertion code
1012 (defun vc-insert-headers ()
1013 "Insert headers in a file for use with your version-control system.
1014 Headers desired are inserted at the start of the buffer, and are pulled from
1015 the variable `vc-header-alist'."
1018 (find-file-other-window (dired-get-filename)))
1019 (while vc-parent-buffer
1020 (pop-to-buffer vc-parent-buffer
))
1024 (if (or (not (vc-check-headers))
1025 (y-or-n-p "Version headers already exist. Insert another set? "))
1027 (let* ((delims (cdr (assq major-mode vc-comment-alist
)))
1028 (comment-start-vc (or (car delims
) comment-start
"#"))
1029 (comment-end-vc (or (car (cdr delims
)) comment-end
""))
1030 (hdstrings (cdr (assoc (vc-backend-deduce (buffer-file-name)) vc-header-alist
))))
1031 (mapcar (function (lambda (s)
1032 (insert comment-start-vc
"\t" s
"\t"
1033 comment-end-vc
"\n")))
1035 (if vc-static-header-alist
1036 (mapcar (function (lambda (f)
1037 (if (string-match (car f
) buffer-file-name
)
1038 (insert (format (cdr f
) (car hdstrings
))))))
1039 vc-static-header-alist
))
1043 ;; The VC directory submode. Coopt Dired for this.
1044 ;; All VC commands get mapped into logical equivalents.
1046 (defvar vc-dired-prefix-map
(make-sparse-keymap))
1047 (define-key vc-dired-prefix-map
"\C-xv" vc-prefix-map
)
1049 (or (not (boundp 'minor-mode-map-alist
))
1050 (assq 'vc-dired-mode minor-mode-map-alist
)
1051 (setq minor-mode-map-alist
1052 (cons (cons 'vc-dired-mode vc-dired-prefix-map
)
1053 minor-mode-map-alist
)))
1055 (defun vc-dired-mode ()
1056 "The augmented Dired minor mode used in VC directory buffers.
1057 All Dired commands operate normally. Users currently locking listed files
1058 are listed in place of the file's owner and group.
1059 Keystrokes bound to VC commands will execute as though they had been called
1060 on a buffer attached to the file named in the current Dired buffer line."
1061 (setq vc-dired-mode t
)
1062 (setq vc-mode
" under VC"))
1064 (defun vc-dired-reformat-line (x)
1065 ;; Hack a directory-listing line, plugging in locking-user info in
1066 ;; place of the user and group info. Should have the beneficial
1067 ;; side-effect of shortening the listing line. Each call starts with
1068 ;; point immediately following the dired mark area on the line to be
1071 ;; Simplest possible one:
1072 ;; (insert (concat x "\t")))
1074 ;; This code, like dired, assumes UNIX -l format.
1075 (forward-word 1) ;; skip over any extra field due to -ibs options
1077 ;; This hack is used by the CVS code. See vc-locking-user.
1080 ((re-search-forward "\\([0-9]+ \\)\\([^ ]+\\)\\( .*\\)" nil
0)
1082 (goto-char (match-beginning 2))
1084 (goto-char (1+ (match-end 2)))
1086 (delete-char (- 17 (- (match-end 2) (match-beginning 2))))
1087 (insert (substring " " 0
1088 (- 7 (- (match-end 2) (match-beginning 2)))))))))
1090 (if x
(setq x
(concat "(" x
")")))
1091 (if (re-search-forward "\\([0-9]+ \\).................\\( .*\\)" nil
0)
1092 (let ((rep (substring (concat x
" ") 0 9)))
1093 (replace-match (concat "\\1" rep
"\\2") t
)))
1096 ;;; Note in Emacs 18 the following defun gets overridden
1097 ;;; with the symbol 'vc-directory-18. See below.
1099 (defun vc-directory (verbose)
1100 "Show version-control status of the current directory and subdirectories.
1101 Normally it creates a Dired buffer that lists only the locked files
1102 in all these directories. With a prefix argument, it lists all files."
1105 (dl (length default-directory
))
1106 (filelist nil
) (userlist nil
)
1108 dired-buf-mod-count
)
1110 (function (lambda (f)
1111 (if (vc-registered f
)
1112 (let ((user (vc-locking-user f
)))
1113 (and (or verbose user
)
1114 (setq filelist
(cons (substring f dl
) filelist
))
1115 (setq userlist
(cons user userlist
))))))))
1117 ;; This uses a semi-documented feature of dired; giving a switch
1118 ;; argument forces the buffer to refresh each time.
1120 (cons default-directory
(nreverse filelist
))
1121 dired-listing-switches
)
1122 (setq dired-buf
(current-buffer))
1123 (setq nonempty
(not (zerop (buffer-size)))))
1126 (pop-to-buffer dired-buf
)
1128 (goto-char (point-min))
1129 (setq buffer-read-only nil
)
1130 (forward-line 1) ;; Skip header line
1134 (forward-char 2) ;; skip dired's mark area
1135 (vc-dired-reformat-line x
)
1136 (forward-line 1))) ;; go to next line
1137 (nreverse userlist
))
1138 (setq buffer-read-only t
)
1139 (goto-char (point-min))
1141 (message "No files are currently %s under %s"
1142 (if verbose
"registered" "locked") default-directory
))
1146 (defun vc-directory-18 (verbose)
1147 "Show version-control status of all files under the current directory."
1149 (let (nonempty (dir default-directory
))
1151 (set-buffer (get-buffer-create "*vc-status*"))
1155 (function (lambda (f)
1156 (if (vc-registered f
)
1157 (let ((user (vc-locking-user f
)))
1158 (if (or user verbose
)
1161 (concat user
) f
))))))))
1162 (setq nonempty
(not (zerop (buffer-size)))))
1165 (pop-to-buffer "*vc-status*" t
)
1166 (goto-char (point-min))
1167 (shrink-window-if-larger-than-buffer)))
1168 (message "No files are currently %s under %s"
1169 (if verbose
"registered" "locked") default-directory
))
1172 (or (boundp 'minor-mode-map-alist
)
1173 (fset 'vc-directory
'vc-directory-18
))
1175 ;; Named-configuration support for SCCS
1177 (defun vc-add-triple (name file rev
)
1179 (find-file (concat (vc-backend-subdirectory-name file
) "/" vc-name-assoc-file
))
1180 (goto-char (point-max))
1181 (insert name
"\t:\t" file
"\t" rev
"\n")
1183 (kill-buffer (current-buffer))
1186 (defun vc-record-rename (file newname
)
1188 (find-file (concat (vc-backend-subdirectory-name file
) "/" vc-name-assoc-file
))
1189 (goto-char (point-min))
1190 ;; (replace-regexp (concat ":" (regexp-quote file) "$") (concat ":" newname))
1191 (while (re-search-forward (concat ":" (regexp-quote file
) "$") nil t
)
1192 (replace-match (concat ":" newname
) nil nil
))
1194 (kill-buffer (current-buffer))
1197 (defun vc-lookup-triple (file name
)
1198 ;; Return the numeric version corresponding to a named snapshot of file
1199 ;; If name is nil or a version number string it's just passed through
1200 (cond ((null name
) name
)
1201 ((let ((firstchar (aref name
0)))
1202 (and (>= firstchar ?
0) (<= firstchar ?
9)))
1205 (car (vc-master-info
1206 (concat (vc-backend-subdirectory-name file
) "/" vc-name-assoc-file
)
1207 (list (concat name
"\t:\t" file
"\t\\(.+\\)"))))
1210 ;; Named-configuration entry points
1212 (defun vc-locked-example ()
1213 ;; Return an example of why the current directory is not ready to be snapshot
1214 ;; or nil if no such example exists.
1215 (catch 'vc-locked-example
1217 (function (lambda (f)
1218 (if (and (vc-registered f
) (vc-locking-user f
))
1219 (throw 'vc-locked-example f
)))))
1223 (defun vc-create-snapshot (name)
1224 "Make a snapshot called NAME.
1225 The snapshot is made from all registered files at or below the current
1226 directory. For each file, the version level of its latest
1227 version becomes part of the named configuration."
1228 (interactive "sNew snapshot name: ")
1229 (let ((locked (vc-locked-example)))
1231 (error "File %s is locked" locked
)
1233 (function (lambda (f) (and
1235 (vc-backend-assign-name f name
)))))
1239 (defun vc-retrieve-snapshot (name)
1240 "Retrieve the snapshot called NAME.
1241 This function fails if any files are locked at or below the current directory
1242 Otherwise, all registered files are checked out (unlocked) at their version
1243 levels in the snapshot."
1244 (interactive "sSnapshot name to retrieve: ")
1245 (let ((locked (vc-locked-example)))
1247 (error "File %s is locked" locked
)
1249 (function (lambda (f) (and
1252 (vc-backend-checkout f nil name
))))))
1255 ;; Miscellaneous other entry points
1258 (defun vc-print-log ()
1259 "List the change log of the current buffer in a window."
1262 (set-buffer (find-file-noselect (dired-get-filename))))
1263 (while vc-parent-buffer
1264 (pop-to-buffer vc-parent-buffer
))
1265 (if (and buffer-file-name
(vc-name buffer-file-name
))
1266 (let ((file buffer-file-name
))
1267 (vc-backend-print-log file
)
1268 (pop-to-buffer (get-buffer-create "*vc*"))
1269 (setq default-directory
(file-name-directory file
))
1270 (while (looking-at "=*\n")
1271 (delete-char (- (match-end 0) (match-beginning 0)))
1273 (goto-char (point-min))
1274 (if (looking-at "[\b\t\n\v\f\r ]+")
1275 (delete-char (- (match-end 0) (match-beginning 0))))
1276 (shrink-window-if-larger-than-buffer)
1278 (vc-registration-error buffer-file-name
)
1283 (defun vc-revert-buffer ()
1284 "Revert the current buffer's file back to the latest checked-in version.
1285 This asks for confirmation if the buffer contents are not identical
1287 If the back-end is CVS, this will give you the most recent revision of
1288 the file on the branch you are editing."
1291 (find-file-other-window (dired-get-filename)))
1292 (while vc-parent-buffer
1293 (pop-to-buffer vc-parent-buffer
))
1294 (let ((file buffer-file-name
)
1295 (obuf (current-buffer)) (changed (vc-diff nil t
)))
1296 (if (and changed
(or vc-suppress-confirm
1297 (not (yes-or-no-p "Discard changes? "))))
1300 (error "Revert cancelled"))
1304 (vc-backend-revert file
)
1305 (vc-resynch-window file t t
)
1310 (defun vc-cancel-version (norevert)
1311 "Get rid of most recently checked in version of this file.
1312 A prefix argument means do not revert the buffer afterwards."
1315 (find-file-other-window (dired-get-filename)))
1316 (while vc-parent-buffer
1317 (pop-to-buffer vc-parent-buffer
))
1318 (let* ((target (concat (vc-latest-version (buffer-file-name))))
1319 (yours (concat (vc-your-latest-version (buffer-file-name))))
1320 (prompt (if (string-equal yours target
)
1321 "Remove your version %s from master? "
1322 "Version %s was not your change. Remove it anyway? ")))
1323 (if (null (yes-or-no-p (format prompt target
)))
1325 (vc-backend-uncheck (buffer-file-name) target
)
1327 (not (yes-or-no-p "Revert buffer to most recent remaining version? ")))
1328 (vc-mode-line (buffer-file-name))
1329 (vc-checkout (buffer-file-name) nil
)))
1333 (defun vc-rename-file (old new
)
1334 "Rename file OLD to NEW, and rename its master file likewise."
1335 (interactive "fVC rename file: \nFRename to: ")
1336 ;; There are several ways of renaming files under CVS 1.3, but they all
1337 ;; have serious disadvantages. See the FAQ (available from think.com in
1338 ;; pub/cvs/). I'd rather send the user an error, than do something he might
1339 ;; consider to be wrong. When the famous, long-awaited rename database is
1340 ;; implemented things might change for the better. This is unlikely to occur
1341 ;; until CVS 2.0 is released. --ceder 1994-01-23 21:27:51
1342 (if (eq (vc-backend-deduce old
) 'CVS
)
1343 (error "Renaming files under CVS is dangerous and not supported in VC."))
1344 (let ((oldbuf (get-file-buffer old
)))
1345 (if (and oldbuf
(buffer-modified-p oldbuf
))
1346 (error "Please save files before moving them"))
1347 (if (get-file-buffer new
)
1348 (error "Already editing new file name"))
1349 (if (file-exists-p new
)
1350 (error "New file already exists"))
1351 (let ((oldmaster (vc-name old
)))
1354 (if (vc-locking-user old
)
1355 (error "Please check in files before moving them"))
1356 (if (or (file-symlink-p oldmaster
)
1357 ;; This had FILE, I changed it to OLD. -- rms.
1358 (file-symlink-p (vc-backend-subdirectory-name old
)))
1359 (error "This is not a safe thing to do in the presence of symbolic links"))
1362 (let ((backend (vc-backend-deduce old
))
1363 (newdir (or (file-name-directory new
) ""))
1364 (newbase (file-name-nondirectory new
)))
1369 (if (eq backend
(cdr s
))
1370 (let* ((newmaster (format (car s
) newdir newbase
))
1371 (newmasterdir (file-name-directory newmaster
)))
1372 (if (or (not newmasterdir
)
1373 (file-directory-p newmasterdir
))
1374 (throw 'found newmaster
))))))
1375 vc-master-templates
)
1376 (error "New file lacks a version control directory"))))))
1377 (if (or (not oldmaster
) (file-exists-p old
))
1378 (rename-file old new
)))
1379 ; ?? Renaming a file might change its contents due to keyword expansion.
1380 ; We should really check out a new copy if the old copy was precisely equal
1381 ; to some checked in version. However, testing for this is tricky....
1385 (set-visited-file-name new
)
1386 (set-buffer-modified-p nil
))))
1387 ;; This had FILE, I changed it to OLD. -- rms.
1388 (vc-backend-dispatch old
1389 (vc-record-rename old new
) ;SCCS
1396 (defun vc-update-change-log (&rest args
)
1397 "Find change log file and add entries from recent RCS logs.
1398 The mark is left at the end of the text prepended to the change log.
1399 With prefix arg of C-u, only find log entries for the current buffer's file.
1400 With any numeric prefix arg, find log entries for all files currently visited.
1401 Otherwise, find log entries for all registered files in the default directory.
1402 From a program, any arguments are passed to the `rcs2log' script."
1404 (cond ((consp current-prefix-arg
) ;C-u
1405 (list buffer-file-name
))
1406 (current-prefix-arg ;Numeric argument.
1408 (buffers (buffer-list))
1411 (setq file
(buffer-file-name (car buffers
)))
1412 (and file
(vc-backend-deduce file
)
1413 (setq files
(cons file files
)))
1414 (setq buffers
(cdr buffers
)))
1417 (let ((RCS (concat default-directory
"RCS")))
1418 (and (file-directory-p RCS
)
1421 (if (string-match "\\(.*\\),v$" f
)
1422 (substring f
0 (match-end 1))
1424 (directory-files RCS nil
"...\\|^[^.]\\|^.[^.]")))))))
1425 (let ((odefault default-directory
))
1426 (find-file-other-window (find-change-log))
1427 (barf-if-buffer-read-only)
1430 (goto-char (point-min))
1432 (message "Computing change log entries...")
1433 (message "Computing change log entries... %s"
1435 (eq 0 (apply 'call-process
"rcs2log" nil t nil
1443 (if (file-name-absolute-p f
)
1445 (concat odefault f
)))))
1449 ;; Functions for querying the master and lock files.
1451 (defun vc-match-substring (bn)
1452 (buffer-substring (match-beginning bn
) (match-end bn
)))
1454 (defun vc-parse-buffer (patterns &optional file properties
)
1455 ;; Use PATTERNS to parse information out of the current buffer
1456 ;; by matching each regular expression in the list and returning \\1.
1457 ;; If a regexp has two tag brackets, assume the second is a date
1458 ;; field and we want the most recent entry matching the template.
1459 ;; If FILE and PROPERTIES are given, the latter must be a list of
1460 ;; properties of the same length as PATTERNS; each property is assigned
1461 ;; the corresponding value.
1462 (mapcar (function (lambda (p)
1463 (goto-char (point-min))
1464 (if (string-match "\\\\(.*\\\\(" p
)
1465 (let ((latest-date "") (latest-val))
1466 (while (re-search-forward p nil t
)
1467 (let ((date (vc-match-substring 2)))
1468 (if (string< latest-date date
)
1470 (setq latest-date date
)
1472 (vc-match-substring 1))))))
1476 (if (re-search-forward p nil t
)
1477 (setq value
(vc-match-substring 1)))
1479 (vc-file-setprop file
(car properties
) value
))
1481 (setq properties
(cdr properties
)))))
1485 (defun vc-master-info (file fields
&optional rfile properties
)
1486 ;; Search for information in a master file.
1487 (if (and file
(file-exists-p file
))
1490 (setq buf
(create-file-buffer file
))
1493 (insert-file-contents file
)
1494 (set-buffer-modified-p nil
)
1495 (auto-save-mode nil
)
1497 (vc-parse-buffer fields rfile properties
)
1498 (kill-buffer (current-buffer)))
1502 (function (lambda (p) (vc-file-setprop rfile p nil
)))
1507 (defun vc-log-info (command file last flags patterns
&optional properties
)
1508 ;; Search for information in log program output
1509 (if (and file
(file-exists-p file
))
1511 (set-buffer (get-buffer-create "*vc*"))
1512 (apply 'vc-do-command
0 command file last flags
)
1513 (set-buffer-modified-p nil
)
1515 (vc-parse-buffer patterns file properties
)
1516 (kill-buffer (current-buffer))
1521 (function (lambda (p) (vc-file-setprop file p nil
)))
1526 (defun vc-locking-user (file)
1527 "Return the name of the person currently holding a lock on FILE.
1528 Return nil if there is no such person.
1529 Under CVS, a file is considered locked if it has been modified since it
1530 was checked out. Under CVS, this will sometimes return the uid of
1531 the owner of the file (as a number) instead of a string."
1532 (setq file
(expand-file-name file
));; ??? Work around bug in 19.0.4
1534 ((eq (vc-backend-deduce file
) 'CVS
)
1535 (if (vc-workfile-unchanged-p file t
)
1537 ;; The expression below should return the username of the owner
1538 ;; of the file. It doesn't. It returns the username if it is
1539 ;; you, or otherwise the UID of the owner of the file. The
1540 ;; return value from this function is only used by
1541 ;; vc-dired-reformat-line, and it does the proper thing if a UID
1544 ;; The *proper* way to fix this would be to implement a built-in
1545 ;; function in Emacs, say, (username UID), that returns the
1546 ;; username of a given UID.
1548 ;; The result of this hack is that vc-directory will print the
1549 ;; name of the owner of the file for any files that are
1551 (let ((uid (nth 2 (file-attributes file
))))
1552 (if (= uid
(user-uid))
1556 (if (or (not vc-keep-workfiles
)
1557 (eq vc-mistrust-permissions
't
)
1558 (and vc-mistrust-permissions
1559 (funcall vc-mistrust-permissions
(vc-backend-subdirectory-name
1561 (vc-true-locking-user file
)
1562 ;; This implementation assumes that any file which is under version
1563 ;; control and has -rw-r--r-- is locked by its owner. This is true
1564 ;; for both RCS and SCCS, which keep unlocked files at -r--r--r--.
1565 ;; We have to be careful not to exclude files with execute bits on;
1566 ;; scripts can be under version control too. Also, we must ignore
1567 ;; the group-read and other-read bits, since paranoid users turn them off.
1568 ;; This hack wins because calls to the very expensive vc-fetch-properties
1569 ;; function only have to be made if (a) the file is locked by someone
1570 ;; other than the current user, or (b) some untoward manipulation
1571 ;; behind vc's back has changed the owner or the `group' or `other'
1573 (let ((attributes (file-attributes file
)))
1574 (cond ((string-match ".r-..-..-." (nth 8 attributes
))
1576 ((and (= (nth 2 attributes
) (user-uid))
1577 (string-match ".rw..-..-." (nth 8 attributes
)))
1580 (vc-true-locking-user file
))))))))
1582 (defun vc-true-locking-user (file)
1583 ;; The slow but reliable version
1584 (vc-fetch-properties file
)
1585 (vc-file-getprop file
'vc-locking-user
))
1587 (defun vc-latest-version (file)
1588 ;; Return version level of the latest version of FILE
1589 (vc-fetch-properties file
)
1590 (vc-file-getprop file
'vc-latest-version
))
1592 (defun vc-your-latest-version (file)
1593 ;; Return version level of the latest version of FILE checked in by you
1594 (vc-fetch-properties file
)
1595 (vc-file-getprop file
'vc-your-latest-version
))
1597 ;; Collect back-end-dependent stuff here
1599 ;; Everything eventually funnels through these functions. To implement
1600 ;; support for a new version-control system, add another branch to the
1601 ;; vc-backend-dispatch macro and fill it in in each call. The variable
1602 ;; vc-master-templates in vc-hooks.el will also have to change.
1604 (defmacro vc-backend-dispatch
(f s r c
)
1605 "Execute FORM1, FORM2 or FORM3 depending whether we're using SCCS, RCS or CVS.
1606 If FORM3 is RCS, use FORM2 even if we are using CVS. (CVS shares some code
1608 (list 'let
(list (list 'type
(list 'vc-backend-deduce f
)))
1610 (list (list 'eq
'type
(quote 'SCCS
)) s
) ;; SCCS
1611 (list (list 'eq
'type
(quote 'RCS
)) r
) ;; RCS
1612 (list (list 'eq
'type
(quote 'CVS
)) ;; CVS
1613 (if (eq c
'RCS
) r c
))
1616 (defun vc-lock-file (file)
1617 ;; Generate lock file name corresponding to FILE
1618 (let ((master (vc-name file
)))
1621 (string-match "\\(.*/\\)s\\.\\(.*\\)" master
)
1623 (substring master
(match-beginning 1) (match-end 1))
1625 (substring master
(match-beginning 2) (match-end 2))))))
1628 (defun vc-fetch-properties (file)
1629 ;; Re-fetch all properties associated with the given file.
1630 ;; Currently these properties are:
1632 ;; vc-locked-version
1633 ;; vc-latest-version
1634 ;; vc-your-latest-version
1635 (vc-backend-dispatch
1639 (vc-master-info (vc-lock-file file
)
1641 "^[^ ]+ [^ ]+ \\([^ ]+\\)"
1644 '(vc-locking-user vc-locked-version
))
1645 (vc-master-info (vc-name file
)
1647 "^\001d D \\([^ ]+\\)"
1648 (concat "^\001d D \\([^ ]+\\) .* "
1649 (regexp-quote (user-login-name)) " ")
1652 '(vc-latest-version vc-your-latest-version
))
1655 (vc-log-info "rlog" file
'MASTER nil
1657 "^locks: strict\n\t\\([^:]+\\)"
1658 "^locks: strict\n\t[^:]+: \\(.+\\)"
1659 "^revision[\t ]+\\([0-9.]+\\).*\ndate: \\([ /0-9:]+\\);"
1661 "^revision[\t ]+\\([0-9.]+\\)\n.*author: "
1662 (regexp-quote (user-login-name))
1664 '(vc-locking-user vc-locked-version
1665 vc-latest-version vc-your-latest-version
))
1667 ;; Don't fetch vc-locking-user and vc-locked-version here, since they
1668 ;; should always be nil anyhow. Don't fetch vc-your-latest-version, since
1669 ;; that is done in vc-find-cvs-master.
1671 "cvs" file
'WORKFILE
'("status")
1672 ;; CVS 1.3 says "RCS Version:", other releases "RCS Revision:",
1673 ;; and CVS 1.4a1 says "Repository revision:". The regexp below
1674 ;; matches much more, but because of the way vc-log-info is
1675 ;; implemented it is impossible to use additional groups.
1676 '("R[eC][pS][ositry]* [VRr]e[rv][si][is]i?on:[\t ]+\\([0-9.]+\\)")
1677 '(vc-latest-version))
1680 (defun vc-backend-subdirectory-name (&optional file
)
1681 ;; Where the master and lock files for the current directory are kept
1684 (and file
(vc-backend-deduce file
))
1686 (setq vc-default-back-end
(if (vc-find-binary "rcs") 'RCS
'SCCS
)))))
1688 (defun vc-backend-admin (file &optional rev comment
)
1689 ;; Register a file into the version-control system
1690 ;; Automatically retrieves a read-only version of the file with
1691 ;; keywords expanded if vc-keep-workfiles is non-nil, otherwise
1692 ;; it deletes the workfile.
1693 (vc-file-clearprops file
)
1694 (or vc-default-back-end
1695 (setq vc-default-back-end
(if (vc-find-binary "rcs") 'RCS
'SCCS
)))
1696 (message "Registering %s..." file
)
1699 ((file-exists-p (vc-backend-subdirectory-name)) vc-default-back-end
)
1700 ((file-exists-p "RCS") 'RCS
)
1701 ((file-exists-p "SCCS") 'SCCS
)
1702 ((file-exists-p "CVS") 'CVS
)
1703 (t vc-default-back-end
))))
1704 (cond ((eq backend
'SCCS
)
1705 (vc-do-command 0 "admin" file
'MASTER
;; SCCS
1706 (and rev
(concat "-r" rev
))
1709 (and comment
(concat "-y" comment
))
1711 (car (rassq 'SCCS vc-master-templates
))
1712 (or (file-name-directory file
) "")
1713 (file-name-nondirectory file
)))
1715 (if vc-keep-workfiles
1716 (vc-do-command 0 "get" file
'MASTER
)))
1718 (vc-do-command 0 "ci" file
'MASTER
;; RCS
1719 (concat (if vc-keep-workfiles
"-u" "-r") rev
)
1720 (and comment
(concat "-t-" comment
))
1723 (vc-do-command 0 "cvs" file
'WORKFILE
;; CVS
1725 (and comment
(not (string= comment
""))
1726 (concat "-m" comment
)))
1728 (message "Registering %s...done" file
)
1731 (defun vc-backend-checkout (file &optional writable rev workfile
)
1732 ;; Retrieve a copy of a saved version into a workfile
1733 (let ((filename (or workfile file
)))
1734 (message "Checking out %s..." filename
)
1736 ;; Change buffers to get local value of vc-checkin-switches.
1737 (set-buffer (or (get-file-buffer file
) (current-buffer)))
1738 (vc-backend-dispatch file
1740 ;; Some SCCS implementations allow checking out directly to a
1741 ;; file using the -G option, but then some don't so use the
1742 ;; least common denominator approach and use the -p option
1744 (let ((vc-modes (logior (file-modes (vc-name file
))
1745 (if writable
128 0)))
1749 (apply 'vc-do-command
1750 0 "/bin/sh" file
'MASTER
"-c"
1751 ;; Some shells make the "" dummy argument into $0
1752 ;; while others use the shell's name as $0 and
1753 ;; use the "" as $1. The if-statement
1754 ;; converts the latter case to the former.
1755 (format "if [ x\"$1\" = x ]; then shift; fi; \
1756 umask %o; exec >\"$1\" || exit; \
1757 shift; umask %o; exec get \"$@\""
1758 (logand 511 (lognot vc-modes
))
1759 (logand 511 (lognot (default-file-modes))))
1760 "" ; dummy argument for shell's $0
1764 (concat "-r" (vc-lookup-triple file rev
)))
1765 vc-checkout-switches
)
1767 (and failed
(file-exists-p filename
) (delete-file filename
))))
1768 (apply 'vc-do-command
0 "get" file
'MASTER
;; SCCS
1770 (and rev
(concat "-r" (vc-lookup-triple file rev
))))
1771 vc-checkout-switches
)
1773 ;; RCS doesn't let us check out into arbitrary file names directly.
1774 ;; Use `co -p' and make stdout point to the correct file.
1775 (let ((vc-modes (logior (file-modes (vc-name file
))
1776 (if writable
128 0)))
1780 (apply 'vc-do-command
1781 0 "/bin/sh" file
'MASTER
"-c"
1782 ;; See the SCCS case, above, regarding the
1784 (format "if [ x\"$1\" = x ]; then shift; fi; \
1785 umask %o; exec >\"$1\" || exit; \
1786 shift; umask %o; exec co \"$@\""
1787 (logand 511 (lognot vc-modes
))
1788 (logand 511 (lognot (default-file-modes))))
1789 "" ; dummy argument for shell's $0
1793 vc-checkout-switches
)
1795 (and failed
(file-exists-p filename
) (delete-file filename
))))
1796 (apply 'vc-do-command
0 "co" file
'MASTER
1798 (and rev
(concat "-r" rev
)))
1799 vc-checkout-switches
)
1801 ;; CVS is much like RCS
1805 (apply 'vc-do-command
1806 0 "/bin/sh" file
'WORKFILE
"-c"
1807 "exec >\"$1\" || exit; shift; exec cvs update \"$@\""
1808 "" ; dummy argument for shell's $0
1812 vc-checkout-switches
)
1814 (and failed
(file-exists-p filename
) (delete-file filename
))))
1815 (apply 'vc-do-command
0 "cvs" file
'WORKFILE
1816 (and rev
(concat "-r" rev
))
1818 vc-checkout-switches
))
1821 (vc-file-setprop file
1822 'vc-checkout-time
(nth 5 (file-attributes file
))))
1823 (message "Checking out %s...done" filename
))
1826 (defun vc-backend-logentry-check (file)
1827 (vc-backend-dispatch file
1828 (if (>= (buffer-size) 512) ;; SCCS
1832 "Log must be less than 512 characters; point is now at pos 512")))
1837 (defun vc-backend-checkin (file rev comment
)
1838 ;; Register changes to FILE as level REV with explanatory COMMENT.
1839 ;; Automatically retrieves a read-only version of the file with
1840 ;; keywords expanded if vc-keep-workfiles is non-nil, otherwise
1841 ;; it deletes the workfile.
1842 (message "Checking in %s..." file
)
1844 ;; Change buffers to get local value of vc-checkin-switches.
1845 (set-buffer (or (get-file-buffer file
) (current-buffer)))
1846 (vc-backend-dispatch file
1848 (apply 'vc-do-command
0 "delta" file
'MASTER
1849 (if rev
(concat "-r" rev
))
1850 (concat "-y" comment
)
1851 vc-checkin-switches
)
1852 (if vc-keep-workfiles
1853 (vc-do-command 0 "get" file
'MASTER
))
1855 (apply 'vc-do-command
0 "ci" file
'MASTER
1856 (concat (if vc-keep-workfiles
"-u" "-r") rev
)
1857 (concat "-m" comment
)
1858 vc-checkin-switches
)
1860 (apply 'vc-do-command
0 "cvs" file
'WORKFILE
1862 vc-checkin-switches
)
1863 (vc-file-setprop file
'vc-checkout-time
1864 (nth 5 (file-attributes file
))))
1866 (vc-file-setprop file
'vc-locking-user nil
)
1867 (message "Checking in %s...done" file
)
1870 (defun vc-backend-revert (file)
1871 ;; Revert file to latest checked-in version.
1872 (message "Reverting %s..." file
)
1873 (vc-backend-dispatch
1876 (vc-do-command 0 "unget" file
'MASTER nil
)
1877 (vc-do-command 0 "get" file
'MASTER nil
))
1878 (vc-do-command 0 "co" file
'MASTER
;; RCS. This deletes the work file.
1882 (vc-do-command 0 "cvs" file
'WORKFILE
"update"))
1884 (vc-file-setprop file
'vc-locking-user nil
)
1885 (message "Reverting %s...done" file
)
1888 (defun vc-backend-steal (file &optional rev
)
1889 ;; Steal the lock on the current workfile. Needs RCS 5.6.2 or later for -M.
1890 (message "Stealing lock on %s..." file
)
1891 (vc-backend-dispatch file
1893 (vc-do-command 0 "unget" file
'MASTER
"-n" (if rev
(concat "-r" rev
)))
1894 (vc-do-command 0 "get" file
'MASTER
"-g" (if rev
(concat "-r" rev
)))
1896 (vc-do-command 0 "rcs" file
'MASTER
;RCS
1897 "-M" (concat "-u" rev
) (concat "-l" rev
))
1898 (error "You cannot steal a CVS lock; there are no CVS locks to steal.") ;CVS
1900 (vc-file-setprop file
'vc-locking-user
(user-login-name))
1901 (message "Stealing lock on %s...done" file
)
1904 (defun vc-backend-uncheck (file target
)
1905 ;; Undo the latest checkin. Note: this code will have to get a lot
1906 ;; smarter when we support multiple branches.
1907 (message "Removing last change from %s..." file
)
1908 (vc-backend-dispatch file
1909 (vc-do-command 0 "rmdel" file
'MASTER
(concat "-r" target
))
1910 (vc-do-command 0 "rcs" file
'MASTER
(concat "-o" target
))
1911 (error "Unchecking files under CVS is dangerous and not supported in VC.")
1913 (message "Removing last change from %s...done" file
)
1916 (defun vc-backend-print-log (file)
1917 ;; Print change log associated with FILE to buffer *vc*.
1918 (vc-backend-dispatch
1920 (vc-do-command 0 "prs" file
'MASTER
)
1921 (vc-do-command 0 "rlog" file
'MASTER
)
1922 (vc-do-command 0 "cvs" file
'WORKFILE
"rlog")))
1924 (defun vc-backend-assign-name (file name
)
1925 ;; Assign to a FILE's latest version a given NAME.
1926 (vc-backend-dispatch file
1927 (vc-add-triple name file
(vc-latest-version file
)) ;; SCCS
1928 (vc-do-command 0 "rcs" file
'MASTER
(concat "-n" name
":")) ;; RCS
1929 (vc-do-command 0 "cvs" file
'WORKFILE
"tag" name
) ;; CVS
1933 (defun vc-backend-diff (file &optional oldvers newvers cmp
)
1934 ;; Get a difference report between two versions of FILE.
1935 ;; Get only a brief comparison report if CMP, a difference report otherwise.
1936 (let ((backend (vc-backend-deduce file
)))
1939 (setq oldvers
(vc-lookup-triple file oldvers
))
1940 (setq newvers
(vc-lookup-triple file newvers
))))
1942 ;; SCCS and RCS shares a lot of code.
1943 ((or (eq backend
'SCCS
) (eq backend
'RCS
))
1944 (let* ((command (if (eq backend
'SCCS
)
1947 (mode (if (eq backend
'RCS
) 'WORKFILE
'MASTER
))
1948 (options (append (list (and cmp
"--brief")
1950 (and oldvers
(concat "-r" oldvers
))
1951 (and newvers
(concat "-r" newvers
)))
1953 (if (listp diff-switches
)
1955 (list diff-switches
)))))
1956 (status (apply 'vc-do-command
2 command file mode options
)))
1957 ;; Some RCS versions don't understand "--brief"; work around this.
1959 (apply 'vc-do-command
1 command file
'WORKFILE
1960 (if cmp
(cdr options
) options
))
1962 ;; CVS is different.
1963 ;; cmp is not yet implemented -- we always do a full diff.
1965 (if (string= (vc-file-getprop file
'vc-your-latest-version
) "0") ;CVS
1966 ;; This file is added but not yet committed; there is no master file.
1967 ;; diff it against /dev/null.
1968 (if (or oldvers newvers
)
1969 (error "No revisions of %s exists" file
)
1970 (apply 'vc-do-command
1971 1 "diff" file
'WORKFILE
"/dev/null"
1972 (if (listp diff-switches
)
1974 (list diff-switches
))))
1975 (apply 'vc-do-command
1976 1 "cvs" file
'WORKFILE
"diff"
1977 (and oldvers
(concat "-r" oldvers
))
1978 (and newvers
(concat "-r" newvers
))
1979 (if (listp diff-switches
)
1981 (list diff-switches
)))))
1983 (vc-registration-error file
)))))
1985 (defun vc-backend-merge-news (file)
1986 ;; Merge in any new changes made to FILE.
1987 (vc-backend-dispatch
1989 (error "vc-backend-merge-news not meaningful for SCCS files") ;SCCS
1990 (error "vc-backend-merge-news not meaningful for RCS files") ;RCS
1991 (vc-do-command 1 "cvs" file
'WORKFILE
"update") ;CVS
1994 (defun vc-check-headers ()
1995 "Check if the current file has any headers in it."
1998 (goto-char (point-min))
1999 (vc-backend-dispatch buffer-file-name
2000 (re-search-forward "%[MIRLBSDHTEGUYFPQCZWA]%" nil t
) ;; SCCS
2001 (re-search-forward "\\$[A-Za-z\300-\326\330-\366\370-\377]+\\(: [\t -#%-\176\240-\377]*\\)?\\$" nil t
) ;; RCS
2002 'RCS
;; CVS works like RCS in this regard.
2006 ;; Back-end-dependent stuff ends here.
2008 ;; Set up key bindings for use while editing log messages
2010 (defun vc-log-mode ()
2011 "Minor mode for driving version-control tools.
2012 These bindings are added to the global keymap when you enter this mode:
2013 \\[vc-next-action] perform next logical version-control operation on current file
2014 \\[vc-register] register current file
2015 \\[vc-toggle-read-only] like next-action, but won't register files
2016 \\[vc-insert-headers] insert version-control headers in current file
2017 \\[vc-print-log] display change history of current file
2018 \\[vc-revert-buffer] revert buffer to latest version
2019 \\[vc-cancel-version] undo latest checkin
2020 \\[vc-diff] show diffs between file versions
2021 \\[vc-version-other-window] visit old version in another window
2022 \\[vc-directory] show all files locked by any user in or below .
2023 \\[vc-update-change-log] add change log entry from recent checkins
2025 While you are entering a change log message for a version, the following
2026 additional bindings will be in effect.
2028 \\[vc-finish-logentry] proceed with check in, ending log message entry
2030 Whenever you do a checkin, your log comment is added to a ring of
2031 saved comments. These can be recalled as follows:
2033 \\[vc-next-comment] replace region with next message in comment ring
2034 \\[vc-previous-comment] replace region with previous message in comment ring
2035 \\[vc-comment-search-reverse] search backward for regexp in the comment ring
2036 \\[vc-comment-search-forward] search backward for regexp in the comment ring
2038 Entry to the change-log submode calls the value of text-mode-hook, then
2039 the value of vc-log-mode-hook.
2041 Global user options:
2042 vc-initial-comment If non-nil, require user to enter a change
2043 comment upon first checkin of the file.
2045 vc-keep-workfiles Non-nil value prevents workfiles from being
2046 deleted when changes are checked in
2048 vc-suppress-confirm Suppresses some confirmation prompts,
2049 notably for reversions.
2051 vc-header-alist Which keywords to insert when adding headers
2052 with \\[vc-insert-headers]. Defaults to
2053 '(\"\%\W\%\") under SCCS, '(\"\$Id\$\") under
2056 vc-static-header-alist By default, version headers inserted in C files
2057 get stuffed in a static string area so that
2058 ident(RCS/CVS) or what(SCCS) can see them in
2059 the compiled object code. You can override
2060 this by setting this variable to nil, or change
2061 the header template by changing it.
2063 vc-command-messages if non-nil, display run messages from the
2064 actual version-control utilities (this is
2065 intended primarily for people hacking vc
2069 (set-syntax-table text-mode-syntax-table
)
2070 (use-local-map vc-log-entry-mode
)
2071 (setq local-abbrev-table text-mode-abbrev-table
)
2072 (setq major-mode
'vc-log-mode
)
2073 (setq mode-name
"VC-Log")
2074 (make-local-variable 'vc-log-file
)
2075 (make-local-variable 'vc-log-version
)
2076 (make-local-variable 'vc-comment-ring-index
)
2077 (set-buffer-modified-p nil
)
2078 (setq buffer-file-name nil
)
2079 (run-hooks 'text-mode-hook
'vc-log-mode-hook
)
2082 ;; Initialization code, to be done just once at load-time
2083 (if vc-log-entry-mode
2085 (setq vc-log-entry-mode
(make-sparse-keymap))
2086 (define-key vc-log-entry-mode
"\M-n" 'vc-next-comment
)
2087 (define-key vc-log-entry-mode
"\M-p" 'vc-previous-comment
)
2088 (define-key vc-log-entry-mode
"\M-r" 'vc-comment-search-reverse
)
2089 (define-key vc-log-entry-mode
"\M-s" 'vc-comment-search-forward
)
2090 (define-key vc-log-entry-mode
"\C-c\C-c" 'vc-finish-logentry
)
2093 ;;; These things should probably be generally available
2095 (defun vc-file-tree-walk (func &rest args
)
2096 "Walk recursively through default directory.
2097 Invoke FUNC f ARGS on each non-directory file f underneath it."
2098 (vc-file-tree-walk-internal default-directory func args
)
2099 (message "Traversing directory %s...done" default-directory
))
2101 (defun vc-file-tree-walk-internal (file func args
)
2102 (if (not (file-directory-p file
))
2103 (apply func file args
)
2104 (message "Traversing directory %s..." file
)
2105 (let ((dir (file-name-as-directory file
)))
2109 (string-equal f
".")
2110 (string-equal f
"..")
2111 (member f vc-directory-exclusion-list
)
2112 (let ((dirf (concat dir f
)))
2114 (file-symlink-p dirf
) ;; Avoid possible loops
2115 (vc-file-tree-walk-internal dirf func args
))))))
2116 (directory-files dir
)))))
2120 ;;; DEVELOPER'S NOTES ON CONCURRENCY PROBLEMS IN THIS CODE
2122 ;;; These may be useful to anyone who has to debug or extend the package.
2124 ;;; A fundamental problem in VC is that there are time windows between
2125 ;;; vc-next-action's computations of the file's version-control state and
2126 ;;; the actions that change it. This is a window open to lossage in a
2127 ;;; multi-user environment; someone else could nip in and change the state
2128 ;;; of the master during it.
2130 ;;; The performance problem is that rlog/prs calls are very expensive; we want
2131 ;;; to avoid them as much as possible.
2135 ;;; The performance problem, it turns out, simplifies in practice to the
2136 ;;; problem of making vc-locking-user fast. The two other functions that call
2137 ;;; prs/rlog will not be so commonly used that the slowdown is a problem; one
2138 ;;; makes snapshots, the other deletes the calling user's last change in the
2141 ;;; The race condition implies that we have to either (a) lock the master
2142 ;;; during the entire execution of vc-next-action, or (b) detect and
2143 ;;; recover from errors resulting from dispatch on an out-of-date state.
2145 ;;; Alternative (a) appears to be unfeasible. The problem is that we can't
2146 ;;; guarantee that the lock will ever be removed. Suppose a user starts a
2147 ;;; checkin, the change message buffer pops up, and the user, having wandered
2148 ;;; off to do something else, simply forgets about it?
2150 ;;; Alternative (b), on the other hand, works well with a cheap way to speed up
2151 ;;; vc-locking-user. Usually, if a file is registered, we can read its locked/
2152 ;;; unlocked state and its current owner from its permissions.
2154 ;;; This shortcut will fail if someone has manually changed the workfile's
2155 ;;; permissions; also if developers are munging the workfile in several
2156 ;;; directories, with symlinks to a master (in this latter case, the
2157 ;;; permissions shortcut will fail to detect a lock asserted from another
2160 ;;; Note that these cases correspond exactly to the errors which could happen
2161 ;;; because of a competing checkin/checkout race in between two instances of
2164 ;;; For VC's purposes, a workfile/master pair may have the following states:
2166 ;;; A. Unregistered. There is a workfile, there is no master.
2168 ;;; B. Registered and not locked by anyone.
2170 ;;; C. Locked by calling user and unchanged.
2172 ;;; D. Locked by the calling user and changed.
2174 ;;; E. Locked by someone other than the calling user.
2176 ;;; This makes for 25 states and 20 error conditions. Here's the matrix:
2178 ;;; VC's idea of state
2180 ;;; V Actual state RCS action SCCS action Effect
2182 ;;; A . 1 2 3 4 ci -u -t- admin -fb -i<file> initial admin
2183 ;;; B 5 . 6 7 8 co -l get -e checkout
2184 ;;; C 9 10 . 11 12 co -u unget; get revert
2185 ;;; D 13 14 15 . 16 ci -u -m<comment> delta -y<comment>; get checkin
2186 ;;; E 17 18 19 20 . rcs -u -M ; rcs -l unget -n ; get -g steal lock
2188 ;;; All commands take the master file name as a last argument (not shown).
2190 ;;; In the discussion below, a "self-race" is a pathological situation in
2191 ;;; which VC operations are being attempted simultaneously by two or more
2192 ;;; Emacsen running under the same username.
2194 ;;; The vc-next-action code has the following windows:
2197 ;;; Between the check for existence of a master file and the call to
2198 ;;; admin/checkin in vc-buffer-admin (apparent state A). This window may
2199 ;;; never close if the initial-comment feature is on.
2202 ;;; Between the call to vc-workfile-unchanged-p in and the immediately
2203 ;;; following revert (apparent state C).
2206 ;;; Between the call to vc-workfile-unchanged-p in and the following
2207 ;;; checkin (apparent state D). This window may never close.
2210 ;;; Between the unlock and the immediately following checkout during a
2211 ;;; revert operation (apparent state C). Included in window Q.
2214 ;;; Between vc-locking-user and the following checkout (apparent state B).
2217 ;;; Between vc-locking-user and the following revert (apparent state C).
2218 ;;; Includes windows Q and S.
2221 ;;; Between vc-locking-user and the following checkin (apparent state
2222 ;;; D). This window may never be closed if the user fails to complete the
2223 ;;; checkin message. Includes window R.
2226 ;;; Between vc-locking-user and the following steal-lock (apparent
2227 ;;; state E). This window may never close if the user fails to complete
2228 ;;; the steal-lock message. Includes window X.
2231 ;;; Between the unlock and the immediately following re-lock during a
2232 ;;; steal-lock operation (apparent state E). This window may never cloce
2233 ;;; if the user fails to complete the steal-lock message.
2237 ;;; Apparent state A ---
2239 ;;; 1. File looked unregistered but is actually registered and not locked.
2241 ;;; Potential cause: someone else's admin during window P, with
2242 ;;; caller's admin happening before their checkout.
2244 ;;; RCS: ci will fail with a "no lock set by <user>" message.
2245 ;;; SCCS: admin will fail with error (ad19).
2247 ;;; We can let these errors be passed up to the user.
2249 ;;; 2. File looked unregistered but is actually locked by caller, unchanged.
2251 ;;; Potential cause: self-race during window P.
2253 ;;; RCS: will revert the file to the last saved version and unlock it.
2254 ;;; SCCS: will fail with error (ad19).
2256 ;;; Either of these consequences is acceptable.
2258 ;;; 3. File looked unregistered but is actually locked by caller, changed.
2260 ;;; Potential cause: self-race during window P.
2262 ;;; RCS: will register the caller's workfile as a delta with a
2263 ;;; null change comment (the -t- switch will be ignored).
2264 ;;; SCCS: will fail with error (ad19).
2266 ;;; 4. File looked unregistered but is locked by someone else.
2268 ;;; Potential cause: someone else's admin during window P, with
2269 ;;; caller's admin happening *after* their checkout.
2271 ;;; RCS: will fail with a "no lock set by <user>" message.
2272 ;;; SCCS: will fail with error (ad19).
2274 ;;; We can let these errors be passed up to the user.
2276 ;;; Apparent state B ---
2278 ;;; 5. File looked registered and not locked, but is actually unregistered.
2280 ;;; Potential cause: master file got nuked during window P.
2282 ;;; RCS: will fail with "RCS/<file>: No such file or directory"
2283 ;;; SCCS: will fail with error ut4.
2285 ;;; We can let these errors be passed up to the user.
2287 ;;; 6. File looked registered and not locked, but is actually locked by the
2288 ;;; calling user and unchanged.
2290 ;;; Potential cause: self-race during window T.
2292 ;;; RCS: in the same directory as the previous workfile, co -l will fail
2293 ;;; with "co error: writable foo exists; checkout aborted". In any other
2294 ;;; directory, checkout will succeed.
2295 ;;; SCCS: will fail with ge17.
2297 ;;; Either of these consequences is acceptable.
2299 ;;; 7. File looked registered and not locked, but is actually locked by the
2300 ;;; calling user and changed.
2304 ;;; 8. File looked registered and not locked, but is actually locked by another
2307 ;;; Potential cause: someone else checks it out during window T.
2309 ;;; RCS: co error: revision 1.3 already locked by <user>
2310 ;;; SCCS: fails with ge4 (in directory) or ut7 (outside it).
2312 ;;; We can let these errors be passed up to the user.
2314 ;;; Apparent state C ---
2316 ;;; 9. File looks locked by calling user and unchanged, but is unregistered.
2320 ;;; 10. File looks locked by calling user and unchanged, but is actually not
2323 ;;; Potential cause: a self-race in window U, or by the revert's
2324 ;;; landing during window X of some other user's steal-lock or window S
2325 ;;; of another user's revert.
2327 ;;; RCS: succeeds, refreshing the file from the identical version in
2329 ;;; SCCS: fails with error ut4 (p file nonexistent).
2331 ;;; Either of these consequences is acceptable.
2333 ;;; 11. File is locked by calling user. It looks unchanged, but is actually
2336 ;;; Potential cause: the file would have to be touched by a self-race
2337 ;;; during window Q.
2339 ;;; The revert will succeed, removing whatever changes came with
2340 ;;; the touch. It is theoretically possible that work could be lost.
2342 ;;; 12. File looks like it's locked by the calling user and unchanged, but
2343 ;;; it's actually locked by someone else.
2345 ;;; Potential cause: a steal-lock in window V.
2347 ;;; RCS: co error: revision <rev> locked by <user>; use co -r or rcs -u
2348 ;;; SCCS: fails with error un2
2350 ;;; We can pass these errors up to the user.
2352 ;;; Apparent state D ---
2354 ;;; 13. File looks like it's locked by the calling user and changed, but it's
2355 ;;; actually unregistered.
2357 ;;; Potential cause: master file got nuked during window P.
2359 ;;; RCS: Checks in the user's version as an initial delta.
2360 ;;; SCCS: will fail with error ut4.
2362 ;;; This case is kind of nasty. It means VC may fail to detect the
2363 ;;; loss of previous version information.
2365 ;;; 14. File looks like it's locked by the calling user and changed, but it's
2366 ;;; actually unlocked.
2368 ;;; Potential cause: self-race in window V, or the checkin happening
2369 ;;; during the window X of someone else's steal-lock or window S of
2370 ;;; someone else's revert.
2372 ;;; RCS: ci will fail with "no lock set by <user>".
2373 ;;; SCCS: delta will fail with error ut4.
2375 ;;; 15. File looks like it's locked by the calling user and changed, but it's
2376 ;;; actually locked by the calling user and unchanged.
2378 ;;; Potential cause: another self-race --- a whole checkin/checkout
2379 ;;; sequence by the calling user would have to land in window R.
2381 ;;; SCCS: checks in a redundant delta and leaves the file unlocked as usual.
2382 ;;; RCS: reverts to the file state as of the second user's checkin, leaving
2383 ;;; the file unlocked.
2385 ;;; It is theoretically possible that work could be lost under RCS.
2387 ;;; 16. File looks like it's locked by the calling user and changed, but it's
2388 ;;; actually locked by a different user.
2390 ;;; RCS: ci error: no lock set by <user>
2391 ;;; SCCS: unget will fail with error un2
2393 ;;; We can pass these errors up to the user.
2395 ;;; Apparent state E ---
2397 ;;; 17. File looks like it's locked by some other user, but it's actually
2402 ;;; 18. File looks like it's locked by some other user, but it's actually
2405 ;;; Potential cause: someone released a lock during window W.
2407 ;;; RCS: The calling user will get the lock on the file.
2408 ;;; SCCS: unget -n will fail with cm4.
2410 ;;; Either of these consequences will be OK.
2412 ;;; 19. File looks like it's locked by some other user, but it's actually
2413 ;;; locked by the calling user and unchanged.
2415 ;;; Potential cause: the other user relinquishing a lock followed by
2416 ;;; a self-race, both in window W.
2418 ;;; Under both RCS and SCCS, both unlock and lock will succeed, making
2419 ;;; the sequence a no-op.
2421 ;;; 20. File looks like it's locked by some other user, but it's actually
2422 ;;; locked by the calling user and changed.
2428 ;;; In order of decreasing severity:
2430 ;;; Cases 11 and 15 under RCS are the only one that potentially lose work.
2431 ;;; They would require a self-race for this to happen.
2433 ;;; Case 13 in RCS loses information about previous deltas, retaining
2434 ;;; only the information in the current workfile. This can only happen
2435 ;;; if the master file gets nuked in window P.
2437 ;;; Case 3 in RCS and case 15 under SCCS insert a redundant delta with
2438 ;;; no change comment in the master. This would require a self-race in
2439 ;;; window P or R respectively.
2441 ;;; Cases 2, 10, 19 and 20 do extra work, but make no changes.
2443 ;;; Unfortunately, it appears to me that no recovery is possible in these
2444 ;;; cases. They don't yield error messages, so there's no way to tell that
2445 ;;; a race condition has occurred.
2447 ;;; All other cases don't change either the workfile or the master, and
2448 ;;; trigger command errors which the user will see.
2450 ;;; Thus, there is no explicit recovery code.