| blob | 1381b11e8fcd14672346ded47ca3e9a652649322 |
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.255 1999/09/22 12:58:49 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
759 ;; Revert buffer, try to keep point and mark where user expects them in spite
760 ;; of changes because of expanded version-control key words.
761 ;; This is quite important since otherwise typeahead won't work as expected.
765 ;; Use save-excursion here, because it may be able to restore point
766 ;; and mark properly even in cases where vc-restore-buffer-context
767 ;; would fail. However, save-excursion might also get it wrong --
768 ;; in this case, vc-restore-buffer-context gives it a second try.
770 ;; t means don't call normal-mode;
771 ;; that's to preserve various minor modes.
777 ;; Make sure the current buffer and its working file are in sync
778 ;; NOT-URGENT means it is ok to continue if the user says not to save.
784 nil
789 ;; Has the given workfile changed since last checkout?
796 ;; 0 stands for an unknown time; it can't match any mod time.
798 unchanged)))))
801 ;;; If comment is specified, it will be used as an admin or checkin comment.
803 owner version buffer)
806 ;; If the file is not under version control, register it
810 ;; CVS: changes to the master file need to be
811 ;; merged back into the working file
830 "Buffer %s modified; merge file on disc anyhow? "
842 ;; For CVS files with implicit checkout: if unmodified, don't do anything
849 ;; If there is no lock on the file, assert one and get it.
851 ;; With implicit checkout, make sure not to lose unsaved changes.
861 file))
872 )
888 )))
890 ;; a checked-out version exists, but the user may not own the lock
899 file
902 owner))
904 ;; OK, user owns the lock on the file
910 ;; If the file on disk is newer, then the user just
911 ;; said no to rereading it. So the user probably wishes to
912 ;; overwrite the file with the buffer's contents, and check
913 ;; that in.
918 ;; if buffer is not saved, give user a chance to do it
921 ;; Revert if file is unchanged and buffer is too.
922 ;; If buffer is modified, that means the user just said no
923 ;; to saving it; in that case, don't revert,
924 ;; because the user might intend to save
925 ;; after finishing the log entry.
928 ;; DO NOT revert the file without asking the user!
934 ;; user may want to set nonstandard parameters
938 ;; OK, let's do the checkin
940 )))))
945 ;; Do a vc-next-action-on-file on all the marked files, possibly
946 ;; passing on the log comment we've just entered.
952 ;; Adjust the default directory so that checkouts
953 ;; go to the right place.
957 ;; Make sure that files don't vanish
958 ;; after they are checked in.
963 nil t))
966 ;; Here's the major entry point.
968 ;;;###autoload
970 "Do the next logical checkin or checkout operation on the current file.
971 If you call this from within a VC dired buffer with no files marked,
972 it will operate on the file in the current line.
973 If you call this from within a VC dired buffer, and one or more
974 files are marked, it will accept a log message and then operate on
975 each one. The log message will be used as a comment for any register
976 or checkin operations, but ignored when doing checkouts. Attempted
977 lock steals will raise an error.
978 A prefix argument lets you specify the version number to use.
980 For RCS and SCCS files:
981 If the file is not already registered, this registers it for version
982 control.
983 If the file is registered and not locked by anyone, this checks out
984 a writable and locked file ready for editing.
985 If the file is checked out and locked by the calling user, this
986 first checks to see if the file has changed since checkout. If not,
987 it performs a revert.
988 If the file has been changed, this pops up a buffer for entry
989 of a log message; when the message has been entered, it checks in the
990 resulting changes along with the log message as change commentary. If
991 the variable `vc-keep-workfiles' is non-nil (which is its default), a
992 read-only copy of the changed file is left in place afterwards.
993 If the file is registered and locked by someone else, you are given
994 the option to steal the lock.
996 For CVS files:
997 If the file is not already registered, this registers it for version
999 If the file is added but not committed, it is committed.
1000 If your working file is changed, but the repository file is
1001 unchanged, this pops up a buffer for entry of a log message; when the
1002 message has been entered, it checks in the resulting changes along
1003 with the logmessage as change commentary. A writable file is retained.
1004 If the repository file is changed, you are asked if you want to
1005 merge in the changes into your working copy."
1024 "Enter a change comment for the marked files."
1033 ;;; These functions help the vc-next-action entry point
1036 "Retrieve a writable copy of the latest version of the current buffer's file."
1038 )
1040 ;;;###autoload
1042 "Register the current file into your version-control system."
1052 ;; Watch out for new buffers of size 0: the corresponding file
1053 ;; does not exist yet, even though buffer-modified-p is nil.
1060 ;; inhibit backup for this buffer
1064 buffer-file-name
1068 vc-default-init-version)
1069 comment)
1070 ;; Recompute backend property (it may have been set to nil before).
1072 )
1075 ;; If the given file is in the current buffer,
1076 ;; either revert on it so we see expanded keywords,
1077 ;; or unvisit it (depending on vc-keep-workfiles)
1078 ;; NOQUERY if non-nil inhibits confirmation for reverting.
1079 ;; NOQUERY should be t *only* if it is known the only difference
1080 ;; between the buffer and the file is due to RCS rather than user editing!
1097 ;; if FILE is currently visited, resynch its buffer
1107 ;; Accept a comment for an operation on FILE revision REV. If COMMENT
1108 ;; is nil, pop up a VC-log buffer, emit MSG, and set the
1109 ;; action on close to ACTION; otherwise, do action immediately.
1110 ;; Remember the file's buffer in vc-parent-buffer (current one if no file).
1111 ;; AFTER-HOOK specifies the local value for vc-log-operation-hook.
1142 "Check a file into your version-control system.
1143 FILE is the unmodified name of the file. REV should be the base version
1144 level to check it in under. COMMENT, if specified, is the checkin comment."
1148 nil))
1151 "Retrieve a copy of the latest version of the given file."
1152 ;; If ftp is on this system and the name matches the ange-ftp format
1153 ;; for a remote file, the user is trying something that won't work.
1160 "Steal the lock on the current workfile."
1168 file-description owner)))
1184 ;; This is called when the notification has been sent.
1193 "Check in the file specified by FILE.
1194 The optional argument REV may be a string specifying the new version level
1195 \(if nil increment the current level). The file is either retained with write
1196 permissions zeroed, or deleted (according to the value of `vc-keep-workfiles').
1197 If the back-end is CVS, a writable workfile is always kept.
1198 COMMENT is a comment string; if omitted, a buffer is popped up to accept a
1199 comment.
1201 Runs the normal hook `vc-checkin-hook'."
1207 "Enter last VC comment into change log file for current buffer's file.
1208 Optional arg (interactive prefix) non-nil means prompt for user name and site.
1209 Second arg is file name of change log. \
1210 If nil, uses `change-log-default-name'.
1212 May be useful as a `vc-checkin-hook' to update change logs automatically."
1216 ;; Make sure the defvar for add-log-current-defun-function has been executed
1217 ;; before binding it.
1221 ;; Don't let add-change-log-entry insert a defun name.
1223 end)
1224 ;; Call add-log to do half the work.
1226 ;; Insert the VC comment, leaving point before it.
1229 ;; It starts with an open-paren, as in "(foo): Frobbed."
1230 ;; So remove the ": " add-log inserted.
1232 ;; Canonicalize the white space between the file name and comment.
1234 ;; Indent rest of the text the same way add-log indented the first line.
1241 ;; Fill the inserted text, preserving open-parens at bol.
1246 ;; Canonicalize the white space at the end of the entry so it is
1247 ;; separated from the next entry by a single blank line.
1254 "Complete the operation implied by the current log entry."
1256 ;; Check and record the comment, if any.
1259 ;; Comment too long?
1261 ;; Record the comment in the comment ring
1263 ))
1264 ;; Sync parent buffer in case the user modified it while editing the comment.
1265 ;; But not if it is a vc-dired buffer.
1271 ;; save the parameters held in buffer-local variables
1279 ;; OK, do it to it
1282 log-file
1283 log-version
1284 log-entry))
1285 ;; Remove checkin window (after the checkin so that if that fails
1286 ;; we don't zap the *VC-log* buffer and the typing therein).
1290 ;; Kill buffer and delete any other dedicated windows/frames.
1295 ;; Now make sure we see the expanded headers
1302 ;; Code for access to the comment ring
1305 "Cycle backwards through comment history."
1313 ;; Initialize the index on the first use of this command
1314 ;; so that the first M-p gets index 0, and the first M-n gets
1315 ;; index -1.
1326 "Cycle forwards through comment history."
1331 "Searches backwards through comment history for substring match."
1348 "Searches forwards through comment history for substring match."
1364 ;; Additional entry points for examining version histories
1366 ;;;###autoload
1368 "Display diffs between file versions.
1369 Normally this compares the current file and buffer with the most recent
1370 checked in version of that file. This uses no arguments.
1371 With a prefix argument, it reads the file name to use
1372 and two version designators specifying which versions to compare."
1378 unchanged)
1384 ;; Ideally, we'd like at this point to parse the diff so that
1385 ;; the buffer effectively goes into compilation mode and we
1386 ;; can visit the old and new change locations via next-error.
1387 ;; Unfortunately, this is just too painful to do. The basic
1388 ;; problem is that the `old' file doesn't exist to be
1389 ;; visited. This plays hell with numerous assumptions in
1390 ;; the diff.el and compile.el machinery.
1403 "For FILE, report diffs between two stored versions REL1 and REL2 of it.
1404 If FILE is a directory, generate diffs between versions for all registered
1405 files in or below it."
1408 "File or dir to diff: (default visited file) "
1410 default-directory buffer-file-name t))
1412 ;; compute default versions based on the file state
1414 ;; if it's a directory, don't supply any version defauolt
1416 nil)
1417 ;; if the file is locked, use current version as older version
1420 ;; if the file is not locked, use last and previous version as default
1424 ;; construct argument list
1430 nil nil rel1-default)
1435 nil nil rel2-default))))
1447 " and "
1453 default-directory
1461 )))
1466 )
1471 ;;;###autoload
1473 "Visit version REV of the current buffer in another window.
1474 If the current buffer is named `F', the version is named `F.~REV~'.
1475 If `F.~REV~' already exists, it is used instead of being re-created."
1480 rev))
1486 ;; Header-insertion code
1488 ;;;###autoload
1490 "Insert headers in a file for use with your version-control system.
1491 Headers desired are inserted at point, and are pulled from
1492 the variable `vc-header-alist'."
1508 hdstrings)
1513 vc-static-header-alist))
1514 )
1515 )))))
1518 ;; Clear all version headers in the current buffer, i.e. reset them
1519 ;; to the nonexpanded form. Only implemented for RCS, yet.
1520 ;; Don't lose point and mark during this.
1523 ;; save-excursion may be able to relocate point and mark properly.
1524 ;; If it fails, vc-restore-buffer-context will give it a second try.
1530 nil t)
1534 ;;;###autoload
1541 first-version second-version locking-user)
1562 ;; We want to merge an entire branch. Set versions
1563 ;; accordingly, so that vc-backend-merge understands us.
1565 ;; first-version must be the starting point of the branch
1581 ;;;###autoload
1583 "Invoke ediff to resolve conflicts in the current buffer.
1584 The conflicts must be marked with rcsmerge conflict markers."
1633 ;; Fire up ediff.
1637 ;; Ediff is now set up, and we are in the control buffer.
1638 ;; Do a few further adjustments and take precautions for exit.
1663 nil))))
1665 ;; The VC directory major mode. Coopt Dired for this.
1666 ;; All VC commands get mapped into logical equivalents.
1672 "The major mode used in VC directory buffers. It works like Dired,
1673 but lists only files under version control, with the current VC state of
1674 each file being indicated in the place of the file's link count, owner,
1675 group and size. Subdirectories are also listed, and you may insert them
1676 into the buffer as desired, like in Dired.
1677 All Dired commands operate normally, with the exception of `v', which
1678 is redefined as the version control prefix, so that you can type
1679 `vl', `v=' etc. to invoke `vc-print-log', `vc-diff', and the like on
1680 the file named in the current Dired buffer line. `vv' invokes
1681 `vc-next-action' on this file, or on all files currently marked.
1682 There is a special command, `*l', to mark all files currently locked."
1685 ;; The following is slightly modified from dired.el,
1686 ;; because file lines look a bit different in vc-dired-mode.
1690 ;; In some locales, month abbreviations are as short as 2 letters,
1691 ;; and they can be padded on the right with spaces.
1693 ;; Recognize any non-ASCII character.
1694 ;; The purpose is to match a Kanji character.
1696 ;; (k "[^\x00-\x7f\x80-\xff]")
1707 vc-dired-switches
1709 vc-dired-switches))
1717 "Toggle terse display in VC Dired."
1720 nil
1729 "Mark all files currently locked."
1741 ;; Don't specify DIR in this command, the default-directory is
1742 ;; enough. Otherwise it might fail with remote repositories.
1754 ;; Return the string that indicates the version control status
1755 ;; on a VC dired line.
1770 ;; Reformat a directory-listing line, replacing various columns with
1771 ;; version control information.
1772 ;; This code, like dired, assumes UNIX -l format.
1782 limit t)
1785 limit t)
1788 limit t))
1795 ;; Called by dired after any portion of a vc-dired buffer has been read in.
1796 ;; Reformat the listing according to version control.
1802 ;; subdir header line
1810 ;; erase (but don't remove) the "total" line
1816 ;; directory entry
1819 ;; subdir
1823 vc-directory-exclusion-list)
1829 ;; Don't show directories in terse mode. Don't use
1830 ;; dired-kill-line to remove it, because in recursive listings,
1831 ;; that would remove the directory contents as well.
1839 ;; ordinary file
1851 ;; any other line
1862 ;; Remove empty subdirs
1873 ;; We cannot remove the top level directory.
1874 ;; Just make it look a little nicer.
1881 ;;;###autoload
1889 vc-dired-switches)))
1892 ;; force a trailing slash
1900 ;; Named-configuration support for SCCS
1905 vc-name-assoc-file
1911 ))
1917 vc-name-assoc-file
1920 ;; (replace-regexp (concat ":" (regexp-quote file) "$") (concat ":" newname))
1925 ))
1928 ;; Return the numeric version corresponding to a named snapshot of file
1929 ;; If name is nil or a version number string it's just passed through
1933 name)
1939 vc-name-assoc-file
1945 ))
1947 ;; Named-configuration entry points
1950 ;; Scan the tree below the current directory.
1951 ;; If any files are locked, return the name of the first such file.
1952 ;; (This means, neither snapshot creation nor retrieval is allowed.)
1953 ;; If one or more of the files are currently visited, return `visited'.
1954 ;; Otherwise, return nil.
1958 default-directory
1963 status)))
1965 ;;;###autoload
1967 "Make a snapshot called NAME.
1968 The snapshot is made from all registered files at or below the current
1969 directory. For each file, the version level of its latest
1970 version becomes part of the named configuration."
1976 default-directory
1980 )))
1982 ;;;###autoload
1984 "Retrieve the snapshot called NAME, or latest versions if NAME is empty.
1985 When retrieving a snapshot, there must not be any locked files at or below
1986 the current directory. If none are locked, all registered files are
1987 checked out (unlocked) at their version levels in the snapshot NAME.
1988 If NAME is the empty string, all registered files that are not currently
1989 locked are updated to the latest versions."
1995 default-directory
2007 default-directory
2013 )))))
2015 ;; Miscellaneous other entry points
2017 ;;;###autoload
2019 "List the change log of the current buffer in a window."
2034 ;; move point to the log entry for the current version
2037 ;; also match some context, for safety
2040 ;; set the display window so that
2041 ;; the whole log entry is displayed
2049 ;; if the global information and this log entry fit
2050 ;; into the window, display from the beginning
2055 ;; if the whole entry fits into the window,
2056 ;; display it centered
2060 ;; otherwise (the entry is too large for the window),
2061 ;; display from the start
2066 ;;;###autoload
2068 "Revert the current buffer's file back to the version it was based on.
2069 This asks for confirmation if the buffer contents are not identical
2070 to that version. Note that for RCS and CVS, this function does not
2071 automatically pick up newer changes found in the master file;
2076 ;; This operation should always ask for confirmation.
2091 ;;;###autoload
2093 "Get rid of most recently checked in version of this file.
2094 A prefix argument means do not revert the buffer afterwards."
2108 nil
2112 ;; Check out the most recent remaining version. If it fails, because
2113 ;; the whole branch got deleted, do a double-take and check out the
2114 ;; version where the branch started.
2119 ;; Check out locked, but only to disc, and keep
2120 ;; modifications in the buffer.
2122 ;; Check out unlocked, and revert buffer.
2125 ;; If the checkout fails, vc-do-command signals an error.
2126 ;; We catch this error, check the reason, correct the
2127 ;; version number, and try a second time.
2132 ;; vc-do-command popped up a window with
2133 ;; the error message. Get rid of it, by
2134 ;; restoring the old window configuration.
2136 ;; No, it was some other error: re-signal it.
2138 ;; If norevert, clear version headers and mark the buffer modified.
2143 ;; inhibit backup for this buffer
2151 )))
2153 ;;;###autoload
2155 "Rename file OLD to NEW, and rename its master file likewise."
2157 ;; There are several ways of renaming files under CVS 1.3, but they all
2158 ;; have serious disadvantages. See the FAQ (available from think.com in
2159 ;; pub/cvs/). I'd rather send the user an error, than do something he might
2160 ;; consider to be wrong. When the famous, long-awaited rename database is
2161 ;; implemented things might change for the better. This is unlikely to occur
2162 ;; until CVS 2.0 is released. --ceder 1994-01-23 21:27:51
2178 ;; This had FILE, I changed it to OLD. -- rms.
2195 vc-master-templates)
2197 ;; Handle the SCCS PROJECTDIR feature. It is odd that this
2198 ;; is a special case, but a more elegant solution would require
2199 ;; significant changes in other parts of VC.
2209 ; ?? Renaming a file might change its contents due to keyword expansion.
2210 ; We should really check out a new copy if the old copy was precisely equal
2211 ; to some checked in version. However, testing for this is tricky....
2220 ;; This had FILE, I changed it to OLD. -- rms.
2223 nil ;RCS
2224 nil ;CVS
2225 )
2226 )
2228 ;;;###autoload
2230 "Find change log file and add entries from recent RCS/CVS logs.
2231 Normally, find log entries for all registered files in the default
2232 directory using `rcs2log', which finds CVS logs preferentially.
2233 The mark is left at the end of the text prepended to the change log.
2235 With prefix arg of C-u, only find log entries for the current buffer's file.
2237 With any numeric prefix arg, find log entries for all currently visited
2238 files that are under version control. This puts all the entries in the
2239 log for the default directory, which may not be appropriate.
2241 From a program, any arguments are assumed to be filenames and are
2242 passed to the `rcs2log' script after massaging to be relative to the
2243 default directory."
2250 file)
2256 files))
2258 ;; `rcs2log' will find the relevant RCS or CVS files
2259 ;; relative to the curent directory if none supplied.
2260 nil)))
2263 ;; Presumably not portable to non-Unixy systems, along with rcs2log:
2267 temporary-file-directory))))
2273 user-mail-address)))
2287 "-c" changelog
2296 f
2298 args)))
2299 "done"
2307 \f
2308 ;; vc-annotate functionality (CVS only).
2315 ;; Syntax Table
2319 ;; Declare globally instead of additional parameter to
2320 ;; temp-buffer-show-function (not possible to pass more than one
2321 ;; parameter).
2337 "Major mode for buffers displaying output from the CVS `annotate' command.
2339 You can use the mode-specific menu to alter the time-span of the used
2340 colors. See variable `vc-annotate-menu-elements' for customizing the
2341 menu items."
2348 ; finds out what to describe.
2354 "Use the default color spectrum for VC Annotate mode."
2361 "Adds the menu 'Annotate' to the menu bar in VC-Annotate mode."
2363 '("Default" . vc-annotate-display-default))
2364 (let ((menu-elements vc-annotate-menu-elements))
2365 (while menu-elements
2366 (let* ((element (car menu-elements))
2367 (days (round (* element
2368 (vc-annotate-car-last-cons vc-annotate-color-map)
2369 0.7585))))
2370 (setq menu-elements (cdr menu-elements))
2371 (define-key vc-annotate-mode-menu
2372 (vector days)
2373 (cons (format "Span %d days"
2374 days)
2375 `(lambda ()
2376 ,(format "Use colors spanning %d days" days)
2377 (interactive)
2378 (message "Redisplaying annotation...")
2379 (vc-annotate-display
2380 (get-buffer (buffer-name))
2381 (vc-annotate-time-span vc-annotate-color-map ,element))
2382 (message "Redisplaying annotation...done"))))))))
2384 ;;;###autoload
2385 (defun vc-annotate (ratio)
2386 "Display the result of the CVS `annotate' command using colors.
2387 New lines are displayed in red, old in blue.
2388 A prefix argument specifies a factor for stretching the time scale.
2390 `vc-annotate-menu-elements' customizes the menu elements of the
2391 mode-specific menu. `vc-annotate-color-map' and
2392 `vc-annotate-very-old-color' defines the mapping of time to
2393 colors. `vc-annotate-background' specifies the background color."
2394 (interactive "p")
2395 (vc-ensure-vc-buffer)
2396 (if (not (eq (vc-backend (buffer-file-name)) 'CVS))
2397 (error "Sorry, vc-annotate is only implemented for CVS"))
2398 (message "Annotating...")
2399 (let ((temp-buffer-name (concat "*cvs annotate " (buffer-name) "*"))
2400 (temp-buffer-show-function 'vc-annotate-display)
2401 (vc-annotate-ratio ratio))
2402 (with-output-to-temp-buffer temp-buffer-name
2403 (call-process "cvs" nil (get-buffer temp-buffer-name) nil
2404 "annotate" (file-name-nondirectory (buffer-file-name)))))
2405 (message "Annotating... done"))
2407 (defun vc-annotate-car-last-cons (a-list)
2408 "Return car of last cons in association list A-LIST."
2409 (if (not (eq nil (cdr a-list)))
2410 (vc-annotate-car-last-cons (cdr a-list))
2411 (car (car a-list))))
2413 (defun vc-annotate-time-span (a-list span &optional quantize)
2414 "Return an association list with factor SPAN applied to the time-span
2415 of association list A-LIST. Optionaly quantize to the factor of
2416 QUANTIZE."
2417 ;; Apply span to each car of every cons
2418 (if (not (eq nil a-list))
2419 (append (list (cons (* (car (car a-list)) span)
2420 (cdr (car a-list))))
2421 (vc-annotate-time-span (nthcdr (cond (quantize) ; optional
2422 (1)) ; Default to cdr
2423 a-list) span quantize))))
2425 (defun vc-annotate-compcar (threshold a-list)
2426 "Test successive cons cells of association list A-LIST against
2427 THRESHOLD. Return the first cons cell which car is not less than
2428 THRESHOLD, nil otherwise"
2429 (let ((i 1)
2430 (tmp-cons (car a-list)))
2431 (while (and tmp-cons (< (car tmp-cons) threshold))
2432 (setq tmp-cons (car (nthcdr i a-list)))
2433 (setq i (+ i 1)))
2434 tmp-cons)) ; Return the appropriate value
2437 (defun vc-annotate-display (buffer &optional color-map)
2438 "Do the VC-Annotate display in BUFFER using COLOR-MAP."
2440 ;; Handle the case of the global variable vc-annotate-ratio being
2441 ;; set. This variable is used to pass information from function
2442 ;; vc-annotate since it is not possible to use another parameter
2443 ;; (see temp-buffer-show-function).
2444 (if (and (not color-map) vc-annotate-ratio)
2445 ;; This will only be true if called from vc-annotate with ratio
2446 ;; being non-nil.
2447 (setq color-map (vc-annotate-time-span vc-annotate-color-map
2448 vc-annotate-ratio)))
2450 ;; We need a list of months and their corresponding numbers.
2451 (let* ((local-month-numbers
2452 '(("Jan" . 1) ("Feb" . 2) ("Mar" . 3) ("Apr" . 4)
2453 ("May" . 5) ("Jun" . 6) ("Jul" . 7) ("Aug" . 8)
2454 ("Sep" . 9) ("Oct" . 10) ("Nov" . 11) ("Dec" . 12))))
2455 (set-buffer buffer)
2456 (display-buffer buffer)
2457 (or (eq major-mode 'vc-annotate-mode) ; Turn on vc-annotate-mode if not done
2458 (vc-annotate-mode))
2459 ;; Delete old overlays
2460 (mapcar
2461 (lambda (overlay)
2462 (if (overlay-get overlay 'vc-annotation)
2463 (delete-overlay overlay)))
2464 (overlays-in (point-min) (point-max)))
2465 (goto-char (point-min)) ; Position at the top of the buffer.
2466 (while (re-search-forward
2469 nil t)
2471 (let* (;; Unfortunately, order is important. match-string will
2472 ;; be corrupted by extent functions in XEmacs. Access
2473 ;; string-matches first.
2474 (day (string-to-number (match-string 1)))
2475 (month (cdr (assoc (match-string 2) local-month-numbers)))
2476 (year-tmp (string-to-number (match-string 3)))
2477 ;; Years 0..68 are 2000..2068.
2478 ;; Years 69..99 are 1969..1999.
2479 (year (+ (cond ((> 69 year-tmp) 2000)
2480 ((> 100 year-tmp) 1900)
2481 (t 0))
2482 year-tmp))
2483 (high (- (car (current-time))
2484 (car (encode-time 0 0 0 day month year))))
2485 (color (cond ((vc-annotate-compcar high (cond (color-map)
2486 (vc-annotate-color-map))))
2487 ((cons nil vc-annotate-very-old-color))))
2488 ;; substring from index 1 to remove any leading `#' in the name
2489 (face-name (concat "vc-annotate-face-" (substring (cdr color) 1)))
2490 ;; Make the face if not done.
2491 (face (cond ((intern-soft face-name))
2492 ((let ((tmp-face (make-face (intern face-name))))
2493 (set-face-foreground tmp-face (cdr color))
2494 (if vc-annotate-background
2495 (set-face-background tmp-face vc-annotate-background))
2496 tmp-face)))) ; Return the face
2497 (point (point))
2498 overlay)
2500 (forward-line 1)
2501 (setq overlay (make-overlay point (point)))
2502 (overlay-put overlay 'face face)
2503 (overlay-put overlay 'vc-annotation t)))))
2505 \f
2506 ;; Collect back-end-dependent stuff here
2508 (defun vc-backend-admin (file &optional rev comment)
2509 ;; Register a file into the version-control system
2510 ;; Automatically retrieves a read-only version of the file with
2511 ;; keywords expanded if vc-keep-workfiles is non-nil, otherwise
2512 ;; it deletes the workfile.
2513 (vc-file-clearprops file)
2514 (or vc-default-back-end
2515 (setq vc-default-back-end (if (vc-find-binary "rcs") 'RCS 'SCCS)))
2516 (message "Registering %s..." file)
2517 (let* ((switches
2518 (if (stringp vc-register-switches)
2519 (list vc-register-switches)
2520 vc-register-switches))
2521 (project-dir)
2522 (backend
2523 (cond
2524 ((file-exists-p (vc-backend-subdirectory-name)) vc-default-back-end)
2525 ((file-exists-p "RCS") 'RCS)
2526 ((file-exists-p "CVS") 'CVS)
2527 ((file-exists-p "SCCS") 'SCCS)
2528 ((setq project-dir (vc-sccs-project-dir)) 'SCCS)
2529 (t vc-default-back-end))))
2530 (cond ((eq backend 'SCCS)
2531 (let ((vc-name
2532 (if project-dir (concat project-dir
2533 "s." (file-name-nondirectory file))
2534 (format
2535 (car (rassq 'SCCS vc-master-templates))
2536 (or (file-name-directory file) "")
2537 (file-name-nondirectory file)))))
2538 (apply 'vc-do-command nil 0 "admin" nil nil ;; SCCS
2539 (and rev (concat "-r" rev))
2540 "-fb"
2541 (concat "-i" file)
2542 (and comment (concat "-y" comment))
2543 vc-name
2544 switches))
2545 (delete-file file)
2546 (if vc-keep-workfiles
2547 (vc-do-command nil 0 "get" file 'MASTER)))
2548 ((eq backend 'RCS)
2549 (apply 'vc-do-command nil 0 "ci" file 'WORKFILE ;; RCS
2550 ;; if available, use the secure registering option
2551 (and (vc-backend-release-p 'RCS "5.6.4") "-i")
2552 (concat (if vc-keep-workfiles "-u" "-r") rev)
2553 (and comment (concat "-t-" comment))
2554 switches))
2555 ((eq backend 'CVS)
2556 (apply 'vc-do-command nil 0 "cvs" file 'WORKFILE ;; CVS
2557 "add"
2559 (concat "-m" comment))
2560 switches)
2561 )))
2562 (message "Registering %s...done" file)
2563 )
2565 (defun vc-backend-checkout (file &optional writable rev workfile)
2566 ;; Retrieve a copy of a saved version into a workfile
2567 (let ((filename (or workfile file))
2568 (file-buffer (get-file-buffer file))
2569 switches)
2570 (message "Checking out %s..." filename)
2571 (save-excursion
2572 ;; Change buffers to get local value of vc-checkout-switches.
2573 (if file-buffer (set-buffer file-buffer))
2574 (setq switches (if (stringp vc-checkout-switches)
2575 (list vc-checkout-switches)
2576 vc-checkout-switches))
2577 ;; Save this buffer's default-directory
2578 ;; and use save-excursion to make sure it is restored
2579 ;; in the same buffer it was saved in.
2580 (let ((default-directory default-directory))
2581 (save-excursion
2582 ;; Adjust the default-directory so that the check-out creates
2583 ;; the file in the right place.
2584 (setq default-directory (file-name-directory filename))
2585 (vc-backend-dispatch file
2586 (progn ;; SCCS
2587 (and rev (string= rev "") (setq rev nil))
2588 (if workfile
2589 ;; Some SCCS implementations allow checking out directly to a
2590 ;; file using the -G option, but then some don't so use the
2591 ;; least common denominator approach and use the -p option
2592 ;; ala RCS.
2593 (let ((vc-modes (logior (file-modes (vc-name file))
2594 (if writable 128 0)))
2595 (failed t))
2596 (unwind-protect
2597 (progn
2598 (let ((coding-system-for-read 'no-conversion)
2599 (coding-system-for-write 'no-conversion))
2600 (with-temp-file filename
2601 (apply 'vc-do-command
2602 (current-buffer) 0 "get" file 'MASTER
2603 "-s" ;; suppress diagnostic output
2604 (if writable "-e")
2605 "-p"
2606 (and rev
2607 (concat "-r"
2608 (vc-lookup-triple file rev)))
2609 switches)))
2610 (set-file-modes filename
2611 (logior (file-modes (vc-name file))
2612 (if writable 128 0)))
2613 (setq failed nil))
2614 (and failed (file-exists-p filename)
2615 (delete-file filename))))
2616 (apply 'vc-do-command nil 0 "get" file 'MASTER ;; SCCS
2617 (if writable "-e")
2618 (and rev (concat "-r" (vc-lookup-triple file rev)))
2619 switches)
2620 (vc-file-setprop file 'vc-workfile-version nil)))
2621 (if workfile ;; RCS
2622 ;; RCS doesn't let us check out into arbitrary file names directly.
2623 ;; Use `co -p' and make stdout point to the correct file.
2624 (let ((vc-modes (logior (file-modes (vc-name file))
2625 (if writable 128 0)))
2626 (failed t))
2627 (unwind-protect
2628 (progn
2629 (let ((coding-system-for-read 'no-conversion)
2630 (coding-system-for-write 'no-conversion))
2631 (with-temp-file filename
2632 (apply 'vc-do-command
2633 (current-buffer) 0 "co" file 'MASTER
2634 "-q" ;; suppress diagnostic output
2635 (if writable "-l")
2636 (concat "-p" rev)
2637 switches)))
2638 (set-file-modes filename
2639 (logior (file-modes (vc-name file))
2640 (if writable 128 0)))
2641 (setq failed nil))
2642 (and failed (file-exists-p filename) (delete-file filename))))
2643 (let (new-version)
2644 ;; if we should go to the head of the trunk,
2645 ;; clear the default branch first
2646 (and rev (string= rev "")
2647 (vc-do-command nil 0 "rcs" file 'MASTER "-b"))
2648 ;; now do the checkout
2649 (apply 'vc-do-command
2650 nil 0 "co" file 'MASTER
2651 ;; If locking is not strict, force to overwrite
2652 ;; the writable workfile.
2653 (if (eq (vc-checkout-model file) 'implicit) "-f")
2654 (if writable "-l")
2655 (if rev (concat "-r" rev)
2656 ;; if no explicit revision was specified,
2657 ;; check out that of the working file
2658 (let ((workrev (vc-workfile-version file)))
2659 (if workrev (concat "-r" workrev)
2660 nil)))
2661 switches)
2662 ;; determine the new workfile version
2663 (save-excursion
2664 (set-buffer "*vc*")
2665 (goto-char (point-min))
2666 (setq new-version
2668 (buffer-substring (match-beginning 1) (match-end 1)))))
2669 (vc-file-setprop file 'vc-workfile-version new-version)
2670 ;; if necessary, adjust the default branch
2671 (and rev (not (string= rev ""))
2672 (vc-do-command nil 0 "rcs" file 'MASTER
2673 (concat "-b" (if (vc-latest-on-branch-p file)
2674 (if (vc-trunk-p new-version) nil
2675 (vc-branch-part new-version))
2676 new-version))))))
2677 (if workfile ;; CVS
2678 ;; CVS is much like RCS
2679 (let ((failed t))
2680 (unwind-protect
2681 (progn
2682 (let ((coding-system-for-read 'no-conversion)
2683 (coding-system-for-write 'no-conversion))
2684 (with-temp-file filename
2685 (apply 'vc-do-command
2686 (current-buffer) 0 "cvs" file 'WORKFILE
2687 "-Q" ;; suppress diagnostic output
2688 "update"
2689 (concat "-r" rev)
2690 "-p"
2691 switches)))
2692 (setq failed nil))
2693 (and failed (file-exists-p filename) (delete-file filename))))
2694 ;; default for verbose checkout: clear the sticky tag
2695 ;; so that the actual update will get the head of the trunk
2696 (and rev (string= rev "")
2697 (vc-do-command nil 0 "cvs" file 'WORKFILE "update" "-A"))
2698 ;; If a revision was specified, check that out.
2699 (if rev
2700 (apply 'vc-do-command nil 0 "cvs" file 'WORKFILE
2701 (and writable (eq (vc-checkout-model file) 'manual) "-w")
2702 "update"
2703 (and rev (not (string= rev ""))
2704 (concat "-r" rev))
2705 switches)
2706 ;; If no revision was specified, call "cvs edit" to make
2707 ;; the file writeable.
2708 (and writable (eq (vc-checkout-model file) 'manual)
2709 (vc-do-command nil 0 "cvs" file 'WORKFILE "edit")))
2710 (if rev (vc-file-setprop file 'vc-workfile-version nil))))
2711 (cond
2712 ((not workfile)
2713 (vc-file-clear-masterprops file)
2714 (if writable
2715 (vc-file-setprop file 'vc-locking-user (vc-user-login-name)))
2716 (vc-file-setprop file
2717 'vc-checkout-time (nth 5 (file-attributes file)))))
2718 (message "Checking out %s...done" filename))))))
2720 (defun vc-backend-logentry-check (file)
2721 (vc-backend-dispatch file
2722 (if (>= (buffer-size) 512) ;; SCCS
2723 (progn
2724 (goto-char 512)
2725 (error
2726 "Log must be less than 512 characters; point is now at pos 512")))
2727 nil ;; RCS
2728 nil) ;; CVS
2729 )
2731 (defun vc-backend-checkin (file rev comment)
2732 ;; Register changes to FILE as level REV with explanatory COMMENT.
2733 ;; Automatically retrieves a read-only version of the file with
2734 ;; keywords expanded if vc-keep-workfiles is non-nil, otherwise
2735 ;; it deletes the workfile.
2736 ;; Adaptation for RCS branch support: if this is an explicit checkin,
2737 ;; or if the checkin creates a new branch, set the master file branch
2738 ;; accordingly.
2739 (message "Checking in %s..." file)
2740 ;; "This log message intentionally left almost blank".
2741 ;; RCS 5.7 gripes about white-space-only comments too.
2743 (setq comment "*** empty log message ***"))
2744 (save-excursion
2745 ;; Change buffers to get local value of vc-checkin-switches.
2746 (set-buffer (or (get-file-buffer file) (current-buffer)))
2747 (let ((switches
2748 (if (stringp vc-checkin-switches)
2749 (list vc-checkin-switches)
2750 vc-checkin-switches)))
2751 ;; Clear the master-properties. Do that here, not at the
2752 ;; end, because if the check-in fails we want them to get
2753 ;; re-computed before the next try.
2754 (vc-file-clear-masterprops file)
2755 (vc-backend-dispatch file
2756 ;; SCCS
2757 (progn
2758 (apply 'vc-do-command nil 0 "delta" file 'MASTER
2759 (if rev (concat "-r" rev))
2760 (concat "-y" comment)
2761 switches)
2762 (vc-file-setprop file 'vc-locking-user 'none)
2763 (vc-file-setprop file 'vc-workfile-version nil)
2764 (if vc-keep-workfiles
2765 (vc-do-command nil 0 "get" file 'MASTER))
2766 )
2767 ;; RCS
2768 (let ((old-version (vc-workfile-version file)) new-version)
2769 (apply 'vc-do-command nil 0 "ci" file 'MASTER
2770 ;; if available, use the secure check-in option
2771 (and (vc-backend-release-p 'RCS "5.6.4") "-j")
2772 (concat (if vc-keep-workfiles "-u" "-r") rev)
2773 (concat "-m" comment)
2774 switches)
2775 (vc-file-setprop file 'vc-locking-user 'none)
2776 (vc-file-setprop file 'vc-workfile-version nil)
2778 ;; determine the new workfile version
2779 (set-buffer "*vc*")
2780 (goto-char (point-min))
2781 (if (or (re-search-forward
2783 (re-search-forward
2785 (progn (setq new-version (buffer-substring (match-beginning 1)
2786 (match-end 1)))
2787 (vc-file-setprop file 'vc-workfile-version new-version)))
2789 ;; if we got to a different branch, adjust the default
2790 ;; branch accordingly
2791 (cond
2792 ((and old-version new-version
2793 (not (string= (vc-branch-part old-version)
2794 (vc-branch-part new-version))))
2795 (vc-do-command nil 0 "rcs" file 'MASTER
2796 (if (vc-trunk-p new-version) "-b"
2797 (concat "-b" (vc-branch-part new-version))))
2798 ;; If this is an old RCS release, we might have
2799 ;; to remove a remaining lock.
2800 (if (not (vc-backend-release-p 'RCS "5.6.2"))
2801 ;; exit status of 1 is also accepted.
2802 ;; It means that the lock was removed before.
2803 (vc-do-command nil 1 "rcs" file 'MASTER
2804 (concat "-u" old-version))))))
2805 ;; CVS
2806 (progn
2807 ;; explicit check-in to the trunk requires a
2808 ;; double check-in (first unexplicit) (CVS-1.3)
2809 (condition-case nil
2810 (progn
2811 (if (and rev (vc-trunk-p rev))
2812 (apply 'vc-do-command nil 0 "cvs" file 'WORKFILE
2813 "ci" "-m" "intermediate"
2814 switches))
2815 (apply 'vc-do-command nil 0 "cvs" file 'WORKFILE
2816 "ci" (if rev (concat "-r" rev))
2817 (concat "-m" comment)
2818 switches))
2819 (error (if (eq (vc-cvs-status file) 'needs-merge)
2820 ;; The CVS output will be on top of this message.
2821 (error "Type C-x 0 C-x C-q to merge in changes")
2822 (error "Check-in failed"))))
2823 ;; determine and store the new workfile version
2824 (set-buffer "*vc*")
2825 (goto-char (point-min))
2826 (if (re-search-forward
2828 (vc-file-setprop file 'vc-workfile-version
2829 (buffer-substring (match-beginning 2)
2830 (match-end 2)))
2831 (vc-file-setprop file 'vc-workfile-version nil))
2832 ;; if this was an explicit check-in, remove the sticky tag
2833 (if rev
2834 (vc-do-command nil 0 "cvs" file 'WORKFILE "update" "-A"))
2835 ;; Forget the checkout model, because we might have assumed
2836 ;; a wrong one when we found the file. After commit, we can
2837 ;; tell it from the permissions of the file
2838 ;; (see vc-checkout-model).
2839 (vc-file-setprop file 'vc-checkout-model nil)
2840 (vc-file-setprop file 'vc-locking-user 'none)
2841 (vc-file-setprop file 'vc-checkout-time
2842 (nth 5 (file-attributes file)))))))
2843 (message "Checking in %s...done" file))
2845 (defun vc-backend-revert (file)
2846 ;; Revert file to the version it was based on.
2847 (message "Reverting %s..." file)
2848 (vc-file-clear-masterprops file)
2849 (vc-backend-dispatch
2850 file
2851 ;; SCCS
2852 (progn
2853 (vc-do-command nil 0 "unget" file 'MASTER nil)
2854 (vc-do-command nil 0 "get" file 'MASTER nil)
2855 ;; Checking out explicit versions is not supported under SCCS, yet.
2856 ;; We always "revert" to the latest version; therefore
2857 ;; vc-workfile-version is cleared here so that it gets recomputed.
2858 (vc-file-setprop file 'vc-workfile-version nil))
2859 ;; RCS
2860 (vc-do-command nil 0 "co" file 'MASTER
2861 "-f" (concat "-u" (vc-workfile-version file)))
2862 ;; CVS
2863 (progn
2864 ;; Check out via standard output (caused by the final argument
2865 ;; FILE below), so that no sticky tag is set.
2866 (vc-backend-checkout file nil (vc-workfile-version file) file)
2867 ;; If "cvs edit" was used to make the file writeable,
2868 ;; call "cvs unedit" now to undo that.
2869 (if (eq (vc-checkout-model file) 'manual)
2870 (vc-do-command nil 0 "cvs" file 'WORKFILE "unedit"))))
2871 (vc-file-setprop file 'vc-locking-user 'none)
2872 (vc-file-setprop file 'vc-checkout-time (nth 5 (file-attributes file)))
2873 (message "Reverting %s...done" file)
2874 )
2876 (defun vc-backend-steal (file &optional rev)
2877 ;; Steal the lock on the current workfile. Needs RCS 5.6.2 or later for -M.
2878 (message "Stealing lock on %s..." file)
2879 (vc-backend-dispatch file
2880 (progn ;SCCS
2881 (vc-do-command nil 0 "unget" file 'MASTER "-n" (if rev (concat "-r" rev)))
2882 (vc-do-command nil 0 "get" file 'MASTER "-g" (if rev (concat "-r" rev)))
2883 )
2884 (vc-do-command nil 0 "rcs" file 'MASTER ;RCS
2885 "-M" (concat "-u" rev) (concat "-l" rev))
2886 (error "You cannot steal a CVS lock; there are no CVS locks to steal") ;CVS
2887 )
2888 (vc-file-setprop file 'vc-locking-user (vc-user-login-name))
2889 (message "Stealing lock on %s...done" file)
2890 )
2892 (defun vc-backend-uncheck (file target)
2893 ;; Undo the latest checkin.
2894 (message "Removing last change from %s..." file)
2895 (vc-backend-dispatch file
2896 (vc-do-command nil 0 "rmdel" file 'MASTER (concat "-r" target))
2897 (vc-do-command nil 0 "rcs" file 'MASTER (concat "-o" target))
2898 nil ;; this is never reached under CVS
2899 )
2900 (message "Removing last change from %s...done" file)
2901 )
2903 (defun vc-backend-print-log (file)
2904 ;; Get change log associated with FILE.
2905 (vc-backend-dispatch
2906 file
2907 (vc-do-command nil 0 "prs" file 'MASTER)
2908 (vc-do-command nil 0 "rlog" file 'MASTER)
2909 (vc-do-command nil 0 "cvs" file 'WORKFILE "log")))
2911 (defun vc-backend-assign-name (file name)
2912 ;; Assign to a FILE's latest version a given NAME.
2913 (vc-backend-dispatch file
2914 (vc-add-triple name file (vc-latest-version file)) ;; SCCS
2915 (vc-do-command nil 0 "rcs" file 'MASTER (concat "-n" name ":")) ;; RCS
2916 (vc-do-command nil 0 "cvs" file 'WORKFILE "tag" name) ;; CVS
2917 )
2918 )
2920 (defun vc-backend-diff (file &optional oldvers newvers cmp)
2921 ;; Get a difference report between two versions of FILE.
2922 ;; Get only a brief comparison report if CMP, a difference report otherwise.
2923 (let ((backend (vc-backend file)) options status
2924 (diff-switches-list (if (listp diff-switches)
2925 diff-switches
2926 (list diff-switches))))
2927 (cond
2928 ((eq backend 'SCCS)
2929 (setq oldvers (vc-lookup-triple file oldvers))
2930 (setq newvers (vc-lookup-triple file newvers))
2931 (setq options (append (list (and cmp "--brief") "-q"
2932 (and oldvers (concat "-r" oldvers))
2933 (and newvers (concat "-r" newvers)))
2934 (and (not cmp) diff-switches-list)))
2935 (apply 'vc-do-command "*vc-diff*" 1 "vcdiff" file 'MASTER options))
2936 ((eq backend 'RCS)
2937 (if (not oldvers) (setq oldvers (vc-workfile-version file)))
2938 ;; If we know that --brief is not supported, don't try it.
2939 (setq cmp (and cmp (not (eq vc-rcsdiff-knows-brief 'no))))
2940 (setq options (append (list (and cmp "--brief") "-q"
2941 (concat "-r" oldvers)
2942 (and newvers (concat "-r" newvers)))
2943 (and (not cmp) diff-switches-list)))
2944 (setq status (apply 'vc-do-command "*vc-diff*" 2
2945 "rcsdiff" file 'WORKFILE options))
2946 ;; If --brief didn't work, do a double-take and remember it
2947 ;; for the future.
2948 (if (eq status 2)
2949 (prog1
2950 (apply 'vc-do-command "*vc-diff*" 1 "rcsdiff" file 'WORKFILE
2951 (if cmp (cdr options) options))
2952 (if cmp (setq vc-rcsdiff-knows-brief 'no)))
2953 ;; If --brief DID work, remember that, too.
2954 (and cmp (not vc-rcsdiff-knows-brief)
2955 (setq vc-rcsdiff-knows-brief 'yes))
2956 status))
2957 ;; CVS is different.
2958 ((eq backend 'CVS)
2959 (if (string= (vc-workfile-version file) "0")
2960 ;; This file is added but not yet committed; there is no master file.
2961 (if (or oldvers newvers)
2962 (error "No revisions of %s exist" file)
2963 (if cmp 1 ;; file is added but not committed,
2964 ;; we regard this as "changed".
2965 ;; diff it against /dev/null.
2966 (apply 'vc-do-command
2967 "*vc-diff*" 1 "diff" file 'WORKFILE
2968 (append diff-switches-list '("/dev/null")))))
2969 ;; cmp is not yet implemented -- we always do a full diff.
2970 (apply 'vc-do-command
2971 "*vc-diff*" 1 "cvs" file 'WORKFILE "diff"
2972 (and oldvers (concat "-r" oldvers))
2973 (and newvers (concat "-r" newvers))
2974 diff-switches-list))))))
2976 (defun vc-backend-merge-news (file)
2977 ;; Merge in any new changes made to FILE.
2978 (message "Merging changes into %s..." file)
2979 (prog1
2980 (vc-backend-dispatch
2981 file
2982 (error "vc-backend-merge-news not meaningful for SCCS files") ;SCCS
2983 (error "vc-backend-merge-news not meaningful for RCS files") ;RCS
2984 (save-excursion ; CVS
2985 (vc-file-clear-masterprops file)
2986 (vc-file-setprop file 'vc-workfile-version nil)
2987 (vc-file-setprop file 'vc-locking-user nil)
2988 (vc-file-setprop file 'vc-checkout-time nil)
2989 (vc-do-command nil 0 "cvs" file 'WORKFILE "update")
2990 ;; Analyze the merge result reported by CVS, and set
2991 ;; file properties accordingly.
2992 (set-buffer (get-buffer "*vc*"))
2993 (goto-char (point-min))
2994 ;; get new workfile version
2995 (if (re-search-forward (concat "^Merging differences between "
2996 "[01234567890.]* and "
2998 nil t)
2999 (vc-file-setprop file 'vc-workfile-version (match-string 1)))
3000 ;; get file status
3001 (if (re-search-forward
3003 (regexp-quote (file-name-nondirectory file))
3005 nil t)
3006 (cond
3007 ;; Merge successful, we are in sync with repository now
3008 ((or (string= (match-string 2) "U")
3009 (string= (match-string 2) "P")
3010 ;; Special case: file contents in sync with
3011 ;; repository anyhow:
3012 (match-string 3))
3013 (vc-file-setprop file 'vc-locking-user 'none)
3014 (vc-file-setprop file 'vc-checkout-time
3015 (nth 5 (file-attributes file)))
3016 0) ;; indicate success to the caller
3017 ;; Merge successful, but our own changes are still in the file
3018 ((string= (match-string 2) "M")
3019 (vc-file-setprop file 'vc-locking-user (vc-file-owner file))
3020 (vc-file-setprop file 'vc-checkout-time 0)
3021 0) ;; indicate success to the caller
3022 ;; Conflicts detected!
3023 ((string= (match-string 2) "C")
3024 (vc-file-setprop file 'vc-locking-user (vc-file-owner file))
3025 (vc-file-setprop file 'vc-checkout-time 0)
3026 1) ;; signal the error to the caller
3027 )
3028 (pop-to-buffer "*vc*")
3029 (error "Couldn't analyze cvs update result"))))
3030 (message "Merging changes into %s...done" file)))
3032 (defun vc-backend-merge (file first-version &optional second-version)
3033 ;; Merge the changes between FIRST-VERSION and SECOND-VERSION into
3034 ;; the current working copy of FILE. It is assumed that FILE is
3035 ;; locked and writable (vc-merge ensures this).
3036 (vc-backend-dispatch file
3037 ;; SCCS
3038 (error "Sorry, merging is not implemented for SCCS")
3039 ;; RCS
3040 (vc-do-command nil 1 "rcsmerge" file 'MASTER
3041 "-kk" ;; ignore keyword conflicts
3042 (concat "-r" first-version)
3043 (if second-version (concat "-r" second-version)))
3044 ;; CVS
3045 (progn
3046 (vc-do-command nil 0 "cvs" file 'WORKFILE
3047 "update" "-kk"
3048 (concat "-j" first-version)
3049 (concat "-j" second-version))
3050 (save-excursion
3051 (set-buffer (get-buffer "*vc*"))
3052 (goto-char (point-min))
3053 (if (re-search-forward "conflicts during merge" nil t)
3054 1 ;; signal error
3055 0 ;; signal success
3056 )))))
3058 (defun vc-check-headers ()
3059 "Check if the current file has any headers in it."
3060 (interactive)
3061 (save-excursion
3062 (goto-char (point-min))
3063 (vc-backend-dispatch buffer-file-name
3064 (re-search-forward "%[MIRLBSDHTEGUYFPQCZWA]%" nil t) ;; SCCS
3065 (re-search-forward "\\$[A-Za-z\300-\326\330-\366\370-\377]+\\(: [\t -#%-\176\240-\377]*\\)?\\$" nil t) ;; RCS
3066 'RCS ;; CVS works like RCS in this regard.
3067 )
3068 ))
3070 ;; Back-end-dependent stuff ends here.
3072 ;; Set up key bindings for use while editing log messages
3074 (defun vc-log-mode (&optional file)
3075 "Minor mode for driving version-control tools.
3076 These bindings are added to the global keymap when you enter this mode:
3090 While you are entering a change log message for a version, the following
3091 additional bindings will be in effect.
3095 Whenever you do a checkin, your log comment is added to a ring of
3096 saved comments. These can be recalled as follows:
3103 Entry to the change-log submode calls the value of text-mode-hook, then
3104 the value of vc-log-mode-hook.
3106 Global user options:
3107 vc-initial-comment If non-nil, require user to enter a change
3108 comment upon first checkin of the file.
3110 vc-keep-workfiles Non-nil value prevents workfiles from being
3111 deleted when changes are checked in
3113 vc-suppress-confirm Suppresses some confirmation prompts,
3114 notably for reversions.
3116 vc-header-alist Which keywords to insert when adding headers
3119 RCS and CVS.
3121 vc-static-header-alist By default, version headers inserted in C files
3122 get stuffed in a static string area so that
3123 ident(RCS/CVS) or what(SCCS) can see them in
3124 the compiled object code. You can override
3125 this by setting this variable to nil, or change
3126 the header template by changing it.
3128 vc-command-messages if non-nil, display run messages from the
3129 actual version-control utilities (this is
3130 intended primarily for people hacking vc
3131 itself).
3132 "
3133 (interactive)
3134 (set-syntax-table text-mode-syntax-table)
3135 (use-local-map vc-log-entry-mode)
3136 (setq local-abbrev-table text-mode-abbrev-table)
3137 (setq major-mode 'vc-log-mode)
3138 (setq mode-name "VC-Log")
3139 (make-local-variable 'vc-log-file)
3140 (setq vc-log-file file)
3141 (make-local-variable 'vc-log-version)
3142 (make-local-variable 'vc-comment-ring-index)
3143 (set-buffer-modified-p nil)
3144 (setq buffer-file-name nil)
3145 (run-hooks 'text-mode-hook 'vc-log-mode-hook)
3146 )
3148 ;; Initialization code, to be done just once at load-time
3149 (if vc-log-entry-mode
3150 nil
3151 (setq vc-log-entry-mode (make-sparse-keymap))
3152 (define-key vc-log-entry-mode "\M-n" 'vc-next-comment)
3153 (define-key vc-log-entry-mode "\M-p" 'vc-previous-comment)
3154 (define-key vc-log-entry-mode "\M-r" 'vc-comment-search-reverse)
3155 (define-key vc-log-entry-mode "\M-s" 'vc-comment-search-forward)
3156 (define-key vc-log-entry-mode "\C-c\C-c" 'vc-finish-logentry)
3157 )
3159 ;;; These things should probably be generally available
3161 (defun vc-file-tree-walk (dirname func &rest args)
3162 "Walk recursively through DIRNAME.
3163 Invoke FUNC f ARGS on each non-directory file f underneath it."
3164 (vc-file-tree-walk-internal (expand-file-name dirname) func args)
3165 (message "Traversing directory %s...done" dirname))
3167 (defun vc-file-tree-walk-internal (file func args)
3168 (if (not (file-directory-p file))
3169 (apply func file args)
3170 (message "Traversing directory %s..." (abbreviate-file-name file))
3171 (let ((dir (file-name-as-directory file)))
3172 (mapcar
3173 (function
3174 (lambda (f) (or
3175 (string-equal f ".")
3176 (string-equal f "..")
3177 (member f vc-directory-exclusion-list)
3178 (let ((dirf (concat dir f)))
3179 (or
3180 (file-symlink-p dirf) ;; Avoid possible loops
3181 (vc-file-tree-walk-internal dirf func args))))))
3182 (directory-files dir)))))
3184 (provide 'vc)
3186 ;;; DEVELOPER'S NOTES ON CONCURRENCY PROBLEMS IN THIS CODE
3187 ;;;
3188 ;;; These may be useful to anyone who has to debug or extend the package.
3189 ;;; (Note that this information corresponds to versions 5.x. Some of it
3190 ;;; might have been invalidated by the additions to support branching
3191 ;;; and RCS keyword lookup. AS, 1995/03/24)
3192 ;;;
3193 ;;; A fundamental problem in VC is that there are time windows between
3194 ;;; vc-next-action's computations of the file's version-control state and
3195 ;;; the actions that change it. This is a window open to lossage in a
3196 ;;; multi-user environment; someone else could nip in and change the state
3197 ;;; of the master during it.
3198 ;;;
3199 ;;; The performance problem is that rlog/prs calls are very expensive; we want
3200 ;;; to avoid them as much as possible.
3201 ;;;
3202 ;;; ANALYSIS:
3203 ;;;
3204 ;;; The performance problem, it turns out, simplifies in practice to the
3205 ;;; problem of making vc-locking-user fast. The two other functions that call
3206 ;;; prs/rlog will not be so commonly used that the slowdown is a problem; one
3207 ;;; makes snapshots, the other deletes the calling user's last change in the
3208 ;;; master.
3209 ;;;
3210 ;;; The race condition implies that we have to either (a) lock the master
3211 ;;; during the entire execution of vc-next-action, or (b) detect and
3212 ;;; recover from errors resulting from dispatch on an out-of-date state.
3213 ;;;
3214 ;;; Alternative (a) appears to be infeasible. The problem is that we can't
3215 ;;; guarantee that the lock will ever be removed. Suppose a user starts a
3216 ;;; checkin, the change message buffer pops up, and the user, having wandered
3217 ;;; off to do something else, simply forgets about it?
3218 ;;;
3219 ;;; Alternative (b), on the other hand, works well with a cheap way to speed up
3220 ;;; vc-locking-user. Usually, if a file is registered, we can read its locked/
3221 ;;; unlocked state and its current owner from its permissions.
3222 ;;;
3223 ;;; This shortcut will fail if someone has manually changed the workfile's
3224 ;;; permissions; also if developers are munging the workfile in several
3225 ;;; directories, with symlinks to a master (in this latter case, the
3226 ;;; permissions shortcut will fail to detect a lock asserted from another
3227 ;;; directory).
3228 ;;;
3229 ;;; Note that these cases correspond exactly to the errors which could happen
3230 ;;; because of a competing checkin/checkout race in between two instances of
3231 ;;; vc-next-action.
3232 ;;;
3233 ;;; For VC's purposes, a workfile/master pair may have the following states:
3234 ;;;
3235 ;;; A. Unregistered. There is a workfile, there is no master.
3236 ;;;
3237 ;;; B. Registered and not locked by anyone.
3238 ;;;
3239 ;;; C. Locked by calling user and unchanged.
3240 ;;;
3241 ;;; D. Locked by the calling user and changed.
3242 ;;;
3243 ;;; E. Locked by someone other than the calling user.
3244 ;;;
3245 ;;; This makes for 25 states and 20 error conditions. Here's the matrix:
3246 ;;;
3247 ;;; VC's idea of state
3248 ;;; |
3249 ;;; V Actual state RCS action SCCS action Effect
3250 ;;; A B C D E
3251 ;;; A . 1 2 3 4 ci -u -t- admin -fb -i<file> initial admin
3252 ;;; B 5 . 6 7 8 co -l get -e checkout
3253 ;;; C 9 10 . 11 12 co -u unget; get revert
3254 ;;; D 13 14 15 . 16 ci -u -m<comment> delta -y<comment>; get checkin
3255 ;;; E 17 18 19 20 . rcs -u -M -l unget -n ; get -g steal lock
3256 ;;;
3257 ;;; All commands take the master file name as a last argument (not shown).
3258 ;;;
3259 ;;; In the discussion below, a "self-race" is a pathological situation in
3260 ;;; which VC operations are being attempted simultaneously by two or more
3261 ;;; Emacsen running under the same username.
3262 ;;;
3263 ;;; The vc-next-action code has the following windows:
3264 ;;;
3265 ;;; Window P:
3266 ;;; Between the check for existence of a master file and the call to
3267 ;;; admin/checkin in vc-buffer-admin (apparent state A). This window may
3268 ;;; never close if the initial-comment feature is on.
3269 ;;;
3270 ;;; Window Q:
3271 ;;; Between the call to vc-workfile-unchanged-p in and the immediately
3272 ;;; following revert (apparent state C).
3273 ;;;
3274 ;;; Window R:
3275 ;;; Between the call to vc-workfile-unchanged-p in and the following
3276 ;;; checkin (apparent state D). This window may never close.
3277 ;;;
3278 ;;; Window S:
3279 ;;; Between the unlock and the immediately following checkout during a
3280 ;;; revert operation (apparent state C). Included in window Q.
3281 ;;;
3282 ;;; Window T:
3283 ;;; Between vc-locking-user and the following checkout (apparent state B).
3284 ;;;
3285 ;;; Window U:
3286 ;;; Between vc-locking-user and the following revert (apparent state C).
3287 ;;; Includes windows Q and S.
3288 ;;;
3289 ;;; Window V:
3290 ;;; Between vc-locking-user and the following checkin (apparent state
3291 ;;; D). This window may never be closed if the user fails to complete the
3292 ;;; checkin message. Includes window R.
3293 ;;;
3294 ;;; Window W:
3295 ;;; Between vc-locking-user and the following steal-lock (apparent
3296 ;;; state E). This window may never close if the user fails to complete
3297 ;;; the steal-lock message. Includes window X.
3298 ;;;
3299 ;;; Window X:
3300 ;;; Between the unlock and the immediately following re-lock during a
3301 ;;; steal-lock operation (apparent state E). This window may never cloce
3302 ;;; if the user fails to complete the steal-lock message.
3303 ;;;
3304 ;;; Errors:
3305 ;;;
3306 ;;; Apparent state A ---
3307 ;;;
3308 ;;; 1. File looked unregistered but is actually registered and not locked.
3309 ;;;
3310 ;;; Potential cause: someone else's admin during window P, with
3311 ;;; caller's admin happening before their checkout.
3312 ;;;
3313 ;;; RCS: Prior to version 5.6.4, ci fails with message
3314 ;;; "no lock set by <user>". From 5.6.4 onwards, VC uses the new
3315 ;;; ci -i option and the message is "<file>,v: already exists".
3316 ;;; SCCS: admin will fail with error (ad19).
3317 ;;;
3318 ;;; We can let these errors be passed up to the user.
3319 ;;;
3320 ;;; 2. File looked unregistered but is actually locked by caller, unchanged.
3321 ;;;
3322 ;;; Potential cause: self-race during window P.
3323 ;;;
3324 ;;; RCS: Prior to version 5.6.4, reverts the file to the last saved
3325 ;;; version and unlocks it. From 5.6.4 onwards, VC uses the new
3326 ;;; ci -i option, failing with message "<file>,v: already exists".
3327 ;;; SCCS: will fail with error (ad19).
3328 ;;;
3329 ;;; Either of these consequences is acceptable.
3330 ;;;
3331 ;;; 3. File looked unregistered but is actually locked by caller, changed.
3332 ;;;
3333 ;;; Potential cause: self-race during window P.
3334 ;;;
3335 ;;; RCS: Prior to version 5.6.4, VC registers the caller's workfile as
3336 ;;; a delta with a null change comment (the -t- switch will be
3337 ;;; ignored). From 5.6.4 onwards, VC uses the new ci -i option,
3338 ;;; failing with message "<file>,v: already exists".
3339 ;;; SCCS: will fail with error (ad19).
3340 ;;;
3341 ;;; 4. File looked unregistered but is locked by someone else.
3342 ;;;
3343 ;;; Potential cause: someone else's admin during window P, with
3344 ;;; caller's admin happening *after* their checkout.
3345 ;;;
3346 ;;; RCS: Prior to version 5.6.4, ci fails with a
3347 ;;; "no lock set by <user>" message. From 5.6.4 onwards,
3348 ;;; VC uses the new ci -i option, failing with message
3349 ;;; "<file>,v: already exists".
3350 ;;; SCCS: will fail with error (ad19).
3351 ;;;
3352 ;;; We can let these errors be passed up to the user.
3353 ;;;
3354 ;;; Apparent state B ---
3355 ;;;
3356 ;;; 5. File looked registered and not locked, but is actually unregistered.
3357 ;;;
3358 ;;; Potential cause: master file got nuked during window P.
3359 ;;;
3360 ;;; RCS: will fail with "RCS/<file>: No such file or directory"
3361 ;;; SCCS: will fail with error ut4.
3362 ;;;
3363 ;;; We can let these errors be passed up to the user.
3364 ;;;
3365 ;;; 6. File looked registered and not locked, but is actually locked by the
3366 ;;; calling user and unchanged.
3367 ;;;
3368 ;;; Potential cause: self-race during window T.
3369 ;;;
3370 ;;; RCS: in the same directory as the previous workfile, co -l will fail
3371 ;;; with "co error: writable foo exists; checkout aborted". In any other
3372 ;;; directory, checkout will succeed.
3373 ;;; SCCS: will fail with ge17.
3374 ;;;
3375 ;;; Either of these consequences is acceptable.
3376 ;;;
3377 ;;; 7. File looked registered and not locked, but is actually locked by the
3378 ;;; calling user and changed.
3379 ;;;
3380 ;;; As case 6.
3381 ;;;
3382 ;;; 8. File looked registered and not locked, but is actually locked by another
3383 ;;; user.
3384 ;;;
3385 ;;; Potential cause: someone else checks it out during window T.
3386 ;;;
3387 ;;; RCS: co error: revision 1.3 already locked by <user>
3388 ;;; SCCS: fails with ge4 (in directory) or ut7 (outside it).
3389 ;;;
3390 ;;; We can let these errors be passed up to the user.
3391 ;;;
3392 ;;; Apparent state C ---
3393 ;;;
3394 ;;; 9. File looks locked by calling user and unchanged, but is unregistered.
3395 ;;;
3396 ;;; As case 5.
3397 ;;;
3398 ;;; 10. File looks locked by calling user and unchanged, but is actually not
3399 ;;; locked.
3400 ;;;
3401 ;;; Potential cause: a self-race in window U, or by the revert's
3402 ;;; landing during window X of some other user's steal-lock or window S
3403 ;;; of another user's revert.
3404 ;;;
3405 ;;; RCS: succeeds, refreshing the file from the identical version in
3406 ;;; the master.
3407 ;;; SCCS: fails with error ut4 (p file nonexistent).
3408 ;;;
3409 ;;; Either of these consequences is acceptable.
3410 ;;;
3411 ;;; 11. File is locked by calling user. It looks unchanged, but is actually
3412 ;;; changed.
3413 ;;;
3414 ;;; Potential cause: the file would have to be touched by a self-race
3415 ;;; during window Q.
3416 ;;;
3417 ;;; The revert will succeed, removing whatever changes came with
3418 ;;; the touch. It is theoretically possible that work could be lost.
3419 ;;;
3420 ;;; 12. File looks like it's locked by the calling user and unchanged, but
3421 ;;; it's actually locked by someone else.
3422 ;;;
3423 ;;; Potential cause: a steal-lock in window V.
3424 ;;;
3425 ;;; RCS: co error: revision <rev> locked by <user>; use co -r or rcs -u
3426 ;;; SCCS: fails with error un2
3427 ;;;
3428 ;;; We can pass these errors up to the user.
3429 ;;;
3430 ;;; Apparent state D ---
3431 ;;;
3432 ;;; 13. File looks like it's locked by the calling user and changed, but it's
3433 ;;; actually unregistered.
3434 ;;;
3435 ;;; Potential cause: master file got nuked during window P.
3436 ;;;
3437 ;;; RCS: Prior to version 5.6.4, checks in the user's version as an
3438 ;;; initial delta. From 5.6.4 onwards, VC uses the new ci -j
3439 ;;; option, failing with message "no such file or directory".
3440 ;;; SCCS: will fail with error ut4.
3441 ;;;
3442 ;;; This case is kind of nasty. Under RCS prior to version 5.6.4,
3443 ;;; VC may fail to detect the loss of previous version information.
3444 ;;;
3445 ;;; 14. File looks like it's locked by the calling user and changed, but it's
3446 ;;; actually unlocked.
3447 ;;;
3448 ;;; Potential cause: self-race in window V, or the checkin happening
3449 ;;; during the window X of someone else's steal-lock or window S of
3450 ;;; someone else's revert.
3451 ;;;
3452 ;;; RCS: ci will fail with "no lock set by <user>".
3453 ;;; SCCS: delta will fail with error ut4.
3454 ;;;
3455 ;;; 15. File looks like it's locked by the calling user and changed, but it's
3456 ;;; actually locked by the calling user and unchanged.
3457 ;;;
3458 ;;; Potential cause: another self-race --- a whole checkin/checkout
3459 ;;; sequence by the calling user would have to land in window R.
3460 ;;;
3461 ;;; SCCS: checks in a redundant delta and leaves the file unlocked as usual.
3462 ;;; RCS: reverts to the file state as of the second user's checkin, leaving
3463 ;;; the file unlocked.
3464 ;;;
3465 ;;; It is theoretically possible that work could be lost under RCS.
3466 ;;;
3467 ;;; 16. File looks like it's locked by the calling user and changed, but it's
3468 ;;; actually locked by a different user.
3469 ;;;
3470 ;;; RCS: ci error: no lock set by <user>
3471 ;;; SCCS: unget will fail with error un2
3472 ;;;
3473 ;;; We can pass these errors up to the user.
3474 ;;;
3475 ;;; Apparent state E ---
3476 ;;;
3477 ;;; 17. File looks like it's locked by some other user, but it's actually
3478 ;;; unregistered.
3479 ;;;
3480 ;;; As case 13.
3481 ;;;
3482 ;;; 18. File looks like it's locked by some other user, but it's actually
3483 ;;; unlocked.
3484 ;;;
3485 ;;; Potential cause: someone released a lock during window W.
3486 ;;;
3487 ;;; RCS: The calling user will get the lock on the file.
3488 ;;; SCCS: unget -n will fail with cm4.
3489 ;;;
3490 ;;; Either of these consequences will be OK.
3491 ;;;
3492 ;;; 19. File looks like it's locked by some other user, but it's actually
3493 ;;; locked by the calling user and unchanged.
3494 ;;;
3495 ;;; Potential cause: the other user relinquishing a lock followed by
3496 ;;; a self-race, both in window W.
3497 ;;;
3498 ;;; Under both RCS and SCCS, both unlock and lock will succeed, making
3499 ;;; the sequence a no-op.
3500 ;;;
3501 ;;; 20. File looks like it's locked by some other user, but it's actually
3502 ;;; locked by the calling user and changed.
3503 ;;;
3504 ;;; As case 19.
3505 ;;;
3506 ;;; PROBLEM CASES:
3507 ;;;
3508 ;;; In order of decreasing severity:
3509 ;;;
3510 ;;; Cases 11 and 15 are the only ones that potentially lose work.
3511 ;;; They would require a self-race for this to happen.
3512 ;;;
3513 ;;; Case 13 in RCS loses information about previous deltas, retaining
3514 ;;; only the information in the current workfile. This can only happen
3515 ;;; if the master file gets nuked in window P.
3516 ;;;
3517 ;;; Case 3 in RCS and case 15 under SCCS insert a redundant delta with
3518 ;;; no change comment in the master. This would require a self-race in
3519 ;;; window P or R respectively.
3520 ;;;
3521 ;;; Cases 2, 10, 19 and 20 do extra work, but make no changes.
3522 ;;;
3523 ;;; Unfortunately, it appears to me that no recovery is possible in these
3524 ;;; cases. They don't yield error messages, so there's no way to tell that
3525 ;;; a race condition has occurred.
3526 ;;;
3527 ;;; All other cases don't change either the workfile or the master, and
3528 ;;; trigger command errors which the user will see.
3529 ;;;
3530 ;;; Thus, there is no explicit recovery code.
3532 ;;; vc.el ends here