| blob | a49092e79e2e5329cd6416904404bbaabf3572d4 |
1 ;;; vc.el --- drive a version-control system from within Emacs
3 ;; Copyright (C) 1992, 93, 94, 95, 96, 97 Free Software Foundation, Inc.
5 ;; Author: Eric S. Raymond <esr@snark.thyrsus.com>
6 ;; Maintainer: Andre Spiegel <spiegel@inf.fu-berlin.de>
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software; you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation; either version 2, or (at your option)
13 ;; any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs; see the file COPYING. If not, write to the
22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23 ;; Boston, MA 02111-1307, USA.
25 ;;; Commentary:
27 ;; This mode is fully documented in the Emacs user's manual.
28 ;;
29 ;; This was designed and implemented by Eric Raymond <esr@snark.thyrsus.com>.
30 ;; Paul Eggert <eggert@twinsun.com>, Sebastian Kremer <sk@thp.uni-koeln.de>,
31 ;; and Richard Stallman contributed valuable criticism, support, and testing.
32 ;; CVS support was added by Per Cederqvist <ceder@lysator.liu.se>
33 ;; in Jan-Feb 1994. Further enhancements came from ttn.netcom.com and
34 ;; Andre Spiegel <spiegel@inf.fu-berlin.de>.
35 ;;
36 ;; Supported version-control systems presently include SCCS, RCS, and CVS.
37 ;;
38 ;; Some features will not work with old RCS versions. Where
39 ;; appropriate, VC finds out which version you have, and allows or
40 ;; disallows those features (stealing locks, for example, works only
41 ;; from 5.6.2 onwards).
42 ;; Even initial checkins will fail if your RCS version is so old that ci
43 ;; doesn't understand -t-; this has been known to happen to people running
44 ;; NExTSTEP 3.0.
45 ;;
46 ;; You can support the RCS -x option by adding pairs to the
47 ;; vc-master-templates list.
48 ;;
49 ;; Proper function of the SCCS diff commands requires the shellscript vcdiff
50 ;; to be installed somewhere on Emacs's path for executables.
51 ;;
52 ;; If your site uses the ChangeLog convention supported by Emacs, the
53 ;; function vc-comment-to-change-log should prove a useful checkin hook.
54 ;;
55 ;; This code depends on call-process passing back the subprocess exit
56 ;; status. Thus, you need Emacs 18.58 or later to run it. For the
57 ;; vc-directory command to work properly as documented, you need 19.
58 ;; You also need Emacs 19's ring.el.
59 ;;
60 ;; The vc code maintains some internal state in order to reduce expensive
61 ;; version-control operations to a minimum. Some names are only computed
62 ;; once. If you perform version control operations with RCS/SCCS/CVS while
63 ;; vc's back is turned, or move/rename master files while vc is running,
64 ;; vc may get seriously confused. Don't do these things!
65 ;;
66 ;; Developer's notes on some concurrency issues are included at the end of
67 ;; the file.
69 ;;; Code:
78 minor-mode-alist)))
80 ;; To implement support for a new version-control system, add another
81 ;; branch to the vc-backend-dispatch macro and fill it in in each
82 ;; call. The variable vc-master-templates in vc-hooks.el will also
83 ;; have to change.
86 "Execute FORM1, FORM2 or FORM3 for SCCS, RCS or CVS respectively.
87 If FORM3 is `RCS', use FORM2 for CVS as well as RCS.
88 \(CVS shares some code with RCS)."
95 )))
97 ;; General customization
100 "Version-control system in Emacs."
104 "*If non-nil, treat user as expert; suppress yes-no prompts on some things."
109 "*If non-nil, prompt for initial comment when a file is registered."
114 "*If non-nil, display run messages from back-end commands."
119 "*A string or list of strings specifying extra switches for checkin.
125 string))
129 "*A string or list of strings specifying extra switches for checkout.
135 string))
139 "*A string or list of strings; extra switches for registering a file.
145 string))
149 "*List of directory names to be ignored while recursively walking file trees."
156 ;;; This is duplicated in diff.el.
179 Ages are given in units of 2**-16 seconds.
180 Default is eighteen steps using a twenty day increment."
185 "*Color for lines older than CAR of last cons in `vc-annotate-color-map'."
191 Default color is used if nil."
196 "*Menu elements for the mode-specific menu of VC-Annotate mode.
197 List of factors, used to expand/compress the time scale. See `vc-annotate'."
201 ;;;###autoload
203 "*Normal hook (List of functions) run after a checkin is done.
204 See `run-hooks'."
208 ;;;###autoload
210 "*Normal hook (list of functions) run before a file gets checked in.
211 See `run-hooks'."
215 ;;;###autoload
217 "*Hooks to run when VC-Annotate mode is turned on."
221 ;; Header-insertion hair
225 "*Header keywords to be inserted by `vc-insert-headers'.
226 Must be a list of two-element lists, the first element of each must
227 be `RCS', `CVS', or `SCCS'. The second element is the string to
228 be inserted for this particular backend."
240 "*Associate static header string templates with file types. A \%s in the
241 template is replaced with the first string associated with the file's
242 version-control type in `vc-header-alist'."
250 "*Special comment delimiters to be used in generating vc headers only.
251 Add an entry in this list if you need to override the normal comment-start
252 and comment-end variables. This will only be necessary if the mode language
253 is sensitive to blank lines."
260 ;; Default is to be extra careful for super-user.
262 "*Non-nil means be extra-careful in checkout.
263 Verify that the file really is not locked
264 and that its contents match what the master file says."
269 "*The release number of your RCS installation, as a string.
270 If nil, VC itself computes this value when it is first needed."
272 string)
276 "*The release number of your SCCS installation, as a string.
277 If nil, VC itself computes this value when it is first needed."
279 string)
283 "*The release number of your CVS installation, as a string.
284 If nil, VC itself computes this value when it is first needed."
286 string)
289 ;; Variables the user doesn't need to know about.
294 ;; In a log entry buffer, this is a local variable
295 ;; that points to the buffer for which it was made
296 ;; (either a file, or a VC dired buffer).
312 ;; Back-portability to Emacs 18
322 ; Conditionally rebind some things for Emacs 18 compatibility
328 ))
333 ;;; Find and compare backend releases
336 ;; Returns which backend release is installed on this system.
358 vc-sccs-release)))
361 ;; Compare release numbers, represented as strings.
362 ;; Release components are assumed cardinal numbers, not decimal
363 ;; fractions (5.10 is a higher release than 5.9). Omitted fields
364 ;; are considered lower (5.6.7 is earlier than 5.6.7.1).
365 ;; Comparison runs till the end of the string is found, or a
366 ;; non-numeric component shows up (5.6.7 is earlier than "5.6.7 beta",
367 ;; which is probably not what you want in some cases).
368 ;; This code is suitable for existing RCS release numbers.
369 ;; CVS releases are handled reasonably, too (1.3 < 1.4* < 1.5).
390 ;; Return t if we have RELEASE of BACKEND or better
397 ;;; functions that operate on RCS revision numbers
400 ;; return t if REV is a revision on the trunk
404 ;; return the branch part of a revision number REV
408 ;; return the minor version number of a revision number REV
413 ;; guess the previous version number
417 ;; version does probably not start a branch or release
420 ;; we are at the beginning of the trunk --
421 ;; don't know anything to return here
422 ""
423 ;; we are at the beginning of a branch --
424 ;; return version of starting point
427 ;; File property caching
430 "Clear all cached file properties and the comment ring."
433 ;; Note: there is potential for minor lossage here if there is an open
434 ;; log buffer with a nonzero local value of vc-comment-ring-index.
438 ;; clear all properties of FILE that were retrieved
439 ;; from the master file
454 ;; Return the RCS head version of FILE
459 ;; Random helper functions
462 ;; return t iff the current workfile version of FILE is
463 ;; the latest on its branch.
465 ;; SCCS
467 ;; RCS
471 ;; Re-fetch the head version number. This is to make
472 ;; sure that no-one has checked in a new version behind
473 ;; our back.
476 workfile-version))
477 ;; If we are not on the trunk, we need to examine the
478 ;; whole current branch. (vc-master-workfile-version
479 ;; is not what we need.)
489 ;; CVS
490 t))
500 "Look for a command anywhere on the subprocess-command search path."
513 exec-path)
514 nil)))
517 "Execute a version-control command, notifying user and checking for errors.
518 Output from COMMAND goes to BUFFER, or *vc* if BUFFER is nil.
519 The command is successful if its exit status does not exceed OKSTATUS.
520 (If OKSTATUS is nil, that means to ignore errors.)
521 The last argument of the command is the master name of FILE if LAST is
522 `MASTER', or the workfile of FILE if LAST is `WORKFILE'; this is appended
523 to an optional list of FLAGS."
532 status)
543 flags)
554 ;; Add vc-path to PATH for the execution of this command.
557 path-separator
559 process-environment))
573 status))
574 )
577 )
579 status)
580 )
582 ;;; Save a bit of the text around POSN in the current buffer, to help
583 ;;; us find the corresponding position again later. This works even
584 ;;; if all markers are destroyed or corrupted.
585 ;;; A lot of this was shamelessly lifted from Sebastian Kremer's rcs.el mode.
592 ;;; Return the position of CONTEXT in the current buffer, or nil if we
593 ;;; couldn't find it.
603 ;; Can't use search-backward since the match may continue
604 ;; after point.
606 ;; goto-char doesn't signal an error at
607 ;; beginning of buffer like backward-char would
609 ;; to beginning of OSTRING
613 ;; Return a list '(point-context mark-context reparse); from which
614 ;; vc-restore-buffer-context can later restore the context.
616 ;; Use mark-marker to avoid confusion in transient-mark-mode.
619 ;; Make the right thing happen in transient-mark-mode.
621 ;; We may want to reparse the compilation buffer after revert
624 ;; Construct a list; each elt is nil or a buffer
625 ;; iff that buffer is a compilation output buffer
626 ;; that contains markers into the current buffer.
632 compilation-old-error-list
633 compilation-error-list))
648 ;; Restore point/mark, and reparse any affected compilation buffers.
649 ;; CONTEXT is that which vc-buffer-context returns.
653 ;; Reparse affected compilation buffers.
659 ;; Record the position in the compilation buffer of
660 ;; the last error next-error went to.
663 ;; Reparse the error messages as far as they were parsed before.
665 ;; Move the pointer up to find the error we were at before
666 ;; reparsing. Now next-error should properly go to the next one.
672 ;; Restore point and mark
680 ;; Revert buffer, try to keep point and mark where user expects them in spite
681 ;; of changes because of expanded version-control key words.
682 ;; This is quite important since otherwise typeahead won't work as expected.
686 ;; t means don't call normal-mode; that's to preserve various minor modes.
692 ;; Make sure the current buffer and its working file are in sync
693 ;; NOT-URGENT means it is ok to continue if the user says not to save.
699 nil
704 ;; Has the given workfile changed since last checkout?
711 ;; 0 stands for an unknown time; it can't match any mod time.
713 unchanged)))))
716 ;;; If comment is specified, it will be used as an admin or checkin comment.
719 owner version buffer)
722 ;; if there is no master file corresponding, create one
730 ;; CVS: changes to the master file need to be
731 ;; merged back into the working file
750 "Buffer %s modified; merge file on disc anyhow? "
754 ;; Overlaps detected - what now? Should use some
755 ;; fancy RCS conflict resolving package, or maybe
756 ;; emerge, but for now, simply warn the user with a
757 ;; message.
763 ;; For CVS files with implicit checkout: if unmodified, don't do anything
770 ;; If there is no lock on the file, assert one and get it.
772 ;; With implicit checkout, make sure not to lose unsaved changes.
782 file))
793 )
809 )))
811 ;; a checked-out version exists, but the user may not own the lock
820 file
823 owner))
825 ;; OK, user owns the lock on the file
831 ;; give luser a chance to save before checking in.
834 ;; Revert if file is unchanged and buffer is too.
835 ;; If buffer is modified, that means the user just said no
836 ;; to saving it; in that case, don't revert,
837 ;; because the user might intend to save
838 ;; after finishing the log entry.
841 ;; DO NOT revert the file without asking the user!
847 ;; user may want to set nonstandard parameters
851 ;; OK, let's do the checkin
853 )))))
856 ;; Do a vc-next-action-on-file on all the marked files, possibly
857 ;; passing on the log comment we've just entered.
865 ;; Adjust the default directory so that checkouts
866 ;; go to the right place.
874 nil t)))
876 ;; Here's the major entry point.
878 ;;;###autoload
880 "Do the next logical checkin or checkout operation on the current file.
881 If you call this from within a VC dired buffer with no files marked,
882 it will operate on the file in the current line.
883 If you call this from within a VC dired buffer, and one or more
884 files are marked, it will accept a log message and then operate on
885 each one. The log message will be used as a comment for any register
886 or checkin operations, but ignored when doing checkouts. Attempted
887 lock steals will raise an error.
888 A prefix argument lets you specify the version number to use.
890 For RCS and SCCS files:
891 If the file is not already registered, this registers it for version
892 control and then retrieves a writable, locked copy for editing.
893 If the file is registered and not locked by anyone, this checks out
894 a writable and locked file ready for editing.
895 If the file is checked out and locked by the calling user, this
896 first checks to see if the file has changed since checkout. If not,
897 it performs a revert.
898 If the file has been changed, this pops up a buffer for entry
899 of a log message; when the message has been entered, it checks in the
900 resulting changes along with the log message as change commentary. If
901 the variable `vc-keep-workfiles' is non-nil (which is its default), a
902 read-only copy of the changed file is left in place afterwards.
903 If the file is registered and locked by someone else, you are given
904 the option to steal the lock.
906 For CVS files:
907 If the file is not already registered, this registers it for version
909 If the file is added but not committed, it is committed.
910 If your working file is changed, but the repository file is
911 unchanged, this pops up a buffer for entry of a log message; when the
912 message has been entered, it checks in the resulting changes along
913 with the logmessage as change commentary. A writable file is retained.
914 If the repository file is changed, you are asked if you want to
915 merge in the changes into your working copy."
932 "Enter a change comment for the marked files."
941 ;;; These functions help the vc-next-action entry point
944 "Retrieve a writable copy of the latest version of the current buffer's file."
946 )
948 ;;;###autoload
950 "Register the current file into your version-control system."
960 ;; Watch out for new buffers of size 0: the corresponding file
961 ;; does not exist yet, even though buffer-modified-p is nil.
968 ;; inhibit backup for this buffer
972 buffer-file-name
976 )
979 ;; If the given file is in the current buffer,
980 ;; either revert on it so we see expanded keywords,
981 ;; or unvisit it (depending on vc-keep-workfiles)
982 ;; NOQUERY if non-nil inhibits confirmation for reverting.
983 ;; NOQUERY should be t *only* if it is known the only difference
984 ;; between the buffer and the file is due to RCS rather than user editing!
988 ;; temporarily remove vc-find-file-hook, so that
989 ;; we don't lose the properties
997 ;; if FILE is currently visited, resynch its buffer
1005 ;; Accept a comment for an operation on FILE revision REV. If COMMENT
1006 ;; is nil, pop up a VC-log buffer, emit MSG, and set the
1007 ;; action on close to ACTION; otherwise, do action immediately.
1008 ;; Remember the file's buffer in vc-parent-buffer (current one if no file).
1009 ;; AFTER-HOOK specifies the local value for vc-log-operation-hook.
1040 "Check a file into your version-control system.
1041 FILE is the unmodified name of the file. REV should be the base version
1042 level to check it in under. COMMENT, if specified, is the checkin comment."
1046 nil))
1049 "Retrieve a copy of the latest version of the given file."
1050 ;; If ftp is on this system and the name matches the ange-ftp format
1051 ;; for a remote file, the user is trying something that won't work.
1058 "Steal the lock on the current workfile."
1066 file-description owner)))
1082 ;; This is called when the notification has been sent.
1091 "Check in the file specified by FILE.
1092 The optional argument REV may be a string specifying the new version level
1093 \(if nil increment the current level). The file is either retained with write
1094 permissions zeroed, or deleted (according to the value of `vc-keep-workfiles').
1095 If the back-end is CVS, a writable workfile is always kept.
1096 COMMENT is a comment string; if omitted, a buffer is
1097 popped up to accept a comment."
1102 ;;; Here is a checkin hook that may prove useful to sites using the
1103 ;;; ChangeLog facility supported by Emacs.
1105 "Enter last VC comment into change log file for current buffer's file.
1106 Optional arg (interactive prefix) non-nil means prompt for user name and site.
1107 Second arg is file name of change log. \
1108 If nil, uses `change-log-default-name'."
1112 ;; Make sure the defvar for add-log-current-defun-function has been executed
1113 ;; before binding it.
1117 ;; Don't let add-change-log-entry insert a defun name.
1119 end)
1120 ;; Call add-log to do half the work.
1122 ;; Insert the VC comment, leaving point before it.
1125 ;; It starts with an open-paren, as in "(foo): Frobbed."
1126 ;; So remove the ": " add-log inserted.
1128 ;; Canonicalize the white space between the file name and comment.
1130 ;; Indent rest of the text the same way add-log indented the first line.
1137 ;; Fill the inserted text, preserving open-parens at bol.
1142 ;; Canonicalize the white space at the end of the entry so it is
1143 ;; separated from the next entry by a single blank line.
1151 "Complete the operation implied by the current log entry."
1153 ;; Check and record the comment, if any.
1159 ;; Comment too long?
1161 ;; Record the comment in the comment ring
1163 ))
1164 ;; Sync parent buffer in case the user modified it while editing the comment.
1165 ;; But not if it is a vc-dired buffer.
1171 ;; save the parameters held in buffer-local variables
1177 ;; Return to "parent" buffer of this checkin and remove checkin window
1182 ;; OK, do it to it
1185 log-file
1186 log-version
1187 log-entry))
1188 ;; Now make sure we see the expanded headers
1193 ;; Code for access to the comment ring
1196 "Cycle backwards through comment history."
1204 ;; Initialize the index on the first use of this command
1205 ;; so that the first M-p gets index 0, and the first M-n gets
1206 ;; index -1.
1217 "Cycle forwards through comment history."
1222 "Searches backwards through comment history for substring match."
1239 "Searches forwards through comment history for substring match."
1255 ;; Additional entry points for examining version histories
1257 ;;;###autoload
1259 "Display diffs between file versions.
1260 Normally this compares the current file and buffer with the most recent
1261 checked in version of that file. This uses no arguments.
1262 With a prefix argument, it reads the file name to use
1263 and two version designators specifying which versions to compare."
1275 unchanged)
1281 ;; Ideally, we'd like at this point to parse the diff so that
1282 ;; the buffer effectively goes into compilation mode and we
1283 ;; can visit the old and new change locations via next-error.
1284 ;; Unfortunately, this is just too painful to do. The basic
1285 ;; problem is that the `old' file doesn't exist to be
1286 ;; visited. This plays hell with numerous assumptions in
1287 ;; the diff.el and compile.el machinery.
1300 "For FILE, report diffs between two stored versions REL1 and REL2 of it.
1301 If FILE is a directory, generate diffs between versions for all registered
1302 files in or below it."
1305 "File or dir to diff: (default visited file) "
1307 default-directory buffer-file-name t))
1309 ;; compute default versions based on the file state
1311 ;; if it's a directory, don't supply any version defauolt
1313 nil)
1314 ;; if the file is locked, use current version as older version
1317 ;; if the file is not locked, use last and previous version as default
1321 ;; construct argument list
1327 nil nil rel1-default)
1332 nil nil rel2-default))))
1344 " and "
1350 default-directory
1358 )))
1363 )
1368 ;;;###autoload
1370 "Visit version REV of the current buffer in another window.
1371 If the current buffer is named `F', the version is named `F.~REV~'.
1372 If `F.~REV~' already exists, it is used instead of being re-created."
1381 rev))
1388 ;; Header-insertion code
1390 ;;;###autoload
1392 "Insert headers in a file for use with your version-control system.
1393 Headers desired are inserted at the start of the buffer, and are pulled from
1394 the variable `vc-header-alist'."
1413 hdstrings)
1418 vc-static-header-alist))
1419 )
1420 )))))
1423 ;; Clear all version headers in the current buffer, i.e. reset them
1424 ;; to the nonexpanded form. Only implemented for RCS, yet.
1425 ;; Don't lose point and mark during this.
1432 nil t)
1436 ;; The VC directory major mode. Coopt Dired for this.
1437 ;; All VC commands get mapped into logical equivalents.
1440 "The major mode used in VC directory buffers. It is derived from Dired.
1441 All Dired commands operate normally. Users currently locking listed files
1442 are listed in place of the file's owner and group.
1443 Keystrokes bound to VC commands will execute as though they had been called
1444 on a buffer attached to the file named in the current Dired buffer line."
1452 ;; Return the string that indicates the version control status
1453 ;; on a VC dired line.
1466 ;; Hack a directory-listing line, plugging in locking-user info in
1467 ;; place of the user and group info. Should have the beneficial
1468 ;; side-effect of shortening the listing line. Each call starts with
1469 ;; point immediately following the dired mark area on the line to be
1470 ;; hacked.
1471 ;;
1472 ;; Simplest possible one:
1473 ;; (insert (concat x "\t")))
1474 ;;
1475 ;; This code, like dired, assumes UNIX -l format.
1484 limit t)
1487 limit t))
1493 limit t)
1501 ;; Update the vc-dired listing line of file -- it is assumed
1502 ;; that point is already on this line. Don't use dired-do-redisplay
1503 ;; for this, because it cannot handle the way vc-dired deals with
1504 ;; subdirectories.
1523 ;;; Note in Emacs 18 the following defun gets overridden
1524 ;;; with the symbol 'vc-directory-18. See below.
1525 ;;;###autoload
1527 "Show version-control status of the current directory and subdirectories.
1528 Normally it creates a Dired buffer that lists only the locked files
1529 in all these directories. With a prefix argument, it lists all files."
1533 ;; force a trailing slash
1540 dired-buf
1541 dired-buf-mod-count)
1543 dirname
1553 ;; This uses a semi-documented feature of dired; giving a switch
1554 ;; argument forces the buffer to refresh each time.
1561 ;; Make a few modifications to the header
1571 ;; Plug the version information into the individual lines
1582 )
1588 ))
1590 ;; Emacs 18 version
1592 "Show version-control status of all files under the current directory."
1600 default-directory
1617 )
1622 ;; Named-configuration support for SCCS
1627 vc-name-assoc-file
1635 ))
1641 vc-name-assoc-file
1646 ;; (replace-regexp (concat ":" (regexp-quote file) "$") (concat ":" newname))
1651 ))
1654 ;; Return the numeric version corresponding to a named snapshot of file
1655 ;; If name is nil or a version number string it's just passed through
1659 name)
1665 vc-name-assoc-file
1673 ))
1675 ;; Named-configuration entry points
1678 ;; Scan the tree below the current directory.
1679 ;; If any files are locked, return the name of the first such file.
1680 ;; (This means, neither snapshot creation nor retrieval is allowed.)
1681 ;; If one or more of the files are currently visited, return `visited'.
1682 ;; Otherwise, return nil.
1686 default-directory
1691 status)))
1693 ;;;###autoload
1695 "Make a snapshot called NAME.
1696 The snapshot is made from all registered files at or below the current
1697 directory. For each file, the version level of its latest
1698 version becomes part of the named configuration."
1704 default-directory
1708 )))
1710 ;;;###autoload
1712 "Retrieve the snapshot called NAME, or latest versions if NAME is empty.
1713 When retrieving a snapshot, there must not be any locked files at or below
1714 the current directory. If none are locked, all registered files are
1715 checked out (unlocked) at their version levels in the snapshot NAME.
1716 If NAME is the empty string, all registered files that are not currently
1717 locked are updated to the latest versions."
1723 default-directory
1735 default-directory
1741 )))))
1743 ;; Miscellaneous other entry points
1745 ;;;###autoload
1747 "List the change log of the current buffer in a window."
1766 ;; move point to the log entry for the current version
1769 ;; also match some context, for safety
1772 ;; set the display window so that
1773 ;; the whole log entry is displayed
1781 ;; if the global information and this log entry fit
1782 ;; into the window, display from the beginning
1787 ;; if the whole entry fits into the window,
1788 ;; display it centered
1792 ;; otherwise (the entry is too large for the window),
1793 ;; display from the start
1797 )
1799 )
1800 )
1802 ;;;###autoload
1804 "Revert the current buffer's file back to the latest checked-in version.
1805 This asks for confirmation if the buffer contents are not identical
1806 to that version.
1807 If the back-end is CVS, this will give you the most recent revision of
1808 the file on the branch you are editing."
1815 ;; This operation should always ask for confirmation.
1833 )
1834 )
1836 ;;;###autoload
1838 "Get rid of most recently checked in version of this file.
1839 A prefix argument means do not revert the buffer afterwards."
1858 nil
1862 ;; Check out the most recent remaining version. If it fails, because
1863 ;; the whole branch got deleted, do a double-take and check out the
1864 ;; version where the branch started.
1869 ;; Check out locked, but only to disc, and keep
1870 ;; modifications in the buffer.
1872 ;; Check out unlocked, and revert buffer.
1875 ;; If the checkout fails, vc-do-command signals an error.
1876 ;; We catch this error, check the reason, correct the
1877 ;; version number, and try a second time.
1882 ;; vc-do-command popped up a window with
1883 ;; the error message. Get rid of it, by
1884 ;; restoring the old window configuration.
1886 ;; No, it was some other error: re-signal it.
1888 ;; If norevert, clear version headers and mark the buffer modified.
1893 ;; inhibit backup for this buffer
1901 )))
1903 ;;;###autoload
1905 "Rename file OLD to NEW, and rename its master file likewise."
1907 ;; There are several ways of renaming files under CVS 1.3, but they all
1908 ;; have serious disadvantages. See the FAQ (available from think.com in
1909 ;; pub/cvs/). I'd rather send the user an error, than do something he might
1910 ;; consider to be wrong. When the famous, long-awaited rename database is
1911 ;; implemented things might change for the better. This is unlikely to occur
1912 ;; until CVS 2.0 is released. --ceder 1994-01-23 21:27:51
1928 ;; This had FILE, I changed it to OLD. -- rms.
1932 oldmaster
1946 vc-master-templates)
1950 ; ?? Renaming a file might change its contents due to keyword expansion.
1951 ; We should really check out a new copy if the old copy was precisely equal
1952 ; to some checked in version. However, testing for this is tricky....
1961 ;; This had FILE, I changed it to OLD. -- rms.
1964 nil ;RCS
1965 nil ;CVS
1966 )
1967 )
1969 ;;;###autoload
1971 "Find change log file and add entries from recent RCS/CVS logs.
1972 Normally, find log entries for all registered files in the default
1973 directory using `rcs2log', which finds CVS logs preferentially.
1974 The mark is left at the end of the text prepended to the change log.
1976 With prefix arg of C-u, only find log entries for the current buffer's file.
1978 With any numeric prefix arg, find log entries for all currently visited
1979 files that are under version control. This puts all the entries in the
1980 log for the default directory, which may not be appropriate.
1982 From a program, any arguments are assumed to be filenames and are
1983 passed to the `rcs2log' script after massaging to be relative to the
1984 default directory."
1991 file)
1997 files))
1999 ;; `rcs2log' will find the relevant RCS or CVS files
2000 ;; relative to the curent directory if none supplied.
2001 nil)))
2004 ;; Presumably not portable to non-Unixy systems, along with rcs2log:
2017 user-mail-address)))
2031 "-c" changelog
2040 f
2042 args)))
2043 "done"
2051 \f
2052 ;; vc-annotate functionality (CVS only).
2062 ;; Syntax Table
2066 ;; Declare globally instead of additional parameter to
2067 ;; temp-buffer-show-function (not possible to pass more than one
2068 ;; parameter).
2084 "Major mode for buffers displaying output from the CVS `annotate' command.
2086 You can use the mode-specific menu to alter the time-span of the used
2087 colors. See variable `vc-annotate-menu-elements' for customizing the
2088 menu items."
2095 ; finds out what to describe.
2101 "Use the default color spectrum for VC Annotate mode."
2108 "Adds the menu 'Annotate' to the menu bar in VC-Annotate mode."
2110 '("Default" . vc-annotate-display-default))
2111 (let ((menu-elements vc-annotate-menu-elements))
2112 (while menu-elements
2113 (let* ((element (car menu-elements))
2114 (days (round (* element
2115 (vc-annotate-car-last-cons vc-annotate-color-map)
2116 0.7585))))
2117 (setq menu-elements (cdr menu-elements))
2118 (define-key vc-annotate-mode-menu
2119 (vector days)
2120 (cons (format "Span %d days"
2121 days)
2122 `(lambda ()
2123 ,(format "Use colors spanning %d days" days)
2124 (interactive)
2125 (message "Redisplaying annotation...")
2126 (vc-annotate-display
2127 (get-buffer (buffer-name))
2128 (vc-annotate-time-span vc-annotate-color-map ,element))
2129 (message "Redisplaying annotation...done"))))))))
2131 ;;;###autoload
2132 (defun vc-annotate (ratio)
2133 "Display the result of the CVS `annotate' command using colors.
2134 New lines are displayed in red, old in blue.
2135 A prefix argument specifies a factor for stretching the time scale.
2137 `vc-annotate-menu-elements' customizes the menu elements of the
2138 mode-specific menu. `vc-annotate-color-map' and
2139 `vc-annotate-very-old-color' defines the mapping of time to
2140 colors. `vc-annotate-background' specifies the background color."
2141 (interactive "p")
2142 (if (not (eq (vc-buffer-backend) 'CVS)) ; This only works with CVS
2143 (vc-registration-error (buffer-file-name)))
2144 (message "Annotating...")
2145 (let ((temp-buffer-name (concat "*cvs annotate " (buffer-name) "*"))
2146 (temp-buffer-show-function 'vc-annotate-display)
2147 (vc-annotate-ratio ratio))
2148 (with-output-to-temp-buffer temp-buffer-name
2149 (call-process "cvs" nil (get-buffer temp-buffer-name) nil
2150 "annotate" (file-name-nondirectory (buffer-file-name)))))
2151 (message "Annotating... done"))
2153 (defun vc-annotate-car-last-cons (assoc-list)
2154 "Return car of last cons in ASSOC-LIST."
2155 (if (not (eq nil (cdr assoc-list)))
2156 (vc-annotate-car-last-cons (cdr assoc-list))
2157 (car (car assoc-list))))
2159 ;; Return an association list with span factor applied to the
2160 ;; time-span of assoc-list. Optionaly quantize to the factor of
2161 ;; quantize.
2162 (defun vc-annotate-time-span (assoc-list span &optional quantize)
2163 ;; Apply span to each car of every cons
2164 (if (not (eq nil assoc-list))
2165 (append (list (cons (* (car (car assoc-list)) span)
2166 (cdr (car assoc-list))))
2167 (vc-annotate-time-span (nthcdr (cond (quantize) ; optional
2168 (1)) ; Default to cdr
2169 assoc-list) span quantize))))
2171 (defun vc-annotate-compcar (threshold &rest args)
2172 "Test successive cars of ARGS against THRESHOLD.
2173 Return the first cons which CAR is not less than THRESHOLD, nil otherwise"
2174 ;; If no list is exhausted,
2175 (if (and (not (memq 'nil args)) (< (car (car (car args))) threshold))
2176 ;; apply to CARs.
2177 (apply 'vc-annotate-compcar threshold
2178 ;; Recurse for rest of elements.
2179 (mapcar 'cdr args))
2180 ;; Return the proper result
2181 (car (car args))))
2183 (defun vc-annotate-display (buffer &optional color-map)
2184 "Do the VC-Annotate display in BUFFER using COLOR-MAP."
2186 ;; Handle the case of the global variable vc-annotate-ratio being
2187 ;; set. This variable is used to pass information from function
2188 ;; vc-annotate since it is not possible to use another parameter
2189 ;; (see temp-buffer-show-function).
2190 (if (and (not color-map) vc-annotate-ratio)
2191 ;; This will only be true if called from vc-annotate with ratio
2192 ;; being non-nil.
2193 (setq color-map (vc-annotate-time-span vc-annotate-color-map
2194 vc-annotate-ratio)))
2196 ;; We need a list of months and their corresponding numbers.
2197 (let* ((local-month-numbers
2198 '(("Jan" . 1) ("Feb" . 2) ("Mar" . 3) ("Apr" . 4)
2199 ("May" . 5) ("Jun" . 6) ("Jul" . 7) ("Aug" . 8)
2200 ("Sep" . 9) ("Oct" . 10) ("Nov" . 11) ("Dec" . 12)))
2201 ;; XEmacs use extents, GNU Emacs overlays.
2202 (overlay-or-extent (if (string-match "XEmacs" emacs-version)
2203 (cons 'make-extent 'set-extent-property)
2204 (cons 'make-overlay 'overlay-put)))
2205 (make-overlay-or-extent (car overlay-or-extent))
2206 (set-property-overlay-or-extent (cdr overlay-or-extent)))
2208 (set-buffer buffer)
2209 (display-buffer buffer)
2210 (if (not vc-annotate-mode) ; Turn on vc-annotate-mode if not done
2211 (vc-annotate-mode))
2212 (goto-char (point-min)) ; Position at the top of the buffer.
2213 (while (re-search-forward
2215 nil t)
2217 (let* (;; Unfortunately, order is important. match-string will
2218 ;; be corrupted by extent functions in XEmacs. Access
2219 ;; string-matches first.
2220 (day (string-to-number (match-string 2)))
2221 (month (cdr (assoc (match-string 3) local-month-numbers)))
2222 (year-tmp (string-to-number (match-string 4)))
2223 (year (+ (if (> 100 year-tmp) 1900 0) year-tmp)) ; Possible millenium problem
2224 (high (- (car (current-time))
2225 (car (encode-time 0 0 0 day month year))))
2226 (color (cond ((vc-annotate-compcar high (cond (color-map)
2227 (vc-annotate-color-map))))
2228 ((cons nil vc-annotate-very-old-color))))
2229 ;; substring from index 1 to remove any leading `#' in the name
2230 (face-name (concat "vc-annotate-face-" (substring (cdr color) 1)))
2231 ;; Make the face if not done.
2232 (face (cond ((intern-soft face-name))
2233 ((make-face (intern face-name)))))
2234 (point (point))
2235 (foo (forward-line 1))
2236 (overlay (cond ((if (string-match "XEmacs" emacs-version)
2237 (extent-at point)
2238 (car (overlays-at point ))))
2239 ((apply make-overlay-or-extent point (point) nil)))))
2241 (if vc-annotate-background
2242 (set-face-background face vc-annotate-background))
2243 (set-face-foreground face (cdr color))
2244 (apply set-property-overlay-or-extent overlay
2245 'face face nil)))))
2246 \f
2247 ;; Collect back-end-dependent stuff here
2249 (defun vc-backend-admin (file &optional rev comment)
2250 ;; Register a file into the version-control system
2251 ;; Automatically retrieves a read-only version of the file with
2252 ;; keywords expanded if vc-keep-workfiles is non-nil, otherwise
2253 ;; it deletes the workfile.
2254 (vc-file-clearprops file)
2255 (or vc-default-back-end
2256 (setq vc-default-back-end (if (vc-find-binary "rcs") 'RCS 'SCCS)))
2257 (message "Registering %s..." file)
2258 (let ((switches
2259 (if (stringp vc-register-switches)
2260 (list vc-register-switches)
2261 vc-register-switches))
2262 (backend
2263 (cond
2264 ((file-exists-p (vc-backend-subdirectory-name)) vc-default-back-end)
2265 ((file-exists-p "RCS") 'RCS)
2266 ((file-exists-p "SCCS") 'SCCS)
2267 ((file-exists-p "CVS") 'CVS)
2268 (t vc-default-back-end))))
2269 (cond ((eq backend 'SCCS)
2270 ;; If there is no SCCS subdirectory yet, create it.
2271 ;; (SCCS could do without it, but VC requires it to be there.)
2272 (if (not (file-exists-p "SCCS")) (make-directory "SCCS"))
2273 (apply 'vc-do-command nil 0 "admin" file 'MASTER ;; SCCS
2274 (and rev (concat "-r" rev))
2275 "-fb"
2276 (concat "-i" file)
2277 (and comment (concat "-y" comment))
2278 (format
2279 (car (rassq 'SCCS vc-master-templates))
2280 (or (file-name-directory file) "")
2281 (file-name-nondirectory file))
2282 switches)
2283 (delete-file file)
2284 (if vc-keep-workfiles
2285 (vc-do-command nil 0 "get" file 'MASTER)))
2286 ((eq backend 'RCS)
2287 (apply 'vc-do-command nil 0 "ci" file 'WORKFILE ;; RCS
2288 ;; if available, use the secure registering option
2289 (and (vc-backend-release-p 'RCS "5.6.4") "-i")
2290 (concat (if vc-keep-workfiles "-u" "-r") rev)
2291 (and comment (concat "-t-" comment))
2292 switches))
2293 ((eq backend 'CVS)
2294 (apply 'vc-do-command nil 0 "cvs" file 'WORKFILE ;; CVS
2295 "add"
2297 (concat "-m" comment))
2298 switches)
2299 )))
2300 (message "Registering %s...done" file)
2301 )
2303 (defun vc-backend-checkout (file &optional writable rev workfile)
2304 ;; Retrieve a copy of a saved version into a workfile
2305 (let ((filename (or workfile file))
2306 (file-buffer (get-file-buffer file))
2307 switches)
2308 (message "Checking out %s..." filename)
2309 (save-excursion
2310 ;; Change buffers to get local value of vc-checkout-switches.
2311 (if file-buffer (set-buffer file-buffer))
2312 (setq switches (if (stringp vc-checkout-switches)
2313 (list vc-checkout-switches)
2314 vc-checkout-switches))
2315 ;; Save this buffer's default-directory
2316 ;; and use save-excursion to make sure it is restored
2317 ;; in the same buffer it was saved in.
2318 (let ((default-directory default-directory))
2319 (save-excursion
2320 ;; Adjust the default-directory so that the check-out creates
2321 ;; the file in the right place.
2322 (setq default-directory (file-name-directory filename))
2323 (vc-backend-dispatch file
2324 (progn ;; SCCS
2325 (and rev (string= rev "") (setq rev nil))
2326 (if workfile
2327 ;; Some SCCS implementations allow checking out directly to a
2328 ;; file using the -G option, but then some don't so use the
2329 ;; least common denominator approach and use the -p option
2330 ;; ala RCS.
2331 (let ((vc-modes (logior (file-modes (vc-name file))
2332 (if writable 128 0)))
2333 (failed t))
2334 (unwind-protect
2335 (progn
2336 (apply 'vc-do-command
2337 nil 0 "/bin/sh" file 'MASTER "-c"
2338 ;; Some shells make the "" dummy argument into $0
2339 ;; while others use the shell's name as $0 and
2340 ;; use the "" as $1. The if-statement
2341 ;; converts the latter case to the former.
2345 (logand 511 (lognot vc-modes))
2346 (logand 511 (lognot (default-file-modes))))
2347 "" ; dummy argument for shell's $0
2348 filename
2349 (if writable "-e")
2350 "-p"
2351 (and rev
2352 (concat "-r" (vc-lookup-triple file rev)))
2353 switches)
2354 (setq failed nil))
2355 (and failed (file-exists-p filename)
2356 (delete-file filename))))
2357 (apply 'vc-do-command nil 0 "get" file 'MASTER ;; SCCS
2358 (if writable "-e")
2359 (and rev (concat "-r" (vc-lookup-triple file rev)))
2360 switches)
2361 (vc-file-setprop file 'vc-workfile-version nil)))
2362 (if workfile ;; RCS
2363 ;; RCS doesn't let us check out into arbitrary file names directly.
2364 ;; Use `co -p' and make stdout point to the correct file.
2365 (let ((vc-modes (logior (file-modes (vc-name file))
2366 (if writable 128 0)))
2367 (failed t))
2368 (unwind-protect
2369 (progn
2370 (apply 'vc-do-command
2371 nil 0 "/bin/sh" file 'MASTER "-c"
2372 ;; See the SCCS case, above, regarding the
2373 ;; if-statement.
2377 (logand 511 (lognot vc-modes))
2378 (logand 511 (lognot (default-file-modes))))
2379 "" ; dummy argument for shell's $0
2380 filename
2381 (if writable "-l")
2382 (concat "-p" rev)
2383 switches)
2384 (setq failed nil))
2385 (and failed (file-exists-p filename) (delete-file filename))))
2386 (let (new-version)
2387 ;; if we should go to the head of the trunk,
2388 ;; clear the default branch first
2389 (and rev (string= rev "")
2390 (vc-do-command nil 0 "rcs" file 'MASTER "-b"))
2391 ;; now do the checkout
2392 (apply 'vc-do-command
2393 nil 0 "co" file 'MASTER
2394 ;; If locking is not strict, force to overwrite
2395 ;; the writable workfile.
2396 (if (eq (vc-checkout-model file) 'implicit) "-f")
2397 (if writable "-l")
2398 (if rev (concat "-r" rev)
2399 ;; if no explicit revision was specified,
2400 ;; check out that of the working file
2401 (let ((workrev (vc-workfile-version file)))
2402 (if workrev (concat "-r" workrev)
2403 nil)))
2404 switches)
2405 ;; determine the new workfile version
2406 (save-excursion
2407 (set-buffer "*vc*")
2408 (goto-char (point-min))
2409 (setq new-version
2411 (buffer-substring (match-beginning 1) (match-end 1)))))
2412 (vc-file-setprop file 'vc-workfile-version new-version)
2413 ;; if necessary, adjust the default branch
2414 (and rev (not (string= rev ""))
2415 (vc-do-command nil 0 "rcs" file 'MASTER
2416 (concat "-b" (if (vc-latest-on-branch-p file)
2417 (if (vc-trunk-p new-version) nil
2418 (vc-branch-part new-version))
2419 new-version))))))
2420 (if workfile ;; CVS
2421 ;; CVS is much like RCS
2422 (let ((failed t))
2423 (unwind-protect
2424 (progn
2425 (apply 'vc-do-command
2426 nil 0 "/bin/sh" file 'WORKFILE "-c"
2428 "" ; dummy argument for shell's $0
2429 workfile
2430 (concat "-r" rev)
2431 "-p"
2432 switches)
2433 (setq failed nil))
2434 (and failed (file-exists-p filename) (delete-file filename))))
2435 ;; default for verbose checkout: clear the sticky tag
2436 ;; so that the actual update will get the head of the trunk
2437 (and rev (string= rev "")
2438 (vc-do-command nil 0 "cvs" file 'WORKFILE "update" "-A"))
2439 ;; If a revision was specified, check that out.
2440 (if rev
2441 (apply 'vc-do-command nil 0 "cvs" file 'WORKFILE
2442 (and writable (eq (vc-checkout-model file) 'manual) "-w")
2443 "update"
2444 (and rev (not (string= rev ""))
2445 (concat "-r" rev))
2446 switches)
2447 ;; If no revision was specified, call "cvs edit" to make
2448 ;; the file writeable.
2449 (and writable (eq (vc-checkout-model file) 'manual)
2450 (vc-do-command nil 0 "cvs" file 'WORKFILE "edit")))
2451 (if rev (vc-file-setprop file 'vc-workfile-version nil))))
2452 (cond
2453 ((not workfile)
2454 (vc-file-clear-masterprops file)
2455 (if writable
2456 (vc-file-setprop file 'vc-locking-user (vc-user-login-name)))
2457 (vc-file-setprop file
2458 'vc-checkout-time (nth 5 (file-attributes file)))))
2459 (message "Checking out %s...done" filename))))))
2461 (defun vc-backend-logentry-check (file)
2462 (vc-backend-dispatch file
2463 (if (>= (buffer-size) 512) ;; SCCS
2464 (progn
2465 (goto-char 512)
2466 (error
2467 "Log must be less than 512 characters; point is now at pos 512")))
2468 nil ;; RCS
2469 nil) ;; CVS
2470 )
2472 (defun vc-backend-checkin (file rev comment)
2473 ;; Register changes to FILE as level REV with explanatory COMMENT.
2474 ;; Automatically retrieves a read-only version of the file with
2475 ;; keywords expanded if vc-keep-workfiles is non-nil, otherwise
2476 ;; it deletes the workfile.
2477 ;; Adaptation for RCS branch support: if this is an explicit checkin,
2478 ;; or if the checkin creates a new branch, set the master file branch
2479 ;; accordingly.
2480 (message "Checking in %s..." file)
2481 ;; "This log message intentionally left almost blank".
2482 ;; RCS 5.7 gripes about white-space-only comments too.
2484 (setq comment "*** empty log message ***"))
2485 (save-excursion
2486 ;; Change buffers to get local value of vc-checkin-switches.
2487 (set-buffer (or (get-file-buffer file) (current-buffer)))
2488 (let ((switches
2489 (if (stringp vc-checkin-switches)
2490 (list vc-checkin-switches)
2491 vc-checkin-switches)))
2492 ;; Clear the master-properties. Do that here, not at the
2493 ;; end, because if the check-in fails we want them to get
2494 ;; re-computed before the next try.
2495 (vc-file-clear-masterprops file)
2496 (vc-backend-dispatch file
2497 ;; SCCS
2498 (progn
2499 (apply 'vc-do-command nil 0 "delta" file 'MASTER
2500 (if rev (concat "-r" rev))
2501 (concat "-y" comment)
2502 switches)
2503 (vc-file-setprop file 'vc-locking-user 'none)
2504 (vc-file-setprop file 'vc-workfile-version nil)
2505 (if vc-keep-workfiles
2506 (vc-do-command nil 0 "get" file 'MASTER))
2507 )
2508 ;; RCS
2509 (let ((old-version (vc-workfile-version file)) new-version)
2510 (apply 'vc-do-command nil 0 "ci" file 'MASTER
2511 ;; if available, use the secure check-in option
2512 (and (vc-backend-release-p 'RCS "5.6.4") "-j")
2513 (concat (if vc-keep-workfiles "-u" "-r") rev)
2514 (concat "-m" comment)
2515 switches)
2516 (vc-file-setprop file 'vc-locking-user 'none)
2517 (vc-file-setprop file 'vc-workfile-version nil)
2519 ;; determine the new workfile version
2520 (set-buffer "*vc*")
2521 (goto-char (point-min))
2522 (if (or (re-search-forward
2524 (re-search-forward
2526 (progn (setq new-version (buffer-substring (match-beginning 1)
2527 (match-end 1)))
2528 (vc-file-setprop file 'vc-workfile-version new-version)))
2530 ;; if we got to a different branch, adjust the default
2531 ;; branch accordingly
2532 (cond
2533 ((and old-version new-version
2534 (not (string= (vc-branch-part old-version)
2535 (vc-branch-part new-version))))
2536 (vc-do-command nil 0 "rcs" file 'MASTER
2537 (if (vc-trunk-p new-version) "-b"
2538 (concat "-b" (vc-branch-part new-version))))
2539 ;; If this is an old RCS release, we might have
2540 ;; to remove a remaining lock.
2541 (if (not (vc-backend-release-p 'RCS "5.6.2"))
2542 ;; exit status of 1 is also accepted.
2543 ;; It means that the lock was removed before.
2544 (vc-do-command nil 1 "rcs" file 'MASTER
2545 (concat "-u" old-version))))))
2546 ;; CVS
2547 (progn
2548 ;; explicit check-in to the trunk requires a
2549 ;; double check-in (first unexplicit) (CVS-1.3)
2550 (condition-case nil
2551 (progn
2552 (if (and rev (vc-trunk-p rev))
2553 (apply 'vc-do-command nil 0 "cvs" file 'WORKFILE
2554 "ci" "-m" "intermediate"
2555 switches))
2556 (apply 'vc-do-command nil 0 "cvs" file 'WORKFILE
2557 "ci" (if rev (concat "-r" rev))
2558 (concat "-m" comment)
2559 switches))
2560 (error (if (eq (vc-cvs-status file) 'needs-merge)
2561 ;; The CVS output will be on top of this message.
2562 (error "Type C-x 0 C-x C-q to merge in changes")
2563 (error "Check-in failed"))))
2564 ;; determine and store the new workfile version
2565 (set-buffer "*vc*")
2566 (goto-char (point-min))
2567 (if (re-search-forward
2569 (vc-file-setprop file 'vc-workfile-version
2570 (buffer-substring (match-beginning 2)
2571 (match-end 2)))
2572 (vc-file-setprop file 'vc-workfile-version nil))
2573 ;; if this was an explicit check-in, remove the sticky tag
2574 (if rev
2575 (vc-do-command nil 0 "cvs" file 'WORKFILE "update" "-A"))
2576 ;; Forget the checkout model, because we might have assumed
2577 ;; a wrong one when we found the file. After commit, we can
2578 ;; tell it from the permissions of the file
2579 ;; (see vc-checkout-model).
2580 (vc-file-setprop file 'vc-checkout-model nil)
2581 (vc-file-setprop file 'vc-locking-user 'none)
2582 (vc-file-setprop file 'vc-checkout-time
2583 (nth 5 (file-attributes file)))))))
2584 (message "Checking in %s...done" file))
2586 (defun vc-backend-revert (file)
2587 ;; Revert file to latest checked-in version.
2588 ;; (for RCS, to workfile version)
2589 (message "Reverting %s..." file)
2590 (vc-file-clear-masterprops file)
2591 (vc-backend-dispatch
2592 file
2593 ;; SCCS
2594 (progn
2595 (vc-do-command nil 0 "unget" file 'MASTER nil)
2596 (vc-do-command nil 0 "get" file 'MASTER nil))
2597 ;; RCS
2598 (vc-do-command nil 0 "co" file 'MASTER
2599 "-f" (concat "-u" (vc-workfile-version file)))
2600 ;; CVS
2601 (progn
2602 (delete-file file)
2603 (vc-do-command nil 0 "cvs" file 'WORKFILE "update")))
2604 (vc-file-setprop file 'vc-locking-user 'none)
2605 (vc-file-setprop file 'vc-checkout-time (nth 5 (file-attributes file)))
2606 (message "Reverting %s...done" file)
2607 )
2609 (defun vc-backend-steal (file &optional rev)
2610 ;; Steal the lock on the current workfile. Needs RCS 5.6.2 or later for -M.
2611 (message "Stealing lock on %s..." file)
2612 (vc-backend-dispatch file
2613 (progn ;SCCS
2614 (vc-do-command nil 0 "unget" file 'MASTER "-n" (if rev (concat "-r" rev)))
2615 (vc-do-command nil 0 "get" file 'MASTER "-g" (if rev (concat "-r" rev)))
2616 )
2617 (vc-do-command nil 0 "rcs" file 'MASTER ;RCS
2618 "-M" (concat "-u" rev) (concat "-l" rev))
2619 (error "You cannot steal a CVS lock; there are no CVS locks to steal") ;CVS
2620 )
2621 (vc-file-setprop file 'vc-locking-user (vc-user-login-name))
2622 (message "Stealing lock on %s...done" file)
2623 )
2625 (defun vc-backend-uncheck (file target)
2626 ;; Undo the latest checkin.
2627 (message "Removing last change from %s..." file)
2628 (vc-backend-dispatch file
2629 (vc-do-command nil 0 "rmdel" file 'MASTER (concat "-r" target))
2630 (vc-do-command nil 0 "rcs" file 'MASTER (concat "-o" target))
2631 nil ;; this is never reached under CVS
2632 )
2633 (message "Removing last change from %s...done" file)
2634 )
2636 (defun vc-backend-print-log (file)
2637 ;; Get change log associated with FILE.
2638 (vc-backend-dispatch
2639 file
2640 (vc-do-command nil 0 "prs" file 'MASTER)
2641 (vc-do-command nil 0 "rlog" file 'MASTER)
2642 (vc-do-command nil 0 "cvs" file 'WORKFILE "log")))
2644 (defun vc-backend-assign-name (file name)
2645 ;; Assign to a FILE's latest version a given NAME.
2646 (vc-backend-dispatch file
2647 (vc-add-triple name file (vc-latest-version file)) ;; SCCS
2648 (vc-do-command nil 0 "rcs" file 'MASTER (concat "-n" name ":")) ;; RCS
2649 (vc-do-command nil 0 "cvs" file 'WORKFILE "tag" name) ;; CVS
2650 )
2651 )
2653 (defun vc-backend-diff (file &optional oldvers newvers cmp)
2654 ;; Get a difference report between two versions of FILE.
2655 ;; Get only a brief comparison report if CMP, a difference report otherwise.
2656 (let ((backend (vc-backend file)) options status
2657 (diff-switches-list (if (listp diff-switches)
2658 diff-switches
2659 (list diff-switches))))
2660 (cond
2661 ((eq backend 'SCCS)
2662 (setq oldvers (vc-lookup-triple file oldvers))
2663 (setq newvers (vc-lookup-triple file newvers))
2664 (setq options (append (list (and cmp "--brief") "-q"
2665 (and oldvers (concat "-r" oldvers))
2666 (and newvers (concat "-r" newvers)))
2667 (and (not cmp) diff-switches-list)))
2668 (apply 'vc-do-command "*vc-diff*" 1 "vcdiff" file 'MASTER options))
2669 ((eq backend 'RCS)
2670 (if (not oldvers) (setq oldvers (vc-workfile-version file)))
2671 ;; If we know that --brief is not supported, don't try it.
2672 (setq cmp (and cmp (not (eq vc-rcsdiff-knows-brief 'no))))
2673 (setq options (append (list (and cmp "--brief") "-q"
2674 (concat "-r" oldvers)
2675 (and newvers (concat "-r" newvers)))
2676 (and (not cmp) diff-switches-list)))
2677 (setq status (apply 'vc-do-command "*vc-diff*" 2
2678 "rcsdiff" file 'WORKFILE options))
2679 ;; If --brief didn't work, do a double-take and remember it
2680 ;; for the future.
2681 (if (eq status 2)
2682 (prog1
2683 (apply 'vc-do-command "*vc-diff*" 1 "rcsdiff" file 'WORKFILE
2684 (if cmp (cdr options) options))
2685 (if cmp (setq vc-rcsdiff-knows-brief 'no)))
2686 ;; If --brief DID work, remember that, too.
2687 (and cmp (not vc-rcsdiff-knows-brief)
2688 (setq vc-rcsdiff-knows-brief 'yes))
2689 status))
2690 ;; CVS is different.
2691 ((eq backend 'CVS)
2692 (if (string= (vc-workfile-version file) "0")
2693 ;; This file is added but not yet committed; there is no master file.
2694 (if (or oldvers newvers)
2695 (error "No revisions of %s exist" file)
2696 (if cmp 1 ;; file is added but not committed,
2697 ;; we regard this as "changed".
2698 ;; diff it against /dev/null.
2699 (apply 'vc-do-command
2700 "*vc-diff*" 1 "diff" file 'WORKFILE
2701 (append (if (listp diff-switches)
2702 diff-switches
2703 (list diff-switches)) '("/dev/null")))))
2704 ;; cmp is not yet implemented -- we always do a full diff.
2705 (apply 'vc-do-command
2706 "*vc-diff*" 1 "cvs" file 'WORKFILE "diff"
2707 (and oldvers (concat "-r" oldvers))
2708 (and newvers (concat "-r" newvers))
2709 (if (listp diff-switches)
2710 diff-switches
2711 (list diff-switches)))))
2712 (t
2713 (vc-registration-error file)))))
2715 (defun vc-backend-merge-news (file)
2716 ;; Merge in any new changes made to FILE.
2717 (message "Merging changes into %s..." file)
2718 (prog1
2719 (vc-backend-dispatch
2720 file
2721 (error "vc-backend-merge-news not meaningful for SCCS files") ;SCCS
2722 (error "vc-backend-merge-news not meaningful for RCS files") ;RCS
2723 (save-excursion ; CVS
2724 (vc-file-clear-masterprops file)
2725 (vc-file-setprop file 'vc-workfile-version nil)
2726 (vc-file-setprop file 'vc-locking-user nil)
2727 (vc-file-setprop file 'vc-checkout-time nil)
2728 (vc-do-command nil 0 "cvs" file 'WORKFILE "update")
2729 ;; Analyze the merge result reported by CVS, and set
2730 ;; file properties accordingly.
2731 (set-buffer (get-buffer "*vc*"))
2732 (goto-char (point-min))
2733 ;; get new workfile version
2734 (if (re-search-forward (concat "^Merging differences between "
2735 "[01234567890.]* and "
2737 nil t)
2738 (vc-file-setprop file 'vc-workfile-version (match-string 1)))
2739 ;; get file status
2740 (if (re-search-forward
2742 (regexp-quote (file-name-nondirectory file)))
2743 nil t)
2744 (cond
2745 ;; Merge successful, we are in sync with repository now
2746 ((string= (match-string 1) "U")
2747 (vc-file-setprop file 'vc-locking-user 'none)
2748 (vc-file-setprop file 'vc-checkout-time
2749 (nth 5 (file-attributes file)))
2750 0) ;; indicate success to the caller
2751 ;; Merge successful, but our own changes are still in the file
2752 ((string= (match-string 1) "M")
2753 (vc-file-setprop file 'vc-locking-user (vc-file-owner file))
2754 (vc-file-setprop file 'vc-checkout-time 0)
2755 0) ;; indicate success to the caller
2756 ;; Conflicts detected!
2757 ((string= (match-string 1) "C")
2758 (vc-file-setprop file 'vc-locking-user (vc-file-owner file))
2759 (vc-file-setprop file 'vc-checkout-time 0)
2760 1) ;; signal the error to the caller
2761 )
2762 (pop-to-buffer "*vc*")
2763 (error "Couldn't analyze cvs update result"))))
2764 (message "Merging changes into %s...done" file)))
2766 (defun vc-check-headers ()
2767 "Check if the current file has any headers in it."
2768 (interactive)
2769 (save-excursion
2770 (goto-char (point-min))
2771 (vc-backend-dispatch buffer-file-name
2772 (re-search-forward "%[MIRLBSDHTEGUYFPQCZWA]%" nil t) ;; SCCS
2773 (re-search-forward "\\$[A-Za-z\300-\326\330-\366\370-\377]+\\(: [\t -#%-\176\240-\377]*\\)?\\$" nil t) ;; RCS
2774 'RCS ;; CVS works like RCS in this regard.
2775 )
2776 ))
2778 ;; Back-end-dependent stuff ends here.
2780 ;; Set up key bindings for use while editing log messages
2782 (defun vc-log-mode (&optional file)
2783 "Minor mode for driving version-control tools.
2784 These bindings are added to the global keymap when you enter this mode:
2798 While you are entering a change log message for a version, the following
2799 additional bindings will be in effect.
2803 Whenever you do a checkin, your log comment is added to a ring of
2804 saved comments. These can be recalled as follows:
2811 Entry to the change-log submode calls the value of text-mode-hook, then
2812 the value of vc-log-mode-hook.
2814 Global user options:
2815 vc-initial-comment If non-nil, require user to enter a change
2816 comment upon first checkin of the file.
2818 vc-keep-workfiles Non-nil value prevents workfiles from being
2819 deleted when changes are checked in
2821 vc-suppress-confirm Suppresses some confirmation prompts,
2822 notably for reversions.
2824 vc-header-alist Which keywords to insert when adding headers
2827 RCS and CVS.
2829 vc-static-header-alist By default, version headers inserted in C files
2830 get stuffed in a static string area so that
2831 ident(RCS/CVS) or what(SCCS) can see them in
2832 the compiled object code. You can override
2833 this by setting this variable to nil, or change
2834 the header template by changing it.
2836 vc-command-messages if non-nil, display run messages from the
2837 actual version-control utilities (this is
2838 intended primarily for people hacking vc
2839 itself).
2840 "
2841 (interactive)
2842 (set-syntax-table text-mode-syntax-table)
2843 (use-local-map vc-log-entry-mode)
2844 (setq local-abbrev-table text-mode-abbrev-table)
2845 (setq major-mode 'vc-log-mode)
2846 (setq mode-name "VC-Log")
2847 (make-local-variable 'vc-log-file)
2848 (setq vc-log-file file)
2849 (make-local-variable 'vc-log-version)
2850 (make-local-variable 'vc-comment-ring-index)
2851 (set-buffer-modified-p nil)
2852 (setq buffer-file-name nil)
2853 (run-hooks 'text-mode-hook 'vc-log-mode-hook)
2854 )
2856 ;; Initialization code, to be done just once at load-time
2857 (if vc-log-entry-mode
2858 nil
2859 (setq vc-log-entry-mode (make-sparse-keymap))
2860 (define-key vc-log-entry-mode "\M-n" 'vc-next-comment)
2861 (define-key vc-log-entry-mode "\M-p" 'vc-previous-comment)
2862 (define-key vc-log-entry-mode "\M-r" 'vc-comment-search-reverse)
2863 (define-key vc-log-entry-mode "\M-s" 'vc-comment-search-forward)
2864 (define-key vc-log-entry-mode "\C-c\C-c" 'vc-finish-logentry)
2865 )
2867 ;;; These things should probably be generally available
2869 (defun vc-file-tree-walk (dirname func &rest args)
2870 "Walk recursively through DIRNAME.
2871 Invoke FUNC f ARGS on each non-directory file f underneath it."
2872 (vc-file-tree-walk-internal (expand-file-name dirname) func args)
2873 (message "Traversing directory %s...done" dirname))
2875 (defun vc-file-tree-walk-internal (file func args)
2876 (if (not (file-directory-p file))
2877 (apply func file args)
2878 (message "Traversing directory %s..." (abbreviate-file-name file))
2879 (let ((dir (file-name-as-directory file)))
2880 (mapcar
2881 (function
2882 (lambda (f) (or
2883 (string-equal f ".")
2884 (string-equal f "..")
2885 (member f vc-directory-exclusion-list)
2886 (let ((dirf (concat dir f)))
2887 (or
2888 (file-symlink-p dirf) ;; Avoid possible loops
2889 (vc-file-tree-walk-internal dirf func args))))))
2890 (directory-files dir)))))
2892 (provide 'vc)
2894 ;;; DEVELOPER'S NOTES ON CONCURRENCY PROBLEMS IN THIS CODE
2895 ;;;
2896 ;;; These may be useful to anyone who has to debug or extend the package.
2897 ;;; (Note that this information corresponds to versions 5.x. Some of it
2898 ;;; might have been invalidated by the additions to support branching
2899 ;;; and RCS keyword lookup. AS, 1995/03/24)
2900 ;;;
2901 ;;; A fundamental problem in VC is that there are time windows between
2902 ;;; vc-next-action's computations of the file's version-control state and
2903 ;;; the actions that change it. This is a window open to lossage in a
2904 ;;; multi-user environment; someone else could nip in and change the state
2905 ;;; of the master during it.
2906 ;;;
2907 ;;; The performance problem is that rlog/prs calls are very expensive; we want
2908 ;;; to avoid them as much as possible.
2909 ;;;
2910 ;;; ANALYSIS:
2911 ;;;
2912 ;;; The performance problem, it turns out, simplifies in practice to the
2913 ;;; problem of making vc-locking-user fast. The two other functions that call
2914 ;;; prs/rlog will not be so commonly used that the slowdown is a problem; one
2915 ;;; makes snapshots, the other deletes the calling user's last change in the
2916 ;;; master.
2917 ;;;
2918 ;;; The race condition implies that we have to either (a) lock the master
2919 ;;; during the entire execution of vc-next-action, or (b) detect and
2920 ;;; recover from errors resulting from dispatch on an out-of-date state.
2921 ;;;
2922 ;;; Alternative (a) appears to be infeasible. The problem is that we can't
2923 ;;; guarantee that the lock will ever be removed. Suppose a user starts a
2924 ;;; checkin, the change message buffer pops up, and the user, having wandered
2925 ;;; off to do something else, simply forgets about it?
2926 ;;;
2927 ;;; Alternative (b), on the other hand, works well with a cheap way to speed up
2928 ;;; vc-locking-user. Usually, if a file is registered, we can read its locked/
2929 ;;; unlocked state and its current owner from its permissions.
2930 ;;;
2931 ;;; This shortcut will fail if someone has manually changed the workfile's
2932 ;;; permissions; also if developers are munging the workfile in several
2933 ;;; directories, with symlinks to a master (in this latter case, the
2934 ;;; permissions shortcut will fail to detect a lock asserted from another
2935 ;;; directory).
2936 ;;;
2937 ;;; Note that these cases correspond exactly to the errors which could happen
2938 ;;; because of a competing checkin/checkout race in between two instances of
2939 ;;; vc-next-action.
2940 ;;;
2941 ;;; For VC's purposes, a workfile/master pair may have the following states:
2942 ;;;
2943 ;;; A. Unregistered. There is a workfile, there is no master.
2944 ;;;
2945 ;;; B. Registered and not locked by anyone.
2946 ;;;
2947 ;;; C. Locked by calling user and unchanged.
2948 ;;;
2949 ;;; D. Locked by the calling user and changed.
2950 ;;;
2951 ;;; E. Locked by someone other than the calling user.
2952 ;;;
2953 ;;; This makes for 25 states and 20 error conditions. Here's the matrix:
2954 ;;;
2955 ;;; VC's idea of state
2956 ;;; |
2957 ;;; V Actual state RCS action SCCS action Effect
2958 ;;; A B C D E
2959 ;;; A . 1 2 3 4 ci -u -t- admin -fb -i<file> initial admin
2960 ;;; B 5 . 6 7 8 co -l get -e checkout
2961 ;;; C 9 10 . 11 12 co -u unget; get revert
2962 ;;; D 13 14 15 . 16 ci -u -m<comment> delta -y<comment>; get checkin
2963 ;;; E 17 18 19 20 . rcs -u -M -l unget -n ; get -g steal lock
2964 ;;;
2965 ;;; All commands take the master file name as a last argument (not shown).
2966 ;;;
2967 ;;; In the discussion below, a "self-race" is a pathological situation in
2968 ;;; which VC operations are being attempted simultaneously by two or more
2969 ;;; Emacsen running under the same username.
2970 ;;;
2971 ;;; The vc-next-action code has the following windows:
2972 ;;;
2973 ;;; Window P:
2974 ;;; Between the check for existence of a master file and the call to
2975 ;;; admin/checkin in vc-buffer-admin (apparent state A). This window may
2976 ;;; never close if the initial-comment feature is on.
2977 ;;;
2978 ;;; Window Q:
2979 ;;; Between the call to vc-workfile-unchanged-p in and the immediately
2980 ;;; following revert (apparent state C).
2981 ;;;
2982 ;;; Window R:
2983 ;;; Between the call to vc-workfile-unchanged-p in and the following
2984 ;;; checkin (apparent state D). This window may never close.
2985 ;;;
2986 ;;; Window S:
2987 ;;; Between the unlock and the immediately following checkout during a
2988 ;;; revert operation (apparent state C). Included in window Q.
2989 ;;;
2990 ;;; Window T:
2991 ;;; Between vc-locking-user and the following checkout (apparent state B).
2992 ;;;
2993 ;;; Window U:
2994 ;;; Between vc-locking-user and the following revert (apparent state C).
2995 ;;; Includes windows Q and S.
2996 ;;;
2997 ;;; Window V:
2998 ;;; Between vc-locking-user and the following checkin (apparent state
2999 ;;; D). This window may never be closed if the user fails to complete the
3000 ;;; checkin message. Includes window R.
3001 ;;;
3002 ;;; Window W:
3003 ;;; Between vc-locking-user and the following steal-lock (apparent
3004 ;;; state E). This window may never close if the user fails to complete
3005 ;;; the steal-lock message. Includes window X.
3006 ;;;
3007 ;;; Window X:
3008 ;;; Between the unlock and the immediately following re-lock during a
3009 ;;; steal-lock operation (apparent state E). This window may never cloce
3010 ;;; if the user fails to complete the steal-lock message.
3011 ;;;
3012 ;;; Errors:
3013 ;;;
3014 ;;; Apparent state A ---
3015 ;;;
3016 ;;; 1. File looked unregistered but is actually registered and not locked.
3017 ;;;
3018 ;;; Potential cause: someone else's admin during window P, with
3019 ;;; caller's admin happening before their checkout.
3020 ;;;
3021 ;;; RCS: Prior to version 5.6.4, ci fails with message
3022 ;;; "no lock set by <user>". From 5.6.4 onwards, VC uses the new
3023 ;;; ci -i option and the message is "<file>,v: already exists".
3024 ;;; SCCS: admin will fail with error (ad19).
3025 ;;;
3026 ;;; We can let these errors be passed up to the user.
3027 ;;;
3028 ;;; 2. File looked unregistered but is actually locked by caller, unchanged.
3029 ;;;
3030 ;;; Potential cause: self-race during window P.
3031 ;;;
3032 ;;; RCS: Prior to version 5.6.4, reverts the file to the last saved
3033 ;;; version and unlocks it. From 5.6.4 onwards, VC uses the new
3034 ;;; ci -i option, failing with message "<file>,v: already exists".
3035 ;;; SCCS: will fail with error (ad19).
3036 ;;;
3037 ;;; Either of these consequences is acceptable.
3038 ;;;
3039 ;;; 3. File looked unregistered but is actually locked by caller, changed.
3040 ;;;
3041 ;;; Potential cause: self-race during window P.
3042 ;;;
3043 ;;; RCS: Prior to version 5.6.4, VC registers the caller's workfile as
3044 ;;; a delta with a null change comment (the -t- switch will be
3045 ;;; ignored). From 5.6.4 onwards, VC uses the new ci -i option,
3046 ;;; failing with message "<file>,v: already exists".
3047 ;;; SCCS: will fail with error (ad19).
3048 ;;;
3049 ;;; 4. File looked unregistered but is locked by someone else.
3050 ;;;
3051 ;;; Potential cause: someone else's admin during window P, with
3052 ;;; caller's admin happening *after* their checkout.
3053 ;;;
3054 ;;; RCS: Prior to version 5.6.4, ci fails with a
3055 ;;; "no lock set by <user>" message. From 5.6.4 onwards,
3056 ;;; VC uses the new ci -i option, failing with message
3057 ;;; "<file>,v: already exists".
3058 ;;; SCCS: will fail with error (ad19).
3059 ;;;
3060 ;;; We can let these errors be passed up to the user.
3061 ;;;
3062 ;;; Apparent state B ---
3063 ;;;
3064 ;;; 5. File looked registered and not locked, but is actually unregistered.
3065 ;;;
3066 ;;; Potential cause: master file got nuked during window P.
3067 ;;;
3068 ;;; RCS: will fail with "RCS/<file>: No such file or directory"
3069 ;;; SCCS: will fail with error ut4.
3070 ;;;
3071 ;;; We can let these errors be passed up to the user.
3072 ;;;
3073 ;;; 6. File looked registered and not locked, but is actually locked by the
3074 ;;; calling user and unchanged.
3075 ;;;
3076 ;;; Potential cause: self-race during window T.
3077 ;;;
3078 ;;; RCS: in the same directory as the previous workfile, co -l will fail
3079 ;;; with "co error: writable foo exists; checkout aborted". In any other
3080 ;;; directory, checkout will succeed.
3081 ;;; SCCS: will fail with ge17.
3082 ;;;
3083 ;;; Either of these consequences is acceptable.
3084 ;;;
3085 ;;; 7. File looked registered and not locked, but is actually locked by the
3086 ;;; calling user and changed.
3087 ;;;
3088 ;;; As case 6.
3089 ;;;
3090 ;;; 8. File looked registered and not locked, but is actually locked by another
3091 ;;; user.
3092 ;;;
3093 ;;; Potential cause: someone else checks it out during window T.
3094 ;;;
3095 ;;; RCS: co error: revision 1.3 already locked by <user>
3096 ;;; SCCS: fails with ge4 (in directory) or ut7 (outside it).
3097 ;;;
3098 ;;; We can let these errors be passed up to the user.
3099 ;;;
3100 ;;; Apparent state C ---
3101 ;;;
3102 ;;; 9. File looks locked by calling user and unchanged, but is unregistered.
3103 ;;;
3104 ;;; As case 5.
3105 ;;;
3106 ;;; 10. File looks locked by calling user and unchanged, but is actually not
3107 ;;; locked.
3108 ;;;
3109 ;;; Potential cause: a self-race in window U, or by the revert's
3110 ;;; landing during window X of some other user's steal-lock or window S
3111 ;;; of another user's revert.
3112 ;;;
3113 ;;; RCS: succeeds, refreshing the file from the identical version in
3114 ;;; the master.
3115 ;;; SCCS: fails with error ut4 (p file nonexistent).
3116 ;;;
3117 ;;; Either of these consequences is acceptable.
3118 ;;;
3119 ;;; 11. File is locked by calling user. It looks unchanged, but is actually
3120 ;;; changed.
3121 ;;;
3122 ;;; Potential cause: the file would have to be touched by a self-race
3123 ;;; during window Q.
3124 ;;;
3125 ;;; The revert will succeed, removing whatever changes came with
3126 ;;; the touch. It is theoretically possible that work could be lost.
3127 ;;;
3128 ;;; 12. File looks like it's locked by the calling user and unchanged, but
3129 ;;; it's actually locked by someone else.
3130 ;;;
3131 ;;; Potential cause: a steal-lock in window V.
3132 ;;;
3133 ;;; RCS: co error: revision <rev> locked by <user>; use co -r or rcs -u
3134 ;;; SCCS: fails with error un2
3135 ;;;
3136 ;;; We can pass these errors up to the user.
3137 ;;;
3138 ;;; Apparent state D ---
3139 ;;;
3140 ;;; 13. File looks like it's locked by the calling user and changed, but it's
3141 ;;; actually unregistered.
3142 ;;;
3143 ;;; Potential cause: master file got nuked during window P.
3144 ;;;
3145 ;;; RCS: Prior to version 5.6.4, checks in the user's version as an
3146 ;;; initial delta. From 5.6.4 onwards, VC uses the new ci -j
3147 ;;; option, failing with message "no such file or directory".
3148 ;;; SCCS: will fail with error ut4.
3149 ;;;
3150 ;;; This case is kind of nasty. Under RCS prior to version 5.6.4,
3151 ;;; VC may fail to detect the loss of previous version information.
3152 ;;;
3153 ;;; 14. File looks like it's locked by the calling user and changed, but it's
3154 ;;; actually unlocked.
3155 ;;;
3156 ;;; Potential cause: self-race in window V, or the checkin happening
3157 ;;; during the window X of someone else's steal-lock or window S of
3158 ;;; someone else's revert.
3159 ;;;
3160 ;;; RCS: ci will fail with "no lock set by <user>".
3161 ;;; SCCS: delta will fail with error ut4.
3162 ;;;
3163 ;;; 15. File looks like it's locked by the calling user and changed, but it's
3164 ;;; actually locked by the calling user and unchanged.
3165 ;;;
3166 ;;; Potential cause: another self-race --- a whole checkin/checkout
3167 ;;; sequence by the calling user would have to land in window R.
3168 ;;;
3169 ;;; SCCS: checks in a redundant delta and leaves the file unlocked as usual.
3170 ;;; RCS: reverts to the file state as of the second user's checkin, leaving
3171 ;;; the file unlocked.
3172 ;;;
3173 ;;; It is theoretically possible that work could be lost under RCS.
3174 ;;;
3175 ;;; 16. File looks like it's locked by the calling user and changed, but it's
3176 ;;; actually locked by a different user.
3177 ;;;
3178 ;;; RCS: ci error: no lock set by <user>
3179 ;;; SCCS: unget will fail with error un2
3180 ;;;
3181 ;;; We can pass these errors up to the user.
3182 ;;;
3183 ;;; Apparent state E ---
3184 ;;;
3185 ;;; 17. File looks like it's locked by some other user, but it's actually
3186 ;;; unregistered.
3187 ;;;
3188 ;;; As case 13.
3189 ;;;
3190 ;;; 18. File looks like it's locked by some other user, but it's actually
3191 ;;; unlocked.
3192 ;;;
3193 ;;; Potential cause: someone released a lock during window W.
3194 ;;;
3195 ;;; RCS: The calling user will get the lock on the file.
3196 ;;; SCCS: unget -n will fail with cm4.
3197 ;;;
3198 ;;; Either of these consequences will be OK.
3199 ;;;
3200 ;;; 19. File looks like it's locked by some other user, but it's actually
3201 ;;; locked by the calling user and unchanged.
3202 ;;;
3203 ;;; Potential cause: the other user relinquishing a lock followed by
3204 ;;; a self-race, both in window W.
3205 ;;;
3206 ;;; Under both RCS and SCCS, both unlock and lock will succeed, making
3207 ;;; the sequence a no-op.
3208 ;;;
3209 ;;; 20. File looks like it's locked by some other user, but it's actually
3210 ;;; locked by the calling user and changed.
3211 ;;;
3212 ;;; As case 19.
3213 ;;;
3214 ;;; PROBLEM CASES:
3215 ;;;
3216 ;;; In order of decreasing severity:
3217 ;;;
3218 ;;; Cases 11 and 15 are the only ones that potentially lose work.
3219 ;;; They would require a self-race for this to happen.
3220 ;;;
3221 ;;; Case 13 in RCS loses information about previous deltas, retaining
3222 ;;; only the information in the current workfile. This can only happen
3223 ;;; if the master file gets nuked in window P.
3224 ;;;
3225 ;;; Case 3 in RCS and case 15 under SCCS insert a redundant delta with
3226 ;;; no change comment in the master. This would require a self-race in
3227 ;;; window P or R respectively.
3228 ;;;
3229 ;;; Cases 2, 10, 19 and 20 do extra work, but make no changes.
3230 ;;;
3231 ;;; Unfortunately, it appears to me that no recovery is possible in these
3232 ;;; cases. They don't yield error messages, so there's no way to tell that
3233 ;;; a race condition has occurred.
3234 ;;;
3235 ;;; All other cases don't change either the workfile or the master, and
3236 ;;; trigger command errors which the user will see.
3237 ;;;
3238 ;;; Thus, there is no explicit recovery code.
3240 ;;; vc.el ends here