1 ;;; vc.el --- drive a version-control system from within Emacs
3 ;; Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 2000,
4 ;; 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008
5 ;; Free Software Foundation, Inc.
7 ;; Author: FSF (see below for full credits)
8 ;; Maintainer: Andre Spiegel <spiegel@gnu.org>
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
28 ;; VC was initially designed and implemented by Eric S. Raymond
29 ;; <esr@thyrsus.com> in 1992. Over the years, many other people have
30 ;; contributed substantial amounts of work to VC. These include:
32 ;; Per Cederqvist <ceder@lysator.liu.se>
33 ;; Paul Eggert <eggert@twinsun.com>
34 ;; Sebastian Kremer <sk@thp.uni-koeln.de>
35 ;; Martin Lorentzson <martinl@gnu.org>
36 ;; Dave Love <fx@gnu.org>
37 ;; Stefan Monnier <monnier@cs.yale.edu>
38 ;; Thien-Thi Nguyen <ttn@gnu.org>
39 ;; Dan Nicolaescu <dann@ics.uci.edu>
40 ;; J.D. Smith <jdsmith@alum.mit.edu>
41 ;; Andre Spiegel <spiegel@gnu.org>
42 ;; Richard Stallman <rms@gnu.org>
44 ;; In July 2007 ESR returned and redesigned the mode to cope better
45 ;; with modern version-control systems that do commits by fileset
46 ;; rather than per individual file.
48 ;; If you maintain a client of the mode or customize it in your .emacs,
49 ;; note that some backend functions which formerly took single file arguments
50 ;; now take a list of files. These include: register, checkin, print-log,
51 ;; rollback, and diff.
55 ;; This mode is fully documented in the Emacs user's manual.
57 ;; Supported version-control systems presently include CVS, RCS, GNU
58 ;; Arch, Subversion, Bzr, Git, Mercurial, Monotone and SCCS
59 ;; (or its free replacement, CSSC).
61 ;; Some features will not work with old RCS versions. Where
62 ;; appropriate, VC finds out which version you have, and allows or
63 ;; disallows those features (stealing locks, for example, works only
64 ;; from 5.6.2 onwards).
65 ;; Even initial checkins will fail if your RCS version is so old that ci
66 ;; doesn't understand -t-; this has been known to happen to people running
69 ;; You can support the RCS -x option by customizing vc-rcs-master-templates.
71 ;; Proper function of the SCCS diff commands requires the shellscript vcdiff
72 ;; to be installed somewhere on Emacs's path for executables.
74 ;; If your site uses the ChangeLog convention supported by Emacs, the
75 ;; function `log-edit-comment-to-change-log' could prove a useful checkin hook,
76 ;; although you might prefer to use C-c C-a (i.e. `log-edit-insert-changelog')
77 ;; from the commit buffer instead or to set `log-edit-setup-invert'.
79 ;; The vc code maintains some internal state in order to reduce expensive
80 ;; version-control operations to a minimum. Some names are only computed
81 ;; once. If you perform version control operations with the backend while
82 ;; vc's back is turned, or move/rename master files while vc is running,
83 ;; vc may get seriously confused. Don't do these things!
85 ;; Developer's notes on some concurrency issues are included at the end of
88 ;; ADDING SUPPORT FOR OTHER BACKENDS
90 ;; VC can use arbitrary version control systems as a backend. To add
91 ;; support for a new backend named SYS, write a library vc-sys.el that
92 ;; contains functions of the form `vc-sys-...' (note that SYS is in lower
93 ;; case for the function and library names). VC will use that library if
94 ;; you put the symbol SYS somewhere into the list of
95 ;; `vc-handled-backends'. Then, for example, if `vc-sys-registered'
96 ;; returns non-nil for a file, all SYS-specific versions of VC commands
97 ;; will be available for that file.
99 ;; VC keeps some per-file information in the form of properties (see
100 ;; vc-file-set/getprop in vc-hooks.el). The backend-specific functions
101 ;; do not generally need to be aware of these properties. For example,
102 ;; `vc-sys-working-revision' should compute the working revision and
103 ;; return it; it should not look it up in the property, and it needn't
104 ;; store it there either. However, if a backend-specific function does
105 ;; store a value in a property, that value takes precedence over any
106 ;; value that the generic code might want to set (check for uses of
107 ;; the macro `with-vc-properties' in vc.el).
109 ;; In the list of functions below, each identifier needs to be prepended
110 ;; with `vc-sys-'. Some of the functions are mandatory (marked with a
111 ;; `*'), others are optional (`-').
113 ;; BACKEND PROPERTIES
115 ;; * revision-granularity
117 ;; Takes no arguments. Returns either 'file or 'repository. Backends
118 ;; that return 'file have per-file revision numbering; backends
119 ;; that return 'repository have per-repository revision numbering,
120 ;; so a revision level implicitly identifies a changeset
122 ;; STATE-QUERYING FUNCTIONS
124 ;; * registered (file)
126 ;; Return non-nil if FILE is registered in this backend. Both this
127 ;; function as well as `state' should be careful to fail gracefully
128 ;; in the event that the backend executable is absent. It is
129 ;; preferable that this function's body is autoloaded, that way only
130 ;; calling vc-registered does not cause the backend to be loaded
131 ;; (all the vc-FOO-registered functions are called to try to find
132 ;; the controlling backend for FILE.
136 ;; Return the current version control state of FILE. For a list of
137 ;; possible values, see `vc-state'. This function should do a full and
138 ;; reliable state computation; it is usually called immediately after
139 ;; C-x v v. If you want to use a faster heuristic when visiting a
140 ;; file, put that into `state-heuristic' below. Note that under most
141 ;; VCSes this won't be called at all, dir-status is used instead.
143 ;; - state-heuristic (file)
145 ;; If provided, this function is used to estimate the version control
146 ;; state of FILE at visiting time. It should be considerably faster
147 ;; than the implementation of `state'. For a list of possible values,
148 ;; see the doc string of `vc-state'.
150 ;; - dir-status (dir update-function)
152 ;; Produce RESULT: a list of lists of the form (FILE VC-STATE EXTRA)
153 ;; for the files in DIR.
154 ;; EXTRA can be used for backend specific information about FILE.
155 ;; If a command needs to be run to compute this list, it should be
156 ;; run asynchronously using (current-buffer) as the buffer for the
157 ;; command. When RESULT is computed, it should be passed back by
158 ;; doing: (funcall UPDATE-FUNCTION RESULT nil).
159 ;; If the backend uses a process filter, hence it produces partial results,
160 ;; they can be passed back by doing:
161 ;; (funcall UPDATE-FUNCTION RESULT t)
162 ;; and then do a (funcall UPDATE-FUNCTION RESULT nil)
163 ;; when all the results have been computed.
164 ;; To provide more backend specific functionality for `vc-dir'
165 ;; the following functions might be needed: `status-extra-headers',
166 ;; `status-printer', `extra-status-menu' and `dir-status-files'.
168 ;; - dir-status-files (dir files default-state update-function)
170 ;; This function is identical to dir-status except that it should
171 ;; only report status for the specified FILES. Also it needs to
172 ;; report on all requested files, including up-to-date or ignored
173 ;; files. If not provided, the default is to consider that the files
174 ;; are in DEFAULT-STATE.
176 ;; - status-extra-headers (dir)
178 ;; Return a string that will be added to the *vc-dir* buffer header.
180 ;; - status-printer (fileinfo)
182 ;; Pretty print the `vc-dir-fileinfo' FILEINFO.
183 ;; If a backend needs to show more information than the default FILE
184 ;; and STATE in the vc-dir listing, it can store that extra
185 ;; information in `vc-dir-fileinfo->extra'. This function can be
186 ;; used to display that extra information in the *vc-dir* buffer.
188 ;; - status-fileinfo-extra (file)
190 ;; Compute `vc-dir-fileinfo->extra' for FILE.
192 ;; * working-revision (file)
194 ;; Return the working revision of FILE. This is the revision fetched
195 ;; by the last checkout or upate, not necessarily the same thing as the
196 ;; head or tip revision. Should return "0" for a file added but not yet
199 ;; - latest-on-branch-p (file)
201 ;; Return non-nil if the working revision of FILE is the latest revision
202 ;; on its branch (many VCSes call this the 'tip' or 'head' revision).
203 ;; The default implementation always returns t, which means that
204 ;; working with non-current revisions is not supported by default.
206 ;; * checkout-model (files)
208 ;; Indicate whether FILES need to be "checked out" before they can be
209 ;; edited. See `vc-checkout-model' for a list of possible values.
211 ;; - workfile-unchanged-p (file)
213 ;; Return non-nil if FILE is unchanged from the working revision.
214 ;; This function should do a brief comparison of FILE's contents
215 ;; with those of the repository master of the working revision. If
216 ;; the backend does not have such a brief-comparison feature, the
217 ;; default implementation of this function can be used, which
218 ;; delegates to a full vc-BACKEND-diff. (Note that vc-BACKEND-diff
219 ;; must not run asynchronously in this case, see variable
220 ;; `vc-disable-async-diff'.)
222 ;; - mode-line-string (file)
224 ;; If provided, this function should return the VC-specific mode
225 ;; line string for FILE. The returned string should have a
226 ;; `help-echo' property which is the text to be displayed as a
227 ;; tooltip when the mouse hovers over the VC entry on the mode-line.
228 ;; The default implementation deals well with all states that
229 ;; `vc-state' can return.
231 ;; - prettify-state-info (file)
233 ;; Translate the `vc-state' property of FILE into a string that can be
234 ;; used in a human-readable buffer. The default implementation deals well
235 ;; with all states that `vc-state' can return.
237 ;; STATE-CHANGING FUNCTIONS
239 ;; * create-repo (backend)
241 ;; Create an empty repository in the current directory and initialize
242 ;; it so VC mode can add files to it. For file-oriented systems, this
243 ;; need do no more than create a subdirectory with the right name.
245 ;; * register (files &optional rev comment)
247 ;; Register FILES in this backend. Optionally, an initial revision REV
248 ;; and an initial description of the file, COMMENT, may be specified,
249 ;; but it is not guaranteed that the backend will do anything with this.
250 ;; The implementation should pass the value of vc-register-switches
251 ;; to the backend command. (Note: in older versions of VC, this
252 ;; command took a single file argument and not a list.)
254 ;; - init-revision (file)
256 ;; The initial revision to use when registering FILE if one is not
257 ;; specified by the user. If not provided, the variable
258 ;; vc-default-init-revision is used instead.
260 ;; - responsible-p (file)
262 ;; Return non-nil if this backend considers itself "responsible" for
263 ;; FILE, which can also be a directory. This function is used to find
264 ;; out what backend to use for registration of new files and for things
265 ;; like change log generation. The default implementation always
268 ;; - could-register (file)
270 ;; Return non-nil if FILE could be registered under this backend. The
271 ;; default implementation always returns t.
273 ;; - receive-file (file rev)
275 ;; Let this backend "receive" a file that is already registered under
276 ;; another backend. The default implementation simply calls `register'
277 ;; for FILE, but it can be overridden to do something more specific,
278 ;; e.g. keep revision numbers consistent or choose editing modes for
279 ;; FILE that resemble those of the other backend.
281 ;; - unregister (file)
283 ;; Unregister FILE from this backend. This is only needed if this
284 ;; backend may be used as a "more local" backend for temporary editing.
286 ;; * checkin (files rev comment)
288 ;; Commit changes in FILES to this backend. If REV is non-nil, that
289 ;; should become the new revision number (not all backends do
290 ;; anything with it). COMMENT is used as a check-in comment. The
291 ;; implementation should pass the value of vc-checkin-switches to
292 ;; the backend command. (Note: in older versions of VC, this
293 ;; command took a single file argument and not a list.)
295 ;; * find-revision (file rev buffer)
297 ;; Fetch revision REV of file FILE and put it into BUFFER.
298 ;; If REV is the empty string, fetch the head of the trunk.
299 ;; The implementation should pass the value of vc-checkout-switches
300 ;; to the backend command.
302 ;; * checkout (file &optional editable rev)
304 ;; Check out revision REV of FILE into the working area. If EDITABLE
305 ;; is non-nil, FILE should be writable by the user and if locking is
306 ;; used for FILE, a lock should also be set. If REV is non-nil, that
307 ;; is the revision to check out (default is the working revision).
308 ;; If REV is t, that means to check out the head of the current branch;
309 ;; if it is the empty string, check out the head of the trunk.
310 ;; The implementation should pass the value of vc-checkout-switches
311 ;; to the backend command.
313 ;; * revert (file &optional contents-done)
315 ;; Revert FILE back to the working revision. If optional
316 ;; arg CONTENTS-DONE is non-nil, then the contents of FILE have
317 ;; already been reverted from a version backup, and this function
318 ;; only needs to update the status of FILE within the backend.
320 ;; - rollback (files)
322 ;; Remove the tip revision of each of FILES from the repository. If
323 ;; this function is not provided, trying to cancel a revision is
324 ;; caught as an error. (Most backends don't provide it.) (Also
325 ;; note that older versions of this backend command were called
326 ;; 'cancel-version' and took a single file arg, not a list of
329 ;; - merge (file rev1 rev2)
331 ;; Merge the changes between REV1 and REV2 into the current working file.
333 ;; - merge-news (file)
335 ;; Merge recent changes from the current branch into FILE.
337 ;; - steal-lock (file &optional revision)
339 ;; Steal any lock on the working revision of FILE, or on REVISION if
340 ;; that is provided. This function is only needed if locking is
341 ;; used for files under this backend, and if files can indeed be
342 ;; locked by other users.
344 ;; - modify-change-comment (files rev comment)
346 ;; Modify the change comments associated with the files at the
347 ;; given revision. This is optional, many backends do not support it.
349 ;; - mark-resolved (files)
351 ;; Mark conflicts as resolved. Some VC systems need to run a
352 ;; command to mark conflicts as resolved.
356 ;; * print-log (files &optional buffer)
358 ;; Insert the revision log for FILES into BUFFER, or the *vc* buffer
359 ;; if BUFFER is nil. (Note: older versions of this function expected
360 ;; only a single file argument.)
362 ;; - log-view-mode ()
364 ;; Mode to use for the output of print-log. This defaults to
365 ;; `log-view-mode' and is expected to be changed (if at all) to a derived
366 ;; mode of `log-view-mode'.
368 ;; - show-log-entry (revision)
370 ;; If provided, search the log entry for REVISION in the current buffer,
371 ;; and make sure it is displayed in the buffer's window. The default
372 ;; implementation of this function works for RCS-style logs.
374 ;; - comment-history (file)
376 ;; Return a string containing all log entries that were made for FILE.
377 ;; This is used for transferring a file from one backend to another,
378 ;; retaining comment information.
380 ;; - update-changelog (files)
382 ;; Using recent log entries, create ChangeLog entries for FILES, or for
383 ;; all files at or below the default-directory if FILES is nil. The
384 ;; default implementation runs rcs2log, which handles RCS- and
387 ;; * diff (files &optional rev1 rev2 buffer)
389 ;; Insert the diff for FILE into BUFFER, or the *vc-diff* buffer if
390 ;; BUFFER is nil. If REV1 and REV2 are non-nil, report differences
391 ;; from REV1 to REV2. If REV1 is nil, use the working revision (as
392 ;; found in the repository) as the older revision; if REV2 is nil,
393 ;; use the current working-copy contents as the newer revision. This
394 ;; function should pass the value of (vc-switches BACKEND 'diff) to
395 ;; the backend command. It should return a status of either 0 (no
396 ;; differences found), or 1 (either non-empty diff or the diff is
397 ;; run asynchronously).
399 ;; - revision-completion-table (files)
401 ;; Return a completion table for existing revisions of FILES.
402 ;; The default is to not use any completion table.
404 ;; - annotate-command (file buf &optional rev)
406 ;; If this function is provided, it should produce an annotated display
407 ;; of FILE in BUF, relative to revision REV. Annotation means each line
408 ;; of FILE displayed is prefixed with version information associated with
409 ;; its addition (deleted lines leave no history) and that the text of the
410 ;; file is fontified according to age.
412 ;; - annotate-time ()
414 ;; Only required if `annotate-command' is defined for the backend.
415 ;; Return the time of the next line of annotation at or after point,
416 ;; as a floating point fractional number of days. The helper
417 ;; function `vc-annotate-convert-time' may be useful for converting
418 ;; multi-part times as returned by `current-time' and `encode-time'
419 ;; to this format. Return nil if no more lines of annotation appear
420 ;; in the buffer. You can safely assume that point is placed at the
421 ;; beginning of each line, starting at `point-min'. The buffer that
422 ;; point is placed in is the Annotate output, as defined by the
423 ;; relevant backend. This function also affects how much of the line
424 ;; is fontified; where it leaves point is where fontification begins.
426 ;; - annotate-current-time ()
428 ;; Only required if `annotate-command' is defined for the backend,
429 ;; AND you'd like the current time considered to be anything besides
430 ;; (vc-annotate-convert-time (current-time)) -- i.e. the current
431 ;; time with hours, minutes, and seconds included. Probably safe to
432 ;; ignore. Return the current-time, in units of fractional days.
434 ;; - annotate-extract-revision-at-line ()
436 ;; Only required if `annotate-command' is defined for the backend.
437 ;; Invoked from a buffer in vc-annotate-mode, return the revision
438 ;; corresponding to the current line, or nil if there is no revision
439 ;; corresponding to the current line.
443 ;; - create-tag (dir name branchp)
445 ;; Attach the tag NAME to the state of the working copy. This
446 ;; should make sure that files are up-to-date before proceeding with
447 ;; the action. DIR can also be a file and if BRANCHP is specified,
448 ;; NAME should be created as a branch and DIR should be checked out
449 ;; under this new branch. The default implementation does not
450 ;; support branches but does a sanity check, a tree traversal and
451 ;; assigns the tag to each file.
453 ;; - retrieve-tag (dir name update)
455 ;; Retrieve the version tagged by NAME of all registered files at or below DIR.
456 ;; If UPDATE is non-nil, then update buffers of any files in the
457 ;; tag that are currently visited. The default implementation
458 ;; does a sanity check whether there aren't any uncommitted changes at
459 ;; or below DIR, and then performs a tree walk, using the `checkout'
460 ;; function to retrieve the corresponding revisions.
466 ;; Return DIR's "root" directory, that is, a parent directory of
467 ;; DIR for which the same backend as used for DIR applies. If no
468 ;; such parent exists, this function should return DIR.
470 ;; - make-version-backups-p (file)
472 ;; Return non-nil if unmodified repository revisions of FILE should be
473 ;; backed up locally. If this is done, VC can perform `diff' and
474 ;; `revert' operations itself, without calling the backend system. The
475 ;; default implementation always returns nil.
477 ;; - repository-hostname (dirname)
479 ;; Return the hostname that the backend will have to contact
480 ;; in order to operate on a file in DIRNAME. If the return value
481 ;; is nil, it means that the repository is local.
482 ;; This function is used in `vc-stay-local-p' which backends can use
483 ;; for their convenience.
485 ;; - previous-revision (file rev)
487 ;; Return the revision number that precedes REV for FILE, or nil if no such
490 ;; - next-revision (file rev)
492 ;; Return the revision number that follows REV for FILE, or nil if no such
495 ;; - check-headers ()
497 ;; Return non-nil if the current buffer contains any version headers.
499 ;; - clear-headers ()
501 ;; In the current buffer, reset all version headers to their unexpanded
502 ;; form. This function should be provided if the state-querying code
503 ;; for this backend uses the version headers to determine the state of
504 ;; a file. This function will then be called whenever VC changes the
505 ;; version control state in such a way that the headers would give
506 ;; wrong information.
508 ;; - delete-file (file)
510 ;; Delete FILE and mark it as deleted in the repository. If this
511 ;; function is not provided, the command `vc-delete-file' will
514 ;; - rename-file (old new)
516 ;; Rename file OLD to NEW, both in the working area and in the
517 ;; repository. If this function is not provided, the renaming
518 ;; will be done by (vc-delete-file old) and (vc-register new).
520 ;; - find-file-hook ()
522 ;; Operation called in current buffer when opening a file. This can
523 ;; be used by the backend to setup some local variables it might need.
525 ;; - find-file-not-found-hook ()
527 ;; Operation called in current buffer when opening a non-existing file.
528 ;; By default, this asks the user if she wants to check out the file.
532 ;; Return a menu keymap, the items in the keymap will appear at the
533 ;; end of the Version Control menu. The goal is to allow backends
534 ;; to specify extra menu items that appear in the VC menu. This way
535 ;; you can provide menu entries for functionality that is specific
536 ;; to your backend and which does not map to any of the VC generic
539 ;; - extra-status-menu ()
541 ;; Return a menu keymap, the items in the keymap will appear at the
542 ;; end of the VC Status menu. The goal is to allow backends to
543 ;; specify extra menu items that appear in the VC Status menu. This
544 ;; makes it possible to provide menu entries for functionality that
545 ;; is specific to a backend and which does not map to any of the VC
550 ;; - Get rid of the "master file" terminology.
552 ;; - Add key-binding for vc-delete-file.
556 ;; - deal with push/pull operations.
558 ;; - add a mechanism for editing the underlying VCS's list of files
559 ;; to be ignored, when that's possible.
561 ;;;; Primitives that need changing:
563 ;; - vc-update/vc-merge should deal with VC systems that don't
564 ;; update/merge on a file basis, but on a whole repository basis.
565 ;; vc-update and vc-merge assume the arguments are always files,
566 ;; they don't deal with directories. Make sure the *vc-dir* buffer
567 ;; is updated after these operations.
568 ;; At least bzr, git and hg should benefit from this.
570 ;;;; Improved branch and tag handling:
572 ;; - add a generic mechanism for remembering the current branch names,
573 ;; display the branch name in the mode-line. Replace
574 ;; vc-cvs-sticky-tag with that.
576 ;; - vc-create-tag and vc-retrieve-tag should update the
577 ;; buffers that might be visiting the affected files.
579 ;;;; Default Behavior:
581 ;; - do not default to RCS anymore when the current directory is not
582 ;; controlled by any VCS and the user does C-x v v
584 ;; - vc-responsible-backend should not return RCS if no backend
585 ;; declares itself responsible.
587 ;;;; Internal cleanups:
589 ;; - backends that care about vc-stay-local should try to take it into
590 ;; account for vc-dir. Is this likely to be useful??? YES!
592 ;; - vc-expand-dirs should take a backend parameter and only look for
593 ;; files managed by that backend.
595 ;; - Another important thing: merge all the status-like backend operations.
596 ;; We should remove dir-status, state, and dir-status-files, and
597 ;; replace them with just `status' which takes a fileset and a continuation
598 ;; (like dir-status) and returns a buffer in which the process(es) are run
599 ;; (or nil if it worked synchronously). Hopefully we can define the old
600 ;; 4 operations in term of this one.
604 ;; - when a file is in `conflict' state, turn on smerge-mode.
606 ;; - figure out what to do with conflicts that are not caused by the
607 ;; file contents, but by metadata or other causes. Example: File A
608 ;; gets renamed to B in one branch and to C in another and you merge
609 ;; the two branches. Or you locally add file FOO and then pull a
610 ;; change that also adds a new file FOO, ...
612 ;; - make it easier to write logs. Maybe C-x 4 a should add to the log
613 ;; buffer, if one is present, instead of adding to the ChangeLog.
615 ;; - When vc-next-action calls vc-checkin it could pre-fill the
616 ;; *VC-log* buffer with some obvious items: the list of files that
617 ;; were added, the list of files that were removed. If the diff is
618 ;; available, maybe it could even call something like
619 ;; `diff-add-change-log-entries-other-window' to create a detailed
620 ;; skeleton for the log...
622 ;; - The *vc-dir* buffer needs to be updated properly after VC
623 ;; operations on directories that change the file VC state.
625 ;; - most vc-dir backends need more work. They might need to
626 ;; provide custom headers, use the `extra' field and deal with all
627 ;; possible VC states.
629 ;; - add a function that calls vc-dir to `find-directory-functions'.
631 ;; - vc-diff, vc-annotate, etc. need to deal better with unregistered
632 ;; files. Now that unregistered and ignored files are shown in
633 ;; vc-dir, it is possible that these commands are called
634 ;; for unregistered/ignored files.
636 ;; - Using multiple backends needs work. Given a CVS directory with some
637 ;; files checked into git (but not all), using C-x v l to get a log file
638 ;; from a file only present in git, and then typing RET on some log entry,
639 ;; vc will bombs out because it wants to see the file being in CVS.
640 ;; Those logs should likely use a local variable to hardware the VC they
641 ;; are supposed to work with.
643 ;; - vc-dir-kill-dir-status-process should not be specific to dir-status,
644 ;; it should work for other async commands done through vc-do-command
647 ;; - vc-dir toolbar needs more icons.
649 ;; - vc-dir-menu-map-filter hook call needs to be moved to vc.el.
653 ;; - the *vc-dir* buffer is not updated correctly anymore after VC
654 ;; operations that change the file state.
659 (require 'vc-dispatcher
)
666 (unless (assoc 'vc-parent-buffer minor-mode-alist
)
667 (setq minor-mode-alist
668 (cons '(vc-parent-buffer vc-parent-buffer-name
)
671 ;; General customization
674 "Version-control system in Emacs."
677 (defcustom vc-initial-comment nil
678 "If non-nil, prompt for initial comment when a file is registered."
682 (defcustom vc-default-init-revision
"1.1"
683 "A string used as the default revision number when a new file is registered.
684 This can be overridden by giving a prefix argument to \\[vc-register]. This
685 can also be overridden by a particular VC backend."
690 (defcustom vc-checkin-switches nil
691 "A string or list of strings specifying extra switches for checkin.
692 These are passed to the checkin program by \\[vc-checkin]."
693 :type
'(choice (const :tag
"None" nil
)
694 (string :tag
"Argument String")
695 (repeat :tag
"Argument List"
700 (defcustom vc-checkout-switches nil
701 "A string or list of strings specifying extra switches for checkout.
702 These are passed to the checkout program by \\[vc-checkout]."
703 :type
'(choice (const :tag
"None" nil
)
704 (string :tag
"Argument String")
705 (repeat :tag
"Argument List"
710 (defcustom vc-register-switches nil
711 "A string or list of strings; extra switches for registering a file.
712 These are passed to the checkin program by \\[vc-register]."
713 :type
'(choice (const :tag
"None" nil
)
714 (string :tag
"Argument String")
715 (repeat :tag
"Argument List"
720 (defcustom vc-diff-switches nil
721 "A string or list of strings specifying switches for diff under VC.
722 When running diff under a given BACKEND, VC concatenates the values of
723 `diff-switches', `vc-diff-switches', and `vc-BACKEND-diff-switches' to
724 get the switches for that command. Thus, `vc-diff-switches' should
725 contain switches that are specific to version control, but not
726 specific to any particular backend."
727 :type
'(choice (const :tag
"None" nil
)
728 (string :tag
"Argument String")
729 (repeat :tag
"Argument List"
735 (defcustom vc-diff-knows-L nil
736 "*Indicates whether diff understands the -L option.
737 The value is either `yes', `no', or nil. If it is nil, VC tries
738 to use -L and sets this variable to remember whether it worked."
739 :type
'(choice (const :tag
"Work out" nil
) (const yes
) (const no
))
742 (defcustom vc-allow-async-revert nil
743 "Specifies whether the diff during \\[vc-revert] may be asynchronous.
744 Enabling this option means that you can confirm a revert operation even
745 if the local changes in the file have not been found and displayed yet."
746 :type
'(choice (const :tag
"No" nil
)
747 (const :tag
"Yes" t
))
752 (defcustom vc-checkout-hook nil
753 "Normal hook (list of functions) run after checking out a file.
760 (defcustom vc-checkin-hook nil
761 "Normal hook (list of functions) run after commit or file checkin.
762 See also `log-edit-done-hook'."
764 :options
'(log-edit-comment-to-change-log)
768 (defcustom vc-before-checkin-hook nil
769 "Normal hook (list of functions) run before a commit or a file checkin.
774 ;; Header-insertion hair
776 (defcustom vc-static-header-alist
778 "\n#ifndef lint\nstatic char vcid[] = \"\%s\";\n#endif /* lint */\n"))
779 "*Associate static header string templates with file types.
780 A \%s in the template is replaced with the first string associated with
781 the file's version control type in `vc-header-alist'."
782 :type
'(repeat (cons :format
"%v"
783 (regexp :tag
"File Type")
784 (string :tag
"Header String")))
787 (defcustom vc-comment-alist
788 '((nroff-mode ".\\\"" ""))
789 "*Special comment delimiters for generating VC headers.
790 Add an entry in this list if you need to override the normal `comment-start'
791 and `comment-end' variables. This will only be necessary if the mode language
792 is sensitive to blank lines."
793 :type
'(repeat (list :format
"%v"
795 (string :tag
"Comment Start")
796 (string :tag
"Comment End")))
799 (defcustom vc-checkout-carefully
(= (user-uid) 0)
800 "*Non-nil means be extra-careful in checkout.
801 Verify that the file really is not locked
802 and that its contents match what the master file says."
805 (make-obsolete-variable 'vc-checkout-carefully
806 "the corresponding checks are always done now."
810 ;; Variables users don't need to see
812 (defvar vc-disable-async-diff nil
813 "VC sets this to t locally to disable some async diff operations.
814 Backends that offer asynchronous diffs should respect this variable
815 in their implementation of vc-BACKEND-diff.")
817 ;; File property caching
819 (defun vc-clear-context ()
820 "Clear all cached file properties."
822 (fillarray vc-file-prop-obarray
0))
824 (defmacro with-vc-properties
(files form settings
)
825 "Execute FORM, then maybe set per-file properties for FILES.
826 SETTINGS is an association list of property/value pairs. After
827 executing FORM, set those properties from SETTINGS that have not yet
828 been updated to their corresponding values."
830 `(let ((vc-touched-properties (list t
)))
832 (dolist (file ,files
)
833 (dolist (setting ,settings
)
834 (let ((property (car setting
)))
835 (unless (memq property vc-touched-properties
)
836 (put (intern file vc-file-prop-obarray
)
837 property
(cdr setting
))))))))
839 ;;; Code for deducing what fileset and backend to assume
841 (defun vc-responsible-backend (file &optional register
)
842 "Return the name of a backend system that is responsible for FILE.
843 The optional argument REGISTER means that a backend suitable for
844 registration should be found.
846 If REGISTER is nil, then if FILE is already registered, return the
847 backend of FILE. If FILE is not registered, or a directory, then the
848 first backend in `vc-handled-backends' that declares itself
849 responsible for FILE is returned. If no backend declares itself
850 responsible, return the first backend.
852 If REGISTER is non-nil, return the first responsible backend under
853 which FILE is not yet registered. If there is no such backend, return
854 the first backend under which FILE is not yet registered, but could
856 (when (not vc-handled-backends
)
857 (error "No handled backends"))
858 (or (and (not (file-directory-p file
)) (not register
) (vc-backend file
))
860 ;; First try: find a responsible backend. If this is for registration,
861 ;; it must be a backend under which FILE is not yet registered.
862 (dolist (backend vc-handled-backends
)
863 (and (or (not register
)
864 (not (vc-call-backend backend
'registered file
)))
865 (vc-call-backend backend
'responsible-p file
)
866 (throw 'found backend
)))
867 ;; no responsible backend
869 ;; if this is not for registration, the first backend must do
870 (car vc-handled-backends
)
871 ;; for registration, we need to find a new backend that
872 ;; could register FILE
873 (dolist (backend vc-handled-backends
)
874 (and (not (vc-call-backend backend
'registered file
))
875 (vc-call-backend backend
'could-register file
)
876 (throw 'found backend
)))
877 (error "No backend that could register")))))
879 (defun vc-expand-dirs (file-or-dir-list)
880 "Expands directories in a file list specification.
881 Within directories, only files already under version control are noticed."
882 (let ((flattened '()))
883 (dolist (node file-or-dir-list
)
884 (when (file-directory-p node
)
886 node
(lambda (f) (when (vc-backend f
) (push f flattened
)))))
887 (unless (file-directory-p node
) (push node flattened
)))
888 (nreverse flattened
)))
890 (defun vc-derived-from-dir-mode (&optional buffer
)
891 "Are we in a VC-directory buffer, or do we have one as an ancestor?"
892 (let ((buffer (or buffer
(current-buffer))))
893 (cond ((derived-mode-p 'vc-dir-mode
) t
)
894 (vc-parent-buffer (vc-derived-from-dir-mode vc-parent-buffer
))
897 (defvar vc-dir-backend
)
899 ;; FIXME: this is not functional, commented out.
900 ;; (defun vc-deduce-fileset (&optional observer)
901 ;; "Deduce a set of files and a backend to which to apply an operation and
902 ;; the common state of the fileset. Return (BACKEND . FILESET)."
903 ;; (let* ((selection (vc-dispatcher-selection-set observer))
904 ;; (raw (car selection)) ;; Selection as user made it
905 ;; (cooked (cdr selection)) ;; Files only
906 ;; ;; FIXME: Store the backend in a buffer-local variable.
907 ;; (backend (if (vc-derived-from-dir-mode (current-buffer))
908 ;; ;; FIXME: this should use vc-dir-backend from
909 ;; ;; the *vc-dir* buffer.
910 ;; (vc-responsible-backend default-directory)
911 ;; (assert (and (= 1 (length raw))
912 ;; (not (file-directory-p (car raw)))))
913 ;; (vc-backend (car cooked)))))
914 ;; (cons backend selection)))
916 (declare-function vc-dir-child-files
"vc-dir" ())
917 (declare-function vc-dir-current-file
"vc-dir" ())
918 (declare-function vc-dir-marked-files
"vc-dir" ())
919 (declare-function vc-dir-marked-only-files
"vc-dir" ())
921 (defun vc-deduce-fileset (&optional observer allow-unregistered only-files
)
922 "Deduce a set of files and a backend to which to apply an operation.
924 Return (BACKEND FILESET FILESET-ONLY-FILES).
925 If we're in VC-dir mode, the fileset is the list of marked files.
926 Otherwise, if we're looking at a buffer visiting a version-controlled file,
927 the fileset is a singleton containing this file.
928 If none of these conditions is met, but ALLOW_UNREGISTERED is on and the
929 visited file is not registered, return a singleton fileset containing it.
930 Otherwise, throw an error.
931 ONLY-FILES if non-nil, means that the caller needs to FILESET-ONLY-FILES
932 info. Otherwise, that part may be skipped.
933 BEWARE: this function may change the current buffer."
934 ;; FIXME: OBSERVER is unused. The name is not intuitive and is not
935 ;; documented. It's set to t when called from diff and print-log.
938 ((derived-mode-p 'vc-dir-mode
)
939 (let ((marked (vc-dir-marked-files)))
941 (list vc-dir-backend marked
942 (if only-files
(vc-dir-marked-only-files)))
943 (let ((crt (vc-dir-current-file)))
944 (list vc-dir-backend
(list crt
)
945 (if only-files
(vc-dir-child-files)))))))
946 ((setq backend
(vc-backend buffer-file-name
))
947 (list backend
(list buffer-file-name
) (list buffer-file-name
)))
948 ((and (buffer-live-p vc-parent-buffer
)
949 ;; FIXME: Why this test? --Stef
950 (or (buffer-file-name vc-parent-buffer
)
951 (with-current-buffer vc-parent-buffer
952 (eq major-mode
'vc-dir-mode
))))
953 (progn ;FIXME: Why not `with-current-buffer'? --Stef.
954 (set-buffer vc-parent-buffer
)
955 (vc-deduce-fileset observer allow-unregistered only-files
)))
956 ((not buffer-file-name
)
957 (error "Buffer %s is not associated with a file" (buffer-name)))
958 ((and allow-unregistered
(not (vc-registered buffer-file-name
)))
959 (list (vc-responsible-backend
960 (file-name-directory (buffer-file-name)))
961 (list buffer-file-name
) (list buffer-file-name
)))
962 (t (error "No fileset is available here.")))))
964 (defun vc-ensure-vc-buffer ()
965 "Make sure that the current buffer visits a version-controlled file."
967 ((vc-dispatcher-browsing)
968 (set-buffer (find-file-noselect (vc-dir-current-file))))
970 (while (and vc-parent-buffer
971 (buffer-live-p vc-parent-buffer
)
972 ;; Avoid infinite looping when vc-parent-buffer and
973 ;; current buffer are the same buffer.
974 (not (eq vc-parent-buffer
(current-buffer))))
975 (set-buffer vc-parent-buffer
))
976 (if (not buffer-file-name
)
977 (error "Buffer %s is not associated with a file" (buffer-name))
978 (unless (vc-backend buffer-file-name
)
979 (error "File %s is not under version control" buffer-file-name
))))))
981 ;;; Support for the C-x v v command.
982 ;; This is where all the single-file-oriented code from before the fileset
985 (defsubst vc-editable-p
(file)
986 "Return non-nil if FILE can be edited."
987 (let ((backend (vc-backend file
)))
989 (or (eq (vc-checkout-model backend
(list file
)) 'implicit
)
990 (memq (vc-state file
) '(edited needs-merge conflict
))))))
992 (defun vc-compatible-state (p q
)
993 "Controls which states can be in the same commit."
996 (and (member p
'(edited added removed
)) (member q
'(edited added removed
)))))
998 ;; Here's the major entry point.
1001 (defun vc-next-action (verbose)
1002 "Do the next logical version control operation on the current fileset.
1003 This requires that all files in the fileset be in the same state.
1005 For locking systems:
1006 If every file is not already registered, this registers each for version
1008 If every file is registered and not locked by anyone, this checks out
1009 a writable and locked file of each ready for editing.
1010 If every file is checked out and locked by the calling user, this
1011 first checks to see if each file has changed since checkout. If not,
1012 it performs a revert on that file.
1013 If every file has been changed, this pops up a buffer for entry
1014 of a log message; when the message has been entered, it checks in the
1015 resulting changes along with the log message as change commentary. If
1016 the variable `vc-keep-workfiles' is non-nil (which is its default), a
1017 read-only copy of each changed file is left in place afterwards.
1018 If the affected file is registered and locked by someone else, you are
1019 given the option to steal the lock(s).
1021 For merging systems:
1022 If every file is not already registered, this registers each one for version
1023 control. This does an add, but not a commit.
1024 If every file is added but not committed, each one is committed.
1025 If every working file is changed, but the corresponding repository file is
1026 unchanged, this pops up a buffer for entry of a log message; when the
1027 message has been entered, it checks in the resulting changes along
1028 with the logmessage as change commentary. A writable file is retained.
1029 If the repository file is changed, you are asked if you want to
1030 merge in the changes into your working copy."
1032 (let* ((vc-fileset (vc-deduce-fileset nil t
'only-files
))
1033 (backend (car vc-fileset
))
1034 (files (nth 1 vc-fileset
))
1035 (fileset-only-files (nth 2 vc-fileset
))
1036 ;; FIXME: We used to call `vc-recompute-state' here.
1037 (state (vc-state (car fileset-only-files
)))
1038 ;; The backend should check that the checkout-model is consistent
1039 ;; among all the `files'.
1041 ;; FIXME: This is not very elegant...
1042 (when (and state
(not (eq state
'unregistered
)))
1043 (vc-checkout-model backend files
)))
1046 ;; Check that all files are in a consistent state, since we use that
1047 ;; state to decide which operation to perform.
1048 (dolist (file (cdr fileset-only-files
))
1049 (unless (vc-compatible-state (vc-state file
) state
)
1050 (error "%s:%s clashes with %s:%s"
1051 file
(vc-state file
) (car fileset-only-files
) state
)))
1053 ;; Do the right thing
1055 ((eq state
'missing
)
1056 (error "Fileset files are missing, so cannot be operated on."))
1057 ((eq state
'ignored
)
1058 (error "Fileset files are ignored by the version-control system."))
1059 ((or (null state
) (eq state
'unregistered
))
1060 (vc-register nil vc-fileset
))
1061 ;; Files are up-to-date, or need a merge and user specified a revision
1062 ((or (eq state
'up-to-date
) (and verbose
(eq state
'needs-update
)))
1065 ;; go to a different revision
1066 (setq revision
(read-string "Branch, revision, or backend to move to: "))
1067 (let ((vsym (intern-soft (upcase revision
))))
1068 (if (member vsym vc-handled-backends
)
1069 (dolist (file files
) (vc-transfer-file file vsym
))
1070 (dolist (file files
)
1071 (vc-checkout file
(eq model
'implicit
) revision
)))))
1072 ((not (eq model
'implicit
))
1073 ;; check the files out
1074 (dolist (file files
) (vc-checkout file t
)))
1077 (message "Fileset is up-to-date"))))
1078 ;; Files have local changes
1079 ((vc-compatible-state state
'edited
)
1080 (let ((ready-for-commit files
))
1081 ;; If files are edited but read-only, give user a chance to correct
1082 (dolist (file files
)
1083 (unless (file-writable-p file
)
1084 ;; Make the file+buffer read-write.
1085 (unless (y-or-n-p (format "%s is edited but read-only; make it writable and continue?" file
))
1087 (set-file-modes file
(logior (file-modes file
) 128))
1088 (let ((visited (get-file-buffer file
)))
1090 (with-current-buffer visited
1091 (toggle-read-only -
1))))))
1092 ;; Allow user to revert files with no changes
1094 (dolist (file files
)
1095 (let ((visited (get-file-buffer file
)))
1096 ;; For files with locking, if the file does not contain
1097 ;; any changes, just let go of the lock, i.e. revert.
1098 (when (and (not (eq model
'implicit
))
1099 (vc-workfile-unchanged-p file
)
1100 ;; If buffer is modified, that means the user just
1101 ;; said no to saving it; in that case, don't revert,
1102 ;; because the user might intend to save after
1103 ;; finishing the log entry and committing.
1104 (not (and visited
(buffer-modified-p))))
1105 (vc-revert-file file
)
1106 (delete file ready-for-commit
)))))
1107 ;; Remaining files need to be committed
1108 (if (not ready-for-commit
)
1109 (message "No files remain to be committed")
1111 (vc-checkin ready-for-commit
)
1113 (setq revision
(read-string "New revision or backend: "))
1114 (let ((vsym (intern (upcase revision
))))
1115 (if (member vsym vc-handled-backends
)
1116 (dolist (file files
) (vc-transfer-file file vsym
))
1117 (vc-checkin ready-for-commit revision
))))))))
1118 ;; locked by somebody else (locking VCSes only)
1120 ;; In the old days, we computed the revision once and used it on
1121 ;; the single file. Then, for the 2007-2008 fileset rewrite, we
1122 ;; computed the revision once (incorrectly, using a free var) and
1123 ;; used it on all files. To fix the free var bug, we can either
1124 ;; use `(car files)' or do what we do here: distribute the
1125 ;; revision computation among `files'. Although this may be
1126 ;; tedious for those backends where a "revision" is a trans-file
1127 ;; concept, it is nonetheless correct for both those and (more
1128 ;; importantly) for those where "revision" is a per-file concept.
1129 ;; If the intersection of the former group and "locking VCSes" is
1130 ;; non-empty [I vaguely doubt it --ttn], we can reinstate the
1131 ;; pre-computation approach of yore.
1132 (dolist (file files
)
1135 (read-string (format "%s revision to steal: " file
))
1136 (vc-working-revision file
))
1139 ((eq state
'conflict
)
1140 ;; FIXME: Is it really the UI we want to provide?
1141 ;; In my experience, the conflicted files should be marked as resolved
1142 ;; one-by-one when saving the file after resolving the conflicts.
1143 ;; I.e. stating explicitly that the conflicts are resolved is done
1145 (vc-mark-resolved backend files
))
1147 ((eq state
'needs-update
)
1148 (dolist (file files
)
1149 (if (yes-or-no-p (format
1150 "%s is not up-to-date. Get latest revision? "
1151 (file-name-nondirectory file
)))
1152 (vc-checkout file
(eq model
'implicit
) t
)
1153 (when (and (not (eq model
'implicit
))
1154 (yes-or-no-p "Lock this revision? "))
1155 (vc-checkout file t
)))))
1157 ((eq state
'needs-merge
)
1158 (dolist (file files
)
1159 (when (yes-or-no-p (format
1160 "%s is not up-to-date. Merge in changes now? "
1161 (file-name-nondirectory file
)))
1162 (vc-maybe-resolve-conflicts
1163 file
(vc-call-backend backend
'merge-news file
)))))
1166 ((eq state
'unlocked-changes
)
1167 (dolist (file files
)
1168 (when (not (equal buffer-file-name file
))
1169 (find-file-other-window file
))
1170 (if (save-window-excursion
1171 (vc-diff-internal nil
1172 (cons (car vc-fileset
) (cons (cadr vc-fileset
) (list file
)))
1173 (vc-working-revision file
) nil
)
1174 (goto-char (point-min))
1175 (let ((inhibit-read-only t
))
1177 (format "Changes to %s since last lock:\n\n" file
)))
1179 (yes-or-no-p (concat "File has unlocked changes. "
1180 "Claim lock retaining changes? ")))
1181 (progn (vc-call-backend backend
'steal-lock file
)
1182 (clear-visited-file-modtime)
1183 ;; Must clear any headers here because they wouldn't
1184 ;; show that the file is locked now.
1185 (vc-clear-headers file
)
1186 (write-file buffer-file-name
)
1187 (vc-mode-line file
))
1188 (if (not (yes-or-no-p
1189 "Revert to checked-in revision, instead? "))
1190 (error "Checkout aborted")
1191 (vc-revert-buffer-internal t t
)
1192 (vc-checkout file t
)))))
1193 ;; Unknown fileset state
1195 (error "Fileset is in an unknown state %s" state
)))))
1197 (defun vc-create-repo (backend)
1198 "Create an empty repository in the current directory."
1204 "Create repository for: "
1205 (mapcar (lambda (b) (list (downcase (symbol-name b
)))) vc-handled-backends
)
1207 (vc-call-backend backend
'create-repo
))
1210 (defun vc-register (&optional set-revision vc-fileset comment
)
1211 "Register into a version control system.
1212 If VC-FILESET is given, register the files in that fileset.
1213 Otherwise register the current file.
1214 With prefix argument SET-REVISION, allow user to specify initial revision
1215 level. If COMMENT is present, use that as an initial comment.
1217 The version control system to use is found by cycling through the list
1218 `vc-handled-backends'. The first backend in that list which declares
1219 itself responsible for the file (usually because other files in that
1220 directory are already registered under that backend) will be used to
1221 register the file. If no backend declares itself responsible, the
1222 first backend that could register the file is used."
1224 (let* ((fileset-arg (or vc-fileset
(vc-deduce-fileset nil t
)))
1225 (backend (car fileset-arg
))
1226 (files (nth 1 fileset-arg
)))
1227 ;; We used to operate on `only-files', but VC wants to provide the
1228 ;; possibility to register directories rather than files only, since
1229 ;; many VCS allow that as well.
1230 (dolist (fname files
)
1231 (let ((bname (get-file-buffer fname
)))
1232 (unless fname
(setq fname buffer-file-name
))
1233 (when (vc-backend fname
)
1234 (if (vc-registered fname
)
1235 (error "This file is already registered")
1236 (unless (y-or-n-p "Previous master file has vanished. Make a new one? ")
1237 (error "Aborted"))))
1238 ;; Watch out for new buffers of size 0: the corresponding file
1239 ;; does not exist yet, even though buffer-modified-p is nil.
1241 (with-current-buffer bname
1242 (when (and (not (buffer-modified-p))
1243 (zerop (buffer-size))
1244 (not (file-exists-p buffer-file-name
)))
1245 (set-buffer-modified-p t
))
1246 (vc-buffer-sync)))))
1247 (lexical-let ((backend backend
)
1252 (read-string (format "Initial revision level for %s: " files
))
1253 (vc-call-backend backend
'init-revision
))
1254 (or comment
(not vc-initial-comment
))
1256 "Enter initial comment."
1258 (lambda (files rev comment
)
1259 (message "Registering %s... " files
)
1260 (mapc 'vc-file-clearprops files
)
1261 (vc-call-backend backend
'register files rev comment
)
1262 (dolist (file files
)
1263 (vc-file-setprop file
'vc-backend backend
)
1264 ;; FIXME: This is wrong: it should set `backup-inhibited' in all
1265 ;; the buffers visiting files affected by this `vc-register', not
1266 ;; in the current-buffer.
1267 ;; (unless vc-make-backup-files
1268 ;; (make-local-variable 'backup-inhibited)
1269 ;; (setq backup-inhibited t))
1271 (message "Registering %s... done" files
))))))
1273 (defun vc-register-with (backend)
1274 "Register the current file with a specified back end."
1275 (interactive "SBackend: ")
1276 (when (not (member backend vc-handled-backends
))
1277 (error "Unknown back end."))
1278 (let ((vc-handled-backends (list backend
)))
1279 (call-interactively 'vc-register
)))
1281 (defun vc-checkout (file &optional writable rev
)
1282 "Retrieve a copy of the revision REV of FILE.
1283 If WRITABLE is non-nil, make sure the retrieved file is writable.
1284 REV defaults to the latest revision.
1286 After check-out, runs the normal hook `vc-checkout-hook'."
1289 (vc-call make-version-backups-p file
)
1290 (vc-up-to-date-p file
)
1291 (vc-make-version-backup file
))
1292 (let ((backend (vc-backend file
)))
1293 (with-vc-properties (list file
)
1295 (vc-call-backend backend
'checkout file writable rev
)
1297 ;; Maybe the backend is not installed ;-(
1299 (let ((buf (get-file-buffer file
)))
1300 (when buf
(with-current-buffer buf
(toggle-read-only -
1)))))
1301 (signal (car err
) (cdr err
))))
1302 `((vc-state .
,(if (or (eq (vc-checkout-model backend
(list file
)) 'implicit
)
1304 (if (vc-call-backend backend
'latest-on-branch-p file
)
1308 (vc-checkout-time .
,(nth 5 (file-attributes file
))))))
1309 (vc-resynch-buffer file t t
)
1310 (run-hooks 'vc-checkout-hook
))
1312 (defun vc-mark-resolved (backend files
)
1315 (vc-call-backend backend
'mark-resolved files
)
1316 ;; XXX: Is this TRTD? Might not be.
1317 `((vc-state . edited
))))
1319 (defun vc-steal-lock (file rev owner
)
1320 "Steal the lock on FILE."
1321 (let (file-description)
1323 (setq file-description
(format "%s:%s" file rev
))
1324 (setq file-description file
))
1325 (when (not (yes-or-no-p (format "Steal the lock on %s from %s? "
1326 file-description owner
)))
1327 (error "Steal canceled"))
1328 (message "Stealing lock on %s..." file
)
1331 (vc-call steal-lock file rev
)
1332 `((vc-state . edited
)))
1333 (vc-resynch-buffer file t t
)
1334 (message "Stealing lock on %s...done" file
)
1335 ;; Write mail after actually stealing, because if the stealing
1336 ;; goes wrong, we don't want to send any mail.
1337 (compose-mail owner
(format "Stolen lock on %s" file-description
))
1338 (setq default-directory
(expand-file-name "~/"))
1339 (goto-char (point-max))
1341 (format "I stole the lock on %s, " file-description
)
1342 (current-time-string)
1344 (message "Please explain why you stole the lock. Type C-c C-c when done.")))
1346 (defun vc-checkin (files &optional rev comment initial-contents
)
1348 The optional argument REV may be a string specifying the new revision
1349 level (if nil increment the current level). COMMENT is a comment
1350 string; if omitted, a buffer is popped up to accept a comment. If
1351 INITIAL-CONTENTS is non-nil, then COMMENT is used as the initial contents
1352 of the log entry buffer.
1354 If `vc-keep-workfiles' is nil, FILE is deleted afterwards, provided
1355 that the version control system supports this mode of operation.
1357 Runs the normal hooks `vc-before-checkin-hook' and `vc-checkin-hook'."
1358 (when vc-before-checkin-hook
1359 (run-hooks 'vc-before-checkin-hook
))
1361 files rev comment initial-contents
1362 "Enter a change comment."
1364 (lambda (files rev comment
)
1365 (message "Checking in %s..." (vc-delistify files
))
1366 ;; "This log message intentionally left almost blank".
1367 ;; RCS 5.7 gripes about white-space-only comments too.
1368 (or (and comment
(string-match "[^\t\n ]" comment
))
1369 (setq comment
"*** empty log message ***"))
1372 ;; We used to change buffers to get local value of vc-checkin-switches,
1373 ;; but 'the' local buffer is not a well-defined concept for filesets.
1375 (vc-call checkin files rev comment
)
1376 (mapc 'vc-delete-automatic-version-backups files
))
1377 `((vc-state . up-to-date
)
1378 (vc-checkout-time .
,(nth 5 (file-attributes file
)))
1379 (vc-working-revision . nil
)))
1380 (message "Checking in %s...done" (vc-delistify files
)))
1383 ;;; Additional entry points for examining version histories
1385 ;; (defun vc-default-diff-tree (backend dir rev1 rev2)
1386 ;; "List differences for all registered files at and below DIR.
1387 ;; The meaning of REV1 and REV2 is the same as for `vc-revision-diff'."
1388 ;; ;; This implementation does an explicit tree walk, and calls
1389 ;; ;; vc-BACKEND-diff directly for each file. An optimization
1390 ;; ;; would be to use `vc-diff-internal', so that diffs can be local,
1391 ;; ;; and to call it only for files that are actually changed.
1392 ;; ;; However, this is expensive for some backends, and so it is left
1393 ;; ;; to backend-specific implementations.
1394 ;; (setq default-directory dir)
1395 ;; (vc-file-tree-walk
1396 ;; default-directory
1399 ;; `(let ((coding-system-for-read (vc-coding-system-for-diff ',f)))
1400 ;; (message "Looking at %s" ',f)
1401 ;; (vc-call-backend ',(vc-backend f)
1402 ;; 'diff (list ',f) ',rev1 ',rev2))))))
1404 (defun vc-coding-system-for-diff (file)
1405 "Return the coding system for reading diff output for FILE."
1406 (or coding-system-for-read
1407 ;; if we already have this file open,
1408 ;; use the buffer's coding system
1409 (let ((buf (find-buffer-visiting file
)))
1410 (when buf
(with-current-buffer buf
1411 buffer-file-coding-system
)))
1412 ;; otherwise, try to find one based on the file name
1413 (car (find-operation-coding-system 'insert-file-contents file
))
1414 ;; and a final fallback
1417 (defun vc-switches (backend op
)
1420 (let ((sym (vc-make-backend-sym
1421 backend
(intern (concat (symbol-name op
)
1423 (when (boundp sym
) (symbol-value sym
))))
1424 (let ((sym (intern (format "vc-%s-switches" (symbol-name op
)))))
1425 (when (boundp sym
) (symbol-value sym
)))
1427 ((eq op
'diff
) diff-switches
)))))
1428 (if (stringp switches
) (list switches
)
1429 ;; If not a list, return nil.
1430 ;; This is so we can set vc-diff-switches to t to override
1431 ;; any switches in diff-switches.
1432 (when (listp switches
) switches
))))
1434 ;; Old def for compatibility with Emacs-21.[123].
1435 (defmacro vc-diff-switches-list
(backend) `(vc-switches ',backend
'diff
))
1436 (make-obsolete 'vc-diff-switches-list
'vc-switches
"22.1")
1438 (defun vc-diff-finish (buffer messages
)
1439 ;; The empty sync output case has already been handled, so the only
1440 ;; possibility of an empty output is for an async process.
1441 (when (buffer-live-p buffer
)
1442 (let ((window (get-buffer-window buffer t
))
1443 (emptyp (zerop (buffer-size buffer
))))
1444 (with-current-buffer buffer
1445 (and messages emptyp
1446 (let ((inhibit-read-only t
))
1447 (insert (cdr messages
) ".\n")
1448 (message "%s" (cdr messages
))))
1449 (goto-char (point-min))
1451 (shrink-window-if-larger-than-buffer window
)))
1452 (when (and messages
(not emptyp
))
1453 (message "%sdone" (car messages
))))))
1455 (defvar vc-diff-added-files nil
1456 "If non-nil, diff added files by comparing them to /dev/null.")
1458 (defun vc-diff-internal (async vc-fileset rev1 rev2
&optional verbose
)
1459 "Report diffs between two revisions of a fileset.
1460 Diff output goes to the *vc-diff* buffer. The function
1461 returns t if the buffer had changes, nil otherwise."
1462 (let* ((files (cadr vc-fileset
))
1463 (messages (cons (format "Finding changes in %s..."
1464 (vc-delistify files
))
1465 (format "No changes between %s and %s"
1466 (or rev1
"working revision")
1467 (or rev2
"workfile"))))
1468 ;; Set coding system based on the first file. It's a kluge,
1469 ;; but the only way to set it for each file included would
1470 ;; be to call the back end separately for each file.
1471 (coding-system-for-read
1472 (if files
(vc-coding-system-for-diff (car files
)) 'undecided
)))
1473 (vc-setup-buffer "*vc-diff*")
1474 (message "%s" (car messages
))
1475 ;; Many backends don't handle well the case of a file that has been
1476 ;; added but not yet committed to the repo (notably CVS and Subversion).
1477 ;; Do that work here so the backends don't have to futz with it. --ESR
1479 ;; Actually most backends (including CVS) have options to control the
1480 ;; behavior since which one is better depends on the user and on the
1481 ;; situation). Worse yet: this code does not handle the case where
1482 ;; `file' is a directory which contains added files.
1483 ;; I made it conditional on vc-diff-added-files but it should probably
1484 ;; just be removed (or copied/moved to specific backends). --Stef.
1485 (when vc-diff-added-files
1486 (let ((filtered '()))
1487 (dolist (file files
)
1488 (if (or (file-directory-p file
)
1489 (not (string= (vc-working-revision file
) "0")))
1490 (push file filtered
)
1491 ;; This file is added but not yet committed;
1492 ;; there is no master file to diff against.
1494 (error "No revisions of %s exist" file
)
1495 ;; We regard this as "changed".
1496 ;; Diff it against /dev/null.
1497 (apply 'vc-do-command
"*vc-diff*"
1499 (append (vc-switches nil
'diff
) '("/dev/null"))))))
1500 (setq files
(nreverse filtered
))))
1501 (let ((vc-disable-async-diff (not async
)))
1502 (vc-call-backend (car vc-fileset
) 'diff files rev1 rev2
"*vc-diff*"))
1503 (set-buffer "*vc-diff*")
1504 (if (and (zerop (buffer-size))
1505 (not (get-buffer-process (current-buffer))))
1506 ;; Treat this case specially so as not to pop the buffer.
1508 (message "%s" (cdr messages
))
1511 ;; Make the *vc-diff* buffer read only, the diff-mode key
1512 ;; bindings are nicer for read only buffers. pcl-cvs does the
1514 (setq buffer-read-only t
)
1515 (vc-exec-after `(vc-diff-finish ,(current-buffer) ',(when verbose
1517 ;; Display the buffer, but at the end because it can change point.
1518 (pop-to-buffer (current-buffer))
1519 ;; In the async case, we return t even if there are no differences
1520 ;; because we don't know that yet.
1524 (defun vc-version-diff (files rev1 rev2
)
1525 "Report diffs between revisions of the fileset in the repository history."
1527 (let* ((vc-fileset (vc-deduce-fileset t
)) ;FIXME: why t? --Stef
1528 (files (cadr vc-fileset
))
1529 (backend (car vc-fileset
))
1532 (vc-call-backend backend
'revision-completion-table files
))
1536 ;; someday we may be able to do revision completion on non-singleton
1537 ;; filesets, but not yet.
1538 ((/= (length files
) 1)
1540 ;; if it's a directory, don't supply any revision default
1541 ((file-directory-p first
)
1543 ;; if the file is not up-to-date, use working revision as older revision
1544 ((not (vc-up-to-date-p first
))
1545 (setq rev1-default
(vc-working-revision first
)))
1546 ;; if the file is not locked, use last and previous revisions as defaults
1548 (setq rev1-default
(vc-call-backend backend
'previous-revision first
1549 (vc-working-revision first
)))
1550 (when (string= rev1-default
"") (setq rev1-default nil
))
1551 (setq rev2-default
(vc-working-revision first
))))
1552 ;; construct argument list
1553 (let* ((rev1-prompt (if rev1-default
1554 (concat "Older revision (default "
1556 "Older revision: "))
1557 (rev2-prompt (concat "Newer revision (default "
1558 (or rev2-default
"current source") "): "))
1559 (rev1 (if completion-table
1560 (completing-read rev1-prompt completion-table
1561 nil nil nil nil rev1-default
)
1562 (read-string rev1-prompt nil nil rev1-default
)))
1563 (rev2 (if completion-table
1564 (completing-read rev2-prompt completion-table
1565 nil nil nil nil rev2-default
)
1566 (read-string rev2-prompt nil nil rev2-default
))))
1567 (when (string= rev1
"") (setq rev1 nil
))
1568 (when (string= rev2
"") (setq rev2 nil
))
1569 (list files rev1 rev2
))))
1570 ;; All that was just so we could do argument completion!
1571 (when (and (not rev1
) rev2
)
1572 (error "Not a valid revision range."))
1573 ;; Yes, it's painful to call (vc-deduce-fileset) again. Alas, the
1574 ;; placement rules for (interactive) don't actually leave us a choice.
1575 (vc-diff-internal t
(vc-deduce-fileset) rev1 rev2
(interactive-p)))
1577 ;; (defun vc-contains-version-controlled-file (dir)
1578 ;; "Return t if DIR contains a version-controlled file, nil otherwise."
1580 ;; (mapc (lambda (f) (and (not (file-directory-p f)) (vc-backend f) (throw 'found 't))) (directory-files dir))
1584 (defun vc-diff (historic &optional not-urgent
)
1585 "Display diffs between file revisions.
1586 Normally this compares the currently selected fileset with their
1587 working revisions. With a prefix argument HISTORIC, it reads two revision
1588 designators specifying which revisions to compare.
1590 The optional argument NOT-URGENT non-nil means it is ok to say no to
1592 (interactive (list current-prefix-arg t
))
1594 (call-interactively 'vc-version-diff
)
1595 (when buffer-file-name
(vc-buffer-sync not-urgent
))
1596 (vc-diff-internal t
(vc-deduce-fileset) nil nil
(interactive-p))))
1599 (defun vc-revision-other-window (rev)
1600 "Visit revision REV of the current file in another window.
1601 If the current file is named `F', the revision is named `F.~REV~'.
1602 If `F.~REV~' already exists, use it instead of checking it out again."
1604 (save-current-buffer
1605 (vc-ensure-vc-buffer)
1606 (let ((completion-table
1607 (vc-call revision-completion-table buffer-file-name
))
1608 (prompt "Revision to visit (default is working revision): "))
1610 (if completion-table
1611 (completing-read prompt completion-table
)
1612 (read-string prompt
))))))
1613 (vc-ensure-vc-buffer)
1614 (let* ((file buffer-file-name
)
1615 (revision (if (string-equal rev
"")
1616 (vc-working-revision file
)
1618 (switch-to-buffer-other-window (vc-find-revision file revision
))))
1620 (defun vc-find-revision (file revision
)
1621 "Read REVISION of FILE into a buffer and return the buffer."
1622 (let ((automatic-backup (vc-version-backup-file-name file revision
))
1623 (filebuf (or (get-file-buffer file
) (current-buffer)))
1624 (filename (vc-version-backup-file-name file revision
'manual
)))
1625 (unless (file-exists-p filename
)
1626 (if (file-exists-p automatic-backup
)
1627 (rename-file automatic-backup filename nil
)
1628 (message "Checking out %s..." filename
)
1629 (with-current-buffer filebuf
1632 (let ((coding-system-for-read 'no-conversion
)
1633 (coding-system-for-write 'no-conversion
))
1634 (with-temp-file filename
1635 (let ((outbuf (current-buffer)))
1636 ;; Change buffer to get local value of
1637 ;; vc-checkout-switches.
1638 (with-current-buffer filebuf
1639 (vc-call find-revision file revision outbuf
))))
1641 (when (and failed
(file-exists-p filename
))
1642 (delete-file filename
))))
1643 (vc-mode-line file
))
1644 (message "Checking out %s...done" filename
)))
1645 (let ((result-buf (find-file-noselect filename
)))
1646 (with-current-buffer result-buf
1647 ;; Set the parent buffer so that things like
1648 ;; C-x v g, C-x v l, ... etc work.
1649 (set (make-local-variable 'vc-parent-buffer
) filebuf
))
1652 ;; Header-insertion code
1655 (defun vc-insert-headers ()
1656 "Insert headers into a file for use with a version control system.
1657 Headers desired are inserted at point, and are pulled from
1658 the variable `vc-BACKEND-header'."
1660 (vc-ensure-vc-buffer)
1664 (when (or (not (vc-check-headers))
1665 (y-or-n-p "Version headers already exist. Insert another set? "))
1666 (let* ((delims (cdr (assq major-mode vc-comment-alist
)))
1667 (comment-start-vc (or (car delims
) comment-start
"#"))
1668 (comment-end-vc (or (car (cdr delims
)) comment-end
""))
1669 (hdsym (vc-make-backend-sym (vc-backend buffer-file-name
)
1671 (hdstrings (and (boundp hdsym
) (symbol-value hdsym
))))
1672 (dolist (s hdstrings
)
1673 (insert comment-start-vc
"\t" s
"\t"
1674 comment-end-vc
"\n"))
1675 (when vc-static-header-alist
1676 (dolist (f vc-static-header-alist
)
1677 (when (string-match (car f
) buffer-file-name
)
1678 (insert (format (cdr f
) (car hdstrings
)))))))))))
1680 (defun vc-clear-headers (&optional file
)
1681 "Clear all version headers in the current buffer (or FILE).
1682 The headers are reset to their non-expanded form."
1683 (let* ((filename (or file buffer-file-name
))
1684 (visited (find-buffer-visiting filename
))
1685 (backend (vc-backend filename
)))
1686 (when (vc-find-backend-function backend
'clear-headers
)
1688 (let ((context (vc-buffer-context)))
1689 ;; save-excursion may be able to relocate point and mark
1690 ;; properly. If it fails, vc-restore-buffer-context
1691 ;; will give it a second try.
1693 (vc-call-backend backend
'clear-headers
))
1694 (vc-restore-buffer-context context
))
1695 (set-buffer (find-file-noselect filename
))
1696 (vc-call-backend backend
'clear-headers
)
1697 (kill-buffer filename
)))))
1699 (defun vc-modify-change-comment (files rev oldcomment
)
1700 "Edit the comment associated with the given files and revision."
1702 files rev oldcomment t
1703 "Enter a replacement change comment."
1705 (lambda (files rev comment
)
1707 ;; Less of a kluge than it looks like; log-view mode only passes
1708 ;; this function a singleton list. Arguments left in this form in
1709 ;; case the more general operation ever becomes meaningful.
1710 (vc-responsible-backend (car files
))
1711 'modify-change-comment files rev comment
))))
1715 "Merge changes between two revisions into the current buffer's file.
1716 This asks for two revisions to merge from in the minibuffer. If the
1717 first revision is a branch number, then merge all changes from that
1718 branch. If the first revision is empty, merge news, i.e. recent changes
1719 from the current branch.
1721 See Info node `Merging'."
1723 (vc-ensure-vc-buffer)
1725 (let* ((file buffer-file-name
)
1726 (backend (vc-backend file
))
1727 (state (vc-state file
))
1728 first-revision second-revision status
)
1730 ((stringp state
) ;; Locking VCses only
1731 (error "File is locked by %s" state
))
1732 ((not (vc-editable-p file
))
1734 "File must be checked out for merging. Check out now? ")
1735 (vc-checkout file t
)
1736 (error "Merge aborted"))))
1737 (setq first-revision
1738 (read-string (concat "Branch or revision to merge from "
1739 "(default news on current branch): ")))
1740 (if (string= first-revision
"")
1741 (setq status
(vc-call-backend backend
'merge-news file
))
1742 (if (not (vc-find-backend-function backend
'merge
))
1743 (error "Sorry, merging is not implemented for %s" backend
)
1744 (if (not (vc-branch-p first-revision
))
1745 (setq second-revision
1746 (read-string "Second revision: "
1747 (concat (vc-branch-part first-revision
) ".")))
1748 ;; We want to merge an entire branch. Set revisions
1749 ;; accordingly, so that vc-BACKEND-merge understands us.
1750 (setq second-revision first-revision
)
1751 ;; first-revision must be the starting point of the branch
1752 (setq first-revision
(vc-branch-part first-revision
)))
1753 (setq status
(vc-call-backend backend
'merge file
1754 first-revision second-revision
))))
1755 (vc-maybe-resolve-conflicts file status
"WORKFILE" "MERGE SOURCE")))
1757 (defun vc-maybe-resolve-conflicts (file status
&optional name-A name-B
)
1758 (vc-resynch-buffer file t
(not (buffer-modified-p)))
1759 (if (zerop status
) (message "Merge successful")
1761 (message "File contains conflicts.")))
1764 (defalias 'vc-resolve-conflicts
'smerge-ediff
)
1766 ;; Named-configuration entry points
1768 (defun vc-tag-precondition (dir)
1769 "Scan the tree below DIR, looking for files not up-to-date.
1770 If any file is not up-to-date, return the name of the first such file.
1771 \(This means, neither tag creation nor retrieval is allowed.\)
1772 If one or more of the files are currently visited, return `visited'.
1773 Otherwise, return nil."
1775 (catch 'vc-locked-example
1779 (if (not (vc-up-to-date-p f
)) (throw 'vc-locked-example f
)
1780 (when (get-file-buffer f
) (setq status
'visited
)))))
1784 (defun vc-create-tag (dir name branchp
)
1785 "Descending recursively from DIR, make a tag called NAME.
1786 For each registered file, the working revision becomes part of
1787 the named configuration. If the prefix argument BRANCHP is
1788 given, the tag is made as a new branch and the files are
1789 checked out in that new branch."
1791 (list (read-file-name "Directory: " default-directory default-directory t
)
1792 (read-string "New tag name: ")
1793 current-prefix-arg
))
1794 (message "Making %s... " (if branchp
"branch" "tag"))
1795 (when (file-directory-p dir
) (setq dir
(file-name-as-directory dir
)))
1796 (vc-call-backend (vc-responsible-backend dir
)
1797 'create-tag dir name branchp
)
1798 (message "Making %s... done" (if branchp
"branch" "tag")))
1801 (defun vc-retrieve-tag (dir name
)
1802 "Descending recursively from DIR, retrieve the tag called NAME.
1803 If NAME is empty, it refers to the latest revisions.
1804 If locking is used for the files in DIR, then there must not be any
1805 locked files at or below DIR (but if NAME is empty, locked files are
1806 allowed and simply skipped)."
1808 (list (read-file-name "Directory: " default-directory default-directory t
)
1809 (read-string "Tag name to retrieve (default latest revisions): ")))
1810 (let ((update (yes-or-no-p "Update any affected buffers? "))
1811 (msg (if (or (not name
) (string= name
""))
1812 (format "Updating %s... " (abbreviate-file-name dir
))
1813 (format "Retrieving tag into %s... "
1814 (abbreviate-file-name dir
)))))
1816 (vc-call-backend (vc-responsible-backend dir
)
1817 'retrieve-tag dir name update
)
1818 (message "%s" (concat msg
"done"))))
1820 ;; Miscellaneous other entry points
1823 (defun vc-print-log (&optional working-revision
)
1824 "List the change log of the current fileset in a window.
1825 If WORKING-REVISION is non-nil, leave the point at that revision."
1827 (let* ((vc-fileset (vc-deduce-fileset t
)) ;FIXME: Why t? --Stef
1828 (backend (car vc-fileset
))
1829 (files (cadr vc-fileset
))
1830 (working-revision (or working-revision
(vc-working-revision (car files
)))))
1831 ;; Don't switch to the output buffer before running the command,
1832 ;; so that any buffer-local settings in the vc-controlled
1833 ;; buffer can be accessed by the command.
1834 (vc-call-backend backend
'print-log files
"*vc-change-log*")
1835 (pop-to-buffer "*vc-change-log*")
1837 `(let ((inhibit-read-only t
))
1838 (vc-call-backend ',backend
'log-view-mode
)
1839 (set (make-local-variable 'log-view-vc-backend
) ',backend
)
1840 (set (make-local-variable 'log-view-vc-fileset
) ',files
)
1841 (goto-char (point-max)) (forward-line -
1)
1842 (while (looking-at "=*\n")
1843 (delete-char (- (match-end 0) (match-beginning 0)))
1845 (goto-char (point-min))
1846 (when (looking-at "[\b\t\n\v\f\r ]+")
1847 (delete-char (- (match-end 0) (match-beginning 0))))
1848 (shrink-window-if-larger-than-buffer)
1849 ;; move point to the log entry for the working revision
1850 (vc-call-backend ',backend
'show-log-entry
',working-revision
)
1851 (setq vc-sentinel-movepoint
(point))
1852 (set-buffer-modified-p nil
)))))
1856 "Revert working copies of the selected fileset to their repository contents.
1857 This asks for confirmation if the buffer contents are not identical
1858 to the working revision (except for keyword expansion)."
1860 (let* ((vc-fileset (vc-deduce-fileset))
1861 (files (cadr vc-fileset
)))
1862 ;; If any of the files is visited by the current buffer, make
1863 ;; sure buffer is saved. If the user says `no', abort since
1864 ;; we cannot show the changes and ask for confirmation to
1866 (when (or (not files
) (memq (buffer-file-name) files
))
1867 (vc-buffer-sync nil
))
1868 (dolist (file files
)
1869 (let ((buf (get-file-buffer file
)))
1870 (when (and buf
(buffer-modified-p buf
))
1871 (error "Please kill or save all modified buffers before reverting.")))
1872 (when (vc-up-to-date-p file
)
1873 (unless (yes-or-no-p (format "%s seems up-to-date. Revert anyway? " file
))
1874 (error "Revert canceled"))))
1875 (when (vc-diff-internal vc-allow-async-revert vc-fileset nil nil
)
1876 (unless (yes-or-no-p (format "Discard changes in %s? " (vc-delistify files
)))
1877 (error "Revert canceled"))
1878 (delete-windows-on "*vc-diff*")
1879 (kill-buffer "*vc-diff*"))
1880 (dolist (file files
)
1881 (message "Reverting %s..." (vc-delistify files
))
1882 (vc-revert-file file
)
1883 (message "Reverting %s...done" (vc-delistify files
)))))
1886 (defun vc-rollback ()
1887 "Roll back (remove) the most recent changeset committed to the repository.
1888 This may be either a file-level or a repository-level operation,
1889 depending on the underlying version-control system."
1891 (let* ((vc-fileset (vc-deduce-fileset))
1892 (backend (car vc-fileset
))
1893 (files (cadr vc-fileset
))
1894 (granularity (vc-call-backend backend
'revision-granularity
)))
1895 (unless (vc-find-backend-function backend
'rollback
)
1896 (error "Rollback is not supported in %s" backend
))
1897 (when (and (not (eq granularity
'repository
)) (/= (length files
) 1))
1898 (error "Rollback requires a singleton fileset or repository versioning"))
1899 ;; FIXME: latest-on-branch-p should take the fileset.
1900 (when (not (vc-call-backend backend
'latest-on-branch-p
(car files
)))
1901 (error "Rollback is only possible at the tip revision."))
1902 ;; If any of the files is visited by the current buffer, make
1903 ;; sure buffer is saved. If the user says `no', abort since
1904 ;; we cannot show the changes and ask for confirmation to
1906 (when (or (not files
) (memq (buffer-file-name) files
))
1907 (vc-buffer-sync nil
))
1908 (dolist (file files
)
1909 (when (buffer-modified-p (get-file-buffer file
))
1910 (error "Please kill or save all modified buffers before rollback."))
1911 (when (not (vc-up-to-date-p file
))
1912 (error "Please revert all modified workfiles before rollback.")))
1913 ;; Accumulate changes associated with the fileset
1914 (vc-setup-buffer "*vc-diff*")
1916 (message "Finding changes...")
1917 (let* ((tip (vc-working-revision (car files
)))
1918 ;; FIXME: `previous-revision' should take the fileset.
1919 (previous (vc-call-backend backend
'previous-revision
1921 (vc-diff-internal nil vc-fileset previous tip
))
1923 (unless (yes-or-no-p "Discard these revisions? ")
1924 (error "Rollback canceled"))
1925 (delete-windows-on "*vc-diff*")
1926 (kill-buffer"*vc-diff*")
1927 ;; Do the actual reversions
1928 (message "Rolling back %s..." (vc-delistify files
))
1931 (vc-call-backend backend
'rollback files
)
1932 `((vc-state .
,'up-to-date
)
1933 (vc-checkout-time .
, (nth 5 (file-attributes file
)))
1934 (vc-working-revision . nil
)))
1935 (dolist (f files
) (vc-resynch-buffer f t t
))
1936 (message "Rolling back %s...done" (vc-delistify files
))))
1939 (define-obsolete-function-alias 'vc-revert-buffer
'vc-revert
"23.1")
1943 "Update the current fileset's files to their tip revisions.
1944 For each one that contains no changes, and is not locked, then this simply
1945 replaces the work file with the latest revision on its branch. If the file
1946 contains changes, and the backend supports merging news, then any recent
1947 changes from the current branch are merged into the working file."
1949 (let* ((vc-fileset (vc-deduce-fileset))
1950 (backend (car vc-fileset
))
1951 (files (cadr vc-fileset
)))
1952 (save-some-buffers ; save buffers visiting files
1954 (and (buffer-modified-p)
1955 (let ((file (buffer-file-name)))
1956 (and file
(member file files
))))))
1957 (dolist (file files
)
1958 (if (vc-up-to-date-p file
)
1959 (vc-checkout file nil t
)
1960 (if (eq (vc-checkout-model backend
(list file
)) 'locking
)
1961 (if (eq (vc-state file
) 'edited
)
1963 (substitute-command-keys
1964 "File is locked--type \\[vc-revert] to discard changes"))
1965 (error "Unexpected file state (%s) -- type %s"
1967 (substitute-command-keys
1968 "\\[vc-next-action] to correct")))
1969 (vc-maybe-resolve-conflicts
1970 file
(vc-call-backend backend
'merge-news file
)))))))
1972 (defun vc-version-backup-file (file &optional rev
)
1973 "Return name of backup file for revision REV of FILE.
1974 If version backups should be used for FILE, and there exists
1975 such a backup for REV or the working revision of file, return
1976 its name; otherwise return nil."
1977 (when (vc-call make-version-backups-p file
)
1978 (let ((backup-file (vc-version-backup-file-name file rev
)))
1979 (if (file-exists-p backup-file
)
1981 ;; there is no automatic backup, but maybe the user made one manually
1982 (setq backup-file
(vc-version-backup-file-name file rev
'manual
))
1983 (when (file-exists-p backup-file
)
1986 (defun vc-revert-file (file)
1987 "Revert FILE back to the repository working revision it was based on."
1990 (let ((backup-file (vc-version-backup-file file
)))
1992 (copy-file backup-file file
'ok-if-already-exists
'keep-date
)
1993 (vc-delete-automatic-version-backups file
))
1994 (vc-call revert file backup-file
))
1995 `((vc-state . up-to-date
)
1996 (vc-checkout-time .
,(nth 5 (file-attributes file
)))))
1997 (vc-resynch-buffer file t t
))
2000 (defun vc-switch-backend (file backend
)
2001 "Make BACKEND the current version control system for FILE.
2002 FILE must already be registered in BACKEND. The change is not
2003 permanent, only for the current session. This function only changes
2004 VC's perspective on FILE, it does not register or unregister it.
2005 By default, this command cycles through the registered backends.
2006 To get a prompt, use a prefix argument."
2009 (or buffer-file-name
2010 (error "There is no version-controlled file in this buffer"))
2011 (let ((crt-bk (vc-backend buffer-file-name
))
2014 (error "File %s is not under version control" buffer-file-name
))
2015 ;; Find the registered backends.
2016 (dolist (crt vc-handled-backends
)
2017 (when (and (vc-call-backend crt
'registered buffer-file-name
)
2018 (not (eq crt-bk crt
)))
2019 (push crt backends
)))
2020 ;; Find the next backend.
2021 (let ((def (car backends
))
2024 ((null others
) (error "No other backend to switch to"))
2029 (format "Switch to backend [%s]: " def
)
2030 (mapcar (lambda (b) (list (downcase (symbol-name b
)))) backends
)
2031 nil t nil nil
(downcase (symbol-name def
))))))
2033 (unless (eq backend
(vc-backend file
))
2034 (vc-file-clearprops file
)
2035 (vc-file-setprop file
'vc-backend backend
)
2036 ;; Force recomputation of the state
2037 (unless (vc-call-backend backend
'registered file
)
2038 (vc-file-clearprops file
)
2039 (error "%s is not registered in %s" file backend
))
2040 (vc-mode-line file
)))
2043 (defun vc-transfer-file (file new-backend
)
2044 "Transfer FILE to another version control system NEW-BACKEND.
2045 If NEW-BACKEND has a higher precedence than FILE's current backend
2046 \(i.e. it comes earlier in `vc-handled-backends'), then register FILE in
2047 NEW-BACKEND, using the revision number from the current backend as the
2048 base level. If NEW-BACKEND has a lower precedence than the current
2049 backend, then commit all changes that were made under the current
2050 backend to NEW-BACKEND, and unregister FILE from the current backend.
2051 \(If FILE is not yet registered under NEW-BACKEND, register it.)"
2052 (let* ((old-backend (vc-backend file
))
2053 (edited (memq (vc-state file
) '(edited needs-merge
)))
2054 (registered (vc-call-backend new-backend
'registered file
))
2056 (and registered
; Never move if not registered in new-backend yet.
2057 ;; move if new-backend comes later in vc-handled-backends
2058 (or (memq new-backend
(memq old-backend vc-handled-backends
))
2059 (y-or-n-p "Final transfer? "))))
2061 (when (eq old-backend new-backend
)
2062 (error "%s is the current backend of %s" new-backend file
))
2064 (set-file-modes file
(logior (file-modes file
) 128))
2065 ;; `registered' might have switched under us.
2066 (vc-switch-backend file old-backend
)
2067 (let* ((rev (vc-working-revision file
))
2068 (modified-file (and edited
(make-temp-file file
)))
2069 (unmodified-file (and modified-file
(vc-version-backup-file file
))))
2070 ;; Go back to the base unmodified file.
2074 (copy-file file modified-file
'ok-if-already-exists
)
2075 ;; If we have a local copy of the unmodified file, handle that
2076 ;; here and not in vc-revert-file because we don't want to
2077 ;; delete that copy -- it is still useful for OLD-BACKEND.
2079 (copy-file unmodified-file file
2080 'ok-if-already-exists
'keep-date
)
2081 (when (y-or-n-p "Get base revision from master? ")
2082 (vc-revert-file file
))))
2083 (vc-call-backend new-backend
'receive-file file rev
))
2085 (vc-switch-backend file new-backend
)
2086 (unless (eq (vc-checkout-model new-backend
(list file
)) 'implicit
)
2087 (vc-checkout file t nil
))
2088 (rename-file modified-file file
'ok-if-already-exists
)
2089 (vc-file-setprop file
'vc-checkout-time nil
)))))
2091 (vc-switch-backend file old-backend
)
2092 (setq comment
(vc-call-backend old-backend
'comment-history file
))
2093 (vc-call-backend old-backend
'unregister file
))
2094 (vc-switch-backend file new-backend
)
2095 (when (or move edited
)
2096 (vc-file-setprop file
'vc-state
'edited
)
2098 (vc-checkin file nil comment
(stringp comment
)))))
2100 (defun vc-rename-master (oldmaster newfile templates
)
2101 "Rename OLDMASTER to be the master file for NEWFILE based on TEMPLATES."
2102 (let* ((dir (file-name-directory (expand-file-name oldmaster
)))
2103 (newdir (or (file-name-directory newfile
) ""))
2104 (newbase (file-name-nondirectory newfile
))
2106 ;; List of potential master files for `newfile'
2108 (lambda (s) (vc-possible-master s newdir newbase
))
2110 (when (or (file-symlink-p oldmaster
)
2111 (file-symlink-p (file-name-directory oldmaster
)))
2112 (error "This is unsafe in the presence of symbolic links"))
2116 ;; If possible, keep the master file in the same directory.
2118 (when (and f
(string= (file-name-directory (expand-file-name f
)) dir
))
2120 ;; If not, just use the first possible place.
2122 (and f
(or (not (setq dir
(file-name-directory f
)))
2123 (file-directory-p dir
))
2125 (error "New file lacks a version control directory")))))
2127 (defun vc-delete-file (file)
2128 "Delete file and mark it as such in the version control system."
2129 (interactive "fVC delete file: ")
2130 (setq file
(expand-file-name file
))
2131 (let ((buf (get-file-buffer file
))
2132 (backend (vc-backend file
)))
2134 (error "File %s is not under version control"
2135 (file-name-nondirectory file
)))
2136 (unless (vc-find-backend-function backend
'delete-file
)
2137 (error "Deleting files under %s is not supported in VC" backend
))
2138 (when (and buf
(buffer-modified-p buf
))
2139 (error "Please save or undo your changes before deleting %s" file
))
2140 (let ((state (vc-state file
)))
2141 (when (eq state
'edited
)
2142 (error "Please commit or undo your changes before deleting %s" file
))
2143 (when (eq state
'conflict
)
2144 (error "Please resolve the conflicts before deleting %s" file
)))
2145 (unless (y-or-n-p (format "Really want to delete %s? "
2146 (file-name-nondirectory file
)))
2148 (unless (or (file-directory-p file
) (null make-backup-files
)
2149 (not (file-exists-p file
)))
2150 (with-current-buffer (or buf
(find-file-noselect file
))
2151 (let ((backup-inhibited nil
))
2153 ;; Bind `default-directory' so that the command that the backend
2154 ;; runs to remove the file is invoked in the correct context.
2155 (let ((default-directory (file-name-directory file
)))
2156 (vc-call-backend backend
'delete-file file
))
2157 ;; If the backend hasn't deleted the file itself, let's do it for him.
2158 (when (file-exists-p file
) (delete-file file
))
2159 ;; Forget what VC knew about the file.
2160 (vc-file-clearprops file
)
2161 ;; Make sure the buffer is deleted and the *vc-dir* buffers are
2162 ;; updated after this.
2163 (vc-resynch-buffer file nil t
)))
2166 (defun vc-rename-file (old new
)
2167 "Rename file OLD to NEW, and rename its master file likewise."
2168 (interactive "fVC rename file: \nFRename to: ")
2169 ;; in CL I would have said (setq new (merge-pathnames new old))
2170 (let ((old-base (file-name-nondirectory old
)))
2171 (when (and (not (string= "" old-base
))
2172 (string= "" (file-name-nondirectory new
)))
2173 (setq new
(concat new old-base
))))
2174 (let ((oldbuf (get-file-buffer old
)))
2175 (when (and oldbuf
(buffer-modified-p oldbuf
))
2176 (error "Please save files before moving them"))
2177 (when (get-file-buffer new
)
2178 (error "Already editing new file name"))
2179 (when (file-exists-p new
)
2180 (error "New file already exists"))
2181 (let ((state (vc-state old
)))
2182 (unless (memq state
'(up-to-date edited
))
2183 (error "Please %s files before moving them"
2184 (if (stringp state
) "check in" "update"))))
2185 (vc-call rename-file old new
)
2186 (vc-file-clearprops old
)
2187 ;; Move the actual file (unless the backend did it already)
2188 (when (file-exists-p old
) (rename-file old new
))
2189 ;; ?? Renaming a file might change its contents due to keyword expansion.
2190 ;; We should really check out a new copy if the old copy was precisely equal
2191 ;; to some checked-in revision. However, testing for this is tricky....
2193 (with-current-buffer oldbuf
2194 (let ((buffer-read-only buffer-read-only
))
2195 (set-visited-file-name new
))
2198 (set-buffer-modified-p nil
)))))
2201 (defun vc-update-change-log (&rest args
)
2202 "Find change log file and add entries from recent version control logs.
2203 Normally, find log entries for all registered files in the default
2206 With prefix arg of \\[universal-argument], only find log entries for the current buffer's file.
2208 With any numeric prefix arg, find log entries for all currently visited
2209 files that are under version control. This puts all the entries in the
2210 log for the default directory, which may not be appropriate.
2212 From a program, any ARGS are assumed to be filenames for which
2213 log entries should be gathered."
2215 (cond ((consp current-prefix-arg
) ;C-u
2216 (list buffer-file-name
))
2217 (current-prefix-arg ;Numeric argument.
2219 (buffers (buffer-list))
2222 (setq file
(buffer-file-name (car buffers
)))
2223 (and file
(vc-backend file
)
2224 (setq files
(cons file files
)))
2225 (setq buffers
(cdr buffers
)))
2228 ;; Don't supply any filenames to backend; this means
2229 ;; it should find all relevant files relative to
2230 ;; the default-directory.
2232 (vc-call-backend (vc-responsible-backend default-directory
)
2233 'update-changelog args
))
2235 ;;; The default back end. Assumes RCS-like revision numbering.
2237 (defun vc-default-revision-granularity ()
2238 (error "Your backend will not work with this version of VC mode."))
2240 ;; functions that operate on RCS revision numbers. This code should
2241 ;; also be moved into the backends. It stays for now, however, since
2242 ;; it is used in code below.
2244 (defun vc-trunk-p (rev)
2245 "Return t if REV is a revision on the trunk."
2246 (not (eq nil
(string-match "\\`[0-9]+\\.[0-9]+\\'" rev
))))
2248 (defun vc-branch-p (rev)
2249 "Return t if REV is a branch revision."
2250 (not (eq nil
(string-match "\\`[0-9]+\\(\\.[0-9]+\\.[0-9]+\\)*\\'" rev
))))
2253 (defun vc-branch-part (rev)
2254 "Return the branch part of a revision number REV."
2255 (let ((index (string-match "\\.[0-9]+\\'" rev
)))
2257 (substring rev
0 index
))))
2259 (defun vc-minor-part (rev)
2260 "Return the minor revision number of a revision number REV."
2261 (string-match "[0-9]+\\'" rev
)
2262 (substring rev
(match-beginning 0) (match-end 0)))
2264 (defun vc-default-previous-revision (backend file rev
)
2265 "Return the revision number immediately preceding REV for FILE,
2266 or nil if there is no previous revision. This default
2267 implementation works for MAJOR.MINOR-style revision numbers as
2268 used by RCS and CVS."
2269 (let ((branch (vc-branch-part rev
))
2270 (minor-num (string-to-number (vc-minor-part rev
))))
2273 ;; revision does probably not start a branch or release
2274 (concat branch
"." (number-to-string (1- minor-num
)))
2275 (if (vc-trunk-p rev
)
2276 ;; we are at the beginning of the trunk --
2277 ;; don't know anything to return here
2279 ;; we are at the beginning of a branch --
2280 ;; return revision of starting point
2281 (vc-branch-part branch
))))))
2283 (defun vc-default-next-revision (backend file rev
)
2284 "Return the revision number immediately following REV for FILE,
2285 or nil if there is no next revision. This default implementation
2286 works for MAJOR.MINOR-style revision numbers as used by RCS
2288 (when (not (string= rev
(vc-working-revision file
)))
2289 (let ((branch (vc-branch-part rev
))
2290 (minor-num (string-to-number (vc-minor-part rev
))))
2291 (concat branch
"." (number-to-string (1+ minor-num
))))))
2293 (defun vc-default-responsible-p (backend file
)
2294 "Indicate whether BACKEND is reponsible for FILE.
2295 The default is to return nil always."
2298 (defun vc-default-could-register (backend file
)
2299 "Return non-nil if BACKEND could be used to register FILE.
2300 The default implementation returns t for all files."
2303 (defun vc-default-latest-on-branch-p (backend file
)
2304 "Return non-nil if FILE is the latest on its branch.
2305 This default implementation always returns non-nil, which means that
2306 editing non-current revisions is not supported by default."
2309 (defun vc-default-init-revision (backend) vc-default-init-revision
)
2311 (defalias 'vc-cvs-update-changelog
'vc-update-changelog-rcs2log
)
2313 (defalias 'vc-rcs-update-changelog
'vc-update-changelog-rcs2log
)
2315 ;; FIXME: This should probably be moved to vc-rcs.el and replaced in
2316 ;; vc-cvs.el by code using cvs2cl.
2317 (defun vc-update-changelog-rcs2log (files)
2318 "Default implementation of update-changelog.
2319 Uses `rcs2log' which only works for RCS and CVS."
2320 ;; FIXME: We (c|sh)ould add support for cvs2cl
2321 (let ((odefault default-directory
)
2322 (changelog (find-change-log))
2323 ;; Presumably not portable to non-Unixy systems, along with rcs2log:
2324 (tempfile (make-temp-file
2325 (expand-file-name "vc"
2326 (or small-temporary-file-directory
2327 temporary-file-directory
))))
2328 (login-name (or user-login-name
2329 (format "uid%d" (number-to-string (user-uid)))))
2330 (full-name (or add-log-full-name
2333 (format "uid%d" (number-to-string (user-uid)))))
2334 (mailing-address (or add-log-mailing-address
2335 user-mail-address
)))
2336 (find-file-other-window changelog
)
2337 (barf-if-buffer-read-only)
2340 (goto-char (point-min))
2342 (message "Computing change log entries...")
2343 (message "Computing change log entries... %s"
2346 (setq default-directory odefault
)
2347 (if (eq 0 (apply 'call-process
2348 (expand-file-name "rcs2log"
2350 nil
(list t tempfile
) nil
2352 "-u" (concat login-name
2354 "\t" mailing-address
)
2358 (expand-file-name f odefault
)))
2361 (pop-to-buffer (get-buffer-create "*vc*"))
2363 (insert-file-contents tempfile
)
2365 (setq default-directory
(file-name-directory changelog
))
2366 (delete-file tempfile
)))))
2368 (defun vc-default-find-revision (backend file rev buffer
)
2369 "Provide the new `find-revision' op based on the old `checkout' op.
2370 This is only for compatibility with old backends. They should be updated
2371 to provide the `find-revision' operation instead."
2372 (let ((tmpfile (make-temp-file (expand-file-name file
))))
2375 (vc-call-backend backend
'checkout file nil rev tmpfile
)
2376 (with-current-buffer buffer
2377 (insert-file-contents-literally tmpfile
)))
2378 (delete-file tmpfile
))))
2380 (defun vc-default-prettify-state-info (backend file
)
2381 (let* ((state (vc-state file
))
2384 ((stringp state
) (concat "(locked:" state
")"))
2385 ((eq state
'edited
) "(modified)")
2386 ((eq state
'needs-merge
) "(merge)")
2387 ((eq state
'needs-update
) "(update)")
2388 ((eq state
'added
) "(added)")
2389 ((eq state
'removed
) "(removed)")
2390 ((eq state
'ignored
) "(ignored)")
2391 ((eq state
'unregistered
) "(unregistered)")
2392 ((eq state
'unlocked-changes
) "(stale)")
2393 (t (format "(unknown:%s)" state
))))
2395 (get-file-buffer file
))
2397 (if (and buffer
(buffer-modified-p buffer
)) "+" "")))
2398 (concat statestring modflag
)))
2400 (defun vc-default-rename-file (backend old new
)
2402 (add-name-to-file old new
)
2403 (error (rename-file old new
)))
2404 (vc-delete-file old
)
2405 (with-current-buffer (find-file-noselect new
)
2408 (defalias 'vc-default-check-headers
'ignore
)
2410 (defun vc-default-log-view-mode (backend) (log-view-mode))
2412 (defun vc-default-show-log-entry (backend rev
)
2414 (log-view-goto-rev rev
)))
2416 (defun vc-default-comment-history (backend file
)
2417 "Return a string with all log entries stored in BACKEND for FILE."
2418 (when (vc-find-backend-function backend
'print-log
)
2419 (with-current-buffer "*vc*"
2420 (vc-call-backend backend
'print-log
(list file
))
2423 (defun vc-default-receive-file (backend file rev
)
2424 "Let BACKEND receive FILE from another version control system."
2425 (vc-call-backend backend
'register file rev
""))
2427 (defun vc-default-retrieve-tag (backend dir name update
)
2428 (if (string= name
"")
2435 (vc-call-backend backend
'checkout f nil
"")
2436 (when update
(vc-resynch-buffer f t t
)))))))
2437 (let ((result (vc-tag-precondition dir
)))
2438 (if (stringp result
)
2439 (error "File %s is locked" result
)
2440 (setq update
(and (eq result
'visited
) update
))
2443 (lambda (f) (vc-error-occurred
2444 (vc-call-backend backend
'checkout f nil name
)
2445 (when update
(vc-resynch-buffer f t t
)))))))))
2447 (defun vc-default-revert (backend file contents-done
)
2448 (unless contents-done
2449 (let ((rev (vc-working-revision file
))
2450 (file-buffer (or (get-file-buffer file
) (current-buffer))))
2451 (message "Checking out %s..." file
)
2453 (backup-name (car (find-backup-file-name file
))))
2455 (copy-file file backup-name
'ok-if-already-exists
'keep-date
)
2456 (unless (file-writable-p file
)
2457 (set-file-modes file
(logior (file-modes file
) 128))))
2459 (let ((coding-system-for-read 'no-conversion
)
2460 (coding-system-for-write 'no-conversion
))
2461 (with-temp-file file
2462 (let ((outbuf (current-buffer)))
2463 ;; Change buffer to get local value of vc-checkout-switches.
2464 (with-current-buffer file-buffer
2465 (let ((default-directory (file-name-directory file
)))
2466 (vc-call-backend backend
'find-revision
2467 file rev outbuf
)))))
2471 (rename-file backup-name file
'ok-if-already-exists
)
2472 (and (not vc-make-backup-files
) (delete-file backup-name
))))))
2473 (message "Checking out %s...done" file
))))
2475 (defalias 'vc-default-revision-completion-table
'ignore
)
2477 (defun vc-default-dir-status-files (backend dir files default-state update-function
)
2478 (funcall update-function
2479 (mapcar (lambda (file) (list file default-state
)) files
)))
2481 (defun vc-check-headers ()
2482 "Check if the current file has any headers in it."
2484 (vc-call-backend (vc-backend buffer-file-name
) 'check-headers
))
2488 ;; These things should probably be generally available
2490 (defun vc-file-tree-walk (dirname func
&rest args
)
2491 "Walk recursively through DIRNAME.
2492 Invoke FUNC f ARGS on each VC-managed file f underneath it."
2493 (vc-file-tree-walk-internal (expand-file-name dirname
) func args
)
2494 (message "Traversing directory %s...done" dirname
))
2496 (defun vc-file-tree-walk-internal (file func args
)
2497 (if (not (file-directory-p file
))
2498 (when (vc-backend file
) (apply func file args
))
2499 (message "Traversing directory %s..." (abbreviate-file-name file
))
2500 (let ((dir (file-name-as-directory file
)))
2503 (string-equal f
".")
2504 (string-equal f
"..")
2505 (member f vc-directory-exclusion-list
)
2506 (let ((dirf (expand-file-name f dir
)))
2508 (file-symlink-p dirf
) ;; Avoid possible loops.
2509 (vc-file-tree-walk-internal dirf func args
)))))
2510 (directory-files dir
)))))
2514 ;; arch-tag: ca82c1de-3091-4e26-af92-460abc6213a6