Mercurial > emacs
annotate lisp/vc.el @ 1478:429e23e87072
(vc-resynch-window): New arg NOQUERY. Pass it to vc-revert-buffer1.
(vc-checkout, vc-finish-logentry, vc-revert-buffer, vc-finish-steal):
Supply t as NOQUERY arg for vc-resynch-window.
(vc-next-action): Don't revert workfile from master if buffer is modified.
author | Richard M. Stallman <rms@gnu.org> |
---|---|
date | Mon, 26 Oct 1992 05:33:20 +0000 |
parents | a8623439066b |
children | 64f5e84c822b |
rev | line source |
---|---|
904 | 1 ;;; vc.el --- drive a version-control system from within Emacs |
2 | |
3 ;; Copyright (C) 1992 Free Software Foundation, Inc. | |
4 | |
5 ;; Author: Eric S. Raymond <esr@snark.thyrsus.com> | |
6 ;; Version: 4.0 | |
7 | |
1478
429e23e87072
(vc-resynch-window): New arg NOQUERY. Pass it to vc-revert-buffer1.
Richard M. Stallman <rms@gnu.org>
parents:
1352
diff
changeset
|
8 ;; $Id: vc.el,v 1.13 1992/10/06 08:59:39 rms Exp rms $ |
904 | 9 |
10 ;; This file is part of GNU Emacs. | |
11 | |
12 ;; GNU Emacs is free software; you can redistribute it and/or modify | |
13 ;; it under the terms of the GNU General Public License as published by | |
14 ;; the Free Software Foundation; either version 2, or (at your option) | |
15 ;; any later version. | |
16 | |
17 ;; GNU Emacs is distributed in the hope that it will be useful, | |
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
20 ;; GNU General Public License for more details. | |
21 | |
22 ;; You should have received a copy of the GNU General Public License | |
23 ;; along with GNU Emacs; see the file COPYING. If not, write to | |
24 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. | |
25 | |
26 ;;; Commentary: | |
27 | |
28 ;; This was designed and implemented by Eric Raymond <esr@snark.thyrsus.com>. | |
29 ;; Paul Eggert <eggert@twinsun.com>, Sebastian Kremer <sk@thp.uni-koeln.de>, | |
30 ;; and Richard Stallman contributed valuable criticism, support, and testing. | |
31 ;; | |
32 ;; Supported version-control systems presently include SCCS and RCS; | |
33 ;; your RCS version should be 5.6.2 or later for proper operation of | |
34 ;; the lock-breaking code. | |
35 ;; | |
36 ;; The RCS code assumes strict locking. You can support the RCS -x option | |
37 ;; by adding pairs to the vc-master-templates list. | |
38 ;; | |
39 ;; Proper function of the SCCS diff commands requires the shellscript vcdiff | |
40 ;; to be installed somewhere on Emacs's path for executables. | |
41 ;; | |
42 ;; This code depends on call-process passing back the subprocess exit | |
43 ;; status. Thus, you need Emacs 18.58 or later to run it. | |
44 ;; | |
45 ;; The vc code maintains some internal state in order to reduce expensive | |
46 ;; version-control operations to a minimum. Some names are only computed | |
47 ;; once. If you perform version control operations with RCS/SCCS/CVS while | |
48 ;; vc's back is turned, or move/rename master files while vc is running, | |
49 ;; vc may get seriously confused. Don't do these things! | |
50 ;; | |
51 ;; Developer's notes on some concurrency issues are included at the end of | |
52 ;; the file. | |
53 | |
54 ;;; Code: | |
55 | |
56 (require 'vc-hooks) | |
57 | |
58 ;; General customization | |
59 | |
60 (defvar vc-default-back-end nil | |
61 "*Back-end actually used by this interface; may be SCCS or RCS. | |
62 The value is only computed when needed to avoid an expensive search.") | |
63 (defvar vc-diff-options '("-a" "-c1") | |
64 "*The command/flags list to be used in constructing diff commands.") | |
65 (defvar vc-suppress-confirm nil | |
66 "*If non-nil, reat user as expert; suppress yes-no prompts on some things.") | |
67 (defvar vc-keep-workfiles t | |
68 "*If non-nil, don't delete working files after registering changes.") | |
69 (defvar vc-initial-comment nil | |
70 "*Prompt for initial comment when a file is registered.") | |
71 (defvar vc-command-messages nil | |
72 "*Display run messages from back-end commands.") | |
73 (defvar vc-mistrust-permissions 'file-symlink-p | |
74 "*Don't assume that permissions and ownership track version-control status.") | |
75 | |
1335
d649d430148d
(vc-checkin-switches): New defvar.
Roland McGrath <roland@gnu.org>
parents:
1243
diff
changeset
|
76 (defvar vc-checkin-switches nil |
d649d430148d
(vc-checkin-switches): New defvar.
Roland McGrath <roland@gnu.org>
parents:
1243
diff
changeset
|
77 "*Extra switches passed to the checkin program by \\[vc-checkin].") |
d649d430148d
(vc-checkin-switches): New defvar.
Roland McGrath <roland@gnu.org>
parents:
1243
diff
changeset
|
78 |
1227
d07030650283
(vc-checkin-hook): New user hook variable.
Roland McGrath <roland@gnu.org>
parents:
1226
diff
changeset
|
79 ;;;###autoload |
d07030650283
(vc-checkin-hook): New user hook variable.
Roland McGrath <roland@gnu.org>
parents:
1226
diff
changeset
|
80 (defvar vc-checkin-hook nil |
d07030650283
(vc-checkin-hook): New user hook variable.
Roland McGrath <roland@gnu.org>
parents:
1226
diff
changeset
|
81 "*List of functions called after a vc-checkin is done. See `runs-hooks'.") |
d07030650283
(vc-checkin-hook): New user hook variable.
Roland McGrath <roland@gnu.org>
parents:
1226
diff
changeset
|
82 |
904 | 83 ;; Header-insertion hair |
84 | |
85 (defvar vc-header-alist | |
86 '((SCCS "\%W\%") (RCS "\$Id\$")) | |
87 "*Header keywords to be inserted when vc-insert-header is executed.") | |
88 (defconst vc-static-header-alist | |
89 '(("\\.c$" . | |
90 "\n#ifndef lint\nstatic char vcid[] = \"\%s\";\n#endif /* lint */\n")) | |
91 "*Associate static header string templates with file types. A \%s in the | |
92 template is replaced with the first string associated with the file's | |
93 verson-control type in vc-header-strings.") | |
94 (defvar vc-comment-alist | |
95 '((nroff-mode ".\\\"" "")) | |
96 "*Special comment delimiters to be used in generating vc headers only. | |
97 Add an entry in this list if you need to override the normal comment-start | |
98 and comment-end variables. This will only be necessary if the mode language | |
99 is sensitive to blank lines.") | |
100 | |
101 ;; Variables the user doesn't need to know about. | |
102 (defvar vc-log-entry-mode nil) | |
103 (defvar vc-log-operation nil) | |
1227
d07030650283
(vc-checkin-hook): New user hook variable.
Roland McGrath <roland@gnu.org>
parents:
1226
diff
changeset
|
104 (defvar vc-log-after-operation-hook nil) |
904 | 105 |
106 (defconst vc-name-assoc-file "VC-names") | |
107 | |
108 (defmacro vc-error-occurred (&rest body) | |
109 (list 'condition-case nil (cons 'progn (append body '(nil))) '(error t))) | |
110 | |
111 ;; File property caching | |
112 | |
113 (defun vc-file-clearprops (file) | |
114 ;; clear all properties of a given file | |
115 (setplist (intern file vc-file-prop-obarray) nil)) | |
116 | |
117 ;; Random helper functions | |
118 | |
119 (defun vc-name (file) | |
120 "Return the master name of a file, nil if it is not registered" | |
121 (or (vc-file-getprop file 'vc-name) | |
122 (vc-file-setprop file 'vc-name | |
123 (let ((name-and-type (vc-registered file))) | |
124 (and name-and-type (car name-and-type)))))) | |
125 | |
126 (defvar vc-binary-assoc nil) | |
127 | |
128 (defun vc-find-binary (name) | |
129 "Look for a command anywhere on the subprocess-command search path." | |
130 (or (cdr (assoc name vc-binary-assoc)) | |
131 (let ((full nil)) | |
132 (catch 'found | |
133 (mapcar | |
134 (function (lambda (s) | |
135 (if (and s (file-exists-p (setq full (concat s "/" name)))) | |
136 (throw 'found nil)))) | |
137 exec-path)) | |
138 (if full | |
139 (setq vc-binary-assoc (cons (cons name full) vc-binary-assoc))) | |
140 full))) | |
141 | |
142 (defun vc-do-command (okstatus command file &rest flags) | |
143 "Execute a version-control command, notifying user and checking for errors. | |
144 The command is successful if its exit status does not exceed OKSTATUS. | |
145 Output from COMMAND goes to buffer *vc*. The last argument of the command is | |
146 the master name of FILE; this is appended to an optional list of FLAGS." | |
147 (setq file (expand-file-name file)) | |
148 (if vc-command-messages | |
149 (message (format "Running %s on %s..." command file))) | |
150 (let ((obuf (current-buffer)) | |
151 (squeezed nil) | |
152 (vc-file (and file (vc-name file))) | |
153 status) | |
154 (set-buffer (get-buffer-create "*vc*")) | |
155 (erase-buffer) | |
156 (mapcar | |
157 (function (lambda (s) (and s (setq squeezed (append squeezed (list s)))))) | |
158 flags) | |
159 (if vc-file | |
160 (setq squeezed (append squeezed (list vc-file)))) | |
161 (let | |
162 ((default-directory (file-name-directory (or file "./")))) | |
163 (setq status (apply 'call-process command nil t nil squeezed)) | |
164 ) | |
165 (goto-char (point-max)) | |
166 (previous-line 1) | |
167 (if (or (not (integerp status)) (< okstatus status)) | |
168 (progn | |
169 (previous-line 1) | |
170 (print (cons command squeezed)) | |
171 (next-line 1) | |
172 (pop-to-buffer "*vc*") | |
173 (vc-shrink-to-fit) | |
174 (goto-char (point-min)) | |
175 (error (format "Running %s...FAILED (%s)" command | |
176 (if (integerp status) | |
177 (format "status %d" status) | |
178 status))) | |
179 ) | |
180 (if vc-command-messages | |
181 (message (format "Running %s...OK" command))) | |
182 ) | |
183 (set-buffer obuf) | |
184 status) | |
185 ) | |
186 | |
187 (defun vc-revert-buffer1 (&optional arg no-confirm) | |
188 ;; This code was shamelessly lifted from Sebastian Kremer's rcs.el mode. | |
189 ;; Revert buffer, try to keep point where user expects it in spite | |
190 ;; of changes because of expanded version-control key words. | |
191 ;; This is quite important since otherwise typeahead won't work as expected. | |
192 (interactive "P") | |
193 (widen) | |
194 (let* ((opoint (point)) | |
195 (osize (buffer-size)) | |
196 diff | |
197 (context 100) | |
198 (ostring (buffer-substring (point) | |
199 (min (point-max) | |
200 (+ (point) context)))) | |
201 (l (length ostring))) | |
202 (revert-buffer arg no-confirm) | |
203 (setq diff (- osize (buffer-size))) | |
204 (if (< diff 0) (setq diff (- diff))) | |
205 (goto-char opoint) | |
206 (cond ((equal "" ostring) | |
207 (goto-char (point-max))) | |
208 ((or (search-forward ostring nil t) | |
209 ;; Can't use search-backward since the match may continue | |
210 ;; after point. | |
211 (progn (goto-char (- (point) diff l)) | |
212 ;; goto-char doesn't signal an error at | |
213 ;; beginning of buffer like backward-char would | |
214 (search-forward ostring nil t))) | |
215 ;; to beginning of OSTRING | |
216 (backward-char l))))) | |
217 | |
218 (defun vc-buffer-sync () | |
219 ;; Make sure the current buffer and its working file are in sync | |
220 (if (and (buffer-modified-p) | |
221 (or | |
222 vc-suppress-confirm | |
223 (y-or-n-p (format "%s has been modified. Write it out? " | |
224 (buffer-name))))) | |
225 (save-buffer))) | |
226 | |
227 (defun vc-workfile-unchanged-p (file) | |
228 ;; Has the given workfile changed since last checkout? | |
229 (let ((checkout-time (vc-file-getprop file 'vc-checkout-time)) | |
230 (lastmod (nth 5 (file-attributes file)))) | |
231 (if checkout-time | |
232 (equal lastmod checkout-time) | |
233 (if (zerop (vc-backend-diff file nil)) | |
234 (progn | |
235 (vc-file-setprop file 'vc-checkout-time lastmod) | |
236 t) | |
237 (progn | |
238 (vc-file-setprop file 'vc-checkout-time '(0 . 0)) | |
239 nil | |
240 )) | |
241 ))) | |
242 | |
927 | 243 ;; Here's the major entry point. |
904 | 244 |
927 | 245 ;;;###autoload |
904 | 246 (defun vc-next-action (verbose) |
247 "Do the next logical checkin or checkout operation on the current file. | |
248 If the file is not already registered, this registers it for version | |
249 control and then retrieves a writeable, locked copy for editing. | |
250 If the file is registered and not locked by anyone, this checks out | |
251 a writeable and locked file ready for editing. | |
252 If the file is checked out and locked by the calling user, this | |
253 first checks to see if the file has changed since checkout. If not, | |
254 it performs a revert. | |
255 If the file has been changed, this pops up a buffer for creation of | |
256 a log message; when the message has been entered, it checks in the | |
257 resulting changes along with the log message as change commentary. If | |
258 the variable vc-keep-workfiles is non-nil (which is its default), a | |
259 read-only copy of the changed file is left in place afterwards. | |
260 If the file is registered and locked by someone else, you are given | |
261 the option to steal the lock." | |
262 (interactive "P") | |
263 (if buffer-file-name | |
264 (let | |
265 (do-update owner version | |
266 (file buffer-file-name) | |
267 (vc-file (vc-name buffer-file-name)) | |
268 (err-msg nil) | |
269 owner) | |
270 | |
271 (cond | |
272 | |
273 ;; if there is no master file corresponding, create one | |
274 ((not vc-file) | |
275 (vc-register verbose) | |
276 (vc-next-action verbose)) | |
277 | |
278 ;; if there is no lock on the file, assert one and get it | |
279 ((not (setq owner (vc-locking-user file))) | |
280 (vc-checkout file t)) | |
281 | |
282 ;; a checked-out version exists, but the user may not own the lock | |
283 ((not (string-equal owner (user-login-name))) | |
284 (vc-steal-lock | |
285 file | |
286 (and verbose (read-string "Version to steal: ")) | |
287 owner)) | |
288 | |
289 ;; OK, user owns the lock on the file | |
290 (t (progn | |
291 | |
292 ;; give luser a chance to save before checking in. | |
293 (vc-buffer-sync) | |
294 | |
1478
429e23e87072
(vc-resynch-window): New arg NOQUERY. Pass it to vc-revert-buffer1.
Richard M. Stallman <rms@gnu.org>
parents:
1352
diff
changeset
|
295 ;; Revert if file is unchanged and buffer is too. |
429e23e87072
(vc-resynch-window): New arg NOQUERY. Pass it to vc-revert-buffer1.
Richard M. Stallman <rms@gnu.org>
parents:
1352
diff
changeset
|
296 ;; If buffer is modified, that means the user just said no |
429e23e87072
(vc-resynch-window): New arg NOQUERY. Pass it to vc-revert-buffer1.
Richard M. Stallman <rms@gnu.org>
parents:
1352
diff
changeset
|
297 ;; to saving it; in that case, don't revert, |
429e23e87072
(vc-resynch-window): New arg NOQUERY. Pass it to vc-revert-buffer1.
Richard M. Stallman <rms@gnu.org>
parents:
1352
diff
changeset
|
298 ;; because the user might intend to save |
429e23e87072
(vc-resynch-window): New arg NOQUERY. Pass it to vc-revert-buffer1.
Richard M. Stallman <rms@gnu.org>
parents:
1352
diff
changeset
|
299 ;; after finishing the log entry. |
429e23e87072
(vc-resynch-window): New arg NOQUERY. Pass it to vc-revert-buffer1.
Richard M. Stallman <rms@gnu.org>
parents:
1352
diff
changeset
|
300 (if (and (vc-workfile-unchanged-p file) |
429e23e87072
(vc-resynch-window): New arg NOQUERY. Pass it to vc-revert-buffer1.
Richard M. Stallman <rms@gnu.org>
parents:
1352
diff
changeset
|
301 (not (buffer-modified-p))) |
904 | 302 (progn |
303 (vc-backend-revert file) | |
304 (vc-resynch-window file t)) | |
305 | |
306 ;; user may want to set nonstandard parameters | |
307 (if verbose | |
308 (setq version (read-string "New version level: "))) | |
309 | |
310 ;; OK, let's do the checkin | |
311 (vc-checkin file version)))))) | |
312 (error "There is no file associated with buffer %s" (buffer-name)))) | |
313 | |
314 ;;; These functions help the vc-next-action entry point | |
315 | |
927 | 316 ;;;###autoload |
904 | 317 (defun vc-register (&optional override) |
318 "Register the current file into your version-control system." | |
319 (interactive "P") | |
320 (if (vc-name buffer-file-name) | |
321 (error "This file is already registered.")) | |
322 (vc-buffer-sync) | |
323 (vc-admin | |
324 buffer-file-name | |
325 (and override (read-string "Initial version level: "))) | |
326 ) | |
327 | |
1478
429e23e87072
(vc-resynch-window): New arg NOQUERY. Pass it to vc-revert-buffer1.
Richard M. Stallman <rms@gnu.org>
parents:
1352
diff
changeset
|
328 (defun vc-resynch-window (file &optional keep noquery) |
904 | 329 ;; If the given file is in the current buffer, |
330 ;; either revert on it so we see expanded keyworks, | |
331 ;; or unvisit it (depending on vc-keep-workfiles) | |
1478
429e23e87072
(vc-resynch-window): New arg NOQUERY. Pass it to vc-revert-buffer1.
Richard M. Stallman <rms@gnu.org>
parents:
1352
diff
changeset
|
332 ;; NOQUERY if non-nil inhibits confirmation for reverting. |
429e23e87072
(vc-resynch-window): New arg NOQUERY. Pass it to vc-revert-buffer1.
Richard M. Stallman <rms@gnu.org>
parents:
1352
diff
changeset
|
333 ;; NOQUERY should be t *only* if it is known the only difference |
429e23e87072
(vc-resynch-window): New arg NOQUERY. Pass it to vc-revert-buffer1.
Richard M. Stallman <rms@gnu.org>
parents:
1352
diff
changeset
|
334 ;; between the buffer and the file is due to RCS rather than user editing! |
904 | 335 (and (string= buffer-file-name file) |
336 (if keep | |
337 (progn | |
1478
429e23e87072
(vc-resynch-window): New arg NOQUERY. Pass it to vc-revert-buffer1.
Richard M. Stallman <rms@gnu.org>
parents:
1352
diff
changeset
|
338 (vc-revert-buffer1 nil noquery) |
904 | 339 (vc-mode-line buffer-file-name)) |
340 (progn | |
341 (delete-window) | |
342 (kill-buffer (current-buffer)))))) | |
343 | |
344 | |
345 (defun vc-admin (file rev) | |
1478
429e23e87072
(vc-resynch-window): New arg NOQUERY. Pass it to vc-revert-buffer1.
Richard M. Stallman <rms@gnu.org>
parents:
1352
diff
changeset
|
346 "Check a file into your version-control system. |
904 | 347 FILE is the unmodified name of the file. REV should be the base version |
348 level to check it in under." | |
349 (if vc-initial-comment | |
350 (progn | |
351 (pop-to-buffer (get-buffer-create "*VC-log*")) | |
352 (vc-log-mode) | |
353 (narrow-to-region (point-max) (point-max)) | |
354 (vc-mode-line file (file-name-nondirectory file)) | |
355 (setq vc-log-operation 'vc-backend-admin) | |
356 (setq vc-log-file file) | |
357 (setq vc-log-version rev) | |
358 (message "Enter initial comment. Type C-c C-c when done.")) | |
359 (progn | |
360 (vc-backend-admin file rev) | |
361 (vc-resynch-window file vc-keep-workfiles)))) | |
362 | |
363 (defun vc-steal-lock (file rev &optional owner) | |
364 "Steal the lock on the current workfile." | |
365 (interactive) | |
366 (if (not owner) | |
367 (setq owner (vc-locking-user file))) | |
368 (if (not (y-or-n-p (format "Take the lock on %s:%s from %s?" file rev owner))) | |
369 (error "Steal cancelled.")) | |
1343
9b5cb40cb6c8
(vc-steal-lock): Use mail-setup, and do like `mail'.
Richard M. Stallman <rms@gnu.org>
parents:
1337
diff
changeset
|
370 (require 'sendmail) |
9b5cb40cb6c8
(vc-steal-lock): Use mail-setup, and do like `mail'.
Richard M. Stallman <rms@gnu.org>
parents:
1337
diff
changeset
|
371 (pop-to-buffer (get-buffer-create "*VC-mail*")) |
9b5cb40cb6c8
(vc-steal-lock): Use mail-setup, and do like `mail'.
Richard M. Stallman <rms@gnu.org>
parents:
1337
diff
changeset
|
372 (setq default-directory (expand-file-name "~/")) |
9b5cb40cb6c8
(vc-steal-lock): Use mail-setup, and do like `mail'.
Richard M. Stallman <rms@gnu.org>
parents:
1337
diff
changeset
|
373 (auto-save-mode auto-save-default) |
9b5cb40cb6c8
(vc-steal-lock): Use mail-setup, and do like `mail'.
Richard M. Stallman <rms@gnu.org>
parents:
1337
diff
changeset
|
374 (mail-mode) |
9b5cb40cb6c8
(vc-steal-lock): Use mail-setup, and do like `mail'.
Richard M. Stallman <rms@gnu.org>
parents:
1337
diff
changeset
|
375 (erase-buffer) |
9b5cb40cb6c8
(vc-steal-lock): Use mail-setup, and do like `mail'.
Richard M. Stallman <rms@gnu.org>
parents:
1337
diff
changeset
|
376 (mail-setup owner (format "%s:%s" file rev) nil nil nil |
9b5cb40cb6c8
(vc-steal-lock): Use mail-setup, and do like `mail'.
Richard M. Stallman <rms@gnu.org>
parents:
1337
diff
changeset
|
377 (list (list 'vc-finish-steal file rev))) |
9b5cb40cb6c8
(vc-steal-lock): Use mail-setup, and do like `mail'.
Richard M. Stallman <rms@gnu.org>
parents:
1337
diff
changeset
|
378 (goto-char (point-max)) |
904 | 379 (insert |
1343
9b5cb40cb6c8
(vc-steal-lock): Use mail-setup, and do like `mail'.
Richard M. Stallman <rms@gnu.org>
parents:
1337
diff
changeset
|
380 (format "I stole the lock on %s:%s, " file rev) |
904 | 381 (current-time-string) |
1343
9b5cb40cb6c8
(vc-steal-lock): Use mail-setup, and do like `mail'.
Richard M. Stallman <rms@gnu.org>
parents:
1337
diff
changeset
|
382 ".\n") |
9b5cb40cb6c8
(vc-steal-lock): Use mail-setup, and do like `mail'.
Richard M. Stallman <rms@gnu.org>
parents:
1337
diff
changeset
|
383 (message "Please explain why you stole the lock. Type C-c C-c when done.")) |
904 | 384 |
1343
9b5cb40cb6c8
(vc-steal-lock): Use mail-setup, and do like `mail'.
Richard M. Stallman <rms@gnu.org>
parents:
1337
diff
changeset
|
385 ;; This is called when the notification has been sent. |
904 | 386 (defun vc-finish-steal (file version) |
387 (vc-backend-steal file version) | |
1478
429e23e87072
(vc-resynch-window): New arg NOQUERY. Pass it to vc-revert-buffer1.
Richard M. Stallman <rms@gnu.org>
parents:
1352
diff
changeset
|
388 (vc-resynch-window file t t)) |
904 | 389 |
390 (defun vc-checkout (file &optional writeable) | |
391 "Retrieve a copy of the latest version of the given file." | |
392 (vc-backend-checkout file writeable) | |
393 (if (string-equal file buffer-file-name) | |
1478
429e23e87072
(vc-resynch-window): New arg NOQUERY. Pass it to vc-revert-buffer1.
Richard M. Stallman <rms@gnu.org>
parents:
1352
diff
changeset
|
394 (vc-resynch-window file t t)) |
904 | 395 ) |
396 | |
397 (defun vc-checkin (file &optional rev comment) | |
398 "Check in the file specified by FILE. | |
399 The optional argument REV may be a string specifying the new version level | |
1227
d07030650283
(vc-checkin-hook): New user hook variable.
Roland McGrath <roland@gnu.org>
parents:
1226
diff
changeset
|
400 \(if nil increment the current level). The file is either retained with write |
904 | 401 permissions zeroed, or deleted (according to the value of vc-keep-workfiles). |
402 COMMENT is a comment string; if omitted, a buffer is | |
403 popped up to accept a comment." | |
404 (pop-to-buffer (get-buffer-create "*VC-log*")) | |
405 (vc-log-mode) | |
406 (narrow-to-region (point-max) (point-max)) | |
407 (vc-mode-line file (file-name-nondirectory file)) | |
1227
d07030650283
(vc-checkin-hook): New user hook variable.
Roland McGrath <roland@gnu.org>
parents:
1226
diff
changeset
|
408 (setq vc-log-operation 'vc-backend-checkin |
d07030650283
(vc-checkin-hook): New user hook variable.
Roland McGrath <roland@gnu.org>
parents:
1226
diff
changeset
|
409 vc-log-file file |
d07030650283
(vc-checkin-hook): New user hook variable.
Roland McGrath <roland@gnu.org>
parents:
1226
diff
changeset
|
410 vc-log-version rev |
d07030650283
(vc-checkin-hook): New user hook variable.
Roland McGrath <roland@gnu.org>
parents:
1226
diff
changeset
|
411 vc-log-after-operation-hook 'vc-checkin-hook) |
904 | 412 (message "Enter log message. Type C-c C-c when done.") |
413 (if comment | |
414 (progn | |
415 (insert comment) | |
416 (vc-finish-logentry)))) | |
417 | |
418 (defun vc-finish-logentry () | |
419 "Complete the operation implied by the current log entry." | |
420 (interactive) | |
421 (goto-char (point-max)) | |
422 (if (not (bolp)) (newline)) | |
423 ;; delimit current page | |
424 (save-excursion | |
425 (widen) | |
426 (goto-char (point-max)) | |
427 (if (and (not (bobp)) (not (= (char-after (1- (point))) ?\f))) | |
428 (insert-char ?\f 1))) | |
429 (if (not (bobp)) | |
430 (forward-char -1)) | |
431 (mark-page) | |
432 ;; Check for errors | |
433 (vc-backend-logentry-check vc-log-file) | |
434 ;; OK, do it to it | |
435 (if vc-log-operation | |
436 (funcall vc-log-operation | |
437 vc-log-file | |
438 vc-log-version | |
439 (buffer-substring (region-beginning) (1- (region-end)))) | |
440 (error "No log operation is pending.")) | |
441 ;; Return to "parent" buffer of this checkin and remove checkin window | |
442 (pop-to-buffer (get-file-buffer vc-log-file)) | |
443 (delete-window (get-buffer-window "*VC-log*")) | |
444 (bury-buffer "*VC-log*") | |
445 ;; Now make sure we see the expanded headers | |
1478
429e23e87072
(vc-resynch-window): New arg NOQUERY. Pass it to vc-revert-buffer1.
Richard M. Stallman <rms@gnu.org>
parents:
1352
diff
changeset
|
446 (vc-resynch-window buffer-file-name vc-keep-workfiles t) |
1227
d07030650283
(vc-checkin-hook): New user hook variable.
Roland McGrath <roland@gnu.org>
parents:
1226
diff
changeset
|
447 (run-hooks vc-log-after-operation-hook) |
904 | 448 ) |
449 | |
450 ;; Code for access to the comment ring | |
451 | |
452 (defun vc-next-comment () | |
453 "Fill the log buffer with the next message in the msg ring." | |
454 (interactive) | |
455 (widen) | |
456 (forward-page) | |
457 (if (= (point) (point-max)) | |
458 (goto-char (point-min))) | |
459 (mark-page) | |
460 (narrow-to-page)) | |
461 | |
462 (defun vc-previous-comment () | |
463 "Fill the log buffer with the previous message in the msg ring." | |
464 (interactive) | |
465 (widen) | |
466 (if (= (point) (point-min)) | |
467 (goto-char (point-max))) | |
468 (backward-page) | |
469 (mark-page) | |
470 (narrow-to-page)) | |
471 | |
472 (defun vc-comment-search-backward (regexp) | |
473 "Fill the log buffer with the last message in the msg ring matching REGEXP." | |
474 (interactive "sSearch backward for: ") | |
475 (widen) | |
476 (if (= (point) (point-min)) | |
477 (goto-char (point-max))) | |
478 (re-search-backward regexp nil t) | |
479 (mark-page) | |
480 (narrow-to-page)) | |
481 | |
482 (defun vc-comment-search-forward (regexp) | |
483 "Fill the log buffer with the next message in the msg ring matching REGEXP." | |
484 (interactive "sSearch forward for: ") | |
485 (widen) | |
486 (if (= (point) (point-min)) | |
487 (goto-char (point-max))) | |
488 (re-search-forward regexp nil t) | |
489 (mark-page) | |
490 (narrow-to-page)) | |
491 | |
492 ;; Additional entry points for examining version histories | |
493 | |
927 | 494 ;;;###autoload |
904 | 495 (defun vc-diff (historic) |
496 "Display diffs between file versions." | |
497 (interactive "P") | |
498 (if historic | |
499 (call-interactively 'vc-version-diff) | |
500 (let ((old | |
501 (and | |
502 current-prefix-arg | |
503 (read-string "Version to compare against: "))) | |
504 (file buffer-file-name) | |
505 unchanged) | |
506 (vc-buffer-sync) | |
507 (setq unchanged (vc-workfile-unchanged-p buffer-file-name)) | |
508 (if unchanged | |
509 (message (format "No changes to %s since latest version." file)) | |
510 (pop-to-buffer "*vc*") | |
511 (vc-backend-diff file nil) | |
512 (goto-char (point-min)) | |
513 ) | |
514 (not unchanged) | |
515 ) | |
516 ) | |
517 ) | |
518 | |
519 (defun vc-version-diff (file rel1 rel2) | |
520 "For FILE, report diffs between two stored versions REL1 and REL2 of it. | |
521 If FILE is a directory, generate diffs between versions for all registered | |
522 files in or below it." | |
523 (interactive "FFile or directory: \nsOlder version: \nsNewer version: ") | |
524 (if (string-equal rel1 "") (setq rel1 nil)) | |
525 (if (string-equal rel2 "") (setq rel2 nil)) | |
526 (if (file-directory-p file) | |
527 (progn | |
528 (set-buffer (get-buffer-create "*vc-status*")) | |
529 (erase-buffer) | |
530 (insert "Diffs between " rel1 " and " rel2 ":\n\n") | |
531 (set-buffer (get-buffer-create "*vc*")) | |
532 (vc-file-tree-walk | |
533 (function (lambda (f) | |
534 (and | |
535 (not (file-directory-p f)) | |
536 (vc-name f) | |
537 (vc-backend-diff f rel1 rel2)) | |
538 (append-to-buffer "*vc-status*" (point-min) (point-max)) | |
539 )) | |
540 default-directory) | |
541 (pop-to-buffer "*vc-status*") | |
542 (insert "\nEnd of diffs.\n") | |
543 (goto-char (point-min)) | |
544 (set-buffer-modified-p nil) | |
545 ) | |
546 (progn | |
547 (vc-backend-diff file rel1 rel2) | |
548 (goto-char (point-min)) | |
549 (if (equal (point-min) (point-max)) | |
550 (message (format "No changes to %s between %s and %s." file rel1 rel2)) | |
551 (pop-to-buffer "*vc*") | |
552 (goto-char (point-min)) | |
553 ) | |
554 ) | |
555 ) | |
556 ) | |
557 | |
558 ;; Header-insertion code | |
559 | |
927 | 560 ;;;###autoload |
904 | 561 (defun vc-insert-headers () |
562 "Insert headers in a file for use with your version-control system. | |
563 Headers desired are inserted at the start of the buffer, and are pulled from | |
564 the variable vc-header-strings" | |
565 (interactive) | |
566 (save-excursion | |
567 (save-restriction | |
568 (widen) | |
569 (if (or (not (vc-check-headers)) | |
570 (y-or-n-p "Version headers already exist. Insert another set?")) | |
571 (progn | |
572 (let* ((delims (cdr (assq major-mode vc-comment-alist))) | |
573 (comment-start-vc (or (car delims) comment-start "#")) | |
574 (comment-end-vc (or (car (cdr delims)) comment-end "")) | |
575 (hdstrings (cdr (assoc (vc-backend-deduce (buffer-file-name)) vc-header-alist)))) | |
576 (mapcar (function (lambda (s) | |
577 (insert comment-start-vc "\t" s "\t" | |
578 comment-end-vc "\n"))) | |
579 hdstrings) | |
580 (if vc-static-header-alist | |
581 (mapcar (function (lambda (f) | |
582 (if (string-match (car f) buffer-file-name) | |
583 (insert (format (cdr f) (car hdstrings)))))) | |
584 vc-static-header-alist)) | |
585 ) | |
586 ))))) | |
587 | |
588 ;; Status-checking functions | |
589 | |
927 | 590 ;;;###autoload |
904 | 591 (defun vc-directory (verbose) |
592 "Show version-control status of all files under the current directory." | |
593 (interactive "P") | |
594 (let ((dir (substring default-directory 0 (1- (length default-directory)))) | |
595 nonempty) | |
596 (save-excursion | |
597 (set-buffer (get-buffer-create "*vc-status*")) | |
598 (erase-buffer) | |
599 (vc-file-tree-walk | |
600 (function (lambda (f) | |
601 (if (vc-registered f) | |
602 (let ((user (vc-locking-user f))) | |
603 (if (or user verbose) | |
604 (insert (format | |
605 "%s %s\n" | |
606 (concat user) f))))))) | |
607 dir) | |
608 (setq nonempty (not (zerop (buffer-size))))) | |
609 (if nonempty | |
610 (progn | |
611 (pop-to-buffer "*vc-status*" t) | |
612 (vc-shrink-to-fit) | |
613 (goto-char (point-min))) | |
614 (message "No files are currently registered under %s" dir)) | |
615 )) | |
616 | |
617 ;; Named-configuration support for SCCS | |
618 | |
619 (defun vc-add-triple (name file rev) | |
620 (save-excursion | |
621 (find-file (concat (vc-backend-subdirectory-name file) "/" vc-name-assoc-file)) | |
622 (goto-char (point-max)) | |
623 (insert name "\t:\t" file "\t" rev "\n") | |
624 (basic-save-buffer) | |
625 (kill-buffer (current-buffer)) | |
626 )) | |
627 | |
628 (defun vc-record-rename (file newname) | |
629 (save-excursion | |
630 (find-file (concat (vc-backend-subdirectory-name file) "/" vc-name-assoc-file)) | |
631 (goto-char (point-min)) | |
632 (replace-regexp (concat ":" (regexp-quote file) "$") (concat ":" newname)) | |
633 (basic-save-buffer) | |
634 (kill-buffer (current-buffer)) | |
635 )) | |
636 | |
637 (defun vc-lookup-triple (file name) | |
638 (or | |
639 name | |
640 (let ((firstchar (aref name 0))) | |
641 (and (>= firstchar ?0) (<= firstchar ?9) name)) | |
642 (car (vc-master-info | |
643 (concat (vc-backend-subdirectory-name file) "/" vc-name-assoc-file) | |
644 (list (concat name "\t:\t" file "\t\\(.+\\)")))) | |
645 )) | |
646 | |
647 ;; Named-configuration entry points | |
648 | |
649 (defun vc-quiescent-p () | |
650 ;; Is the current directory ready to be snapshot? | |
651 (let ((dir (substring default-directory 0 (1- (length default-directory))))) | |
652 (catch 'quiet | |
653 (vc-file-tree-walk | |
654 (function (lambda (f) | |
655 (if (and (vc-registered f) (vc-locking-user f)) | |
656 (throw 'quiet nil)))) | |
657 dir) | |
658 t))) | |
659 | |
927 | 660 ;;;###autoload |
904 | 661 (defun vc-create-snapshot (name) |
662 "Make a snapshot called NAME. | |
663 The snapshot is made from all registered files at or below the current | |
664 directory. For each file, the version level of its latest | |
665 version becomes part of the named configuration." | |
666 (interactive "sNew snapshot name: ") | |
667 (if (not (vc-quiescent-p)) | |
668 (error "Can't make a snapshot, locked files are in the way.") | |
669 (vc-file-tree-walk | |
670 (function (lambda (f) (and | |
671 (not (file-directory-p f)) | |
672 (vc-name f) | |
673 (vc-backend-assign-name f name)))) | |
674 default-directory) | |
675 )) | |
676 | |
927 | 677 ;;;###autoload |
904 | 678 (defun vc-retrieve-snapshot (name) |
679 "Retrieve the snapshot called NAME. | |
680 This function fails if any files are locked at or below the current directory | |
681 Otherwise, all registered files are checked out (unlocked) at their version | |
682 levels in the snapshot." | |
683 (interactive "sSnapshot name to retrieve: ") | |
684 (if (not (vc-quiescent-p)) | |
685 (error "Can't retrieve a snapshot, locked files are in the way.") | |
686 (vc-file-tree-walk | |
687 (function (lambda (f) (and | |
688 (not (file-directory-p f)) | |
689 (vc-name f) | |
690 (vc-error-occurred (vc-backend-checkout f nil name))))) | |
691 default-directory) | |
692 )) | |
693 | |
694 ;; Miscellaneous other entry points | |
695 | |
927 | 696 ;;;###autoload |
904 | 697 (defun vc-print-log () |
698 "List the change log of the current buffer in a window." | |
699 (interactive) | |
700 (if (and buffer-file-name (vc-name buffer-file-name)) | |
701 (progn | |
702 (vc-backend-print-log buffer-file-name) | |
703 (pop-to-buffer (get-buffer-create "*vc*")) | |
704 (goto-char (point-min)) | |
705 ) | |
706 (error "There is no version-control master associated with this buffer") | |
707 ) | |
708 ) | |
709 | |
927 | 710 ;;;###autoload |
904 | 711 (defun vc-revert-buffer () |
952 | 712 "Revert the current buffer's file back to the latest checked-in version. |
713 This asks for confirmation if the buffer contents are not identical | |
714 to that version." | |
904 | 715 (interactive) |
716 (let ((file buffer-file-name) | |
717 (obuf (current-buffer)) (changed (vc-diff nil))) | |
952 | 718 (if (and changed (or vc-suppress-confirm |
719 (not (yes-or-no-p "Discard changes? ")))) | |
904 | 720 (progn |
721 (delete-window) | |
722 (error "Revert cancelled.")) | |
723 (set-buffer obuf)) | |
724 (if changed | |
725 (delete-window)) | |
726 (vc-backend-revert file) | |
1478
429e23e87072
(vc-resynch-window): New arg NOQUERY. Pass it to vc-revert-buffer1.
Richard M. Stallman <rms@gnu.org>
parents:
1352
diff
changeset
|
727 (vc-resynch-window file t t) |
904 | 728 ) |
729 ) | |
730 | |
927 | 731 ;;;###autoload |
904 | 732 (defun vc-cancel-version (norevert) |
733 "Undo your latest checkin." | |
734 (interactive "P") | |
735 (let ((target (vc-your-latest-version (buffer-file-name)))) | |
736 (if (null target) | |
737 (error "You didn't check in the last change.")) | |
738 (and (y-or-n-p (format "Remove version %s from master? " target)) | |
739 (vc-backend-uncheck (buffer-file-name) target))) | |
740 (if norevert | |
741 (vc-mode-line (buffer-file-name)) | |
742 (vc-checkout (buffer-file-name) nil)) | |
743 ) | |
744 | |
745 (defun vc-rename-file (old new) | |
746 "Rename a file, taking its master files with it." | |
747 (interactive "fOld name: \nFNew name: ") | |
748 (let ((oldbuf (get-file-buffer old))) | |
749 (if (buffer-modified-p oldbuf) | |
750 (error "Please save files before moving them.")) | |
751 (if (get-file-buffer new) | |
752 (error "Already editing new file name.")) | |
753 (let ((oldmaster (vc-name old))) | |
754 (if oldmaster | |
755 (if (vc-locking-user old) | |
756 (error "Please check in files before moving them.")) | |
757 (if (or (file-symlink-p oldmaster) | |
1243
de79e26e67cf
(vc-rename-file): Use OLD, not FILE which is unbound.
Richard M. Stallman <rms@gnu.org>
parents:
1232
diff
changeset
|
758 ;; This had FILE, I changed it to OLD. -- rms. |
de79e26e67cf
(vc-rename-file): Use OLD, not FILE which is unbound.
Richard M. Stallman <rms@gnu.org>
parents:
1232
diff
changeset
|
759 (file-symlink-p (vc-backend-subdirectory-name old))) |
904 | 760 (error "This is not a safe thing to do in the presence of symbolic links.")) |
761 (rename-file oldmaster (vc-name new))) | |
762 (if (or (not oldmaster) (file-exists-p old)) | |
763 (rename-file old new))) | |
764 ; ?? Renaming a file might change its contents due to keyword expansion. | |
765 ; We should really check out a new copy if the old copy was precisely equal | |
766 ; to some checked in version. However, testing for this is tricky.... | |
767 (if oldbuf | |
768 (save-excursion | |
769 (set-buffer oldbuf) | |
770 (set-visited-file-name new) | |
771 (set-buffer-modified-p nil)))) | |
1243
de79e26e67cf
(vc-rename-file): Use OLD, not FILE which is unbound.
Richard M. Stallman <rms@gnu.org>
parents:
1232
diff
changeset
|
772 ;; This had FILE, I changed it to OLD. -- rms. |
de79e26e67cf
(vc-rename-file): Use OLD, not FILE which is unbound.
Richard M. Stallman <rms@gnu.org>
parents:
1232
diff
changeset
|
773 (vc-backend-dispatch old |
904 | 774 (vc-record-rename old new) |
775 nil) | |
776 ) | |
777 | |
927 | 778 ;;;###autoload |
1226
573df03a54d8
(vc-update-change-log): Use shell-command, not shell-command-on-region.
Roland McGrath <roland@gnu.org>
parents:
952
diff
changeset
|
779 (defun vc-update-change-log (&rest args) |
573df03a54d8
(vc-update-change-log): Use shell-command, not shell-command-on-region.
Roland McGrath <roland@gnu.org>
parents:
952
diff
changeset
|
780 "Find change log file and add entries from recent RCS logs. |
573df03a54d8
(vc-update-change-log): Use shell-command, not shell-command-on-region.
Roland McGrath <roland@gnu.org>
parents:
952
diff
changeset
|
781 The mark is left at the end of the text prepended to the change log. |
573df03a54d8
(vc-update-change-log): Use shell-command, not shell-command-on-region.
Roland McGrath <roland@gnu.org>
parents:
952
diff
changeset
|
782 With prefix arg of C-u, only find log entries for the current buffer's file. |
573df03a54d8
(vc-update-change-log): Use shell-command, not shell-command-on-region.
Roland McGrath <roland@gnu.org>
parents:
952
diff
changeset
|
783 With any numeric prefix arg, find log entries for all files currently visited. |
573df03a54d8
(vc-update-change-log): Use shell-command, not shell-command-on-region.
Roland McGrath <roland@gnu.org>
parents:
952
diff
changeset
|
784 From a program, any arguments are passed to the `rcs2log' script." |
1227
d07030650283
(vc-checkin-hook): New user hook variable.
Roland McGrath <roland@gnu.org>
parents:
1226
diff
changeset
|
785 (interactive |
d07030650283
(vc-checkin-hook): New user hook variable.
Roland McGrath <roland@gnu.org>
parents:
1226
diff
changeset
|
786 (cond ((consp current-prefix-arg) ;C-u |
d07030650283
(vc-checkin-hook): New user hook variable.
Roland McGrath <roland@gnu.org>
parents:
1226
diff
changeset
|
787 (list buffer-file-name)) |
d07030650283
(vc-checkin-hook): New user hook variable.
Roland McGrath <roland@gnu.org>
parents:
1226
diff
changeset
|
788 (current-prefix-arg ;Numeric argument. |
d07030650283
(vc-checkin-hook): New user hook variable.
Roland McGrath <roland@gnu.org>
parents:
1226
diff
changeset
|
789 (let ((files nil) |
d07030650283
(vc-checkin-hook): New user hook variable.
Roland McGrath <roland@gnu.org>
parents:
1226
diff
changeset
|
790 (buffers (buffer-list)) |
d07030650283
(vc-checkin-hook): New user hook variable.
Roland McGrath <roland@gnu.org>
parents:
1226
diff
changeset
|
791 file) |
d07030650283
(vc-checkin-hook): New user hook variable.
Roland McGrath <roland@gnu.org>
parents:
1226
diff
changeset
|
792 (while buffers |
d07030650283
(vc-checkin-hook): New user hook variable.
Roland McGrath <roland@gnu.org>
parents:
1226
diff
changeset
|
793 (setq file (buffer-file-name (car buffers))) |
d07030650283
(vc-checkin-hook): New user hook variable.
Roland McGrath <roland@gnu.org>
parents:
1226
diff
changeset
|
794 (and file (vc-backend-deduce file) |
1232
2c56a159c9b6
(vc-update-change-log): Use file-relative-name.
Roland McGrath <roland@gnu.org>
parents:
1227
diff
changeset
|
795 (setq files (cons (file-relative-name file) files))) |
1227
d07030650283
(vc-checkin-hook): New user hook variable.
Roland McGrath <roland@gnu.org>
parents:
1226
diff
changeset
|
796 (setq buffers (cdr buffers))) |
d07030650283
(vc-checkin-hook): New user hook variable.
Roland McGrath <roland@gnu.org>
parents:
1226
diff
changeset
|
797 files)))) |
1226
573df03a54d8
(vc-update-change-log): Use shell-command, not shell-command-on-region.
Roland McGrath <roland@gnu.org>
parents:
952
diff
changeset
|
798 (find-file-other-window "ChangeLog") |
573df03a54d8
(vc-update-change-log): Use shell-command, not shell-command-on-region.
Roland McGrath <roland@gnu.org>
parents:
952
diff
changeset
|
799 (vc-buffer-sync) |
573df03a54d8
(vc-update-change-log): Use shell-command, not shell-command-on-region.
Roland McGrath <roland@gnu.org>
parents:
952
diff
changeset
|
800 (undo-boundary) |
573df03a54d8
(vc-update-change-log): Use shell-command, not shell-command-on-region.
Roland McGrath <roland@gnu.org>
parents:
952
diff
changeset
|
801 (goto-char (point-min)) |
573df03a54d8
(vc-update-change-log): Use shell-command, not shell-command-on-region.
Roland McGrath <roland@gnu.org>
parents:
952
diff
changeset
|
802 (message "Computing change log entries...") |
573df03a54d8
(vc-update-change-log): Use shell-command, not shell-command-on-region.
Roland McGrath <roland@gnu.org>
parents:
952
diff
changeset
|
803 (shell-command (mapconcat 'identity (cons "rcs2log" args) " ") t) |
573df03a54d8
(vc-update-change-log): Use shell-command, not shell-command-on-region.
Roland McGrath <roland@gnu.org>
parents:
952
diff
changeset
|
804 (message "Computing change log entries... done")) |
904 | 805 |
806 ;; Functions for querying the master and lock files. | |
807 | |
808 (defun match-substring (bn) | |
809 (buffer-substring (match-beginning bn) (match-end bn))) | |
810 | |
811 (defun vc-parse-buffer (patterns &optional file properties) | |
812 ;; Use PATTERNS to parse information out of the current buffer | |
813 ;; by matching each regular expression in the list and returning \\1. | |
814 ;; If a regexp has two tag brackets, assume the second is a date | |
815 ;; field and we want the most recent entry matching the template. | |
816 ;; If FILE and PROPERTIES are given, the latter must be a list of | |
817 ;; properties of the same length as PATTERNS; each property is assigned | |
818 ;; the corresponding value. | |
819 (mapcar (function (lambda (p) | |
820 (goto-char (point-min)) | |
821 (if (string-match "\\\\(.*\\\\(" p) | |
822 (let ((latest-date "") (latest-val)) | |
823 (while (re-search-forward p nil t) | |
824 (let ((date (match-substring 2))) | |
825 (if (string< latest-date date) | |
826 (progn | |
827 (setq latest-date date) | |
828 (setq latest-val | |
829 (match-substring 1)))))) | |
830 latest-val)) | |
831 (prog1 | |
832 (and (re-search-forward p nil t) | |
833 (let ((value (match-substring 1))) | |
834 (if file | |
835 (vc-file-setprop file (car properties) value)) | |
836 value)) | |
837 (setq properties (cdr properties))))) | |
838 patterns) | |
839 ) | |
840 | |
841 (defun vc-master-info (file fields &optional rfile properties) | |
842 ;; Search for information in a master file. | |
843 (if (and file (file-exists-p file)) | |
844 (save-excursion | |
845 (let ((buf)) | |
846 (setq buf (create-file-buffer file)) | |
847 (set-buffer buf)) | |
848 (erase-buffer) | |
849 (insert-file-contents file nil) | |
850 (set-buffer-modified-p nil) | |
851 (auto-save-mode nil) | |
852 (prog1 | |
853 (vc-parse-buffer fields rfile properties) | |
854 (kill-buffer (current-buffer))) | |
855 ) | |
856 (if rfile | |
857 (mapcar | |
858 (function (lambda (p) (vc-file-setprop rfile p nil))) | |
859 properties)) | |
860 ) | |
861 ) | |
862 | |
863 (defun vc-log-info (command file patterns &optional properties) | |
864 ;; Search for information in log program output | |
865 (if (and file (file-exists-p file)) | |
866 (save-excursion | |
867 (let ((buf)) | |
868 (setq buf (get-buffer-create "*vc*")) | |
869 (set-buffer buf)) | |
870 (apply 'vc-do-command 0 command file nil) | |
871 (set-buffer-modified-p nil) | |
872 (prog1 | |
873 (vc-parse-buffer patterns file properties) | |
874 (kill-buffer (current-buffer)) | |
875 ) | |
876 ) | |
877 (if file | |
878 (mapcar | |
879 (function (lambda (p) (vc-file-setprop file p nil))) | |
880 properties)) | |
881 ) | |
882 ) | |
883 | |
884 (defun vc-locking-user (file) | |
885 "Return the name of the person currently holding a lock on FILE. | |
886 Return nil if there is no such person." | |
887 (if (or (not vc-keep-workfiles) | |
888 (eq vc-mistrust-permissions 't) | |
889 (and vc-mistrust-permissions | |
890 (funcall vc-mistrust-permissions (vc-backend-subdirectory-name file)))) | |
891 (vc-true-locking-user file) | |
892 ;; This implementation assumes that any file which is under version | |
893 ;; control and has -rw-r--r-- is locked by its owner. This is true | |
894 ;; for both RCS and SCCS, which keep unlocked files at -r--r--r--. | |
895 ;; We have to be careful not to exclude files with execute bits on; | |
896 ;; scripts can be under version control too. The advantage of this | |
897 ;; hack is that calls to the very expensive vc-fetch-properties | |
898 ;; function only have to be made if (a) the file is locked by someone | |
899 ;; other than the current user, or (b) some untoward manipulation | |
900 ;; behind vc's back has twiddled the `group' or `other' write bits. | |
901 (let ((attributes (file-attributes file))) | |
902 (cond ((string-match ".r-.r-.r-." (nth 8 attributes)) | |
903 nil) | |
904 ((and (= (nth 2 attributes) (user-uid)) | |
905 (string-match ".rw.r-.r-." (nth 8 attributes))) | |
906 (user-login-name)) | |
907 (t | |
908 (vc-true-locking-user file)))))) | |
909 | |
910 (defun vc-true-locking-user (file) | |
911 ;; The slow but reliable version | |
912 (vc-fetch-properties file) | |
913 (vc-file-getprop file 'vc-locking-user)) | |
914 | |
915 (defun vc-latest-version (file) | |
916 ;; Return version level of the latest version of FILE | |
917 (vc-fetch-properties file) | |
918 (vc-file-getprop file 'vc-latest-version)) | |
919 | |
920 (defun vc-your-latest-version (file) | |
921 ;; Return version level of the latest version of FILE checked in by you | |
922 (vc-fetch-properties file) | |
923 (vc-file-getprop file 'vc-your-latest-version)) | |
924 | |
925 ;; Collect back-end-dependent stuff here | |
926 ;; | |
927 ;; Everything eventually funnels through these functions. To implement | |
928 ;; support for a new version-control system, add another branch to the | |
929 ;; vc-backend-dispatch macro (in vc-hooks.el) and fill it in in each call. | |
930 | |
931 (defmacro vc-backend-dispatch (f s r) | |
932 "Execute FORM1 or FORM2 depending on whether we're using SCCS or RCS." | |
933 (list 'let (list (list 'type (list 'vc-backend-deduce f))) | |
934 (list 'cond | |
935 (list (list 'eq 'type (quote 'SCCS)) s) ;; SCCS | |
936 (list (list 'eq 'type (quote 'RCS)) r) ;; RCS | |
937 ))) | |
938 | |
939 (defun vc-lock-file (file) | |
940 ;; Generate lock file name corresponding to FILE | |
941 (let ((master (vc-name file))) | |
942 (and | |
943 master | |
944 (string-match "\\(.*/\\)s\\.\\(.*\\)" master) | |
945 (concat | |
946 (substring master (match-beginning 1) (match-end 1)) | |
947 "p." | |
948 (substring master (match-beginning 2) (match-end 2)))))) | |
949 | |
950 | |
951 (defun vc-fetch-properties (file) | |
952 ;; Re-fetch all properties associated with the given file. | |
953 ;; Currently these properties are: | |
954 ;; vc-locking-user | |
955 ;; vc-locked-version | |
956 ;; vc-latest-version | |
957 ;; vc-your-latest-version | |
958 (vc-backend-dispatch | |
959 file | |
960 ;; SCCS | |
961 (progn | |
962 (vc-master-info (vc-lock-file file) | |
963 (list | |
964 "^[^ ]+ [^ ]+ \\([^ ]+\\)" | |
965 "^\\([^ ]+\\)") | |
966 file | |
967 '(vc-locking-user vc-locked-version)) | |
968 (vc-master-info (vc-name file) | |
969 (list | |
970 "^\001d D \\([^ ]+\\)" | |
971 (concat "^\001d D \\([^ ]+\\) .* " | |
972 (regexp-quote (user-login-name)) " ") | |
973 ) | |
974 file | |
975 '(vc-latest-version vc-your-latest-version)) | |
976 ) | |
977 ;; RCS | |
978 (vc-log-info "rlog" file | |
979 (list | |
980 "^locks: strict\n\t\\([^:]+\\)" | |
981 "^locks: strict\n\t[^:]+: \\(.+\\)" | |
982 "^revision[\t ]+\\([0-9.]+\\).*\ndate: \\([ /0-9:]+\\);" | |
983 (concat | |
984 "^revision[\t ]+\\([0-9.]+\\).*locked by: " | |
985 (regexp-quote (user-login-name)) | |
986 ";\ndate: \\([ /0-9:]+\\);")) | |
987 '(vc-locking-user vc-locked-version | |
988 vc-latest-version vc-your-latest-version)) | |
989 )) | |
990 | |
991 (defun vc-backend-subdirectory-name (&optional file) | |
992 ;; Where the master and lock files for the current directory are kept | |
993 (symbol-name | |
994 (or | |
995 (and file (vc-backend-deduce file)) | |
996 vc-default-back-end | |
997 (setq vc-default-back-end (if (vc-find-binary "rcs") 'RCS 'SCCS))))) | |
998 | |
999 (defun vc-backend-admin (file &optional rev comment) | |
1000 ;; Register a file into the version-control system | |
1001 ;; Automatically retrieves a read-only version of the file with | |
1002 ;; keywords expanded if vc-keep-workfiles is non-nil, otherwise | |
1003 ;; it deletes the workfile. | |
1004 (vc-file-clearprops file) | |
1005 (or vc-default-back-end | |
1006 (setq vc-default-back-end (if (vc-find-binary "rcs") 'RCS 'SCCS))) | |
1007 (message "Registering %s..." file) | |
1008 (let ((backend | |
1009 (cond | |
1010 ((file-exists-p (vc-backend-subdirectory-name)) vc-default-back-end) | |
1011 ((file-exists-p "RCS") 'RCS) | |
1012 ((file-exists-p "SCCS") 'SCCS) | |
1013 (t vc-default-back-end)))) | |
1014 (cond ((eq backend 'SCCS) | |
1015 (vc-do-command 0 "admin" file ;; SCCS | |
1016 (and rev (concat "-r" rev)) | |
1017 "-fb" | |
1018 (concat "-i" file) | |
1019 (and comment (concat "-y" comment)) | |
1020 (format | |
1021 (car (rassq 'SCCS vc-master-templates)) | |
1022 (or (file-name-directory file) "") | |
1023 (file-name-nondirectory file))) | |
1024 (delete-file file) | |
1025 (if vc-keep-workfiles | |
1026 (vc-do-command 0 "get" file))) | |
1027 ((eq backend 'RCS) | |
1028 (vc-do-command 0 "ci" file ;; RCS | |
1029 (concat (if vc-keep-workfiles "-u" "-r") rev) | |
1030 (and comment (concat "-t-" comment)) | |
1031 file) | |
1032 ))) | |
1033 (message "Registering %s...done" file) | |
1034 ) | |
1035 | |
1036 (defun vc-backend-checkout (file &optional writeable rev) | |
1037 ;; Retrieve a copy of a saved version into a workfile | |
1038 (message "Checking out %s..." file) | |
1039 (vc-backend-dispatch file | |
1040 (progn | |
1041 (vc-do-command 0 "get" file ;; SCCS | |
1042 (if writeable "-e") | |
1043 (and rev (concat "-r" (vc-lookup-triple file rev)))) | |
1044 ) | |
1045 (vc-do-command 0 "co" file ;; RCS | |
1046 (if writeable "-l") | |
1047 (and rev (concat "-r" rev))) | |
1048 ) | |
1049 (vc-file-setprop file 'vc-checkout-time (nth 5 (file-attributes file))) | |
1050 (message "Checking out %s...done" file) | |
1051 ) | |
1052 | |
1053 (defun vc-backend-logentry-check (file) | |
1054 (vc-backend-dispatch file | |
1055 (if (>= (- (region-end) (region-beginning)) 512) ;; SCCS | |
1056 (progn | |
1057 (goto-char 512) | |
1058 (error | |
1059 "Log must be less than 512 characters. Point is now at char 512."))) | |
1060 nil) | |
1061 ) | |
1062 | |
1063 (defun vc-backend-checkin (file &optional rev comment) | |
1064 ;; Register changes to FILE as level REV with explanatory COMMENT. | |
1065 ;; Automatically retrieves a read-only version of the file with | |
1066 ;; keywords expanded if vc-keep-workfiles is non-nil, otherwise | |
1067 ;; it deletes the workfile. | |
1068 (message "Checking in %s..." file) | |
1337
ab589b426055
(vc-backend-checkin): Change buffers to get local value of vc-checkin-switches.
Roland McGrath <roland@gnu.org>
parents:
1336
diff
changeset
|
1069 (save-excursion |
ab589b426055
(vc-backend-checkin): Change buffers to get local value of vc-checkin-switches.
Roland McGrath <roland@gnu.org>
parents:
1336
diff
changeset
|
1070 ;; Change buffers to get local value of vc-checkin-switches. |
ab589b426055
(vc-backend-checkin): Change buffers to get local value of vc-checkin-switches.
Roland McGrath <roland@gnu.org>
parents:
1336
diff
changeset
|
1071 (set-buffer (or (get-file-buffer file) (current-buffer))) |
ab589b426055
(vc-backend-checkin): Change buffers to get local value of vc-checkin-switches.
Roland McGrath <roland@gnu.org>
parents:
1336
diff
changeset
|
1072 (vc-backend-dispatch file |
ab589b426055
(vc-backend-checkin): Change buffers to get local value of vc-checkin-switches.
Roland McGrath <roland@gnu.org>
parents:
1336
diff
changeset
|
1073 (progn |
ab589b426055
(vc-backend-checkin): Change buffers to get local value of vc-checkin-switches.
Roland McGrath <roland@gnu.org>
parents:
1336
diff
changeset
|
1074 (apply 'vc-do-command 0 "delta" file |
ab589b426055
(vc-backend-checkin): Change buffers to get local value of vc-checkin-switches.
Roland McGrath <roland@gnu.org>
parents:
1336
diff
changeset
|
1075 (if rev (concat "-r" rev)) |
ab589b426055
(vc-backend-checkin): Change buffers to get local value of vc-checkin-switches.
Roland McGrath <roland@gnu.org>
parents:
1336
diff
changeset
|
1076 (concat "-y" comment) |
ab589b426055
(vc-backend-checkin): Change buffers to get local value of vc-checkin-switches.
Roland McGrath <roland@gnu.org>
parents:
1336
diff
changeset
|
1077 vc-checkin-switches) |
ab589b426055
(vc-backend-checkin): Change buffers to get local value of vc-checkin-switches.
Roland McGrath <roland@gnu.org>
parents:
1336
diff
changeset
|
1078 (if vc-keep-workfiles |
ab589b426055
(vc-backend-checkin): Change buffers to get local value of vc-checkin-switches.
Roland McGrath <roland@gnu.org>
parents:
1336
diff
changeset
|
1079 (vc-do-command 0 "get" file)) |
ab589b426055
(vc-backend-checkin): Change buffers to get local value of vc-checkin-switches.
Roland McGrath <roland@gnu.org>
parents:
1336
diff
changeset
|
1080 ) |
ab589b426055
(vc-backend-checkin): Change buffers to get local value of vc-checkin-switches.
Roland McGrath <roland@gnu.org>
parents:
1336
diff
changeset
|
1081 (apply 'vc-do-command 0 "ci" file |
ab589b426055
(vc-backend-checkin): Change buffers to get local value of vc-checkin-switches.
Roland McGrath <roland@gnu.org>
parents:
1336
diff
changeset
|
1082 (concat (if vc-keep-workfiles "-u" "-r") rev) |
ab589b426055
(vc-backend-checkin): Change buffers to get local value of vc-checkin-switches.
Roland McGrath <roland@gnu.org>
parents:
1336
diff
changeset
|
1083 (concat "-m" comment) |
ab589b426055
(vc-backend-checkin): Change buffers to get local value of vc-checkin-switches.
Roland McGrath <roland@gnu.org>
parents:
1336
diff
changeset
|
1084 vc-checkin-switches) |
ab589b426055
(vc-backend-checkin): Change buffers to get local value of vc-checkin-switches.
Roland McGrath <roland@gnu.org>
parents:
1336
diff
changeset
|
1085 )) |
904 | 1086 (vc-file-setprop file 'vc-locking-user nil) |
1087 (message "Checking in %s...done" file) | |
1088 ) | |
1089 | |
1090 (defun vc-backend-revert (file) | |
1091 ;; Revert file to latest checked-in version. | |
1092 (message "Reverting %s..." file) | |
1093 (vc-backend-dispatch | |
1094 file | |
1095 (progn ;; SCCS | |
1096 (vc-do-command 0 "unget" file nil) | |
1097 (vc-do-command 0 "get" file nil)) | |
1098 (progn | |
1099 (delete-file file) ;; RCS | |
1100 (vc-do-command 0 "co" file "-u"))) | |
1101 (vc-file-setprop file 'vc-locking-user nil) | |
1102 (message "Reverting %s...done" file) | |
1103 ) | |
1104 | |
1105 (defun vc-backend-steal (file &optional rev) | |
1106 ;; Steal the lock on the current workfile. Needs RCS 5.6.2 or later for -M. | |
1107 (message "Stealing lock on %s..." file) | |
1108 (progn | |
1109 (vc-do-command 0 "unget" file "-n" (if rev (concat "-r" rev))) | |
1110 (vc-do-command 0 "get" file "-g" (if rev (concat "-r" rev))) | |
1111 ) | |
1112 (progn | |
1344
8d047d2d2592
(vc-backend-steal): Put filename after options in rcs commands.
Richard M. Stallman <rms@gnu.org>
parents:
1343
diff
changeset
|
1113 (vc-do-command 0 "rcs" "-M" (concat "-u" rev) file) |
1352
a8623439066b
(vc-backend-steal): Delete the workfile after the rcs -M -u.
Richard M. Stallman <rms@gnu.org>
parents:
1344
diff
changeset
|
1114 (delete-file file) |
1344
8d047d2d2592
(vc-backend-steal): Put filename after options in rcs commands.
Richard M. Stallman <rms@gnu.org>
parents:
1343
diff
changeset
|
1115 (vc-do-command 0 "rcs" (concat "-l" rev) file) |
904 | 1116 ) |
1117 (vc-file-setprop file 'vc-locking-user (user-login-name)) | |
1118 (message "Stealing lock on %s...done" file) | |
1119 ) | |
1120 | |
1121 (defun vc-backend-uncheck (file target) | |
1122 ;; Undo the latest checkin. Note: this code will have to get a lot | |
1123 ;; smarter when we support multiple branches. | |
1124 (message "Removing last change from %s..." file) | |
1125 (vc-backend-dispatch file | |
1126 (vc-do-command 0 "rmdel" file (concat "-r" target)) | |
1127 (vc-do-command 0 "rcs" file (concat "-o" target)) | |
1128 ) | |
1129 (message "Removing last change from %s...done" file) | |
1130 ) | |
1131 | |
1132 (defun vc-backend-print-log (file) | |
1133 ;; Print change log associated with FILE to buffer *vc*. | |
1134 (vc-do-command 0 | |
1135 (vc-backend-dispatch file "prs" "rlog") | |
1136 file) | |
1137 ) | |
1138 | |
1139 (defun vc-backend-assign-name (file name) | |
1140 ;; Assign to a FILE's latest version a given NAME. | |
1141 (vc-backend-dispatch file | |
1142 (vc-add-triple name file (vc-latest-version file)) ;; SCCS | |
1143 (vc-do-command 0 "rcs" file (concat "-n" name ":")) ;; RCS | |
1144 )) | |
1145 | |
1146 (defun vc-backend-diff (file oldvers &optional newvers) | |
1147 ;; Get a difference report between two versions | |
1148 (apply 'vc-do-command 1 | |
1149 (or (vc-backend-dispatch file "vcdiff" "rcsdiff") | |
1150 (error (format "File %s is not under version control." file))) | |
1151 file | |
1152 (and oldvers (concat "-r" oldvers)) | |
1153 (and newvers (concat "-r" newvers)) | |
1154 vc-diff-options | |
1155 )) | |
1156 | |
1157 (defun vc-check-headers () | |
1158 "Check if the current file has any headers in it." | |
1159 (interactive) | |
1160 (save-excursion | |
1161 (goto-char (point-min)) | |
1162 (vc-backend-dispatch buffer-file-name | |
1163 (re-search-forward "%[MIRLBSDHTEGUYFPQCZWA]%" nil t) ;; SCCS | |
1164 (re-search-forward "\\$[A-Za-z\300-\326\330-\366\370-\377]+\\(: [\t -#%-\176\240-\377]*\\)?\\$" nil t) ;; RCS | |
1165 ) | |
1166 )) | |
1167 | |
1168 ;; Back-end-dependent stuff ends here. | |
1169 | |
1170 ;; Set up key bindings for use while editing log messages | |
1171 | |
1172 (defun vc-log-mode () | |
1173 "Minor mode for driving version-control tools. | |
1174 These bindings are added to the global keymap when you enter this mode: | |
1175 \\[vc-next-action] perform next logical version-control operation on current file | |
1176 \\[vc-register] register current file | |
1177 \\[vc-toggle-read-only] like next-action, but won't register files | |
1178 \\[vc-insert-headers] insert version-control headers in current file | |
1179 \\[vc-print-log] display change history of current file | |
1180 \\[vc-revert-buffer] revert buffer to latest version | |
1181 \\[vc-cancel-version] undo latest checkin | |
1182 \\[vc-diff] show diffs between file versions | |
1183 \\[vc-directory] show all files locked by any user in or below . | |
1184 \\[vc-update-change-log] add change log entry from recent checkins | |
1185 | |
1186 While you are entering a change log message for a version, the following | |
1187 additional bindings will be in effect. | |
1188 | |
1189 \\[vc-finish-logentry] proceed with check in, ending log message entry | |
1190 | |
1191 Whenever you do a checkin, your log comment is added to a ring of | |
1192 saved comments. These can be recalled as follows: | |
1193 | |
1194 \\[vc-next-comment] replace region with next message in comment ring | |
1195 \\[vc-previous-comment] replace region with previous message in comment ring | |
1196 \\[vc-search-comment-reverse] search backward for regexp in the comment ring | |
1197 \\[vc-search-comment-forward] search backward for regexp in the comment ring | |
1198 | |
1199 Entry to the change-log submode calls the value of text-mode-hook, then | |
1200 the value of vc-log-mode-hook. | |
1201 | |
1202 Global user options: | |
1203 vc-initial-comment If non-nil, require user to enter a change | |
1204 comment upon first checkin of the file. | |
1205 | |
1206 vc-keep-workfiles Non-nil value prevents workfiles from being | |
1207 deleted when changes are checked in | |
1208 | |
1209 vc-suppress-confirm Suppresses some confirmation prompts, | |
1210 notably for reversions. | |
1211 | |
1212 vc-diff-options A list consisting of the flags | |
1213 to be used for generating context diffs. | |
1214 | |
1215 vc-header-strings Which keywords to insert when adding headers | |
1216 with \\[vc-insert-headers]. Defaults to | |
1217 '(\"\%\W\%\") under SCCS, '(\"\$Id\$\") under RCS. | |
1218 | |
1219 vc-static-header-alist By default, version headers inserted in C files | |
1220 get stuffed in a static string area so that | |
1221 ident(RCS) or what(SCCS) can see them in the | |
1222 compiled object code. You can override this | |
1223 by setting this variable to nil, or change | |
1224 the header template by changing it. | |
1225 | |
1226 vc-command-messages if non-nil, display run messages from the | |
1227 actual version-control utilities (this is | |
1228 intended primarily for people hacking vc | |
1229 itself). | |
1230 " | |
1231 (interactive) | |
1232 (set-syntax-table text-mode-syntax-table) | |
1233 (use-local-map vc-log-entry-mode) | |
1234 (setq local-abbrev-table text-mode-abbrev-table) | |
1235 (setq major-mode 'vc-log-mode) | |
1236 (setq mode-name "VC-Log") | |
1237 (make-local-variable 'vc-log-file) | |
1238 (make-local-variable 'vc-log-version) | |
1239 (set-buffer-modified-p nil) | |
1240 (setq buffer-file-name nil) | |
1241 (run-hooks 'text-mode-hook 'vc-log-mode-hook) | |
1242 ) | |
1243 | |
1244 ;; Initialization code, to be done just once at load-time | |
1245 (if vc-log-entry-mode | |
1246 nil | |
1247 (setq vc-log-entry-mode (make-sparse-keymap)) | |
1248 (define-key vc-log-entry-mode "\M-n" 'vc-next-comment) | |
1249 (define-key vc-log-entry-mode "\M-p" 'vc-previous-comment) | |
1250 (define-key vc-log-entry-mode "\M-r" 'vc-comment-search-backward) | |
1251 (define-key vc-log-entry-mode "\M-s" 'vc-comment-search-forward) | |
1252 (define-key vc-log-entry-mode "\C-c\C-c" 'vc-finish-logentry) | |
1253 ) | |
1254 | |
1255 ;;; These things should probably be generally available | |
1256 | |
1257 (defun vc-shrink-to-fit () | |
1258 "Shrink a window vertically until it's just large enough to contain its text" | |
1259 (let ((minsize (1+ (count-lines (point-min) (point-max))))) | |
1260 (if (< minsize (window-height)) | |
1261 (let ((window-min-height 2)) | |
1262 (shrink-window (- (window-height) minsize)))))) | |
1263 | |
1264 (defun vc-file-tree-walk (func dir &rest args) | |
1265 "Apply a given function to dir and all files underneath it, recursively." | |
1266 (apply 'funcall func dir args) | |
1267 (and (file-directory-p dir) | |
1268 (mapcar | |
1269 (function (lambda (f) (or | |
1270 (string-equal f ".") | |
1271 (string-equal f "..") | |
1272 (file-symlink-p f) ;; Avoid possible loops | |
1273 (apply 'vc-file-tree-walk | |
1274 func | |
1275 (if (= (aref dir (1- (length dir))) ?/) | |
1276 (concat dir f) | |
1277 (concat dir "/" f)) | |
1278 args)))) | |
1279 (directory-files dir)))) | |
1280 | |
1281 (provide 'vc) | |
1282 | |
1283 ;;; DEVELOPER'S NOTES ON CONCURRENCY PROBLEMS IN THIS CODE | |
1284 ;;; | |
1285 ;;; These may be useful to anyone who has to debug or extend the package. | |
1286 ;;; | |
1287 ;;; A fundamental problem in VC is that there are time windows between | |
1288 ;;; vc-next-action's computations of the file's version-control state and | |
1289 ;;; the actions that change it. This is a window open to lossage in a | |
1290 ;;; multi-user environment; someone else could nip in and change the state | |
1291 ;;; of the master during it. | |
1292 ;;; | |
1293 ;;; The performance problem is that rlog/prs calls are very expensive; we want | |
1294 ;;; to avoid them as much as possible. | |
1295 ;;; | |
1296 ;;; ANALYSIS: | |
1297 ;;; | |
1298 ;;; The performance problem, it turns out, simplifies in practice to the | |
1299 ;;; problem of making vc-locking-user fast. The two other functions that call | |
1300 ;;; prs/rlog will not be so commonly used that the slowdown is a problem; one | |
1301 ;;; makes snapshots, the other deletes the calling user's last change in the | |
1302 ;;; master. | |
1303 ;;; | |
1304 ;;; The race condition implies that we have to either (a) lock the master | |
1305 ;;; during the entire execution of vc-next-action, or (b) detect and | |
1306 ;;; recover from errors resulting from dispatch on an out-of-date state. | |
1307 ;;; | |
1308 ;;; Alternative (a) appears to be unfeasible. The problem is that we can't | |
1309 ;;; guarantee that the lock will ever be removed. Suppose a user starts a | |
1310 ;;; checkin, the change message buffer pops up, and the user, having wandered | |
1311 ;;; off to do something else, simply forgets about it? | |
1312 ;;; | |
1313 ;;; Alternative (b), on the other hand, works well with a cheap way to speed up | |
1314 ;;; vc-locking-user. Usually, if a file is registered, we can read its locked/ | |
1315 ;;; unlocked state and its current owner from its permissions. | |
1316 ;;; | |
1317 ;;; This shortcut will fail if someone has manually changed the workfile's | |
1318 ;;; permissions; also if developers are munging the workfile in several | |
1319 ;;; directories, with symlinks to a master (in this latter case, the | |
1320 ;;; permissions shortcut will fail to detect a lock asserted from another | |
1321 ;;; directory). | |
1322 ;;; | |
1323 ;;; Note that these cases correspond exactly to the errors which could happen | |
1324 ;;; because of a competing checkin/checkout race in between two instances of | |
1325 ;;; vc-next-action. | |
1326 ;;; | |
1327 ;;; For VC's purposes, a workfile/master pair may have the following states: | |
1328 ;;; | |
1329 ;;; A. Unregistered. There is a workfile, there is no master. | |
1330 ;;; | |
1331 ;;; B. Registered and not locked by anyone. | |
1332 ;;; | |
1333 ;;; C. Locked by calling user and unchanged. | |
1334 ;;; | |
1335 ;;; D. Locked by the calling user and changed. | |
1336 ;;; | |
1337 ;;; E. Locked by someone other than the calling user. | |
1338 ;;; | |
1339 ;;; This makes for 25 states and 20 error conditions. Here's the matrix: | |
1340 ;;; | |
1341 ;;; VC's idea of state | |
1342 ;;; | | |
1343 ;;; V Actual state RCS action SCCS action Effect | |
1344 ;;; A B C D E | |
1345 ;;; A . 1 2 3 4 ci -u -t- admin -fb -i<file> initial admin | |
1346 ;;; B 5 . 6 7 8 co -l get -e checkout | |
1347 ;;; C 9 10 . 11 12 co -u unget; get revert | |
1348 ;;; D 13 14 15 . 16 ci -u -m<comment> delta -y<comment>; get checkin | |
1349 ;;; E 17 18 19 20 . rcs -u -M ; rcs -l unget -n ; get -g steal lock | |
1350 ;;; | |
1351 ;;; All commands take the master file name as a last argument (not shown). | |
1352 ;;; | |
1353 ;;; In the discussion below, a "self-race" is a pathological situation in | |
1354 ;;; which VC operations are being attempted simultaneously by two or more | |
1355 ;;; Emacsen running under the same username. | |
1356 ;;; | |
1357 ;;; The vc-next-action code has the following windows: | |
1358 ;;; | |
1359 ;;; Window P: | |
1360 ;;; Between the check for existence of a master file and the call to | |
1361 ;;; admin/checkin in vc-buffer-admin (apparent state A). This window may | |
1362 ;;; never close if the initial-comment feature is on. | |
1363 ;;; | |
1364 ;;; Window Q: | |
1365 ;;; Between the call to vc-workfile-unchanged-p in and the immediately | |
1366 ;;; following revert (apparent state C). | |
1367 ;;; | |
1368 ;;; Window R: | |
1369 ;;; Between the call to vc-workfile-unchanged-p in and the following | |
1370 ;;; checkin (apparent state D). This window may never close. | |
1371 ;;; | |
1372 ;;; Window S: | |
1373 ;;; Between the unlock and the immediately following checkout during a | |
1374 ;;; revert operation (apparent state C). Included in window Q. | |
1375 ;;; | |
1376 ;;; Window T: | |
1377 ;;; Between vc-locking-user and the following checkout (apparent state B). | |
1378 ;;; | |
1379 ;;; Window U: | |
1380 ;;; Between vc-locking-user and the following revert (apparent state C). | |
1381 ;;; Includes windows Q and S. | |
1382 ;;; | |
1383 ;;; Window V: | |
1384 ;;; Between vc-locking-user and the following checkin (apparent state | |
1385 ;;; D). This window may never be closed if the user fails to complete the | |
1386 ;;; checkin message. Includes window R. | |
1387 ;;; | |
1388 ;;; Window W: | |
1389 ;;; Between vc-locking-user and the following steal-lock (apparent | |
1390 ;;; state E). This window may never cloce if the user fails to complete | |
1391 ;;; the steal-lock message. Includes window X. | |
1392 ;;; | |
1393 ;;; Window X: | |
1394 ;;; Between the unlock and the immediately following re-lock during a | |
1395 ;;; steal-lock operation (apparent state E). This window may never cloce | |
1396 ;;; if the user fails to complete the steal-lock message. | |
1397 ;;; | |
1398 ;;; Errors: | |
1399 ;;; | |
1400 ;;; Apparent state A --- | |
1401 ;;; | |
1402 ;;; 1. File looked unregistered but is actually registered and not locked. | |
1403 ;;; | |
1404 ;;; Potential cause: someone else's admin during window P, with | |
1405 ;;; caller's admin happening before their checkout. | |
1406 ;;; | |
1407 ;;; RCS: ci will fail with a "no lock set by <user>" message. | |
1408 ;;; SCCS: admin will fail with error (ad19). | |
1409 ;;; | |
1410 ;;; We can let these errors be passed up to the user. | |
1411 ;;; | |
1412 ;;; 2. File looked unregistered but is actually locked by caller, unchanged. | |
1413 ;;; | |
1414 ;;; Potential cause: self-race during window P. | |
1415 ;;; | |
1416 ;;; RCS: will revert the file to the last saved version and unlock it. | |
1417 ;;; SCCS: will fail with error (ad19). | |
1418 ;;; | |
1419 ;;; Either of these consequences is acceptable. | |
1420 ;;; | |
1421 ;;; 3. File looked unregistered but is actually locked by caller, changed. | |
1422 ;;; | |
1423 ;;; Potential cause: self-race during window P. | |
1424 ;;; | |
1425 ;;; RCS: will register the caller's workfile as a delta with a | |
1426 ;;; null change comment (the -t- switch will be ignored). | |
1427 ;;; SCCS: will fail with error (ad19). | |
1428 ;;; | |
1429 ;;; 4. File looked unregistered but is locked by someone else. | |
1430 ;;; | |
1431 ;;; Potential cause: someone else's admin during window P, with | |
1432 ;;; caller's admin happening *after* their checkout. | |
1433 ;;; | |
1434 ;;; RCS: will fail with a "no lock set by <user>" message. | |
1435 ;;; SCCS: will fail with error (ad19). | |
1436 ;;; | |
1437 ;;; We can let these errors be passed up to the user. | |
1438 ;;; | |
1439 ;;; Apparent state B --- | |
1440 ;;; | |
1441 ;;; 5. File looked registered and not locked, but is actually unregistered. | |
1442 ;;; | |
1443 ;;; Potential cause: master file got nuked during window P. | |
1444 ;;; | |
1445 ;;; RCS: will fail with "RCS/<file>: No such file or directory" | |
1446 ;;; SCCS: will fail with error ut4. | |
1447 ;;; | |
1448 ;;; We can let these errors be passed up to the user. | |
1449 ;;; | |
1450 ;;; 6. File looked registered and not locked, but is actually locked by the | |
1451 ;;; calling user and unchanged. | |
1452 ;;; | |
1453 ;;; Potential cause: self-race during window T. | |
1454 ;;; | |
1455 ;;; RCS: in the same directory as the previous workfile, co -l will fail | |
1456 ;;; with "co error: writable foo exists; checkout aborted". In any other | |
1457 ;;; directory, checkout will succeed. | |
1458 ;;; SCCS: will fail with ge17. | |
1459 ;;; | |
1460 ;;; Either of these consequences is acceptable. | |
1461 ;;; | |
1462 ;;; 7. File looked registered and not locked, but is actually locked by the | |
1463 ;;; calling user and changed. | |
1464 ;;; | |
1465 ;;; As case 6. | |
1466 ;;; | |
1467 ;;; 8. File looked registered and not locked, but is actually locked by another | |
1468 ;;; user. | |
1469 ;;; | |
1470 ;;; Potential cause: someone else checks it out during window T. | |
1471 ;;; | |
1472 ;;; RCS: co error: revision 1.3 already locked by <user> | |
1473 ;;; SCCS: fails with ge4 (in directory) or ut7 (outside it). | |
1474 ;;; | |
1475 ;;; We can let these errors be passed up to the user. | |
1476 ;;; | |
1477 ;;; Apparent state C --- | |
1478 ;;; | |
1479 ;;; 9. File looks locked by calling user and unchanged, but is unregistered. | |
1480 ;;; | |
1481 ;;; As case 5. | |
1482 ;;; | |
1483 ;;; 10. File looks locked by calling user and unchanged, but is actually not | |
1484 ;;; locked. | |
1485 ;;; | |
1486 ;;; Potential cause: a self-race in window U, or by the revert's | |
1487 ;;; landing during window X of some other user's steal-lock or window S | |
1488 ;;; of another user's revert. | |
1489 ;;; | |
1490 ;;; RCS: succeeds, refreshing the file from the identical version in | |
1491 ;;; the master. | |
1492 ;;; SCCS: fails with error ut4 (p file nonexistent). | |
1493 ;;; | |
1494 ;;; Either of these consequences is acceptable. | |
1495 ;;; | |
1496 ;;; 11. File is locked by calling user. It looks unchanged, but is actually | |
1497 ;;; changed. | |
1498 ;;; | |
1499 ;;; Potential cause: the file would have to be touched by a self-race | |
1500 ;;; during window Q. | |
1501 ;;; | |
1502 ;;; The revert will succeed, removing whatever changes came with | |
1503 ;;; the touch. It is theoretically possible that work could be lost. | |
1504 ;;; | |
1505 ;;; 12. File looks like it's locked by the calling user and unchanged, but | |
1506 ;;; it's actually locked by someone else. | |
1507 ;;; | |
1508 ;;; Potential cause: a steal-lock in window V. | |
1509 ;;; | |
1510 ;;; RCS: co error: revision <rev> locked by <user>; use co -r or rcs -u | |
1511 ;;; SCCS: fails with error un2 | |
1512 ;;; | |
1513 ;;; We can pass these errors up to the user. | |
1514 ;;; | |
1515 ;;; Apparent state D --- | |
1516 ;;; | |
1517 ;;; 13. File looks like it's locked by the calling user and changed, but it's | |
1518 ;;; actually unregistered. | |
1519 ;;; | |
1520 ;;; Potential cause: master file got nuked during window P. | |
1521 ;;; | |
1522 ;;; RCS: Checks in the user's version as an initial delta. | |
1523 ;;; SCCS: will fail with error ut4. | |
1524 ;;; | |
1525 ;;; This case is kind of nasty. It means VC may fail to detect the | |
1526 ;;; loss of previous version information. | |
1527 ;;; | |
1528 ;;; 14. File looks like it's locked by the calling user and changed, but it's | |
1529 ;;; actually unlocked. | |
1530 ;;; | |
1531 ;;; Potential cause: self-race in window V, or the checkin happening | |
1532 ;;; during the window X of someone else's steal-lock or window S of | |
1533 ;;; someone else's revert. | |
1534 ;;; | |
1535 ;;; RCS: ci will fail with "no lock set by <user>". | |
1536 ;;; SCCS: delta will fail with error ut4. | |
1537 ;;; | |
1538 ;;; 15. File looks like it's locked by the calling user and changed, but it's | |
1539 ;;; actually locked by the calling user and unchanged. | |
1540 ;;; | |
1541 ;;; Potential cause: another self-race --- a whole checkin/checkout | |
1542 ;;; sequence by the calling user would have to land in window R. | |
1543 ;;; | |
1544 ;;; SCCS: checks in a redundant delta and leaves the file unlocked as usual. | |
1545 ;;; RCS: reverts to the file state as of the second user's checkin, leaving | |
1546 ;;; the file unlocked. | |
1547 ;;; | |
1548 ;;; It is theoretically possible that work could be lost under RCS. | |
1549 ;;; | |
1550 ;;; 16. File looks like it's locked by the calling user and changed, but it's | |
1551 ;;; actually locked by a different user. | |
1552 ;;; | |
1553 ;;; RCS: ci error: no lock set by <user> | |
1554 ;;; SCCS: unget will fail with error un2 | |
1555 ;;; | |
1556 ;;; We can pass these errors up to the user. | |
1557 ;;; | |
1558 ;;; Apparent state E --- | |
1559 ;;; | |
1560 ;;; 17. File looks like it's locked by some other user, but it's actually | |
1561 ;;; unregistered. | |
1562 ;;; | |
1563 ;;; As case 13. | |
1564 ;;; | |
1565 ;;; 18. File looks like it's locked by some other user, but it's actually | |
1566 ;;; unlocked. | |
1567 ;;; | |
1568 ;;; Potential cause: someone released a lock during window W. | |
1569 ;;; | |
1570 ;;; RCS: The calling user will get the lock on the file. | |
1571 ;;; SCCS: unget -n will fail with cm4. | |
1572 ;;; | |
1573 ;;; Either of these consequences will be OK. | |
1574 ;;; | |
1575 ;;; 19. File looks like it's locked by some other user, but it's actually | |
1576 ;;; locked by the calling user and unchanged. | |
1577 ;;; | |
1578 ;;; Potential cause: the other user relinquishing a lock followed by | |
1579 ;;; a self-race, both in window W. | |
1580 ;;; | |
1581 ;;; Under both RCS and SCCS, both unlock and lock will succeed, making | |
1582 ;;; the sequence a no-op. | |
1583 ;;; | |
1584 ;;; 20. File looks like it's locked by some other user, but it's actually | |
1585 ;;; locked by the calling user and changed. | |
1586 ;;; | |
1587 ;;; As case 19. | |
1588 ;;; | |
1589 ;;; PROBLEM CASES: | |
1590 ;;; | |
1591 ;;; In order of decreasing severity: | |
1592 ;;; | |
1593 ;;; Cases 11 and 15 under RCS are the only one that potentially lose work. | |
1594 ;;; They would require a self-race for this to happen. | |
1595 ;;; | |
1596 ;;; Case 13 in RCS loses information about previous deltas, retaining | |
1597 ;;; only the information in the current workfile. This can only happen | |
1598 ;;; if the master file gets nuked in window P. | |
1599 ;;; | |
1600 ;;; Case 3 in RCS and case 15 under SCCS insert a redundant delta with | |
1601 ;;; no change comment in the master. This would require a self-race in | |
1602 ;;; window P or R respectively. | |
1603 ;;; | |
1604 ;;; Cases 2, 10, 19 and 20 do extra work, but make no changes. | |
1605 ;;; | |
1606 ;;; Unfortunately, it appears to me that no recovery is possible in these | |
1607 ;;; cases. They don't yield error messages, so there's no way to tell that | |
1608 ;;; a race condition has occurred. | |
1609 ;;; | |
1610 ;;; All other cases don't change either the workfile or the master, and | |
1611 ;;; trigger command errors which the user will see. | |
1612 ;;; | |
1613 ;;; Thus, there is no explicit recovery code. | |
1614 | |
1615 ;;; vc.el ends here |