| blob | cd496400c6e17d25a8c3bda467b15fc4cc5ff0d6 |
1 ;;; vc.el --- drive a version-control system from within Emacs
3 ;; Copyright (C) 1992, 93, 94, 95, 96 Free Software Foundation, Inc.
5 ;; Author: Eric S. Raymond <esr@snark.thyrsus.com>
6 ;; Modified by:
7 ;; ttn@netcom.com
8 ;; Per Cederqvist <ceder@lysator.liu.edu>
9 ;; Andre Spiegel <spiegel@berlin.informatik.uni-stuttgart.de>
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software; you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation; either version 2, or (at your option)
16 ;; any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs; see the file COPYING. If not, write to the
25 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
26 ;; Boston, MA 02111-1307, USA.
28 ;;; Commentary:
30 ;; This mode is fully documented in the Emacs user's manual.
31 ;;
32 ;; This was designed and implemented by Eric Raymond <esr@snark.thyrsus.com>.
33 ;; Paul Eggert <eggert@twinsun.com>, Sebastian Kremer <sk@thp.uni-koeln.de>,
34 ;; and Richard Stallman contributed valuable criticism, support, and testing.
35 ;; CVS support was added by Per Cederqvist <ceder@lysator.liu.se>
36 ;; in Jan-Feb 1994.
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
108 "*A string or list of strings specifying extra switches passed
111 "*A string or list of strings specifying extra switches passed
114 "*A list of directory names ignored by functions that recursively
120 ;;; This is duplicated in diff.el.
124 ;;;###autoload
129 "*List of functions called when a buffer is made writable. See `run-hooks.'
130 This hook is only used when the version control system is CVS. It
131 might be useful for sites who uses locking with CVS, or who uses link
134 ;; Header-insertion hair
138 "*Header keywords to be inserted by `vc-insert-headers'.
139 Must be a list of two-element lists, the first element of each must
140 be `RCS', `CVS', or `SCCS'. The second element is the string to
145 "*Associate static header string templates with file types. A \%s in the
146 template is replaced with the first string associated with the file's
151 "*Special comment delimiters to be used in generating vc headers only.
152 Add an entry in this list if you need to override the normal comment-start
153 and comment-end variables. This will only be necessary if the mode language
156 ;; Default is to be extra careful for super-user.
158 "*Non-nil means be extra-careful in checkout.
159 Verify that the file really is not locked
163 "*The release number of your RCS installation, as a string.
167 "*The release number of your SCCS installation, as a string.
171 "*The release number of your CVS installation, as a string.
174 ;; Variables the user doesn't need to know about.
179 ;; In a log entry buffer, this is a local variable
180 ;; that points to the buffer for which it was made
181 ;; (either a file, or a VC dired buffer).
197 ;; Back-portability to Emacs 18
207 ; Conditionally rebind some things for Emacs 18 compatibility
213 ))
218 ;;; Find and compare backend releases
221 ;; Returns which backend release is installed on this system.
243 vc-sccs-release)))
246 ;; Compare release numbers, represented as strings.
247 ;; Release components are assumed cardinal numbers, not decimal
248 ;; fractions (5.10 is a higher release than 5.9). Omitted fields
249 ;; are considered lower (5.6.7 is earlier than 5.6.7.1).
250 ;; Comparison runs till the end of the string is found, or a
251 ;; non-numeric component shows up (5.6.7 is earlier than "5.6.7 beta",
252 ;; which is probably not what you want in some cases).
253 ;; This code is suitable for existing RCS release numbers.
254 ;; CVS releases are handled reasonably, too (1.3 < 1.4* < 1.5).
275 ;; Return t if we have RELEASE of BACKEND or better
282 ;;; functions that operate on RCS revision numbers
285 ;; return t if REV is a revision on the trunk
289 ;; return the branch part of a revision number REV
292 ;; File property caching
295 "Clear all cached file properties and the comment ring."
298 ;; Note: there is potential for minor lossage here if there is an open
299 ;; log buffer with a nonzero local value of vc-comment-ring-index.
303 ;; clear all properties of FILE that were retrieved
304 ;; from the master file
319 ;; Return the RCS head version of FILE
324 ;; Random helper functions
327 ;; return t iff the current workfile version of FILE is
328 ;; the latest on its branch.
330 ;; SCCS
332 ;; RCS
336 ;; Re-fetch the head version number. This is to make
337 ;; sure that no-one has checked in a new version behind
338 ;; our back.
341 workfile-version))
342 ;; If we are not on the trunk, we need to examine the
343 ;; whole current branch. (vc-master-workfile-version
344 ;; is not what we need.)
354 ;; CVS
355 t))
365 "Look for a command anywhere on the subprocess-command search path."
378 exec-path)
379 nil)))
382 "Execute a version-control command, notifying user and checking for errors.
383 Output from COMMAND goes to BUFFER, or *vc* if BUFFER is nil.
384 The command is successful if its exit status does not exceed OKSTATUS.
385 The last argument of the command is the master name of FILE if LAST is
386 `MASTER', or the workfile of FILE if LAST is `WORKFILE'; this is appended
387 to an optional list of FLAGS."
396 status)
407 flags)
418 ;; Add vc-path to PATH for the execution of this command.
421 path-separator
423 process-environment))
437 status))
438 )
441 )
443 status)
444 )
446 ;;; Save a bit of the text around POSN in the current buffer, to help
447 ;;; us find the corresponding position again later. This works even
448 ;;; if all markers are destroyed or corrupted.
449 ;;; A lot of this was shamelessly lifted from Sebastian Kremer's rcs.el mode.
456 ;;; Return the position of CONTEXT in the current buffer, or nil if we
457 ;;; couldn't find it.
467 ;; Can't use search-backward since the match may continue
468 ;; after point.
470 ;; goto-char doesn't signal an error at
471 ;; beginning of buffer like backward-char would
473 ;; to beginning of OSTRING
477 ;; Return a list '(point-context mark-context reparse); from which
478 ;; vc-restore-buffer-context can later restore the context.
480 ;; Use mark-marker to avoid confusion in transient-mark-mode.
483 ;; Make the right thing happen in transient-mark-mode.
485 ;; We may want to reparse the compilation buffer after revert
488 ;; Construct a list; each elt is nil or a buffer
489 ;; iff that buffer is a compilation output buffer
490 ;; that contains markers into the current buffer.
496 compilation-old-error-list
497 compilation-error-list))
512 ;; Restore point/mark, and reparse any affected compilation buffers.
513 ;; CONTEXT is that which vc-buffer-context returns.
517 ;; Reparse affected compilation buffers.
523 ;; Record the position in the compilation buffer of
524 ;; the last error next-error went to.
527 ;; Reparse the error messages as far as they were parsed before.
529 ;; Move the pointer up to find the error we were at before
530 ;; reparsing. Now next-error should properly go to the next one.
536 ;; Restore point and mark
544 ;; Revert buffer, try to keep point and mark where user expects them in spite
545 ;; of changes because of expanded version-control key words.
546 ;; This is quite important since otherwise typeahead won't work as expected.
550 ;; t means don't call normal-mode; that's to preserve various minor modes.
556 ;; Make sure the current buffer and its working file are in sync
557 ;; NOT-URGENT means it is ok to continue if the user says not to save.
563 nil
568 ;; Has the given workfile changed since last checkout?
575 ;; 0 stands for an unknown time; it can't match any mod time.
577 unchanged)))))
580 ;;; If comment is specified, it will be used as an admin or checkin comment.
583 owner version buffer)
586 ;; if there is no master file corresponding, create one
594 ;; CVS: changes to the master file need to be
595 ;; merged back into the working file
614 "Buffer %s modified; merge file on disc anyhow? "
618 ;; Overlaps detected - what now? Should use some
619 ;; fancy RCS conflict resolving package, or maybe
620 ;; emerge, but for now, simply warn the user with a
621 ;; message.
627 ;; if there is no lock on the file, assert one and get it
635 file))
646 )
662 )))
664 ;; a checked-out version exists, but the user may not own the lock
673 file
676 owner))
678 ;; OK, user owns the lock on the file
684 ;; give luser a chance to save before checking in.
687 ;; Revert if file is unchanged and buffer is too.
688 ;; If buffer is modified, that means the user just said no
689 ;; to saving it; in that case, don't revert,
690 ;; because the user might intend to save
691 ;; after finishing the log entry.
694 ;; DO NOT revert the file without asking the user!
700 ;; user may want to set nonstandard parameters
704 ;; OK, let's do the checkin
706 )))))
709 ;; Do a vc-next-action-on-file on all the marked files, possibly
710 ;; passing on the log comment we've just entered.
718 ;; Adjust the default directory so that checkouts
719 ;; go to the right place.
727 nil t)))
729 ;; Here's the major entry point.
731 ;;;###autoload
733 "Do the next logical checkin or checkout operation on the current file.
734 If you call this from within a VC dired buffer with no files marked,
735 it will operate on the file in the current line.
736 If you call this from within a VC dired buffer, and one or more
737 files are marked, it will accept a log message and then operate on
738 each one. The log message will be used as a comment for any register
739 or checkin operations, but ignored when doing checkouts. Attempted
740 lock steals will raise an error.
741 A prefix argument lets you specify the version number to use.
743 For RCS and SCCS files:
744 If the file is not already registered, this registers it for version
745 control and then retrieves a writable, locked copy for editing.
746 If the file is registered and not locked by anyone, this checks out
747 a writable and locked file ready for editing.
748 If the file is checked out and locked by the calling user, this
749 first checks to see if the file has changed since checkout. If not,
750 it performs a revert.
751 If the file has been changed, this pops up a buffer for entry
752 of a log message; when the message has been entered, it checks in the
753 resulting changes along with the log message as change commentary. If
754 the variable `vc-keep-workfiles' is non-nil (which is its default), a
755 read-only copy of the changed file is left in place afterwards.
756 If the file is registered and locked by someone else, you are given
757 the option to steal the lock.
759 For CVS files:
760 If the file is not already registered, this registers it for version
762 If the file is added but not committed, it is committed.
763 If your working file is changed, but the repository file is
764 unchanged, this pops up a buffer for entry of a log message; when the
765 message has been entered, it checks in the resulting changes along
766 with the logmessage as change commentary. A writable file is retained.
767 If the repository file is changed, you are asked if you want to
768 merge in the changes into your working copy."
785 "Enter a change comment for the marked files."
794 ;;; These functions help the vc-next-action entry point
797 "Retrieve a writable copy of the latest version of the current buffer's file."
799 )
801 ;;;###autoload
803 "Register the current file into your version-control system."
813 ;; Watch out for new buffers of size 0: the corresponding file
814 ;; does not exist yet, even though buffer-modified-p is nil.
821 ;; inhibit backup for this buffer
825 buffer-file-name
829 )
832 ;; If the given file is in the current buffer,
833 ;; either revert on it so we see expanded keywords,
834 ;; or unvisit it (depending on vc-keep-workfiles)
835 ;; NOQUERY if non-nil inhibits confirmation for reverting.
836 ;; NOQUERY should be t *only* if it is known the only difference
837 ;; between the buffer and the file is due to RCS rather than user editing!
841 ;; temporarily remove vc-find-file-hook, so that
842 ;; we don't lose the properties
850 ;; if FILE is currently visited, resynch its buffer
858 ;; Accept a comment for an operation on FILE revision REV. If COMMENT
859 ;; is nil, pop up a VC-log buffer, emit MSG, and set the
860 ;; action on close to ACTION; otherwise, do action immediately.
861 ;; Remember the file's buffer in vc-parent-buffer (current one if no file).
862 ;; AFTER-HOOK specifies the local value for vc-log-operation-hook.
888 "Check a file into your version-control system.
889 FILE is the unmodified name of the file. REV should be the base version
890 level to check it in under. COMMENT, if specified, is the checkin comment."
894 nil))
897 "Retrieve a copy of the latest version of the given file."
898 ;; If ftp is on this system and the name matches the ange-ftp format
899 ;; for a remote file, the user is trying something that won't work.
906 "Steal the lock on the current workfile."
914 file-description owner)))
930 ;; This is called when the notification has been sent.
939 "Check in the file specified by FILE.
940 The optional argument REV may be a string specifying the new version level
941 \(if nil increment the current level). The file is either retained with write
942 permissions zeroed, or deleted (according to the value of `vc-keep-workfiles').
943 If the back-end is CVS, a writable workfile is always kept.
944 COMMENT is a comment string; if omitted, a buffer is
945 popped up to accept a comment."
950 ;;; Here is a checkin hook that may prove useful to sites using the
951 ;;; ChangeLog facility supported by Emacs.
953 "Enter last VC comment into change log file for current buffer's file.
954 Optional arg (interactive prefix) non-nil means prompt for user name and site.
955 Second arg is file name of change log. \
956 If nil, uses `change-log-default-name'."
960 ;; Make sure the defvar for add-log-current-defun-function has been executed
961 ;; before binding it.
965 ;; Don't let add-change-log-entry insert a defun name.
967 end)
968 ;; Call add-log to do half the work.
970 ;; Insert the VC comment, leaving point before it.
973 ;; It starts with an open-paren, as in "(foo): Frobbed."
974 ;; So remove the ": " add-log inserted.
976 ;; Canonicalize the white space between the file name and comment.
978 ;; Indent rest of the text the same way add-log indented the first line.
985 ;; Fill the inserted text, preserving open-parens at bol.
990 ;; Canonicalize the white space at the end of the entry so it is
991 ;; separated from the next entry by a single blank line.
999 "Complete the operation implied by the current log entry."
1001 ;; Check and record the comment, if any.
1007 ;; Comment too long?
1009 ;; Record the comment in the comment ring
1011 ))
1012 ;; Sync parent buffer in case the user modified it while editing the comment.
1013 ;; But not if it is a vc-dired buffer.
1019 ;; save the parameters held in buffer-local variables
1025 ;; Return to "parent" buffer of this checkin and remove checkin window
1030 ;; OK, do it to it
1033 log-file
1034 log-version
1035 log-entry))
1036 ;; Now make sure we see the expanded headers
1041 ;; Code for access to the comment ring
1044 "Cycle backwards through comment history."
1052 ;; Initialize the index on the first use of this command
1053 ;; so that the first M-p gets index 0, and the first M-n gets
1054 ;; index -1.
1065 "Cycle forwards through comment history."
1070 "Searches backwards through comment history for substring match."
1087 "Searches forwards through comment history for substring match."
1103 ;; Additional entry points for examining version histories
1105 ;;;###autoload
1107 "Display diffs between file versions.
1108 Normally this compares the current file and buffer with the most recent
1109 checked in version of that file. This uses no arguments.
1110 With a prefix argument, it reads the file name to use
1111 and two version designators specifying which versions to compare."
1123 unchanged)
1131 ;; Ideally, we'd like at this point to parse the diff so that
1132 ;; the buffer effectively goes into compilation mode and we
1133 ;; can visit the old and new change locations via next-error.
1134 ;; Unfortunately, this is just too painful to do. The basic
1135 ;; problem is that the `old' file doesn't exist to be
1136 ;; visited. This plays hell with numerous assumptions in
1137 ;; the diff.el and compile.el machinery.
1150 "For FILE, report diffs between two stored versions REL1 and REL2 of it.
1151 If FILE is a directory, generate diffs between versions for all registered
1152 files in or below it."
1165 " and "
1171 default-directory
1179 )))
1184 )
1189 ;;;###autoload
1191 "Visit version REV of the current buffer in another window.
1192 If the current buffer is named `F', the version is named `F.~REV~'.
1193 If `F.~REV~' already exists, it is used instead of being re-created."
1202 rev))
1209 ;; Header-insertion code
1211 ;;;###autoload
1213 "Insert headers in a file for use with your version-control system.
1214 Headers desired are inserted at the start of the buffer, and are pulled from
1215 the variable `vc-header-alist'."
1234 hdstrings)
1239 vc-static-header-alist))
1240 )
1241 )))))
1244 ;; Clear all version headers in the current buffer, i.e. reset them
1245 ;; to the nonexpanded form. Only implemented for RCS, yet.
1246 ;; Don't lose point and mark during this.
1253 ;; The VC directory major mode. Coopt Dired for this.
1254 ;; All VC commands get mapped into logical equivalents.
1257 "The major mode used in VC directory buffers. It is derived from Dired.
1258 All Dired commands operate normally. Users currently locking listed files
1259 are listed in place of the file's owner and group.
1260 Keystrokes bound to VC commands will execute as though they had been called
1261 on a buffer attached to the file named in the current Dired buffer line."
1269 ;; Return the string that indicates the version control status
1270 ;; on a VC dired line.
1283 ;; Hack a directory-listing line, plugging in locking-user info in
1284 ;; place of the user and group info. Should have the beneficial
1285 ;; side-effect of shortening the listing line. Each call starts with
1286 ;; point immediately following the dired mark area on the line to be
1287 ;; hacked.
1288 ;;
1289 ;; Simplest possible one:
1290 ;; (insert (concat x "\t")))
1291 ;;
1292 ;; This code, like dired, assumes UNIX -l format.
1301 limit t)
1304 limit t))
1310 limit t)
1319 ;; Update the vc-dired listing line of file -- it is assumed
1320 ;; that point is already on this line. Don't use dired-do-redisplay
1321 ;; for this, because it cannot handle the way vc-dired deals with
1322 ;; subdirectories.
1341 ;;; Note in Emacs 18 the following defun gets overridden
1342 ;;; with the symbol 'vc-directory-18. See below.
1343 ;;;###autoload
1345 "Show version-control status of the current directory and subdirectories.
1346 Normally it creates a Dired buffer that lists only the locked files
1347 in all these directories. With a prefix argument, it lists all files."
1351 ;; force a trailing slash
1358 dired-buf
1359 dired-buf-mod-count)
1361 dirname
1371 ;; This uses a semi-documented feature of dired; giving a switch
1372 ;; argument forces the buffer to refresh each time.
1379 ;; Make a few modifications to the header
1389 ;; Plug the version information into the individual lines
1400 )
1406 ))
1408 ;; Emacs 18 version
1410 "Show version-control status of all files under the current directory."
1418 default-directory
1435 )
1440 ;; Named-configuration support for SCCS
1445 vc-name-assoc-file
1453 ))
1459 vc-name-assoc-file
1464 ;; (replace-regexp (concat ":" (regexp-quote file) "$") (concat ":" newname))
1469 ))
1472 ;; Return the numeric version corresponding to a named snapshot of file
1473 ;; If name is nil or a version number string it's just passed through
1477 name)
1483 vc-name-assoc-file
1491 ))
1493 ;; Named-configuration entry points
1496 ;; Scan the tree below the current directory.
1497 ;; If any files are locked, return the name of the first such file.
1498 ;; (This means, neither snapshot creation nor retrieval is allowed.)
1499 ;; If one or more of the files are currently visited, return `visited'.
1500 ;; Otherwise, return nil.
1504 default-directory
1509 status)))
1511 ;;;###autoload
1513 "Make a snapshot called NAME.
1514 The snapshot is made from all registered files at or below the current
1515 directory. For each file, the version level of its latest
1516 version becomes part of the named configuration."
1522 default-directory
1526 )))
1528 ;;;###autoload
1530 "Retrieve the snapshot called NAME.
1531 This function fails if any files are locked at or below the current directory
1532 Otherwise, all registered files are checked out (unlocked) at their version
1533 levels in the snapshot."
1542 default-directory
1548 )))
1550 ;; Miscellaneous other entry points
1552 ;;;###autoload
1554 "List the change log of the current buffer in a window."
1572 )
1574 )
1575 )
1577 ;;;###autoload
1579 "Revert the current buffer's file back to the latest checked-in version.
1580 This asks for confirmation if the buffer contents are not identical
1581 to that version.
1582 If the back-end is CVS, this will give you the most recent revision of
1583 the file on the branch you are editing."
1590 ;; This operation should always ask for confirmation.
1608 )
1609 )
1611 ;;;###autoload
1613 "Get rid of most recently checked in version of this file.
1614 A prefix argument means do not revert the buffer afterwards."
1633 nil
1637 ;; Check out the most recent remaining version. If it fails, because
1638 ;; the whole branch got deleted, do a double-take and check out the
1639 ;; version where the branch started.
1644 ;; Check out locked, but only to disc, and keep
1645 ;; modifications in the buffer.
1647 ;; Check out unlocked, and revert buffer.
1650 ;; If the checkout fails, vc-do-command signals an error.
1651 ;; We catch this error, check the reason, correct the
1652 ;; version number, and try a second time.
1657 ;; vc-do-command popped up a window with
1658 ;; the error message. Get rid of it, by
1659 ;; restoring the old window configuration.
1661 ;; No, it was some other error: re-signal it.
1663 ;; If norevert, clear version headers and mark the buffer modified.
1668 ;; inhibit backup for this buffer
1676 )))
1678 ;;;###autoload
1680 "Rename file OLD to NEW, and rename its master file likewise."
1682 ;; There are several ways of renaming files under CVS 1.3, but they all
1683 ;; have serious disadvantages. See the FAQ (available from think.com in
1684 ;; pub/cvs/). I'd rather send the user an error, than do something he might
1685 ;; consider to be wrong. When the famous, long-awaited rename database is
1686 ;; implemented things might change for the better. This is unlikely to occur
1687 ;; until CVS 2.0 is released. --ceder 1994-01-23 21:27:51
1703 ;; This had FILE, I changed it to OLD. -- rms.
1707 oldmaster
1721 vc-master-templates)
1725 ; ?? Renaming a file might change its contents due to keyword expansion.
1726 ; We should really check out a new copy if the old copy was precisely equal
1727 ; to some checked in version. However, testing for this is tricky....
1736 ;; This had FILE, I changed it to OLD. -- rms.
1739 nil ;RCS
1740 nil ;CVS
1741 )
1742 )
1744 ;;;###autoload
1746 "Find change log file and add entries from recent RCS/CVS logs.
1747 Normally, find log entries for all registered files in the default
1748 directory using `rcs2log', which finds CVS logs preferentially.
1749 The mark is left at the end of the text prepended to the change log.
1751 With prefix arg of C-u, only find log entries for the current buffer's file.
1753 With any numeric prefix arg, find log entries for all currently visited
1754 files that are under version control. This puts all the entries in the
1755 log for the default directory, which may not be appropriate.
1757 From a program, any arguments are assumed to be filenames and are
1758 passed to the `rcs2log' script after massaging to be relative to the
1759 default directory."
1766 file)
1772 files))
1774 ;; `rcs2log' will find the relevant RCS or CVS files
1775 ;; relative to the curent directory if none supplied.
1776 nil)))
1781 user-mail-address)))
1791 "-u"
1794 full-name
1796 mailing-address)
1801 f
1803 args)))
1806 ;; Collect back-end-dependent stuff here
1809 ;; Register a file into the version-control system
1810 ;; Automatically retrieves a read-only version of the file with
1811 ;; keywords expanded if vc-keep-workfiles is non-nil, otherwise
1812 ;; it deletes the workfile.
1827 "-fb"
1839 ;; if available, use the secure registering option
1843 file))
1846 "add"
1849 )))
1851 )
1854 ;; Retrieve a copy of a saved version into a workfile
1857 switches)
1860 ;; Change buffers to get local value of vc-checkout-switches.
1864 vc-checkout-switches))
1865 ;; Save this buffer's default-directory
1866 ;; and use save-excursion to make sure it is restored
1867 ;; in the same buffer it was saved in.
1870 ;; Adjust the default-directory so that the check-out creates
1871 ;; the file in the right place.
1877 ;; Some SCCS implementations allow checking out directly to a
1878 ;; file using the -G option, but then some don't so use the
1879 ;; least common denominator approach and use the -p option
1880 ;; ala RCS.
1888 ;; Some shells make the "" dummy argument into $0
1889 ;; while others use the shell's name as $0 and
1890 ;; use the "" as $1. The if-statement
1891 ;; converts the latter case to the former.
1898 filename
1900 "-p"
1903 switches)
1910 switches)
1913 ;; RCS doesn't let us check out into arbitrary file names directly.
1914 ;; Use `co -p' and make stdout point to the correct file.
1922 ;; See the SCCS case, above, regarding the
1923 ;; if-statement.
1930 filename
1933 switches)
1937 ;; if we should go to the head of the trunk,
1938 ;; clear the default branch first
1941 ;; now do the checkout
1944 ;; If locking is not strict, force to overwrite
1945 ;; the writable workfile.
1949 ;; if no explicit revision was specified,
1950 ;; check out that of the working file
1953 nil)))
1954 switches)
1955 ;; determine the new workfile version
1963 ;; if necessary, adjust the default branch
1969 new-version))))))
1971 ;; CVS is much like RCS
1979 workfile
1981 "-p"
1982 switches)
1985 ;; default for verbose checkout: clear the sticky tag
1986 ;; so that the actual update will get the head of the trunk
1989 ;; If a revision was specified, check that out.
1993 "update"
1996 switches)
1997 ;; If no revision was specified, simply make the file writable.
2019 nil ;; RCS
2021 )
2024 ;; Register changes to FILE as level REV with explanatory COMMENT.
2025 ;; Automatically retrieves a read-only version of the file with
2026 ;; keywords expanded if vc-keep-workfiles is non-nil, otherwise
2027 ;; it deletes the workfile.
2028 ;; Adaptation for RCS branch support: if this is an explicit checkin,
2029 ;; or if the checkin creates a new branch, set the master file branch
2030 ;; accordingly.
2032 ;; "This log message intentionally left almost blank".
2033 ;; RCS 5.7 gripes about white-space-only comments too.
2037 ;; Change buffers to get local value of vc-checkin-switches.
2042 vc-checkin-switches)))
2043 ;; Clear the master-properties. Do that here, not at the
2044 ;; end, because if the check-in fails we want them to get
2045 ;; re-computed before the next try.
2048 ;; SCCS
2053 switches)
2058 )
2059 ;; RCS
2062 ;; if available, use the secure check-in option
2066 switches)
2070 ;; determine the new workfile version
2081 ;; if we got to a different branch, adjust the default
2082 ;; branch accordingly
2090 ;; If this is an old RCS release, we might have
2091 ;; to remove a remaining lock.
2093 ;; exit status of 1 is also accepted.
2094 ;; It means that the lock was removed before.
2097 ;; CVS
2099 ;; explicit check-in to the trunk requires a
2100 ;; double check-in (first unexplicit) (CVS-1.3)
2106 switches))
2110 switches))
2112 ;; The CVS output will be on top of this message.
2115 ;; determine and store the new workfile version
2124 ;; if this was an explicit check-in, remove the sticky tag
2133 ;; Revert file to latest checked-in version.
2134 ;; (for RCS, to workfile version)
2138 file
2139 ;; SCCS
2143 ;; RCS
2146 ;; CVS
2153 )
2156 ;; Steal the lock on the current workfile. Needs RCS 5.6.2 or later for -M.
2162 )
2166 )
2169 )
2172 ;; Undo the latest checkin.
2177 nil ;; this is never reached under CVS
2178 )
2180 )
2183 ;; Get change log associated with FILE.
2185 file
2191 ;; Assign to a FILE's latest version a given NAME.
2196 )
2197 )
2200 ;; Get a difference report between two versions of FILE.
2201 ;; Get only a brief comparison report if CMP, a difference report otherwise.
2209 ;; If we know that --brief is not supported, don't try it.
2211 ;; SCCS and RCS shares a lot of code.
2217 "-q"
2222 diff-switches
2225 command file mode options)))
2226 ;; If --brief didn't work, do a double-take and remember it
2227 ;; for the future.
2233 ;; If --brief DID work, remember that, too.
2236 status)))
2237 ;; CVS is different.
2240 ;; This file is added but not yet committed; there is no master file.
2244 ;; we regard this as "changed".
2245 ;; diff it against /dev/null.
2249 diff-switches
2251 ;; cmp is not yet implemented -- we always do a full diff.
2257 diff-switches
2263 ;; Merge in any new changes made to FILE.
2267 file
2275 ;; CVS doesn't return an error code if conflicts are detected.
2276 ;; Since we want to warn the user about it (and possibly start
2277 ;; emerge later), scan the output and see if this occurred.
2283 )))
2287 "Check if the current file has any headers in it."
2293 (re-search-forward "\\$[A-Za-z\300-\326\330-\366\370-\377]+\\(: [\t -#%-\176\240-\377]*\\)?\\$" nil t) ;; RCS
2295 )
2296 ))
2298 ;; Back-end-dependent stuff ends here.
2300 ;; Set up key bindings for use while editing log messages
2303 "Minor mode for driving version-control tools.
2304 These bindings are added to the global keymap when you enter this mode:
2317 While you are entering a change log message for a version, the following
2318 additional bindings will be in effect.
2322 Whenever you do a checkin, your log comment is added to a ring of
2323 saved comments. These can be recalled as follows:
2330 Entry to the change-log submode calls the value of text-mode-hook, then
2331 the value of vc-log-mode-hook.
2333 Global user options:
2334 vc-initial-comment If non-nil, require user to enter a change
2335 comment upon first checkin of the file.
2337 vc-keep-workfiles Non-nil value prevents workfiles from being
2338 deleted when changes are checked in
2340 vc-suppress-confirm Suppresses some confirmation prompts,
2341 notably for reversions.
2343 vc-header-alist Which keywords to insert when adding headers
2346 RCS and CVS.
2348 vc-static-header-alist By default, version headers inserted in C files
2349 get stuffed in a static string area so that
2350 ident(RCS/CVS) or what(SCCS) can see them in
2351 the compiled object code. You can override
2352 this by setting this variable to nil, or change
2353 the header template by changing it.
2355 vc-command-messages if non-nil, display run messages from the
2356 actual version-control utilities (this is
2357 intended primarily for people hacking vc
2358 itself).
2359 "
2372 )
2374 ;; Initialization code, to be done just once at load-time
2376 nil
2383 )
2385 ;;; These things should probably be generally available
2388 "Walk recursively through DIRNAME.
2389 Invoke FUNC f ARGS on each non-directory file f underneath it."
2412 ;;; DEVELOPER'S NOTES ON CONCURRENCY PROBLEMS IN THIS CODE
2413 ;;;
2414 ;;; These may be useful to anyone who has to debug or extend the package.
2415 ;;; (Note that this information corresponds to versions 5.x. Some of it
2416 ;;; might have been invalidated by the additions to support branching
2417 ;;; and RCS keyword lookup. AS, 1995/03/24)
2418 ;;;
2419 ;;; A fundamental problem in VC is that there are time windows between
2420 ;;; vc-next-action's computations of the file's version-control state and
2421 ;;; the actions that change it. This is a window open to lossage in a
2422 ;;; multi-user environment; someone else could nip in and change the state
2423 ;;; of the master during it.
2424 ;;;
2425 ;;; The performance problem is that rlog/prs calls are very expensive; we want
2426 ;;; to avoid them as much as possible.
2427 ;;;
2428 ;;; ANALYSIS:
2429 ;;;
2430 ;;; The performance problem, it turns out, simplifies in practice to the
2431 ;;; problem of making vc-locking-user fast. The two other functions that call
2432 ;;; prs/rlog will not be so commonly used that the slowdown is a problem; one
2433 ;;; makes snapshots, the other deletes the calling user's last change in the
2434 ;;; master.
2435 ;;;
2436 ;;; The race condition implies that we have to either (a) lock the master
2437 ;;; during the entire execution of vc-next-action, or (b) detect and
2438 ;;; recover from errors resulting from dispatch on an out-of-date state.
2439 ;;;
2440 ;;; Alternative (a) appears to be infeasible. The problem is that we can't
2441 ;;; guarantee that the lock will ever be removed. Suppose a user starts a
2442 ;;; checkin, the change message buffer pops up, and the user, having wandered
2443 ;;; off to do something else, simply forgets about it?
2444 ;;;
2445 ;;; Alternative (b), on the other hand, works well with a cheap way to speed up
2446 ;;; vc-locking-user. Usually, if a file is registered, we can read its locked/
2447 ;;; unlocked state and its current owner from its permissions.
2448 ;;;
2449 ;;; This shortcut will fail if someone has manually changed the workfile's
2450 ;;; permissions; also if developers are munging the workfile in several
2451 ;;; directories, with symlinks to a master (in this latter case, the
2452 ;;; permissions shortcut will fail to detect a lock asserted from another
2453 ;;; directory).
2454 ;;;
2455 ;;; Note that these cases correspond exactly to the errors which could happen
2456 ;;; because of a competing checkin/checkout race in between two instances of
2457 ;;; vc-next-action.
2458 ;;;
2459 ;;; For VC's purposes, a workfile/master pair may have the following states:
2460 ;;;
2461 ;;; A. Unregistered. There is a workfile, there is no master.
2462 ;;;
2463 ;;; B. Registered and not locked by anyone.
2464 ;;;
2465 ;;; C. Locked by calling user and unchanged.
2466 ;;;
2467 ;;; D. Locked by the calling user and changed.
2468 ;;;
2469 ;;; E. Locked by someone other than the calling user.
2470 ;;;
2471 ;;; This makes for 25 states and 20 error conditions. Here's the matrix:
2472 ;;;
2473 ;;; VC's idea of state
2474 ;;; |
2475 ;;; V Actual state RCS action SCCS action Effect
2476 ;;; A B C D E
2477 ;;; A . 1 2 3 4 ci -u -t- admin -fb -i<file> initial admin
2478 ;;; B 5 . 6 7 8 co -l get -e checkout
2479 ;;; C 9 10 . 11 12 co -u unget; get revert
2480 ;;; D 13 14 15 . 16 ci -u -m<comment> delta -y<comment>; get checkin
2481 ;;; E 17 18 19 20 . rcs -u -M -l unget -n ; get -g steal lock
2482 ;;;
2483 ;;; All commands take the master file name as a last argument (not shown).
2484 ;;;
2485 ;;; In the discussion below, a "self-race" is a pathological situation in
2486 ;;; which VC operations are being attempted simultaneously by two or more
2487 ;;; Emacsen running under the same username.
2488 ;;;
2489 ;;; The vc-next-action code has the following windows:
2490 ;;;
2491 ;;; Window P:
2492 ;;; Between the check for existence of a master file and the call to
2493 ;;; admin/checkin in vc-buffer-admin (apparent state A). This window may
2494 ;;; never close if the initial-comment feature is on.
2495 ;;;
2496 ;;; Window Q:
2497 ;;; Between the call to vc-workfile-unchanged-p in and the immediately
2498 ;;; following revert (apparent state C).
2499 ;;;
2500 ;;; Window R:
2501 ;;; Between the call to vc-workfile-unchanged-p in and the following
2502 ;;; checkin (apparent state D). This window may never close.
2503 ;;;
2504 ;;; Window S:
2505 ;;; Between the unlock and the immediately following checkout during a
2506 ;;; revert operation (apparent state C). Included in window Q.
2507 ;;;
2508 ;;; Window T:
2509 ;;; Between vc-locking-user and the following checkout (apparent state B).
2510 ;;;
2511 ;;; Window U:
2512 ;;; Between vc-locking-user and the following revert (apparent state C).
2513 ;;; Includes windows Q and S.
2514 ;;;
2515 ;;; Window V:
2516 ;;; Between vc-locking-user and the following checkin (apparent state
2517 ;;; D). This window may never be closed if the user fails to complete the
2518 ;;; checkin message. Includes window R.
2519 ;;;
2520 ;;; Window W:
2521 ;;; Between vc-locking-user and the following steal-lock (apparent
2522 ;;; state E). This window may never close if the user fails to complete
2523 ;;; the steal-lock message. Includes window X.
2524 ;;;
2525 ;;; Window X:
2526 ;;; Between the unlock and the immediately following re-lock during a
2527 ;;; steal-lock operation (apparent state E). This window may never cloce
2528 ;;; if the user fails to complete the steal-lock message.
2529 ;;;
2530 ;;; Errors:
2531 ;;;
2532 ;;; Apparent state A ---
2533 ;;;
2534 ;;; 1. File looked unregistered but is actually registered and not locked.
2535 ;;;
2536 ;;; Potential cause: someone else's admin during window P, with
2537 ;;; caller's admin happening before their checkout.
2538 ;;;
2539 ;;; RCS: Prior to version 5.6.4, ci fails with message
2540 ;;; "no lock set by <user>". From 5.6.4 onwards, VC uses the new
2541 ;;; ci -i option and the message is "<file>,v: already exists".
2542 ;;; SCCS: admin will fail with error (ad19).
2543 ;;;
2544 ;;; We can let these errors be passed up to the user.
2545 ;;;
2546 ;;; 2. File looked unregistered but is actually locked by caller, unchanged.
2547 ;;;
2548 ;;; Potential cause: self-race during window P.
2549 ;;;
2550 ;;; RCS: Prior to version 5.6.4, reverts the file to the last saved
2551 ;;; version and unlocks it. From 5.6.4 onwards, VC uses the new
2552 ;;; ci -i option, failing with message "<file>,v: already exists".
2553 ;;; SCCS: will fail with error (ad19).
2554 ;;;
2555 ;;; Either of these consequences is acceptable.
2556 ;;;
2557 ;;; 3. File looked unregistered but is actually locked by caller, changed.
2558 ;;;
2559 ;;; Potential cause: self-race during window P.
2560 ;;;
2561 ;;; RCS: Prior to version 5.6.4, VC registers the caller's workfile as
2562 ;;; a delta with a null change comment (the -t- switch will be
2563 ;;; ignored). From 5.6.4 onwards, VC uses the new ci -i option,
2564 ;;; failing with message "<file>,v: already exists".
2565 ;;; SCCS: will fail with error (ad19).
2566 ;;;
2567 ;;; 4. File looked unregistered but is locked by someone else.
2568 ;;;
2569 ;;; Potential cause: someone else's admin during window P, with
2570 ;;; caller's admin happening *after* their checkout.
2571 ;;;
2572 ;;; RCS: Prior to version 5.6.4, ci fails with a
2573 ;;; "no lock set by <user>" message. From 5.6.4 onwards,
2574 ;;; VC uses the new ci -i option, failing with message
2575 ;;; "<file>,v: already exists".
2576 ;;; SCCS: will fail with error (ad19).
2577 ;;;
2578 ;;; We can let these errors be passed up to the user.
2579 ;;;
2580 ;;; Apparent state B ---
2581 ;;;
2582 ;;; 5. File looked registered and not locked, but is actually unregistered.
2583 ;;;
2584 ;;; Potential cause: master file got nuked during window P.
2585 ;;;
2586 ;;; RCS: will fail with "RCS/<file>: No such file or directory"
2587 ;;; SCCS: will fail with error ut4.
2588 ;;;
2589 ;;; We can let these errors be passed up to the user.
2590 ;;;
2591 ;;; 6. File looked registered and not locked, but is actually locked by the
2592 ;;; calling user and unchanged.
2593 ;;;
2594 ;;; Potential cause: self-race during window T.
2595 ;;;
2596 ;;; RCS: in the same directory as the previous workfile, co -l will fail
2597 ;;; with "co error: writable foo exists; checkout aborted". In any other
2598 ;;; directory, checkout will succeed.
2599 ;;; SCCS: will fail with ge17.
2600 ;;;
2601 ;;; Either of these consequences is acceptable.
2602 ;;;
2603 ;;; 7. File looked registered and not locked, but is actually locked by the
2604 ;;; calling user and changed.
2605 ;;;
2606 ;;; As case 6.
2607 ;;;
2608 ;;; 8. File looked registered and not locked, but is actually locked by another
2609 ;;; user.
2610 ;;;
2611 ;;; Potential cause: someone else checks it out during window T.
2612 ;;;
2613 ;;; RCS: co error: revision 1.3 already locked by <user>
2614 ;;; SCCS: fails with ge4 (in directory) or ut7 (outside it).
2615 ;;;
2616 ;;; We can let these errors be passed up to the user.
2617 ;;;
2618 ;;; Apparent state C ---
2619 ;;;
2620 ;;; 9. File looks locked by calling user and unchanged, but is unregistered.
2621 ;;;
2622 ;;; As case 5.
2623 ;;;
2624 ;;; 10. File looks locked by calling user and unchanged, but is actually not
2625 ;;; locked.
2626 ;;;
2627 ;;; Potential cause: a self-race in window U, or by the revert's
2628 ;;; landing during window X of some other user's steal-lock or window S
2629 ;;; of another user's revert.
2630 ;;;
2631 ;;; RCS: succeeds, refreshing the file from the identical version in
2632 ;;; the master.
2633 ;;; SCCS: fails with error ut4 (p file nonexistent).
2634 ;;;
2635 ;;; Either of these consequences is acceptable.
2636 ;;;
2637 ;;; 11. File is locked by calling user. It looks unchanged, but is actually
2638 ;;; changed.
2639 ;;;
2640 ;;; Potential cause: the file would have to be touched by a self-race
2641 ;;; during window Q.
2642 ;;;
2643 ;;; The revert will succeed, removing whatever changes came with
2644 ;;; the touch. It is theoretically possible that work could be lost.
2645 ;;;
2646 ;;; 12. File looks like it's locked by the calling user and unchanged, but
2647 ;;; it's actually locked by someone else.
2648 ;;;
2649 ;;; Potential cause: a steal-lock in window V.
2650 ;;;
2651 ;;; RCS: co error: revision <rev> locked by <user>; use co -r or rcs -u
2652 ;;; SCCS: fails with error un2
2653 ;;;
2654 ;;; We can pass these errors up to the user.
2655 ;;;
2656 ;;; Apparent state D ---
2657 ;;;
2658 ;;; 13. File looks like it's locked by the calling user and changed, but it's
2659 ;;; actually unregistered.
2660 ;;;
2661 ;;; Potential cause: master file got nuked during window P.
2662 ;;;
2663 ;;; RCS: Prior to version 5.6.4, checks in the user's version as an
2664 ;;; initial delta. From 5.6.4 onwards, VC uses the new ci -j
2665 ;;; option, failing with message "no such file or directory".
2666 ;;; SCCS: will fail with error ut4.
2667 ;;;
2668 ;;; This case is kind of nasty. Under RCS prior to version 5.6.4,
2669 ;;; VC may fail to detect the loss of previous version information.
2670 ;;;
2671 ;;; 14. File looks like it's locked by the calling user and changed, but it's
2672 ;;; actually unlocked.
2673 ;;;
2674 ;;; Potential cause: self-race in window V, or the checkin happening
2675 ;;; during the window X of someone else's steal-lock or window S of
2676 ;;; someone else's revert.
2677 ;;;
2678 ;;; RCS: ci will fail with "no lock set by <user>".
2679 ;;; SCCS: delta will fail with error ut4.
2680 ;;;
2681 ;;; 15. File looks like it's locked by the calling user and changed, but it's
2682 ;;; actually locked by the calling user and unchanged.
2683 ;;;
2684 ;;; Potential cause: another self-race --- a whole checkin/checkout
2685 ;;; sequence by the calling user would have to land in window R.
2686 ;;;
2687 ;;; SCCS: checks in a redundant delta and leaves the file unlocked as usual.
2688 ;;; RCS: reverts to the file state as of the second user's checkin, leaving
2689 ;;; the file unlocked.
2690 ;;;
2691 ;;; It is theoretically possible that work could be lost under RCS.
2692 ;;;
2693 ;;; 16. File looks like it's locked by the calling user and changed, but it's
2694 ;;; actually locked by a different user.
2695 ;;;
2696 ;;; RCS: ci error: no lock set by <user>
2697 ;;; SCCS: unget will fail with error un2
2698 ;;;
2699 ;;; We can pass these errors up to the user.
2700 ;;;
2701 ;;; Apparent state E ---
2702 ;;;
2703 ;;; 17. File looks like it's locked by some other user, but it's actually
2704 ;;; unregistered.
2705 ;;;
2706 ;;; As case 13.
2707 ;;;
2708 ;;; 18. File looks like it's locked by some other user, but it's actually
2709 ;;; unlocked.
2710 ;;;
2711 ;;; Potential cause: someone released a lock during window W.
2712 ;;;
2713 ;;; RCS: The calling user will get the lock on the file.
2714 ;;; SCCS: unget -n will fail with cm4.
2715 ;;;
2716 ;;; Either of these consequences will be OK.
2717 ;;;
2718 ;;; 19. File looks like it's locked by some other user, but it's actually
2719 ;;; locked by the calling user and unchanged.
2720 ;;;
2721 ;;; Potential cause: the other user relinquishing a lock followed by
2722 ;;; a self-race, both in window W.
2723 ;;;
2724 ;;; Under both RCS and SCCS, both unlock and lock will succeed, making
2725 ;;; the sequence a no-op.
2726 ;;;
2727 ;;; 20. File looks like it's locked by some other user, but it's actually
2728 ;;; locked by the calling user and changed.
2729 ;;;
2730 ;;; As case 19.
2731 ;;;
2732 ;;; PROBLEM CASES:
2733 ;;;
2734 ;;; In order of decreasing severity:
2735 ;;;
2736 ;;; Cases 11 and 15 are the only ones that potentially lose work.
2737 ;;; They would require a self-race for this to happen.
2738 ;;;
2739 ;;; Case 13 in RCS loses information about previous deltas, retaining
2740 ;;; only the information in the current workfile. This can only happen
2741 ;;; if the master file gets nuked in window P.
2742 ;;;
2743 ;;; Case 3 in RCS and case 15 under SCCS insert a redundant delta with
2744 ;;; no change comment in the master. This would require a self-race in
2745 ;;; window P or R respectively.
2746 ;;;
2747 ;;; Cases 2, 10, 19 and 20 do extra work, but make no changes.
2748 ;;;
2749 ;;; Unfortunately, it appears to me that no recovery is possible in these
2750 ;;; cases. They don't yield error messages, so there's no way to tell that
2751 ;;; a race condition has occurred.
2752 ;;;
2753 ;;; All other cases don't change either the workfile or the master, and
2754 ;;; trigger command errors which the user will see.
2755 ;;;
2756 ;;; Thus, there is no explicit recovery code.
2758 ;;; vc.el ends here