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