| blob | 1848a950d7209b61d1a6b9767e7402b0beaae22f |
1 ;;; vc.el --- drive a version-control system from within Emacs
3 ;; Copyright (C) 1992, 93, 94, 95, 96, 97, 1998 Free Software Foundation, Inc.
5 ;; Author: Eric S. Raymond <esr@snark.thyrsus.com>
6 ;; Maintainer: Andre Spiegel <spiegel@inf.fu-berlin.de>
8 ;; $Id: vc.el,v 1.256 1999/10/02 10:53:18 spiegel Exp $
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software; you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation; either version 2, or (at your option)
15 ;; any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
25 ;; Boston, MA 02111-1307, USA.
27 ;;; Commentary:
29 ;; This mode is fully documented in the Emacs user's manual.
30 ;;
31 ;; This was designed and implemented by Eric Raymond <esr@snark.thyrsus.com>.
32 ;; Paul Eggert <eggert@twinsun.com>, Sebastian Kremer <sk@thp.uni-koeln.de>,
33 ;; and Richard Stallman contributed valuable criticism, support, and testing.
34 ;; CVS support was added by Per Cederqvist <ceder@lysator.liu.se>
35 ;; in Jan-Feb 1994. Further enhancements came from ttn@netcom.com and
36 ;; Andre Spiegel <spiegel@inf.fu-berlin.de>.
37 ;;
38 ;; Supported version-control systems presently include SCCS, RCS, and CVS.
39 ;;
40 ;; Some features will not work with old RCS versions. Where
41 ;; appropriate, VC finds out which version you have, and allows or
42 ;; disallows those features (stealing locks, for example, works only
43 ;; from 5.6.2 onwards).
44 ;; Even initial checkins will fail if your RCS version is so old that ci
45 ;; doesn't understand -t-; this has been known to happen to people running
46 ;; NExTSTEP 3.0.
47 ;;
48 ;; You can support the RCS -x option by adding pairs to the
49 ;; vc-master-templates list.
50 ;;
51 ;; Proper function of the SCCS diff commands requires the shellscript vcdiff
52 ;; to be installed somewhere on Emacs's path for executables.
53 ;;
54 ;; If your site uses the ChangeLog convention supported by Emacs, the
55 ;; function vc-comment-to-change-log should prove a useful checkin hook.
56 ;;
57 ;; This code depends on call-process passing back the subprocess exit
58 ;; status. Thus, you need Emacs 18.58 or later to run it. For the
59 ;; vc-directory command to work properly as documented, you need 19.
60 ;; You also need Emacs 19's ring.el.
61 ;;
62 ;; The vc code maintains some internal state in order to reduce expensive
63 ;; version-control operations to a minimum. Some names are only computed
64 ;; once. If you perform version control operations with RCS/SCCS/CVS while
65 ;; vc's back is turned, or move/rename master files while vc is running,
66 ;; vc may get seriously confused. Don't do these things!
67 ;;
68 ;; Developer's notes on some concurrency issues are included at the end of
69 ;; the file.
71 ;;; Code:
80 minor-mode-alist)))
82 ;; To implement support for a new version-control system, add another
83 ;; branch to the vc-backend-dispatch macro and fill it in in each
84 ;; call. The variable vc-master-templates in vc-hooks.el will also
85 ;; have to change.
88 "Execute FORM1, FORM2 or FORM3 for SCCS, RCS or CVS respectively.
89 If FORM3 is `RCS', use FORM2 for CVS as well as RCS.
90 \(CVS shares some code with RCS)."
97 )))
99 ;; General customization
102 "Version-control system in Emacs."
106 "*If non-nil, treat user as expert; suppress yes-no prompts on some things."
111 "*If non-nil, delete the *VC-log* buffer and window after each logical action.
112 If nil, bury that buffer instead.
113 This is most useful if you have multiple windows on a frame and would like to
114 preserve the setting."
119 "*If non-nil, prompt for initial comment when a file is registered."
124 "*A string used as the default version number when a new file is registered.
131 "*If non-nil, display run messages from back-end commands."
136 "*A string or list of strings specifying extra switches for checkin.
142 string))
146 "*A string or list of strings specifying extra switches for checkout.
152 string))
156 "*A string or list of strings; extra switches for registering a file.
162 string))
166 "*If non-nil, show directory trees recursively in VC Dired."
172 "*If non-nil, show only locked files in VC Dired."
178 "*List of directory names to be ignored while recursively walking file trees."
185 ;;; This is duplicated in diff.el.
208 Ages are given in units of 2**-16 seconds.
209 Default is eighteen steps using a twenty day increment."
214 "*Color for lines older than CAR of last cons in `vc-annotate-color-map'."
220 Default color is used if nil."
225 "*Menu elements for the mode-specific menu of VC-Annotate mode.
226 List of factors, used to expand/compress the time scale. See `vc-annotate'."
230 ;;;###autoload
232 "*Normal hook (list of functions) run after a checkin is done.
233 See `run-hooks'."
238 ;;;###autoload
240 "*Normal hook (list of functions) run before a file gets checked in.
241 See `run-hooks'."
245 ;;;###autoload
247 "*Hooks to run when VC-Annotate mode is turned on."
251 ;; Header-insertion hair
255 "*Header keywords to be inserted by `vc-insert-headers'.
256 Must be a list of two-element lists, the first element of each must
257 be `RCS', `CVS', or `SCCS'. The second element is the string to
258 be inserted for this particular backend."
270 "*Associate static header string templates with file types. A \%s in the
271 template is replaced with the first string associated with the file's
272 version-control type in `vc-header-alist'."
280 "*Special comment delimiters to be used in generating vc headers only.
281 Add an entry in this list if you need to override the normal comment-start
282 and comment-end variables. This will only be necessary if the mode language
283 is sensitive to blank lines."
290 ;; Default is to be extra careful for super-user.
292 "*Non-nil means be extra-careful in checkout.
293 Verify that the file really is not locked
294 and that its contents match what the master file says."
299 "*The release number of your RCS installation, as a string.
300 If nil, VC itself computes this value when it is first needed."
302 string
307 "*The release number of your SCCS installation, as a string.
308 If nil, VC itself computes this value when it is first needed."
310 string
315 "*The release number of your CVS installation, as a string.
316 If nil, VC itself computes this value when it is first needed."
318 string
322 ;; Variables the user doesn't need to know about.
327 ;; In a log entry buffer, this is a local variable
328 ;; that points to the buffer for which it was made
329 ;; (either a file, or a VC dired buffer).
345 ;;; Find and compare backend releases
348 ;; Returns which backend release is installed on this system.
370 vc-sccs-release)))
373 ;; Compare release numbers, represented as strings.
374 ;; Release components are assumed cardinal numbers, not decimal
375 ;; fractions (5.10 is a higher release than 5.9). Omitted fields
376 ;; are considered lower (5.6.7 is earlier than 5.6.7.1).
377 ;; Comparison runs till the end of the string is found, or a
378 ;; non-numeric component shows up (5.6.7 is earlier than "5.6.7 beta",
379 ;; which is probably not what you want in some cases).
380 ;; This code is suitable for existing RCS release numbers.
381 ;; CVS releases are handled reasonably, too (1.3 < 1.4* < 1.5).
402 ;; Return t if we have RELEASE of BACKEND or better
409 ;;; functions that operate on RCS revision numbers
412 ;; return t if REV is a revision on the trunk
416 ;; return t if REV is a branch revision
420 ;; return the branch part of a revision number REV
424 ;; return the minor version number of a revision number REV
429 ;; guess the previous version number
433 ;; version does probably not start a branch or release
436 ;; we are at the beginning of the trunk --
437 ;; don't know anything to return here
438 ""
439 ;; we are at the beginning of a branch --
440 ;; return version of starting point
443 ;; File property caching
446 "Clear all cached file properties and the comment ring."
449 ;; Note: there is potential for minor lossage here if there is an open
450 ;; log buffer with a nonzero local value of vc-comment-ring-index.
454 ;; clear all properties of FILE that were retrieved
455 ;; from the master file
470 ;; Return the RCS head version of FILE
475 ;; Random helper functions
478 ;; return t iff the current workfile version of FILE is
479 ;; the latest on its branch.
481 ;; SCCS
483 ;; RCS
487 ;; Re-fetch the head version number. This is to make
488 ;; sure that no-one has checked in a new version behind
489 ;; our back.
492 workfile-version))
493 ;; If we are not on the trunk, we need to examine the
494 ;; whole current branch. (vc-master-workfile-version
495 ;; is not what we need.)
505 ;; CVS
506 t))
508 ;;; Two macros for elisp programming
509 ;;;###autoload
511 "Execute BODY, checking out a writable copy of FILE first if necessary.
512 After BODY has been executed, check-in FILE with COMMENT (a string).
513 FILE is passed through `expand-file-name'; BODY executed within
514 `save-excursion'. If FILE is not under version control, or locked by
515 somebody else, signal error."
530 ;;;###autoload
532 "Edit FILE under version control, executing BODY. Checkin with COMMENT.
533 This macro uses `with-vc-file', passing args to it.
534 However, before executing BODY, find FILE, and after BODY, save buffer."
538 ,@body
542 ;; Make sure that the current buffer visits a version-controlled file.
558 "Look for a command anywhere on the subprocess-command search path."
567 candidate)
577 exec-path)
578 nil)))
581 "Execute a version-control command, notifying user and checking for errors.
582 Output from COMMAND goes to BUFFER, or *vc* if BUFFER is nil. The
583 command is considered successful if its exit status does not exceed
584 OKSTATUS (if OKSTATUS is nil, that means to ignore errors). FILE is
585 the name of the working file (may also be nil, to execute commands
586 that don't expect a file name). If FILE is non-nil, the argument LAST
587 indicates what filename should actually be passed to the command: if
588 it is `MASTER', the name of FILE's master file is used, if it is
589 `WORKFILE', then FILE is passed through unchanged. If an optional
590 list of FLAGS is present, that is inserted into the command line
591 before the filename."
599 vc-file status)
610 flags)
621 ;; Add vc-path to PATH for the execution of this command.
624 path-separator
626 process-environment))
640 status))
641 )
644 )
646 status)
647 )
649 ;;; Save a bit of the text around POSN in the current buffer, to help
650 ;;; us find the corresponding position again later. This works even
651 ;;; if all markers are destroyed or corrupted.
652 ;;; A lot of this was shamelessly lifted from Sebastian Kremer's rcs.el mode.
659 ;;; Return the position of CONTEXT in the current buffer, or nil if we
660 ;;; couldn't find it.
670 ;; Can't use search-backward since the match may continue
671 ;; after point.
673 ;; goto-char doesn't signal an error at
674 ;; beginning of buffer like backward-char would
676 ;; to beginning of OSTRING
680 ;; Returns t if POSN matches CONTEXT, nil otherwise.
685 nil
689 ;; Return a list '(point-context mark-context reparse); from which
690 ;; vc-restore-buffer-context can later restore the context.
692 ;; Use mark-marker to avoid confusion in transient-mark-mode.
695 ;; Make the right thing happen in transient-mark-mode.
697 ;; We may want to reparse the compilation buffer after revert
700 ;; Construct a list; each elt is nil or a buffer
701 ;; iff that buffer is a compilation output buffer
702 ;; that contains markers into the current buffer.
708 compilation-old-error-list
709 compilation-error-list))
724 ;; Restore point/mark, and reparse any affected compilation buffers.
725 ;; CONTEXT is that which vc-buffer-context returns.
729 ;; Reparse affected compilation buffers.
735 ;; Record the position in the compilation buffer of
736 ;; the last error next-error went to.
739 ;; Reparse the error messages as far as they were parsed before.
741 ;; Move the pointer up to find the error we were at before
742 ;; reparsing. Now next-error should properly go to the next one.
748 ;; if necessary, restore point and mark
753 mark-context
758 ;; Maybe this "smart mark preservation" could be added directly
759 ;; to revert-buffer since it can be generally useful. -sm
761 ;; Revert buffer, try to keep point and mark where user expects them in spite
762 ;; of changes because of expanded version-control key words.
763 ;; This is quite important since otherwise typeahead won't work as expected.
767 ;; Use save-excursion here, because it may be able to restore point
768 ;; and mark properly even in cases where vc-restore-buffer-context
769 ;; would fail. However, save-excursion might also get it wrong --
770 ;; in this case, vc-restore-buffer-context gives it a second try.
772 ;; t means don't call normal-mode;
773 ;; that's to preserve various minor modes.
779 ;; Make sure the current buffer and its working file are in sync
780 ;; NOT-URGENT means it is ok to continue if the user says not to save.
786 nil
791 ;; Has the given workfile changed since last checkout?
798 ;; 0 stands for an unknown time; it can't match any mod time.
800 unchanged)))))
803 ;;; If comment is specified, it will be used as an admin or checkin comment.
805 owner version buffer)
808 ;; If the file is not under version control, register it
812 ;; CVS: changes to the master file need to be
813 ;; merged back into the working file
832 "Buffer %s modified; merge file on disc anyhow? "
844 ;; For CVS files with implicit checkout: if unmodified, don't do anything
851 ;; If there is no lock on the file, assert one and get it.
853 ;; With implicit checkout, make sure not to lose unsaved changes.
863 file))
874 )
890 )))
892 ;; a checked-out version exists, but the user may not own the lock
901 file
904 owner))
906 ;; OK, user owns the lock on the file
912 ;; If the file on disk is newer, then the user just
913 ;; said no to rereading it. So the user probably wishes to
914 ;; overwrite the file with the buffer's contents, and check
915 ;; that in.
920 ;; if buffer is not saved, give user a chance to do it
923 ;; Revert if file is unchanged and buffer is too.
924 ;; If buffer is modified, that means the user just said no
925 ;; to saving it; in that case, don't revert,
926 ;; because the user might intend to save
927 ;; after finishing the log entry.
930 ;; DO NOT revert the file without asking the user!
936 ;; user may want to set nonstandard parameters
940 ;; OK, let's do the checkin
942 )))))
947 ;; Do a vc-next-action-on-file on all the marked files, possibly
948 ;; passing on the log comment we've just entered.
954 ;; Adjust the default directory so that checkouts
955 ;; go to the right place.
959 ;; Make sure that files don't vanish
960 ;; after they are checked in.
965 nil t))
968 ;; Here's the major entry point.
970 ;;;###autoload
972 "Do the next logical checkin or checkout operation on the current file.
973 If you call this from within a VC dired buffer with no files marked,
974 it will operate on the file in the current line.
975 If you call this from within a VC dired buffer, and one or more
976 files are marked, it will accept a log message and then operate on
977 each one. The log message will be used as a comment for any register
978 or checkin operations, but ignored when doing checkouts. Attempted
979 lock steals will raise an error.
980 A prefix argument lets you specify the version number to use.
982 For RCS and SCCS files:
983 If the file is not already registered, this registers it for version
984 control.
985 If the file is registered and not locked by anyone, this checks out
986 a writable and locked file ready for editing.
987 If the file is checked out and locked by the calling user, this
988 first checks to see if the file has changed since checkout. If not,
989 it performs a revert.
990 If the file has been changed, this pops up a buffer for entry
991 of a log message; when the message has been entered, it checks in the
992 resulting changes along with the log message as change commentary. If
993 the variable `vc-keep-workfiles' is non-nil (which is its default), a
994 read-only copy of the changed file is left in place afterwards.
995 If the file is registered and locked by someone else, you are given
996 the option to steal the lock.
998 For CVS files:
999 If the file is not already registered, this registers it for version
1001 If the file is added but not committed, it is committed.
1002 If your working file is changed, but the repository file is
1003 unchanged, this pops up a buffer for entry of a log message; when the
1004 message has been entered, it checks in the resulting changes along
1005 with the logmessage as change commentary. A writable file is retained.
1006 If the repository file is changed, you are asked if you want to
1007 merge in the changes into your working copy."
1026 "Enter a change comment for the marked files."
1035 ;;; These functions help the vc-next-action entry point
1038 "Retrieve a writable copy of the latest version of the current buffer's file."
1040 )
1042 ;;;###autoload
1044 "Register the current file into your version-control system."
1054 ;; Watch out for new buffers of size 0: the corresponding file
1055 ;; does not exist yet, even though buffer-modified-p is nil.
1062 ;; inhibit backup for this buffer
1066 buffer-file-name
1070 vc-default-init-version)
1071 comment)
1072 ;; Recompute backend property (it may have been set to nil before).
1074 )
1077 ;; If the given file is in the current buffer,
1078 ;; either revert on it so we see expanded keywords,
1079 ;; or unvisit it (depending on vc-keep-workfiles)
1080 ;; NOQUERY if non-nil inhibits confirmation for reverting.
1081 ;; NOQUERY should be t *only* if it is known the only difference
1082 ;; between the buffer and the file is due to RCS rather than user editing!
1099 ;; if FILE is currently visited, resynch its buffer
1109 ;; Accept a comment for an operation on FILE revision REV. If COMMENT
1110 ;; is nil, pop up a VC-log buffer, emit MSG, and set the
1111 ;; action on close to ACTION; otherwise, do action immediately.
1112 ;; Remember the file's buffer in vc-parent-buffer (current one if no file).
1113 ;; AFTER-HOOK specifies the local value for vc-log-operation-hook.
1144 "Check a file into your version-control system.
1145 FILE is the unmodified name of the file. REV should be the base version
1146 level to check it in under. COMMENT, if specified, is the checkin comment."
1150 nil))
1153 "Retrieve a copy of the latest version of the given file."
1154 ;; If ftp is on this system and the name matches the ange-ftp format
1155 ;; for a remote file, the user is trying something that won't work.
1162 "Steal the lock on the current workfile."
1170 file-description owner)))
1186 ;; This is called when the notification has been sent.
1195 "Check in the file specified by FILE.
1196 The optional argument REV may be a string specifying the new version level
1197 \(if nil increment the current level). The file is either retained with write
1198 permissions zeroed, or deleted (according to the value of `vc-keep-workfiles').
1199 If the back-end is CVS, a writable workfile is always kept.
1200 COMMENT is a comment string; if omitted, a buffer is popped up to accept a
1201 comment.
1203 Runs the normal hook `vc-checkin-hook'."
1209 "Enter last VC comment into change log file for current buffer's file.
1210 Optional arg (interactive prefix) non-nil means prompt for user name and site.
1211 Second arg is file name of change log. \
1212 If nil, uses `change-log-default-name'.
1214 May be useful as a `vc-checkin-hook' to update change logs automatically."
1218 ;; Make sure the defvar for add-log-current-defun-function has been executed
1219 ;; before binding it.
1223 ;; Don't let add-change-log-entry insert a defun name.
1225 end)
1226 ;; Call add-log to do half the work.
1228 ;; Insert the VC comment, leaving point before it.
1231 ;; It starts with an open-paren, as in "(foo): Frobbed."
1232 ;; So remove the ": " add-log inserted.
1234 ;; Canonicalize the white space between the file name and comment.
1236 ;; Indent rest of the text the same way add-log indented the first line.
1243 ;; Fill the inserted text, preserving open-parens at bol.
1248 ;; Canonicalize the white space at the end of the entry so it is
1249 ;; separated from the next entry by a single blank line.
1256 "Complete the operation implied by the current log entry."
1258 ;; Check and record the comment, if any.
1261 ;; Comment too long?
1263 ;; Record the comment in the comment ring
1265 ))
1266 ;; Sync parent buffer in case the user modified it while editing the comment.
1267 ;; But not if it is a vc-dired buffer.
1273 ;; save the parameters held in buffer-local variables
1281 ;; OK, do it to it
1284 log-file
1285 log-version
1286 log-entry))
1287 ;; Remove checkin window (after the checkin so that if that fails
1288 ;; we don't zap the *VC-log* buffer and the typing therein).
1292 ;; Kill buffer and delete any other dedicated windows/frames.
1297 ;; Now make sure we see the expanded headers
1304 ;; Code for access to the comment ring
1307 "Cycle backwards through comment history."
1315 ;; Initialize the index on the first use of this command
1316 ;; so that the first M-p gets index 0, and the first M-n gets
1317 ;; index -1.
1328 "Cycle forwards through comment history."
1333 "Searches backwards through comment history for substring match."
1350 "Searches forwards through comment history for substring match."
1366 ;; Additional entry points for examining version histories
1368 ;;;###autoload
1370 "Display diffs between file versions.
1371 Normally this compares the current file and buffer with the most recent
1372 checked in version of that file. This uses no arguments.
1373 With a prefix argument, it reads the file name to use
1374 and two version designators specifying which versions to compare."
1380 unchanged)
1386 ;; Ideally, we'd like at this point to parse the diff so that
1387 ;; the buffer effectively goes into compilation mode and we
1388 ;; can visit the old and new change locations via next-error.
1389 ;; Unfortunately, this is just too painful to do. The basic
1390 ;; problem is that the `old' file doesn't exist to be
1391 ;; visited. This plays hell with numerous assumptions in
1392 ;; the diff.el and compile.el machinery.
1405 "For FILE, report diffs between two stored versions REL1 and REL2 of it.
1406 If FILE is a directory, generate diffs between versions for all registered
1407 files in or below it."
1410 "File or dir to diff: (default visited file) "
1412 default-directory buffer-file-name t))
1414 ;; compute default versions based on the file state
1416 ;; if it's a directory, don't supply any version defauolt
1418 nil)
1419 ;; if the file is locked, use current version as older version
1422 ;; if the file is not locked, use last and previous version as default
1426 ;; construct argument list
1432 nil nil rel1-default)
1437 nil nil rel2-default))))
1449 " and "
1455 default-directory
1463 )))
1468 )
1473 ;;;###autoload
1475 "Visit version REV of the current buffer in another window.
1476 If the current buffer is named `F', the version is named `F.~REV~'.
1477 If `F.~REV~' already exists, it is used instead of being re-created."
1482 rev))
1488 ;; Header-insertion code
1490 ;;;###autoload
1492 "Insert headers in a file for use with your version-control system.
1493 Headers desired are inserted at point, and are pulled from
1494 the variable `vc-header-alist'."
1510 hdstrings)
1515 vc-static-header-alist))
1516 )
1517 )))))
1520 ;; Clear all version headers in the current buffer, i.e. reset them
1521 ;; to the nonexpanded form. Only implemented for RCS, yet.
1522 ;; Don't lose point and mark during this.
1525 ;; save-excursion may be able to relocate point and mark properly.
1526 ;; If it fails, vc-restore-buffer-context will give it a second try.
1532 nil t)
1536 ;;;###autoload
1543 first-version second-version locking-user)
1564 ;; We want to merge an entire branch. Set versions
1565 ;; accordingly, so that vc-backend-merge understands us.
1567 ;; first-version must be the starting point of the branch
1583 ;;;###autoload
1585 "Invoke ediff to resolve conflicts in the current buffer.
1586 The conflicts must be marked with rcsmerge conflict markers."
1635 ;; Fire up ediff.
1639 ;; Ediff is now set up, and we are in the control buffer.
1640 ;; Do a few further adjustments and take precautions for exit.
1665 nil))))
1667 ;; The VC directory major mode. Coopt Dired for this.
1668 ;; All VC commands get mapped into logical equivalents.
1674 "The major mode used in VC directory buffers. It works like Dired,
1675 but lists only files under version control, with the current VC state of
1676 each file being indicated in the place of the file's link count, owner,
1677 group and size. Subdirectories are also listed, and you may insert them
1678 into the buffer as desired, like in Dired.
1679 All Dired commands operate normally, with the exception of `v', which
1680 is redefined as the version control prefix, so that you can type
1681 `vl', `v=' etc. to invoke `vc-print-log', `vc-diff', and the like on
1682 the file named in the current Dired buffer line. `vv' invokes
1683 `vc-next-action' on this file, or on all files currently marked.
1684 There is a special command, `*l', to mark all files currently locked."
1687 ;; The following is slightly modified from dired.el,
1688 ;; because file lines look a bit different in vc-dired-mode.
1692 ;; In some locales, month abbreviations are as short as 2 letters,
1693 ;; and they can be padded on the right with spaces.
1695 ;; Recognize any non-ASCII character.
1696 ;; The purpose is to match a Kanji character.
1698 ;; (k "[^\x00-\x7f\x80-\xff]")
1709 vc-dired-switches
1711 vc-dired-switches))
1719 "Toggle terse display in VC Dired."
1722 nil
1731 "Mark all files currently locked."
1743 ;; Don't specify DIR in this command, the default-directory is
1744 ;; enough. Otherwise it might fail with remote repositories.
1756 ;; Return the string that indicates the version control status
1757 ;; on a VC dired line.
1772 ;; Reformat a directory-listing line, replacing various columns with
1773 ;; version control information.
1774 ;; This code, like dired, assumes UNIX -l format.
1784 limit t)
1787 limit t)
1790 limit t))
1797 ;; Called by dired after any portion of a vc-dired buffer has been read in.
1798 ;; Reformat the listing according to version control.
1804 ;; subdir header line
1812 ;; erase (but don't remove) the "total" line
1818 ;; directory entry
1821 ;; subdir
1825 vc-directory-exclusion-list)
1831 ;; Don't show directories in terse mode. Don't use
1832 ;; dired-kill-line to remove it, because in recursive listings,
1833 ;; that would remove the directory contents as well.
1841 ;; ordinary file
1853 ;; any other line
1864 ;; Remove empty subdirs
1875 ;; We cannot remove the top level directory.
1876 ;; Just make it look a little nicer.
1883 ;;;###autoload
1891 vc-dired-switches)))
1894 ;; force a trailing slash
1902 ;; Named-configuration support for SCCS
1907 vc-name-assoc-file
1913 ))
1919 vc-name-assoc-file
1922 ;; (replace-regexp (concat ":" (regexp-quote file) "$") (concat ":" newname))
1927 ))
1930 ;; Return the numeric version corresponding to a named snapshot of file
1931 ;; If name is nil or a version number string it's just passed through
1935 name)
1941 vc-name-assoc-file
1947 ))
1949 ;; Named-configuration entry points
1952 ;; Scan the tree below the current directory.
1953 ;; If any files are locked, return the name of the first such file.
1954 ;; (This means, neither snapshot creation nor retrieval is allowed.)
1955 ;; If one or more of the files are currently visited, return `visited'.
1956 ;; Otherwise, return nil.
1960 default-directory
1965 status)))
1967 ;;;###autoload
1969 "Make a snapshot called NAME.
1970 The snapshot is made from all registered files at or below the current
1971 directory. For each file, the version level of its latest
1972 version becomes part of the named configuration."
1978 default-directory
1982 )))
1984 ;;;###autoload
1986 "Retrieve the snapshot called NAME, or latest versions if NAME is empty.
1987 When retrieving a snapshot, there must not be any locked files at or below
1988 the current directory. If none are locked, all registered files are
1989 checked out (unlocked) at their version levels in the snapshot NAME.
1990 If NAME is the empty string, all registered files that are not currently
1991 locked are updated to the latest versions."
1997 default-directory
2009 default-directory
2015 )))))
2017 ;; Miscellaneous other entry points
2019 ;;;###autoload
2021 "List the change log of the current buffer in a window."
2036 ;; move point to the log entry for the current version
2039 ;; also match some context, for safety
2042 ;; set the display window so that
2043 ;; the whole log entry is displayed
2051 ;; if the global information and this log entry fit
2052 ;; into the window, display from the beginning
2057 ;; if the whole entry fits into the window,
2058 ;; display it centered
2062 ;; otherwise (the entry is too large for the window),
2063 ;; display from the start
2068 ;;;###autoload
2070 "Revert the current buffer's file back to the version it was based on.
2071 This asks for confirmation if the buffer contents are not identical
2072 to that version. Note that for RCS and CVS, this function does not
2073 automatically pick up newer changes found in the master file;
2078 ;; This operation should always ask for confirmation.
2093 ;;;###autoload
2095 "Get rid of most recently checked in version of this file.
2096 A prefix argument means do not revert the buffer afterwards."
2110 nil
2114 ;; Check out the most recent remaining version. If it fails, because
2115 ;; the whole branch got deleted, do a double-take and check out the
2116 ;; version where the branch started.
2121 ;; Check out locked, but only to disc, and keep
2122 ;; modifications in the buffer.
2124 ;; Check out unlocked, and revert buffer.
2127 ;; If the checkout fails, vc-do-command signals an error.
2128 ;; We catch this error, check the reason, correct the
2129 ;; version number, and try a second time.
2134 ;; vc-do-command popped up a window with
2135 ;; the error message. Get rid of it, by
2136 ;; restoring the old window configuration.
2138 ;; No, it was some other error: re-signal it.
2140 ;; If norevert, clear version headers and mark the buffer modified.
2145 ;; inhibit backup for this buffer
2153 )))
2155 ;;;###autoload
2157 "Rename file OLD to NEW, and rename its master file likewise."
2159 ;; There are several ways of renaming files under CVS 1.3, but they all
2160 ;; have serious disadvantages. See the FAQ (available from think.com in
2161 ;; pub/cvs/). I'd rather send the user an error, than do something he might
2162 ;; consider to be wrong. When the famous, long-awaited rename database is
2163 ;; implemented things might change for the better. This is unlikely to occur
2164 ;; until CVS 2.0 is released. --ceder 1994-01-23 21:27:51
2180 ;; This had FILE, I changed it to OLD. -- rms.
2197 vc-master-templates)
2199 ;; Handle the SCCS PROJECTDIR feature. It is odd that this
2200 ;; is a special case, but a more elegant solution would require
2201 ;; significant changes in other parts of VC.
2211 ; ?? Renaming a file might change its contents due to keyword expansion.
2212 ; We should really check out a new copy if the old copy was precisely equal
2213 ; to some checked in version. However, testing for this is tricky....
2222 ;; This had FILE, I changed it to OLD. -- rms.
2225 nil ;RCS
2226 nil ;CVS
2227 )
2228 )
2230 ;;;###autoload
2232 "Find change log file and add entries from recent RCS/CVS logs.
2233 Normally, find log entries for all registered files in the default
2234 directory using `rcs2log', which finds CVS logs preferentially.
2235 The mark is left at the end of the text prepended to the change log.
2237 With prefix arg of C-u, only find log entries for the current buffer's file.
2239 With any numeric prefix arg, find log entries for all currently visited
2240 files that are under version control. This puts all the entries in the
2241 log for the default directory, which may not be appropriate.
2243 From a program, any arguments are assumed to be filenames and are
2244 passed to the `rcs2log' script after massaging to be relative to the
2245 default directory."
2252 file)
2258 files))
2260 ;; `rcs2log' will find the relevant RCS or CVS files
2261 ;; relative to the curent directory if none supplied.
2262 nil)))
2265 ;; Presumably not portable to non-Unixy systems, along with rcs2log:
2269 temporary-file-directory))))
2275 user-mail-address)))
2289 "-c" changelog
2298 f
2300 args)))
2301 "done"
2309 \f
2310 ;; vc-annotate functionality (CVS only).
2317 ;; Syntax Table
2321 ;; Declare globally instead of additional parameter to
2322 ;; temp-buffer-show-function (not possible to pass more than one
2323 ;; parameter).
2339 "Major mode for buffers displaying output from the CVS `annotate' command.
2341 You can use the mode-specific menu to alter the time-span of the used
2342 colors. See variable `vc-annotate-menu-elements' for customizing the
2343 menu items."
2350 ; finds out what to describe.
2356 "Use the default color spectrum for VC Annotate mode."
2363 "Adds the menu 'Annotate' to the menu bar in VC-Annotate mode."
2365 '("Default" . vc-annotate-display-default))
2366 (let ((menu-elements vc-annotate-menu-elements))
2367 (while menu-elements
2368 (let* ((element (car menu-elements))
2369 (days (round (* element
2370 (vc-annotate-car-last-cons vc-annotate-color-map)
2371 0.7585))))
2372 (setq menu-elements (cdr menu-elements))
2373 (define-key vc-annotate-mode-menu
2374 (vector days)
2375 (cons (format "Span %d days"
2376 days)
2377 `(lambda ()
2378 ,(format "Use colors spanning %d days" days)
2379 (interactive)
2380 (message "Redisplaying annotation...")
2381 (vc-annotate-display
2382 (get-buffer (buffer-name))
2383 (vc-annotate-time-span vc-annotate-color-map ,element))
2384 (message "Redisplaying annotation...done"))))))))
2386 ;;;###autoload
2387 (defun vc-annotate (ratio)
2388 "Display the result of the CVS `annotate' command using colors.
2389 New lines are displayed in red, old in blue.
2390 A prefix argument specifies a factor for stretching the time scale.
2392 `vc-annotate-menu-elements' customizes the menu elements of the
2393 mode-specific menu. `vc-annotate-color-map' and
2394 `vc-annotate-very-old-color' defines the mapping of time to
2395 colors. `vc-annotate-background' specifies the background color."
2396 (interactive "p")
2397 (vc-ensure-vc-buffer)
2398 (if (not (eq (vc-backend (buffer-file-name)) 'CVS))
2399 (error "Sorry, vc-annotate is only implemented for CVS"))
2400 (message "Annotating...")
2401 (let ((temp-buffer-name (concat "*cvs annotate " (buffer-name) "*"))
2402 (temp-buffer-show-function 'vc-annotate-display)
2403 (vc-annotate-ratio ratio))
2404 (with-output-to-temp-buffer temp-buffer-name
2405 (call-process "cvs" nil (get-buffer temp-buffer-name) nil
2406 "annotate" (file-name-nondirectory (buffer-file-name)))))
2407 (message "Annotating... done"))
2409 (defun vc-annotate-car-last-cons (a-list)
2410 "Return car of last cons in association list A-LIST."
2411 (if (not (eq nil (cdr a-list)))
2412 (vc-annotate-car-last-cons (cdr a-list))
2413 (car (car a-list))))
2415 (defun vc-annotate-time-span (a-list span &optional quantize)
2416 "Return an association list with factor SPAN applied to the time-span
2417 of association list A-LIST. Optionaly quantize to the factor of
2418 QUANTIZE."
2419 ;; Apply span to each car of every cons
2420 (if (not (eq nil a-list))
2421 (append (list (cons (* (car (car a-list)) span)
2422 (cdr (car a-list))))
2423 (vc-annotate-time-span (nthcdr (cond (quantize) ; optional
2424 (1)) ; Default to cdr
2425 a-list) span quantize))))
2427 (defun vc-annotate-compcar (threshold a-list)
2428 "Test successive cons cells of association list A-LIST against
2429 THRESHOLD. Return the first cons cell which car is not less than
2430 THRESHOLD, nil otherwise"
2431 (let ((i 1)
2432 (tmp-cons (car a-list)))
2433 (while (and tmp-cons (< (car tmp-cons) threshold))
2434 (setq tmp-cons (car (nthcdr i a-list)))
2435 (setq i (+ i 1)))
2436 tmp-cons)) ; Return the appropriate value
2439 (defun vc-annotate-display (buffer &optional color-map)
2440 "Do the VC-Annotate display in BUFFER using COLOR-MAP."
2442 ;; Handle the case of the global variable vc-annotate-ratio being
2443 ;; set. This variable is used to pass information from function
2444 ;; vc-annotate since it is not possible to use another parameter
2445 ;; (see temp-buffer-show-function).
2446 (if (and (not color-map) vc-annotate-ratio)
2447 ;; This will only be true if called from vc-annotate with ratio
2448 ;; being non-nil.
2449 (setq color-map (vc-annotate-time-span vc-annotate-color-map
2450 vc-annotate-ratio)))
2452 ;; We need a list of months and their corresponding numbers.
2453 (let* ((local-month-numbers
2454 '(("Jan" . 1) ("Feb" . 2) ("Mar" . 3) ("Apr" . 4)
2455 ("May" . 5) ("Jun" . 6) ("Jul" . 7) ("Aug" . 8)
2456 ("Sep" . 9) ("Oct" . 10) ("Nov" . 11) ("Dec" . 12))))
2457 (set-buffer buffer)
2458 (display-buffer buffer)
2459 (or (eq major-mode 'vc-annotate-mode) ; Turn on vc-annotate-mode if not done
2460 (vc-annotate-mode))
2461 ;; Delete old overlays
2462 (mapcar
2463 (lambda (overlay)
2464 (if (overlay-get overlay 'vc-annotation)
2465 (delete-overlay overlay)))
2466 (overlays-in (point-min) (point-max)))
2467 (goto-char (point-min)) ; Position at the top of the buffer.
2468 (while (re-search-forward
2471 nil t)
2473 (let* (;; Unfortunately, order is important. match-string will
2474 ;; be corrupted by extent functions in XEmacs. Access
2475 ;; string-matches first.
2476 (day (string-to-number (match-string 1)))
2477 (month (cdr (assoc (match-string 2) local-month-numbers)))
2478 (year-tmp (string-to-number (match-string 3)))
2479 ;; Years 0..68 are 2000..2068.
2480 ;; Years 69..99 are 1969..1999.
2481 (year (+ (cond ((> 69 year-tmp) 2000)
2482 ((> 100 year-tmp) 1900)
2483 (t 0))
2484 year-tmp))
2485 (high (- (car (current-time))
2486 (car (encode-time 0 0 0 day month year))))
2487 (color (cond ((vc-annotate-compcar high (cond (color-map)
2488 (vc-annotate-color-map))))
2489 ((cons nil vc-annotate-very-old-color))))
2490 ;; substring from index 1 to remove any leading `#' in the name
2491 (face-name (concat "vc-annotate-face-" (substring (cdr color) 1)))
2492 ;; Make the face if not done.
2493 (face (cond ((intern-soft face-name))
2494 ((let ((tmp-face (make-face (intern face-name))))
2495 (set-face-foreground tmp-face (cdr color))
2496 (if vc-annotate-background
2497 (set-face-background tmp-face vc-annotate-background))
2498 tmp-face)))) ; Return the face
2499 (point (point))
2500 overlay)
2502 (forward-line 1)
2503 (setq overlay (make-overlay point (point)))
2504 (overlay-put overlay 'face face)
2505 (overlay-put overlay 'vc-annotation t)))))
2507 \f
2508 ;; Collect back-end-dependent stuff here
2510 (defun vc-backend-admin (file &optional rev comment)
2511 ;; Register a file into the version-control system
2512 ;; Automatically retrieves a read-only version of the file with
2513 ;; keywords expanded if vc-keep-workfiles is non-nil, otherwise
2514 ;; it deletes the workfile.
2515 (vc-file-clearprops file)
2516 (or vc-default-back-end
2517 (setq vc-default-back-end (if (vc-find-binary "rcs") 'RCS 'SCCS)))
2518 (message "Registering %s..." file)
2519 (let* ((switches
2520 (if (stringp vc-register-switches)
2521 (list vc-register-switches)
2522 vc-register-switches))
2523 (project-dir)
2524 (backend
2525 (cond
2526 ((file-exists-p (vc-backend-subdirectory-name)) vc-default-back-end)
2527 ((file-exists-p "RCS") 'RCS)
2528 ((file-exists-p "CVS") 'CVS)
2529 ((file-exists-p "SCCS") 'SCCS)
2530 ((setq project-dir (vc-sccs-project-dir)) 'SCCS)
2531 (t vc-default-back-end))))
2532 (cond ((eq backend 'SCCS)
2533 (let ((vc-name
2534 (if project-dir (concat project-dir
2535 "s." (file-name-nondirectory file))
2536 (format
2537 (car (rassq 'SCCS vc-master-templates))
2538 (or (file-name-directory file) "")
2539 (file-name-nondirectory file)))))
2540 (apply 'vc-do-command nil 0 "admin" nil nil ;; SCCS
2541 (and rev (concat "-r" rev))
2542 "-fb"
2543 (concat "-i" file)
2544 (and comment (concat "-y" comment))
2545 vc-name
2546 switches))
2547 (delete-file file)
2548 (if vc-keep-workfiles
2549 (vc-do-command nil 0 "get" file 'MASTER)))
2550 ((eq backend 'RCS)
2551 (apply 'vc-do-command nil 0 "ci" file 'WORKFILE ;; RCS
2552 ;; if available, use the secure registering option
2553 (and (vc-backend-release-p 'RCS "5.6.4") "-i")
2554 (concat (if vc-keep-workfiles "-u" "-r") rev)
2555 (and comment (concat "-t-" comment))
2556 switches))
2557 ((eq backend 'CVS)
2558 (apply 'vc-do-command nil 0 "cvs" file 'WORKFILE ;; CVS
2559 "add"
2561 (concat "-m" comment))
2562 switches)
2563 )))
2564 (message "Registering %s...done" file)
2565 )
2567 (defun vc-backend-checkout (file &optional writable rev workfile)
2568 ;; Retrieve a copy of a saved version into a workfile
2569 (let ((filename (or workfile file))
2570 (file-buffer (get-file-buffer file))
2571 switches)
2572 (message "Checking out %s..." filename)
2573 (save-excursion
2574 ;; Change buffers to get local value of vc-checkout-switches.
2575 (if file-buffer (set-buffer file-buffer))
2576 (setq switches (if (stringp vc-checkout-switches)
2577 (list vc-checkout-switches)
2578 vc-checkout-switches))
2579 ;; Save this buffer's default-directory
2580 ;; and use save-excursion to make sure it is restored
2581 ;; in the same buffer it was saved in.
2582 (let ((default-directory default-directory))
2583 (save-excursion
2584 ;; Adjust the default-directory so that the check-out creates
2585 ;; the file in the right place.
2586 (setq default-directory (file-name-directory filename))
2587 (vc-backend-dispatch file
2588 (progn ;; SCCS
2589 (and rev (string= rev "") (setq rev nil))
2590 (if workfile
2591 ;; Some SCCS implementations allow checking out directly to a
2592 ;; file using the -G option, but then some don't so use the
2593 ;; least common denominator approach and use the -p option
2594 ;; ala RCS.
2595 (let ((vc-modes (logior (file-modes (vc-name file))
2596 (if writable 128 0)))
2597 (failed t))
2598 (unwind-protect
2599 (progn
2600 (let ((coding-system-for-read 'no-conversion)
2601 (coding-system-for-write 'no-conversion))
2602 (with-temp-file filename
2603 (apply 'vc-do-command
2604 (current-buffer) 0 "get" file 'MASTER
2605 "-s" ;; suppress diagnostic output
2606 (if writable "-e")
2607 "-p"
2608 (and rev
2609 (concat "-r"
2610 (vc-lookup-triple file rev)))
2611 switches)))
2612 (set-file-modes filename
2613 (logior (file-modes (vc-name file))
2614 (if writable 128 0)))
2615 (setq failed nil))
2616 (and failed (file-exists-p filename)
2617 (delete-file filename))))
2618 (apply 'vc-do-command nil 0 "get" file 'MASTER ;; SCCS
2619 (if writable "-e")
2620 (and rev (concat "-r" (vc-lookup-triple file rev)))
2621 switches)
2622 (vc-file-setprop file 'vc-workfile-version nil)))
2623 (if workfile ;; RCS
2624 ;; RCS doesn't let us check out into arbitrary file names directly.
2625 ;; Use `co -p' and make stdout point to the correct file.
2626 (let ((vc-modes (logior (file-modes (vc-name file))
2627 (if writable 128 0)))
2628 (failed t))
2629 (unwind-protect
2630 (progn
2631 (let ((coding-system-for-read 'no-conversion)
2632 (coding-system-for-write 'no-conversion))
2633 (with-temp-file filename
2634 (apply 'vc-do-command
2635 (current-buffer) 0 "co" file 'MASTER
2636 "-q" ;; suppress diagnostic output
2637 (if writable "-l")
2638 (concat "-p" rev)
2639 switches)))
2640 (set-file-modes filename
2641 (logior (file-modes (vc-name file))
2642 (if writable 128 0)))
2643 (setq failed nil))
2644 (and failed (file-exists-p filename) (delete-file filename))))
2645 (let (new-version)
2646 ;; if we should go to the head of the trunk,
2647 ;; clear the default branch first
2648 (and rev (string= rev "")
2649 (vc-do-command nil 0 "rcs" file 'MASTER "-b"))
2650 ;; now do the checkout
2651 (apply 'vc-do-command
2652 nil 0 "co" file 'MASTER
2653 ;; If locking is not strict, force to overwrite
2654 ;; the writable workfile.
2655 (if (eq (vc-checkout-model file) 'implicit) "-f")
2656 (if writable "-l")
2657 (if rev (concat "-r" rev)
2658 ;; if no explicit revision was specified,
2659 ;; check out that of the working file
2660 (let ((workrev (vc-workfile-version file)))
2661 (if workrev (concat "-r" workrev)
2662 nil)))
2663 switches)
2664 ;; determine the new workfile version
2665 (save-excursion
2666 (set-buffer "*vc*")
2667 (goto-char (point-min))
2668 (setq new-version
2670 (buffer-substring (match-beginning 1) (match-end 1)))))
2671 (vc-file-setprop file 'vc-workfile-version new-version)
2672 ;; if necessary, adjust the default branch
2673 (and rev (not (string= rev ""))
2674 (vc-do-command nil 0 "rcs" file 'MASTER
2675 (concat "-b" (if (vc-latest-on-branch-p file)
2676 (if (vc-trunk-p new-version) nil
2677 (vc-branch-part new-version))
2678 new-version))))))
2679 (if workfile ;; CVS
2680 ;; CVS is much like RCS
2681 (let ((failed t))
2682 (unwind-protect
2683 (progn
2684 (let ((coding-system-for-read 'no-conversion)
2685 (coding-system-for-write 'no-conversion))
2686 (with-temp-file filename
2687 (apply 'vc-do-command
2688 (current-buffer) 0 "cvs" file 'WORKFILE
2689 "-Q" ;; suppress diagnostic output
2690 "update"
2691 (concat "-r" rev)
2692 "-p"
2693 switches)))
2694 (setq failed nil))
2695 (and failed (file-exists-p filename) (delete-file filename))))
2696 ;; default for verbose checkout: clear the sticky tag
2697 ;; so that the actual update will get the head of the trunk
2698 (and rev (string= rev "")
2699 (vc-do-command nil 0 "cvs" file 'WORKFILE "update" "-A"))
2700 ;; If a revision was specified, check that out.
2701 (if rev
2702 (apply 'vc-do-command nil 0 "cvs" file 'WORKFILE
2703 (and writable (eq (vc-checkout-model file) 'manual) "-w")
2704 "update"
2705 (and rev (not (string= rev ""))
2706 (concat "-r" rev))
2707 switches)
2708 ;; If no revision was specified, call "cvs edit" to make
2709 ;; the file writeable.
2710 (and writable (eq (vc-checkout-model file) 'manual)
2711 (vc-do-command nil 0 "cvs" file 'WORKFILE "edit")))
2712 (if rev (vc-file-setprop file 'vc-workfile-version nil))))
2713 (cond
2714 ((not workfile)
2715 (vc-file-clear-masterprops file)
2716 (if writable
2717 (vc-file-setprop file 'vc-locking-user (vc-user-login-name)))
2718 (vc-file-setprop file
2719 'vc-checkout-time (nth 5 (file-attributes file)))))
2720 (message "Checking out %s...done" filename))))))
2722 (defun vc-backend-logentry-check (file)
2723 (vc-backend-dispatch file
2724 (if (>= (buffer-size) 512) ;; SCCS
2725 (progn
2726 (goto-char 512)
2727 (error
2728 "Log must be less than 512 characters; point is now at pos 512")))
2729 nil ;; RCS
2730 nil) ;; CVS
2731 )
2733 (defun vc-backend-checkin (file rev comment)
2734 ;; Register changes to FILE as level REV with explanatory COMMENT.
2735 ;; Automatically retrieves a read-only version of the file with
2736 ;; keywords expanded if vc-keep-workfiles is non-nil, otherwise
2737 ;; it deletes the workfile.
2738 ;; Adaptation for RCS branch support: if this is an explicit checkin,
2739 ;; or if the checkin creates a new branch, set the master file branch
2740 ;; accordingly.
2741 (message "Checking in %s..." file)
2742 ;; "This log message intentionally left almost blank".
2743 ;; RCS 5.7 gripes about white-space-only comments too.
2745 (setq comment "*** empty log message ***"))
2746 (save-excursion
2747 ;; Change buffers to get local value of vc-checkin-switches.
2748 (set-buffer (or (get-file-buffer file) (current-buffer)))
2749 (let ((switches
2750 (if (stringp vc-checkin-switches)
2751 (list vc-checkin-switches)
2752 vc-checkin-switches)))
2753 ;; Clear the master-properties. Do that here, not at the
2754 ;; end, because if the check-in fails we want them to get
2755 ;; re-computed before the next try.
2756 (vc-file-clear-masterprops file)
2757 (vc-backend-dispatch file
2758 ;; SCCS
2759 (progn
2760 (apply 'vc-do-command nil 0 "delta" file 'MASTER
2761 (if rev (concat "-r" rev))
2762 (concat "-y" comment)
2763 switches)
2764 (vc-file-setprop file 'vc-locking-user 'none)
2765 (vc-file-setprop file 'vc-workfile-version nil)
2766 (if vc-keep-workfiles
2767 (vc-do-command nil 0 "get" file 'MASTER))
2768 )
2769 ;; RCS
2770 (let ((old-version (vc-workfile-version file)) new-version)
2771 (apply 'vc-do-command nil 0 "ci" file 'MASTER
2772 ;; if available, use the secure check-in option
2773 (and (vc-backend-release-p 'RCS "5.6.4") "-j")
2774 (concat (if vc-keep-workfiles "-u" "-r") rev)
2775 (concat "-m" comment)
2776 switches)
2777 (vc-file-setprop file 'vc-locking-user 'none)
2778 (vc-file-setprop file 'vc-workfile-version nil)
2780 ;; determine the new workfile version
2781 (set-buffer "*vc*")
2782 (goto-char (point-min))
2783 (if (or (re-search-forward
2785 (re-search-forward
2787 (progn (setq new-version (buffer-substring (match-beginning 1)
2788 (match-end 1)))
2789 (vc-file-setprop file 'vc-workfile-version new-version)))
2791 ;; if we got to a different branch, adjust the default
2792 ;; branch accordingly
2793 (cond
2794 ((and old-version new-version
2795 (not (string= (vc-branch-part old-version)
2796 (vc-branch-part new-version))))
2797 (vc-do-command nil 0 "rcs" file 'MASTER
2798 (if (vc-trunk-p new-version) "-b"
2799 (concat "-b" (vc-branch-part new-version))))
2800 ;; If this is an old RCS release, we might have
2801 ;; to remove a remaining lock.
2802 (if (not (vc-backend-release-p 'RCS "5.6.2"))
2803 ;; exit status of 1 is also accepted.
2804 ;; It means that the lock was removed before.
2805 (vc-do-command nil 1 "rcs" file 'MASTER
2806 (concat "-u" old-version))))))
2807 ;; CVS
2808 (progn
2809 ;; explicit check-in to the trunk requires a
2810 ;; double check-in (first unexplicit) (CVS-1.3)
2811 (condition-case nil
2812 (progn
2813 (if (and rev (vc-trunk-p rev))
2814 (apply 'vc-do-command nil 0 "cvs" file 'WORKFILE
2815 "ci" "-m" "intermediate"
2816 switches))
2817 (apply 'vc-do-command nil 0 "cvs" file 'WORKFILE
2818 "ci" (if rev (concat "-r" rev))
2819 (concat "-m" comment)
2820 switches))
2821 (error (if (eq (vc-cvs-status file) 'needs-merge)
2822 ;; The CVS output will be on top of this message.
2823 (error "Type C-x 0 C-x C-q to merge in changes")
2824 (error "Check-in failed"))))
2825 ;; determine and store the new workfile version
2826 (set-buffer "*vc*")
2827 (goto-char (point-min))
2828 (if (re-search-forward
2830 (vc-file-setprop file 'vc-workfile-version
2831 (buffer-substring (match-beginning 2)
2832 (match-end 2)))
2833 (vc-file-setprop file 'vc-workfile-version nil))
2834 ;; if this was an explicit check-in, remove the sticky tag
2835 (if rev
2836 (vc-do-command nil 0 "cvs" file 'WORKFILE "update" "-A"))
2837 ;; Forget the checkout model, because we might have assumed
2838 ;; a wrong one when we found the file. After commit, we can
2839 ;; tell it from the permissions of the file
2840 ;; (see vc-checkout-model).
2841 (vc-file-setprop file 'vc-checkout-model nil)
2842 (vc-file-setprop file 'vc-locking-user 'none)
2843 (vc-file-setprop file 'vc-checkout-time
2844 (nth 5 (file-attributes file)))))))
2845 (message "Checking in %s...done" file))
2847 (defun vc-backend-revert (file)
2848 ;; Revert file to the version it was based on.
2849 (message "Reverting %s..." file)
2850 (vc-file-clear-masterprops file)
2851 (vc-backend-dispatch
2852 file
2853 ;; SCCS
2854 (progn
2855 (vc-do-command nil 0 "unget" file 'MASTER nil)
2856 (vc-do-command nil 0 "get" file 'MASTER nil)
2857 ;; Checking out explicit versions is not supported under SCCS, yet.
2858 ;; We always "revert" to the latest version; therefore
2859 ;; vc-workfile-version is cleared here so that it gets recomputed.
2860 (vc-file-setprop file 'vc-workfile-version nil))
2861 ;; RCS
2862 (vc-do-command nil 0 "co" file 'MASTER
2863 "-f" (concat "-u" (vc-workfile-version file)))
2864 ;; CVS
2865 (progn
2866 ;; Check out via standard output (caused by the final argument
2867 ;; FILE below), so that no sticky tag is set.
2868 (vc-backend-checkout file nil (vc-workfile-version file) file)
2869 ;; If "cvs edit" was used to make the file writeable,
2870 ;; call "cvs unedit" now to undo that.
2871 (if (eq (vc-checkout-model file) 'manual)
2872 (vc-do-command nil 0 "cvs" file 'WORKFILE "unedit"))))
2873 (vc-file-setprop file 'vc-locking-user 'none)
2874 (vc-file-setprop file 'vc-checkout-time (nth 5 (file-attributes file)))
2875 (message "Reverting %s...done" file)
2876 )
2878 (defun vc-backend-steal (file &optional rev)
2879 ;; Steal the lock on the current workfile. Needs RCS 5.6.2 or later for -M.
2880 (message "Stealing lock on %s..." file)
2881 (vc-backend-dispatch file
2882 (progn ;SCCS
2883 (vc-do-command nil 0 "unget" file 'MASTER "-n" (if rev (concat "-r" rev)))
2884 (vc-do-command nil 0 "get" file 'MASTER "-g" (if rev (concat "-r" rev)))
2885 )
2886 (vc-do-command nil 0 "rcs" file 'MASTER ;RCS
2887 "-M" (concat "-u" rev) (concat "-l" rev))
2888 (error "You cannot steal a CVS lock; there are no CVS locks to steal") ;CVS
2889 )
2890 (vc-file-setprop file 'vc-locking-user (vc-user-login-name))
2891 (message "Stealing lock on %s...done" file)
2892 )
2894 (defun vc-backend-uncheck (file target)
2895 ;; Undo the latest checkin.
2896 (message "Removing last change from %s..." file)
2897 (vc-backend-dispatch file
2898 (vc-do-command nil 0 "rmdel" file 'MASTER (concat "-r" target))
2899 (vc-do-command nil 0 "rcs" file 'MASTER (concat "-o" target))
2900 nil ;; this is never reached under CVS
2901 )
2902 (message "Removing last change from %s...done" file)
2903 )
2905 (defun vc-backend-print-log (file)
2906 ;; Get change log associated with FILE.
2907 (vc-backend-dispatch
2908 file
2909 (vc-do-command nil 0 "prs" file 'MASTER)
2910 (vc-do-command nil 0 "rlog" file 'MASTER)
2911 (vc-do-command nil 0 "cvs" file 'WORKFILE "log")))
2913 (defun vc-backend-assign-name (file name)
2914 ;; Assign to a FILE's latest version a given NAME.
2915 (vc-backend-dispatch file
2916 (vc-add-triple name file (vc-latest-version file)) ;; SCCS
2917 (vc-do-command nil 0 "rcs" file 'MASTER (concat "-n" name ":")) ;; RCS
2918 (vc-do-command nil 0 "cvs" file 'WORKFILE "tag" name) ;; CVS
2919 )
2920 )
2922 (defun vc-backend-diff (file &optional oldvers newvers cmp)
2923 ;; Get a difference report between two versions of FILE.
2924 ;; Get only a brief comparison report if CMP, a difference report otherwise.
2925 (let ((backend (vc-backend file)) options status
2926 (diff-switches-list (if (listp diff-switches)
2927 diff-switches
2928 (list diff-switches))))
2929 (cond
2930 ((eq backend 'SCCS)
2931 (setq oldvers (vc-lookup-triple file oldvers))
2932 (setq newvers (vc-lookup-triple file newvers))
2933 (setq options (append (list (and cmp "--brief") "-q"
2934 (and oldvers (concat "-r" oldvers))
2935 (and newvers (concat "-r" newvers)))
2936 (and (not cmp) diff-switches-list)))
2937 (apply 'vc-do-command "*vc-diff*" 1 "vcdiff" file 'MASTER options))
2938 ((eq backend 'RCS)
2939 (if (not oldvers) (setq oldvers (vc-workfile-version file)))
2940 ;; If we know that --brief is not supported, don't try it.
2941 (setq cmp (and cmp (not (eq vc-rcsdiff-knows-brief 'no))))
2942 (setq options (append (list (and cmp "--brief") "-q"
2943 (concat "-r" oldvers)
2944 (and newvers (concat "-r" newvers)))
2945 (and (not cmp) diff-switches-list)))
2946 (setq status (apply 'vc-do-command "*vc-diff*" 2
2947 "rcsdiff" file 'WORKFILE options))
2948 ;; If --brief didn't work, do a double-take and remember it
2949 ;; for the future.
2950 (if (eq status 2)
2951 (prog1
2952 (apply 'vc-do-command "*vc-diff*" 1 "rcsdiff" file 'WORKFILE
2953 (if cmp (cdr options) options))
2954 (if cmp (setq vc-rcsdiff-knows-brief 'no)))
2955 ;; If --brief DID work, remember that, too.
2956 (and cmp (not vc-rcsdiff-knows-brief)
2957 (setq vc-rcsdiff-knows-brief 'yes))
2958 status))
2959 ;; CVS is different.
2960 ((eq backend 'CVS)
2961 (if (string= (vc-workfile-version file) "0")
2962 ;; This file is added but not yet committed; there is no master file.
2963 (if (or oldvers newvers)
2964 (error "No revisions of %s exist" file)
2965 (if cmp 1 ;; file is added but not committed,
2966 ;; we regard this as "changed".
2967 ;; diff it against /dev/null.
2968 (apply 'vc-do-command
2969 "*vc-diff*" 1 "diff" file 'WORKFILE
2970 (append diff-switches-list '("/dev/null")))))
2971 ;; cmp is not yet implemented -- we always do a full diff.
2972 (apply 'vc-do-command
2973 "*vc-diff*" 1 "cvs" file 'WORKFILE "diff"
2974 (and oldvers (concat "-r" oldvers))
2975 (and newvers (concat "-r" newvers))
2976 diff-switches-list))))))
2978 (defun vc-backend-merge-news (file)
2979 ;; Merge in any new changes made to FILE.
2980 (message "Merging changes into %s..." file)
2981 (prog1
2982 (vc-backend-dispatch
2983 file
2984 (error "vc-backend-merge-news not meaningful for SCCS files") ;SCCS
2985 (error "vc-backend-merge-news not meaningful for RCS files") ;RCS
2986 (save-excursion ; CVS
2987 (vc-file-clear-masterprops file)
2988 (vc-file-setprop file 'vc-workfile-version nil)
2989 (vc-file-setprop file 'vc-locking-user nil)
2990 (vc-file-setprop file 'vc-checkout-time nil)
2991 (vc-do-command nil 0 "cvs" file 'WORKFILE "update")
2992 ;; Analyze the merge result reported by CVS, and set
2993 ;; file properties accordingly.
2994 (set-buffer (get-buffer "*vc*"))
2995 (goto-char (point-min))
2996 ;; get new workfile version
2997 (if (re-search-forward (concat "^Merging differences between "
2998 "[01234567890.]* and "
3000 nil t)
3001 (vc-file-setprop file 'vc-workfile-version (match-string 1)))
3002 ;; get file status
3003 (if (re-search-forward
3005 (regexp-quote (file-name-nondirectory file))
3007 nil t)
3008 (cond
3009 ;; Merge successful, we are in sync with repository now
3010 ((or (string= (match-string 2) "U")
3011 (string= (match-string 2) "P")
3012 ;; Special case: file contents in sync with
3013 ;; repository anyhow:
3014 (match-string 3))
3015 (vc-file-setprop file 'vc-locking-user 'none)
3016 (vc-file-setprop file 'vc-checkout-time
3017 (nth 5 (file-attributes file)))
3018 0) ;; indicate success to the caller
3019 ;; Merge successful, but our own changes are still in the file
3020 ((string= (match-string 2) "M")
3021 (vc-file-setprop file 'vc-locking-user (vc-file-owner file))
3022 (vc-file-setprop file 'vc-checkout-time 0)
3023 0) ;; indicate success to the caller
3024 ;; Conflicts detected!
3025 ((string= (match-string 2) "C")
3026 (vc-file-setprop file 'vc-locking-user (vc-file-owner file))
3027 (vc-file-setprop file 'vc-checkout-time 0)
3028 1) ;; signal the error to the caller
3029 )
3030 (pop-to-buffer "*vc*")
3031 (error "Couldn't analyze cvs update result"))))
3032 (message "Merging changes into %s...done" file)))
3034 (defun vc-backend-merge (file first-version &optional second-version)
3035 ;; Merge the changes between FIRST-VERSION and SECOND-VERSION into
3036 ;; the current working copy of FILE. It is assumed that FILE is
3037 ;; locked and writable (vc-merge ensures this).
3038 (vc-backend-dispatch file
3039 ;; SCCS
3040 (error "Sorry, merging is not implemented for SCCS")
3041 ;; RCS
3042 (vc-do-command nil 1 "rcsmerge" file 'MASTER
3043 "-kk" ;; ignore keyword conflicts
3044 (concat "-r" first-version)
3045 (if second-version (concat "-r" second-version)))
3046 ;; CVS
3047 (progn
3048 (vc-do-command nil 0 "cvs" file 'WORKFILE
3049 "update" "-kk"
3050 (concat "-j" first-version)
3051 (concat "-j" second-version))
3052 (save-excursion
3053 (set-buffer (get-buffer "*vc*"))
3054 (goto-char (point-min))
3055 (if (re-search-forward "conflicts during merge" nil t)
3056 1 ;; signal error
3057 0 ;; signal success
3058 )))))
3060 (defun vc-check-headers ()
3061 "Check if the current file has any headers in it."
3062 (interactive)
3063 (save-excursion
3064 (goto-char (point-min))
3065 (vc-backend-dispatch buffer-file-name
3066 (re-search-forward "%[MIRLBSDHTEGUYFPQCZWA]%" nil t) ;; SCCS
3067 (re-search-forward "\\$[A-Za-z\300-\326\330-\366\370-\377]+\\(: [\t -#%-\176\240-\377]*\\)?\\$" nil t) ;; RCS
3068 'RCS ;; CVS works like RCS in this regard.
3069 )
3070 ))
3072 ;; Back-end-dependent stuff ends here.
3074 ;; Set up key bindings for use while editing log messages
3076 (defun vc-log-mode (&optional file)
3077 "Minor mode for driving version-control tools.
3078 These bindings are added to the global keymap when you enter this mode:
3092 While you are entering a change log message for a version, the following
3093 additional bindings will be in effect.
3097 Whenever you do a checkin, your log comment is added to a ring of
3098 saved comments. These can be recalled as follows:
3105 Entry to the change-log submode calls the value of text-mode-hook, then
3106 the value of vc-log-mode-hook.
3108 Global user options:
3109 vc-initial-comment If non-nil, require user to enter a change
3110 comment upon first checkin of the file.
3112 vc-keep-workfiles Non-nil value prevents workfiles from being
3113 deleted when changes are checked in
3115 vc-suppress-confirm Suppresses some confirmation prompts,
3116 notably for reversions.
3118 vc-header-alist Which keywords to insert when adding headers
3121 RCS and CVS.
3123 vc-static-header-alist By default, version headers inserted in C files
3124 get stuffed in a static string area so that
3125 ident(RCS/CVS) or what(SCCS) can see them in
3126 the compiled object code. You can override
3127 this by setting this variable to nil, or change
3128 the header template by changing it.
3130 vc-command-messages if non-nil, display run messages from the
3131 actual version-control utilities (this is
3132 intended primarily for people hacking vc
3133 itself).
3134 "
3135 (interactive)
3136 (set-syntax-table text-mode-syntax-table)
3137 (use-local-map vc-log-entry-mode)
3138 (setq local-abbrev-table text-mode-abbrev-table)
3139 (setq major-mode 'vc-log-mode)
3140 (setq mode-name "VC-Log")
3141 (make-local-variable 'vc-log-file)
3142 (setq vc-log-file file)
3143 (make-local-variable 'vc-log-version)
3144 (make-local-variable 'vc-comment-ring-index)
3145 (set-buffer-modified-p nil)
3146 (setq buffer-file-name nil)
3147 (run-hooks 'text-mode-hook 'vc-log-mode-hook)
3148 )
3150 ;; Initialization code, to be done just once at load-time
3151 (if vc-log-entry-mode
3152 nil
3153 (setq vc-log-entry-mode (make-sparse-keymap))
3154 (define-key vc-log-entry-mode "\M-n" 'vc-next-comment)
3155 (define-key vc-log-entry-mode "\M-p" 'vc-previous-comment)
3156 (define-key vc-log-entry-mode "\M-r" 'vc-comment-search-reverse)
3157 (define-key vc-log-entry-mode "\M-s" 'vc-comment-search-forward)
3158 (define-key vc-log-entry-mode "\C-c\C-c" 'vc-finish-logentry)
3159 )
3161 ;;; These things should probably be generally available
3163 (defun vc-file-tree-walk (dirname func &rest args)
3164 "Walk recursively through DIRNAME.
3165 Invoke FUNC f ARGS on each non-directory file f underneath it."
3166 (vc-file-tree-walk-internal (expand-file-name dirname) func args)
3167 (message "Traversing directory %s...done" dirname))
3169 (defun vc-file-tree-walk-internal (file func args)
3170 (if (not (file-directory-p file))
3171 (apply func file args)
3172 (message "Traversing directory %s..." (abbreviate-file-name file))
3173 (let ((dir (file-name-as-directory file)))
3174 (mapcar
3175 (function
3176 (lambda (f) (or
3177 (string-equal f ".")
3178 (string-equal f "..")
3179 (member f vc-directory-exclusion-list)
3180 (let ((dirf (concat dir f)))
3181 (or
3182 (file-symlink-p dirf) ;; Avoid possible loops
3183 (vc-file-tree-walk-internal dirf func args))))))
3184 (directory-files dir)))))
3186 (provide 'vc)
3188 ;;; DEVELOPER'S NOTES ON CONCURRENCY PROBLEMS IN THIS CODE
3189 ;;;
3190 ;;; These may be useful to anyone who has to debug or extend the package.
3191 ;;; (Note that this information corresponds to versions 5.x. Some of it
3192 ;;; might have been invalidated by the additions to support branching
3193 ;;; and RCS keyword lookup. AS, 1995/03/24)
3194 ;;;
3195 ;;; A fundamental problem in VC is that there are time windows between
3196 ;;; vc-next-action's computations of the file's version-control state and
3197 ;;; the actions that change it. This is a window open to lossage in a
3198 ;;; multi-user environment; someone else could nip in and change the state
3199 ;;; of the master during it.
3200 ;;;
3201 ;;; The performance problem is that rlog/prs calls are very expensive; we want
3202 ;;; to avoid them as much as possible.
3203 ;;;
3204 ;;; ANALYSIS:
3205 ;;;
3206 ;;; The performance problem, it turns out, simplifies in practice to the
3207 ;;; problem of making vc-locking-user fast. The two other functions that call
3208 ;;; prs/rlog will not be so commonly used that the slowdown is a problem; one
3209 ;;; makes snapshots, the other deletes the calling user's last change in the
3210 ;;; master.
3211 ;;;
3212 ;;; The race condition implies that we have to either (a) lock the master
3213 ;;; during the entire execution of vc-next-action, or (b) detect and
3214 ;;; recover from errors resulting from dispatch on an out-of-date state.
3215 ;;;
3216 ;;; Alternative (a) appears to be infeasible. The problem is that we can't
3217 ;;; guarantee that the lock will ever be removed. Suppose a user starts a
3218 ;;; checkin, the change message buffer pops up, and the user, having wandered
3219 ;;; off to do something else, simply forgets about it?
3220 ;;;
3221 ;;; Alternative (b), on the other hand, works well with a cheap way to speed up
3222 ;;; vc-locking-user. Usually, if a file is registered, we can read its locked/
3223 ;;; unlocked state and its current owner from its permissions.
3224 ;;;
3225 ;;; This shortcut will fail if someone has manually changed the workfile's
3226 ;;; permissions; also if developers are munging the workfile in several
3227 ;;; directories, with symlinks to a master (in this latter case, the
3228 ;;; permissions shortcut will fail to detect a lock asserted from another
3229 ;;; directory).
3230 ;;;
3231 ;;; Note that these cases correspond exactly to the errors which could happen
3232 ;;; because of a competing checkin/checkout race in between two instances of
3233 ;;; vc-next-action.
3234 ;;;
3235 ;;; For VC's purposes, a workfile/master pair may have the following states:
3236 ;;;
3237 ;;; A. Unregistered. There is a workfile, there is no master.
3238 ;;;
3239 ;;; B. Registered and not locked by anyone.
3240 ;;;
3241 ;;; C. Locked by calling user and unchanged.
3242 ;;;
3243 ;;; D. Locked by the calling user and changed.
3244 ;;;
3245 ;;; E. Locked by someone other than the calling user.
3246 ;;;
3247 ;;; This makes for 25 states and 20 error conditions. Here's the matrix:
3248 ;;;
3249 ;;; VC's idea of state
3250 ;;; |
3251 ;;; V Actual state RCS action SCCS action Effect
3252 ;;; A B C D E
3253 ;;; A . 1 2 3 4 ci -u -t- admin -fb -i<file> initial admin
3254 ;;; B 5 . 6 7 8 co -l get -e checkout
3255 ;;; C 9 10 . 11 12 co -u unget; get revert
3256 ;;; D 13 14 15 . 16 ci -u -m<comment> delta -y<comment>; get checkin
3257 ;;; E 17 18 19 20 . rcs -u -M -l unget -n ; get -g steal lock
3258 ;;;
3259 ;;; All commands take the master file name as a last argument (not shown).
3260 ;;;
3261 ;;; In the discussion below, a "self-race" is a pathological situation in
3262 ;;; which VC operations are being attempted simultaneously by two or more
3263 ;;; Emacsen running under the same username.
3264 ;;;
3265 ;;; The vc-next-action code has the following windows:
3266 ;;;
3267 ;;; Window P:
3268 ;;; Between the check for existence of a master file and the call to
3269 ;;; admin/checkin in vc-buffer-admin (apparent state A). This window may
3270 ;;; never close if the initial-comment feature is on.
3271 ;;;
3272 ;;; Window Q:
3273 ;;; Between the call to vc-workfile-unchanged-p in and the immediately
3274 ;;; following revert (apparent state C).
3275 ;;;
3276 ;;; Window R:
3277 ;;; Between the call to vc-workfile-unchanged-p in and the following
3278 ;;; checkin (apparent state D). This window may never close.
3279 ;;;
3280 ;;; Window S:
3281 ;;; Between the unlock and the immediately following checkout during a
3282 ;;; revert operation (apparent state C). Included in window Q.
3283 ;;;
3284 ;;; Window T:
3285 ;;; Between vc-locking-user and the following checkout (apparent state B).
3286 ;;;
3287 ;;; Window U:
3288 ;;; Between vc-locking-user and the following revert (apparent state C).
3289 ;;; Includes windows Q and S.
3290 ;;;
3291 ;;; Window V:
3292 ;;; Between vc-locking-user and the following checkin (apparent state
3293 ;;; D). This window may never be closed if the user fails to complete the
3294 ;;; checkin message. Includes window R.
3295 ;;;
3296 ;;; Window W:
3297 ;;; Between vc-locking-user and the following steal-lock (apparent
3298 ;;; state E). This window may never close if the user fails to complete
3299 ;;; the steal-lock message. Includes window X.
3300 ;;;
3301 ;;; Window X:
3302 ;;; Between the unlock and the immediately following re-lock during a
3303 ;;; steal-lock operation (apparent state E). This window may never cloce
3304 ;;; if the user fails to complete the steal-lock message.
3305 ;;;
3306 ;;; Errors:
3307 ;;;
3308 ;;; Apparent state A ---
3309 ;;;
3310 ;;; 1. File looked unregistered but is actually registered and not locked.
3311 ;;;
3312 ;;; Potential cause: someone else's admin during window P, with
3313 ;;; caller's admin happening before their checkout.
3314 ;;;
3315 ;;; RCS: Prior to version 5.6.4, ci fails with message
3316 ;;; "no lock set by <user>". From 5.6.4 onwards, VC uses the new
3317 ;;; ci -i option and the message is "<file>,v: already exists".
3318 ;;; SCCS: admin will fail with error (ad19).
3319 ;;;
3320 ;;; We can let these errors be passed up to the user.
3321 ;;;
3322 ;;; 2. File looked unregistered but is actually locked by caller, unchanged.
3323 ;;;
3324 ;;; Potential cause: self-race during window P.
3325 ;;;
3326 ;;; RCS: Prior to version 5.6.4, reverts the file to the last saved
3327 ;;; version and unlocks it. From 5.6.4 onwards, VC uses the new
3328 ;;; ci -i option, failing with message "<file>,v: already exists".
3329 ;;; SCCS: will fail with error (ad19).
3330 ;;;
3331 ;;; Either of these consequences is acceptable.
3332 ;;;
3333 ;;; 3. File looked unregistered but is actually locked by caller, changed.
3334 ;;;
3335 ;;; Potential cause: self-race during window P.
3336 ;;;
3337 ;;; RCS: Prior to version 5.6.4, VC registers the caller's workfile as
3338 ;;; a delta with a null change comment (the -t- switch will be
3339 ;;; ignored). From 5.6.4 onwards, VC uses the new ci -i option,
3340 ;;; failing with message "<file>,v: already exists".
3341 ;;; SCCS: will fail with error (ad19).
3342 ;;;
3343 ;;; 4. File looked unregistered but is locked by someone else.
3344 ;;;
3345 ;;; Potential cause: someone else's admin during window P, with
3346 ;;; caller's admin happening *after* their checkout.
3347 ;;;
3348 ;;; RCS: Prior to version 5.6.4, ci fails with a
3349 ;;; "no lock set by <user>" message. From 5.6.4 onwards,
3350 ;;; VC uses the new ci -i option, failing with message
3351 ;;; "<file>,v: already exists".
3352 ;;; SCCS: will fail with error (ad19).
3353 ;;;
3354 ;;; We can let these errors be passed up to the user.
3355 ;;;
3356 ;;; Apparent state B ---
3357 ;;;
3358 ;;; 5. File looked registered and not locked, but is actually unregistered.
3359 ;;;
3360 ;;; Potential cause: master file got nuked during window P.
3361 ;;;
3362 ;;; RCS: will fail with "RCS/<file>: No such file or directory"
3363 ;;; SCCS: will fail with error ut4.
3364 ;;;
3365 ;;; We can let these errors be passed up to the user.
3366 ;;;
3367 ;;; 6. File looked registered and not locked, but is actually locked by the
3368 ;;; calling user and unchanged.
3369 ;;;
3370 ;;; Potential cause: self-race during window T.
3371 ;;;
3372 ;;; RCS: in the same directory as the previous workfile, co -l will fail
3373 ;;; with "co error: writable foo exists; checkout aborted". In any other
3374 ;;; directory, checkout will succeed.
3375 ;;; SCCS: will fail with ge17.
3376 ;;;
3377 ;;; Either of these consequences is acceptable.
3378 ;;;
3379 ;;; 7. File looked registered and not locked, but is actually locked by the
3380 ;;; calling user and changed.
3381 ;;;
3382 ;;; As case 6.
3383 ;;;
3384 ;;; 8. File looked registered and not locked, but is actually locked by another
3385 ;;; user.
3386 ;;;
3387 ;;; Potential cause: someone else checks it out during window T.
3388 ;;;
3389 ;;; RCS: co error: revision 1.3 already locked by <user>
3390 ;;; SCCS: fails with ge4 (in directory) or ut7 (outside it).
3391 ;;;
3392 ;;; We can let these errors be passed up to the user.
3393 ;;;
3394 ;;; Apparent state C ---
3395 ;;;
3396 ;;; 9. File looks locked by calling user and unchanged, but is unregistered.
3397 ;;;
3398 ;;; As case 5.
3399 ;;;
3400 ;;; 10. File looks locked by calling user and unchanged, but is actually not
3401 ;;; locked.
3402 ;;;
3403 ;;; Potential cause: a self-race in window U, or by the revert's
3404 ;;; landing during window X of some other user's steal-lock or window S
3405 ;;; of another user's revert.
3406 ;;;
3407 ;;; RCS: succeeds, refreshing the file from the identical version in
3408 ;;; the master.
3409 ;;; SCCS: fails with error ut4 (p file nonexistent).
3410 ;;;
3411 ;;; Either of these consequences is acceptable.
3412 ;;;
3413 ;;; 11. File is locked by calling user. It looks unchanged, but is actually
3414 ;;; changed.
3415 ;;;
3416 ;;; Potential cause: the file would have to be touched by a self-race
3417 ;;; during window Q.
3418 ;;;
3419 ;;; The revert will succeed, removing whatever changes came with
3420 ;;; the touch. It is theoretically possible that work could be lost.
3421 ;;;
3422 ;;; 12. File looks like it's locked by the calling user and unchanged, but
3423 ;;; it's actually locked by someone else.
3424 ;;;
3425 ;;; Potential cause: a steal-lock in window V.
3426 ;;;
3427 ;;; RCS: co error: revision <rev> locked by <user>; use co -r or rcs -u
3428 ;;; SCCS: fails with error un2
3429 ;;;
3430 ;;; We can pass these errors up to the user.
3431 ;;;
3432 ;;; Apparent state D ---
3433 ;;;
3434 ;;; 13. File looks like it's locked by the calling user and changed, but it's
3435 ;;; actually unregistered.
3436 ;;;
3437 ;;; Potential cause: master file got nuked during window P.
3438 ;;;
3439 ;;; RCS: Prior to version 5.6.4, checks in the user's version as an
3440 ;;; initial delta. From 5.6.4 onwards, VC uses the new ci -j
3441 ;;; option, failing with message "no such file or directory".
3442 ;;; SCCS: will fail with error ut4.
3443 ;;;
3444 ;;; This case is kind of nasty. Under RCS prior to version 5.6.4,
3445 ;;; VC may fail to detect the loss of previous version information.
3446 ;;;
3447 ;;; 14. File looks like it's locked by the calling user and changed, but it's
3448 ;;; actually unlocked.
3449 ;;;
3450 ;;; Potential cause: self-race in window V, or the checkin happening
3451 ;;; during the window X of someone else's steal-lock or window S of
3452 ;;; someone else's revert.
3453 ;;;
3454 ;;; RCS: ci will fail with "no lock set by <user>".
3455 ;;; SCCS: delta will fail with error ut4.
3456 ;;;
3457 ;;; 15. File looks like it's locked by the calling user and changed, but it's
3458 ;;; actually locked by the calling user and unchanged.
3459 ;;;
3460 ;;; Potential cause: another self-race --- a whole checkin/checkout
3461 ;;; sequence by the calling user would have to land in window R.
3462 ;;;
3463 ;;; SCCS: checks in a redundant delta and leaves the file unlocked as usual.
3464 ;;; RCS: reverts to the file state as of the second user's checkin, leaving
3465 ;;; the file unlocked.
3466 ;;;
3467 ;;; It is theoretically possible that work could be lost under RCS.
3468 ;;;
3469 ;;; 16. File looks like it's locked by the calling user and changed, but it's
3470 ;;; actually locked by a different user.
3471 ;;;
3472 ;;; RCS: ci error: no lock set by <user>
3473 ;;; SCCS: unget will fail with error un2
3474 ;;;
3475 ;;; We can pass these errors up to the user.
3476 ;;;
3477 ;;; Apparent state E ---
3478 ;;;
3479 ;;; 17. File looks like it's locked by some other user, but it's actually
3480 ;;; unregistered.
3481 ;;;
3482 ;;; As case 13.
3483 ;;;
3484 ;;; 18. File looks like it's locked by some other user, but it's actually
3485 ;;; unlocked.
3486 ;;;
3487 ;;; Potential cause: someone released a lock during window W.
3488 ;;;
3489 ;;; RCS: The calling user will get the lock on the file.
3490 ;;; SCCS: unget -n will fail with cm4.
3491 ;;;
3492 ;;; Either of these consequences will be OK.
3493 ;;;
3494 ;;; 19. File looks like it's locked by some other user, but it's actually
3495 ;;; locked by the calling user and unchanged.
3496 ;;;
3497 ;;; Potential cause: the other user relinquishing a lock followed by
3498 ;;; a self-race, both in window W.
3499 ;;;
3500 ;;; Under both RCS and SCCS, both unlock and lock will succeed, making
3501 ;;; the sequence a no-op.
3502 ;;;
3503 ;;; 20. File looks like it's locked by some other user, but it's actually
3504 ;;; locked by the calling user and changed.
3505 ;;;
3506 ;;; As case 19.
3507 ;;;
3508 ;;; PROBLEM CASES:
3509 ;;;
3510 ;;; In order of decreasing severity:
3511 ;;;
3512 ;;; Cases 11 and 15 are the only ones that potentially lose work.
3513 ;;; They would require a self-race for this to happen.
3514 ;;;
3515 ;;; Case 13 in RCS loses information about previous deltas, retaining
3516 ;;; only the information in the current workfile. This can only happen
3517 ;;; if the master file gets nuked in window P.
3518 ;;;
3519 ;;; Case 3 in RCS and case 15 under SCCS insert a redundant delta with
3520 ;;; no change comment in the master. This would require a self-race in
3521 ;;; window P or R respectively.
3522 ;;;
3523 ;;; Cases 2, 10, 19 and 20 do extra work, but make no changes.
3524 ;;;
3525 ;;; Unfortunately, it appears to me that no recovery is possible in these
3526 ;;; cases. They don't yield error messages, so there's no way to tell that
3527 ;;; a race condition has occurred.
3528 ;;;
3529 ;;; All other cases don't change either the workfile or the master, and
3530 ;;; trigger command errors which the user will see.
3531 ;;;
3532 ;;; Thus, there is no explicit recovery code.
3534 ;;; vc.el ends here