| blob | 37694325cda4d2dd023d0993229ebd92e89277a2 |
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 ;; 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
106 "*A string or list of strings specifying extra switches passed
109 "*A string or list of strings specifying extra switches passed
112 "*A string or list of strings specifying extra switches passed
115 "*A list of directory names ignored by functions that recursively
121 ;;; This is duplicated in diff.el.
125 ;;;###autoload
127 "*Normal hook (list of functions) run before a file gets checked in.
130 ;;;###autoload
132 "*Normal hook (List of functions) run after a checkin is done.
135 ;; Header-insertion hair
139 "*Header keywords to be inserted by `vc-insert-headers'.
140 Must be a list of two-element lists, the first element of each must
141 be `RCS', `CVS', or `SCCS'. The second element is the string to
146 "*Associate static header string templates with file types. A \%s in the
147 template is replaced with the first string associated with the file's
152 "*Special comment delimiters to be used in generating vc headers only.
153 Add an entry in this list if you need to override the normal comment-start
154 and comment-end variables. This will only be necessary if the mode language
157 ;; Default is to be extra careful for super-user.
159 "*Non-nil means be extra-careful in checkout.
160 Verify that the file really is not locked
164 "*The release number of your RCS installation, as a string.
168 "*The release number of your SCCS installation, as a string.
172 "*The release number of your CVS installation, as a string.
175 ;; Variables the user doesn't need to know about.
180 ;; In a log entry buffer, this is a local variable
181 ;; that points to the buffer for which it was made
182 ;; (either a file, or a VC dired buffer).
198 ;; Back-portability to Emacs 18
208 ; Conditionally rebind some things for Emacs 18 compatibility
214 ))
219 ;;; Find and compare backend releases
222 ;; Returns which backend release is installed on this system.
244 vc-sccs-release)))
247 ;; Compare release numbers, represented as strings.
248 ;; Release components are assumed cardinal numbers, not decimal
249 ;; fractions (5.10 is a higher release than 5.9). Omitted fields
250 ;; are considered lower (5.6.7 is earlier than 5.6.7.1).
251 ;; Comparison runs till the end of the string is found, or a
252 ;; non-numeric component shows up (5.6.7 is earlier than "5.6.7 beta",
253 ;; which is probably not what you want in some cases).
254 ;; This code is suitable for existing RCS release numbers.
255 ;; CVS releases are handled reasonably, too (1.3 < 1.4* < 1.5).
276 ;; Return t if we have RELEASE of BACKEND or better
283 ;;; functions that operate on RCS revision numbers
286 ;; return t if REV is a revision on the trunk
290 ;; return the branch part of a revision number REV
293 ;; File property caching
296 "Clear all cached file properties and the comment ring."
299 ;; Note: there is potential for minor lossage here if there is an open
300 ;; log buffer with a nonzero local value of vc-comment-ring-index.
304 ;; clear all properties of FILE that were retrieved
305 ;; from the master file
320 ;; Return the RCS head version of FILE
325 ;; Random helper functions
328 ;; return t iff the current workfile version of FILE is
329 ;; the latest on its branch.
331 ;; SCCS
333 ;; RCS
337 ;; Re-fetch the head version number. This is to make
338 ;; sure that no-one has checked in a new version behind
339 ;; our back.
342 workfile-version))
343 ;; If we are not on the trunk, we need to examine the
344 ;; whole current branch. (vc-master-workfile-version
345 ;; is not what we need.)
355 ;; CVS
356 t))
366 "Look for a command anywhere on the subprocess-command search path."
379 exec-path)
380 nil)))
383 "Execute a version-control command, notifying user and checking for errors.
384 Output from COMMAND goes to BUFFER, or *vc* if BUFFER is nil.
385 The command is successful if its exit status does not exceed OKSTATUS.
386 (If OKSTATUS is nil, that means to ignore errors.)
387 The last argument of the command is the master name of FILE if LAST is
388 `MASTER', or the workfile of FILE if LAST is `WORKFILE'; this is appended
389 to an optional list of FLAGS."
398 status)
409 flags)
420 ;; Add vc-path to PATH for the execution of this command.
423 path-separator
425 process-environment))
439 status))
440 )
443 )
445 status)
446 )
448 ;;; Save a bit of the text around POSN in the current buffer, to help
449 ;;; us find the corresponding position again later. This works even
450 ;;; if all markers are destroyed or corrupted.
451 ;;; A lot of this was shamelessly lifted from Sebastian Kremer's rcs.el mode.
458 ;;; Return the position of CONTEXT in the current buffer, or nil if we
459 ;;; couldn't find it.
469 ;; Can't use search-backward since the match may continue
470 ;; after point.
472 ;; goto-char doesn't signal an error at
473 ;; beginning of buffer like backward-char would
475 ;; to beginning of OSTRING
479 ;; Return a list '(point-context mark-context reparse); from which
480 ;; vc-restore-buffer-context can later restore the context.
482 ;; Use mark-marker to avoid confusion in transient-mark-mode.
485 ;; Make the right thing happen in transient-mark-mode.
487 ;; We may want to reparse the compilation buffer after revert
490 ;; Construct a list; each elt is nil or a buffer
491 ;; iff that buffer is a compilation output buffer
492 ;; that contains markers into the current buffer.
498 compilation-old-error-list
499 compilation-error-list))
514 ;; Restore point/mark, and reparse any affected compilation buffers.
515 ;; CONTEXT is that which vc-buffer-context returns.
519 ;; Reparse affected compilation buffers.
525 ;; Record the position in the compilation buffer of
526 ;; the last error next-error went to.
529 ;; Reparse the error messages as far as they were parsed before.
531 ;; Move the pointer up to find the error we were at before
532 ;; reparsing. Now next-error should properly go to the next one.
538 ;; Restore point and mark
546 ;; Revert buffer, try to keep point and mark where user expects them in spite
547 ;; of changes because of expanded version-control key words.
548 ;; This is quite important since otherwise typeahead won't work as expected.
552 ;; t means don't call normal-mode; that's to preserve various minor modes.
558 ;; Make sure the current buffer and its working file are in sync
559 ;; NOT-URGENT means it is ok to continue if the user says not to save.
565 nil
570 ;; Has the given workfile changed since last checkout?
577 ;; 0 stands for an unknown time; it can't match any mod time.
579 unchanged)))))
582 ;;; If comment is specified, it will be used as an admin or checkin comment.
585 owner version buffer)
588 ;; if there is no master file corresponding, create one
596 ;; CVS: changes to the master file need to be
597 ;; merged back into the working file
616 "Buffer %s modified; merge file on disc anyhow? "
620 ;; Overlaps detected - what now? Should use some
621 ;; fancy RCS conflict resolving package, or maybe
622 ;; emerge, but for now, simply warn the user with a
623 ;; message.
629 ;; If there is no lock on the file, assert one and get it.
630 ;; (With implicit checkout, make sure not to lose unsaved changes.)
641 file))
652 )
668 )))
670 ;; a checked-out version exists, but the user may not own the lock
679 file
682 owner))
684 ;; OK, user owns the lock on the file
690 ;; give luser a chance to save before checking in.
693 ;; Revert if file is unchanged and buffer is too.
694 ;; If buffer is modified, that means the user just said no
695 ;; to saving it; in that case, don't revert,
696 ;; because the user might intend to save
697 ;; after finishing the log entry.
700 ;; DO NOT revert the file without asking the user!
706 ;; user may want to set nonstandard parameters
710 ;; OK, let's do the checkin
712 )))))
715 ;; Do a vc-next-action-on-file on all the marked files, possibly
716 ;; passing on the log comment we've just entered.
724 ;; Adjust the default directory so that checkouts
725 ;; go to the right place.
733 nil t)))
735 ;; Here's the major entry point.
737 ;;;###autoload
739 "Do the next logical checkin or checkout operation on the current file.
740 If you call this from within a VC dired buffer with no files marked,
741 it will operate on the file in the current line.
742 If you call this from within a VC dired buffer, and one or more
743 files are marked, it will accept a log message and then operate on
744 each one. The log message will be used as a comment for any register
745 or checkin operations, but ignored when doing checkouts. Attempted
746 lock steals will raise an error.
747 A prefix argument lets you specify the version number to use.
749 For RCS and SCCS files:
750 If the file is not already registered, this registers it for version
751 control and then retrieves a writable, locked copy for editing.
752 If the file is registered and not locked by anyone, this checks out
753 a writable and locked file ready for editing.
754 If the file is checked out and locked by the calling user, this
755 first checks to see if the file has changed since checkout. If not,
756 it performs a revert.
757 If the file has been changed, this pops up a buffer for entry
758 of a log message; when the message has been entered, it checks in the
759 resulting changes along with the log message as change commentary. If
760 the variable `vc-keep-workfiles' is non-nil (which is its default), a
761 read-only copy of the changed file is left in place afterwards.
762 If the file is registered and locked by someone else, you are given
763 the option to steal the lock.
765 For CVS files:
766 If the file is not already registered, this registers it for version
768 If the file is added but not committed, it is committed.
769 If your working file is changed, but the repository file is
770 unchanged, this pops up a buffer for entry of a log message; when the
771 message has been entered, it checks in the resulting changes along
772 with the logmessage as change commentary. A writable file is retained.
773 If the repository file is changed, you are asked if you want to
774 merge in the changes into your working copy."
791 "Enter a change comment for the marked files."
800 ;;; These functions help the vc-next-action entry point
803 "Retrieve a writable copy of the latest version of the current buffer's file."
805 )
807 ;;;###autoload
809 "Register the current file into your version-control system."
819 ;; Watch out for new buffers of size 0: the corresponding file
820 ;; does not exist yet, even though buffer-modified-p is nil.
827 ;; inhibit backup for this buffer
831 buffer-file-name
835 )
838 ;; If the given file is in the current buffer,
839 ;; either revert on it so we see expanded keywords,
840 ;; or unvisit it (depending on vc-keep-workfiles)
841 ;; NOQUERY if non-nil inhibits confirmation for reverting.
842 ;; NOQUERY should be t *only* if it is known the only difference
843 ;; between the buffer and the file is due to RCS rather than user editing!
847 ;; temporarily remove vc-find-file-hook, so that
848 ;; we don't lose the properties
856 ;; if FILE is currently visited, resynch its buffer
864 ;; Accept a comment for an operation on FILE revision REV. If COMMENT
865 ;; is nil, pop up a VC-log buffer, emit MSG, and set the
866 ;; action on close to ACTION; otherwise, do action immediately.
867 ;; Remember the file's buffer in vc-parent-buffer (current one if no file).
868 ;; AFTER-HOOK specifies the local value for vc-log-operation-hook.
899 "Check a file into your version-control system.
900 FILE is the unmodified name of the file. REV should be the base version
901 level to check it in under. COMMENT, if specified, is the checkin comment."
905 nil))
908 "Retrieve a copy of the latest version of the given file."
909 ;; If ftp is on this system and the name matches the ange-ftp format
910 ;; for a remote file, the user is trying something that won't work.
917 "Steal the lock on the current workfile."
925 file-description owner)))
941 ;; This is called when the notification has been sent.
950 "Check in the file specified by FILE.
951 The optional argument REV may be a string specifying the new version level
952 \(if nil increment the current level). The file is either retained with write
953 permissions zeroed, or deleted (according to the value of `vc-keep-workfiles').
954 If the back-end is CVS, a writable workfile is always kept.
955 COMMENT is a comment string; if omitted, a buffer is
956 popped up to accept a comment."
961 ;;; Here is a checkin hook that may prove useful to sites using the
962 ;;; ChangeLog facility supported by Emacs.
964 "Enter last VC comment into change log file for current buffer's file.
965 Optional arg (interactive prefix) non-nil means prompt for user name and site.
966 Second arg is file name of change log. \
967 If nil, uses `change-log-default-name'."
971 ;; Make sure the defvar for add-log-current-defun-function has been executed
972 ;; before binding it.
976 ;; Don't let add-change-log-entry insert a defun name.
978 end)
979 ;; Call add-log to do half the work.
981 ;; Insert the VC comment, leaving point before it.
984 ;; It starts with an open-paren, as in "(foo): Frobbed."
985 ;; So remove the ": " add-log inserted.
987 ;; Canonicalize the white space between the file name and comment.
989 ;; Indent rest of the text the same way add-log indented the first line.
996 ;; Fill the inserted text, preserving open-parens at bol.
1001 ;; Canonicalize the white space at the end of the entry so it is
1002 ;; separated from the next entry by a single blank line.
1010 "Complete the operation implied by the current log entry."
1012 ;; Check and record the comment, if any.
1018 ;; Comment too long?
1020 ;; Record the comment in the comment ring
1022 ))
1023 ;; Sync parent buffer in case the user modified it while editing the comment.
1024 ;; But not if it is a vc-dired buffer.
1030 ;; save the parameters held in buffer-local variables
1036 ;; Return to "parent" buffer of this checkin and remove checkin window
1041 ;; OK, do it to it
1044 log-file
1045 log-version
1046 log-entry))
1047 ;; Now make sure we see the expanded headers
1052 ;; Code for access to the comment ring
1055 "Cycle backwards through comment history."
1063 ;; Initialize the index on the first use of this command
1064 ;; so that the first M-p gets index 0, and the first M-n gets
1065 ;; index -1.
1076 "Cycle forwards through comment history."
1081 "Searches backwards through comment history for substring match."
1098 "Searches forwards through comment history for substring match."
1114 ;; Additional entry points for examining version histories
1116 ;;;###autoload
1118 "Display diffs between file versions.
1119 Normally this compares the current file and buffer with the most recent
1120 checked in version of that file. This uses no arguments.
1121 With a prefix argument, it reads the file name to use
1122 and two version designators specifying which versions to compare."
1134 unchanged)
1142 ;; Ideally, we'd like at this point to parse the diff so that
1143 ;; the buffer effectively goes into compilation mode and we
1144 ;; can visit the old and new change locations via next-error.
1145 ;; Unfortunately, this is just too painful to do. The basic
1146 ;; problem is that the `old' file doesn't exist to be
1147 ;; visited. This plays hell with numerous assumptions in
1148 ;; the diff.el and compile.el machinery.
1161 "For FILE, report diffs between two stored versions REL1 and REL2 of it.
1162 If FILE is a directory, generate diffs between versions for all registered
1163 files in or below it."
1176 " and "
1182 default-directory
1190 )))
1195 )
1200 ;;;###autoload
1202 "Visit version REV of the current buffer in another window.
1203 If the current buffer is named `F', the version is named `F.~REV~'.
1204 If `F.~REV~' already exists, it is used instead of being re-created."
1213 rev))
1220 ;; Header-insertion code
1222 ;;;###autoload
1224 "Insert headers in a file for use with your version-control system.
1225 Headers desired are inserted at the start of the buffer, and are pulled from
1226 the variable `vc-header-alist'."
1245 hdstrings)
1250 vc-static-header-alist))
1251 )
1252 )))))
1255 ;; Clear all version headers in the current buffer, i.e. reset them
1256 ;; to the nonexpanded form. Only implemented for RCS, yet.
1257 ;; Don't lose point and mark during this.
1264 ;; The VC directory major mode. Coopt Dired for this.
1265 ;; All VC commands get mapped into logical equivalents.
1268 "The major mode used in VC directory buffers. It is derived from Dired.
1269 All Dired commands operate normally. Users currently locking listed files
1270 are listed in place of the file's owner and group.
1271 Keystrokes bound to VC commands will execute as though they had been called
1272 on a buffer attached to the file named in the current Dired buffer line."
1280 ;; Return the string that indicates the version control status
1281 ;; on a VC dired line.
1294 ;; Hack a directory-listing line, plugging in locking-user info in
1295 ;; place of the user and group info. Should have the beneficial
1296 ;; side-effect of shortening the listing line. Each call starts with
1297 ;; point immediately following the dired mark area on the line to be
1298 ;; hacked.
1299 ;;
1300 ;; Simplest possible one:
1301 ;; (insert (concat x "\t")))
1302 ;;
1303 ;; This code, like dired, assumes UNIX -l format.
1312 limit t)
1315 limit t))
1321 limit t)
1329 ;; Update the vc-dired listing line of file -- it is assumed
1330 ;; that point is already on this line. Don't use dired-do-redisplay
1331 ;; for this, because it cannot handle the way vc-dired deals with
1332 ;; subdirectories.
1351 ;;; Note in Emacs 18 the following defun gets overridden
1352 ;;; with the symbol 'vc-directory-18. See below.
1353 ;;;###autoload
1355 "Show version-control status of the current directory and subdirectories.
1356 Normally it creates a Dired buffer that lists only the locked files
1357 in all these directories. With a prefix argument, it lists all files."
1361 ;; force a trailing slash
1368 dired-buf
1369 dired-buf-mod-count)
1371 dirname
1381 ;; This uses a semi-documented feature of dired; giving a switch
1382 ;; argument forces the buffer to refresh each time.
1389 ;; Make a few modifications to the header
1399 ;; Plug the version information into the individual lines
1410 )
1416 ))
1418 ;; Emacs 18 version
1420 "Show version-control status of all files under the current directory."
1428 default-directory
1445 )
1450 ;; Named-configuration support for SCCS
1455 vc-name-assoc-file
1463 ))
1469 vc-name-assoc-file
1474 ;; (replace-regexp (concat ":" (regexp-quote file) "$") (concat ":" newname))
1479 ))
1482 ;; Return the numeric version corresponding to a named snapshot of file
1483 ;; If name is nil or a version number string it's just passed through
1487 name)
1493 vc-name-assoc-file
1501 ))
1503 ;; Named-configuration entry points
1506 ;; Scan the tree below the current directory.
1507 ;; If any files are locked, return the name of the first such file.
1508 ;; (This means, neither snapshot creation nor retrieval is allowed.)
1509 ;; If one or more of the files are currently visited, return `visited'.
1510 ;; Otherwise, return nil.
1514 default-directory
1519 status)))
1521 ;;;###autoload
1523 "Make a snapshot called NAME.
1524 The snapshot is made from all registered files at or below the current
1525 directory. For each file, the version level of its latest
1526 version becomes part of the named configuration."
1532 default-directory
1536 )))
1538 ;;;###autoload
1540 "Retrieve the snapshot called NAME.
1541 This function fails if any files are locked at or below the current directory
1542 Otherwise, all registered files are checked out (unlocked) at their version
1543 levels in the snapshot."
1552 default-directory
1558 )))
1560 ;; Miscellaneous other entry points
1562 ;;;###autoload
1564 "List the change log of the current buffer in a window."
1583 ;; move point to the log entry for the current version
1586 ;; also match some context, for safety
1589 ;; set the display window so that
1590 ;; the whole log entry is displayed
1598 ;; if the global information and this log entry fit
1599 ;; into the window, display from the beginning
1604 ;; if the whole entry fits into the window,
1605 ;; display it centered
1609 ;; otherwise (the entry is too large for the window),
1610 ;; display from the start
1614 )
1616 )
1617 )
1619 ;;;###autoload
1621 "Revert the current buffer's file back to the latest checked-in version.
1622 This asks for confirmation if the buffer contents are not identical
1623 to that version.
1624 If the back-end is CVS, this will give you the most recent revision of
1625 the file on the branch you are editing."
1632 ;; This operation should always ask for confirmation.
1650 )
1651 )
1653 ;;;###autoload
1655 "Get rid of most recently checked in version of this file.
1656 A prefix argument means do not revert the buffer afterwards."
1675 nil
1679 ;; Check out the most recent remaining version. If it fails, because
1680 ;; the whole branch got deleted, do a double-take and check out the
1681 ;; version where the branch started.
1686 ;; Check out locked, but only to disc, and keep
1687 ;; modifications in the buffer.
1689 ;; Check out unlocked, and revert buffer.
1692 ;; If the checkout fails, vc-do-command signals an error.
1693 ;; We catch this error, check the reason, correct the
1694 ;; version number, and try a second time.
1699 ;; vc-do-command popped up a window with
1700 ;; the error message. Get rid of it, by
1701 ;; restoring the old window configuration.
1703 ;; No, it was some other error: re-signal it.
1705 ;; If norevert, clear version headers and mark the buffer modified.
1710 ;; inhibit backup for this buffer
1718 )))
1720 ;;;###autoload
1722 "Rename file OLD to NEW, and rename its master file likewise."
1724 ;; There are several ways of renaming files under CVS 1.3, but they all
1725 ;; have serious disadvantages. See the FAQ (available from think.com in
1726 ;; pub/cvs/). I'd rather send the user an error, than do something he might
1727 ;; consider to be wrong. When the famous, long-awaited rename database is
1728 ;; implemented things might change for the better. This is unlikely to occur
1729 ;; until CVS 2.0 is released. --ceder 1994-01-23 21:27:51
1745 ;; This had FILE, I changed it to OLD. -- rms.
1749 oldmaster
1763 vc-master-templates)
1767 ; ?? Renaming a file might change its contents due to keyword expansion.
1768 ; We should really check out a new copy if the old copy was precisely equal
1769 ; to some checked in version. However, testing for this is tricky....
1778 ;; This had FILE, I changed it to OLD. -- rms.
1781 nil ;RCS
1782 nil ;CVS
1783 )
1784 )
1786 ;;;###autoload
1788 "Find change log file and add entries from recent RCS/CVS logs.
1789 Normally, find log entries for all registered files in the default
1790 directory using `rcs2log', which finds CVS logs preferentially.
1791 The mark is left at the end of the text prepended to the change log.
1793 With prefix arg of C-u, only find log entries for the current buffer's file.
1795 With any numeric prefix arg, find log entries for all currently visited
1796 files that are under version control. This puts all the entries in the
1797 log for the default directory, which may not be appropriate.
1799 From a program, any arguments are assumed to be filenames and are
1800 passed to the `rcs2log' script after massaging to be relative to the
1801 default directory."
1808 file)
1814 files))
1816 ;; `rcs2log' will find the relevant RCS or CVS files
1817 ;; relative to the curent directory if none supplied.
1818 nil)))
1825 user-mail-address)))
1835 "-u"
1838 full-name
1840 mailing-address)
1845 f
1847 args)))
1850 ;; Collect back-end-dependent stuff here
1853 ;; Register a file into the version-control system
1854 ;; Automatically retrieves a read-only version of the file with
1855 ;; keywords expanded if vc-keep-workfiles is non-nil, otherwise
1856 ;; it deletes the workfile.
1864 vc-register-switches))
1875 "-fb"
1882 switches)
1888 ;; if available, use the secure registering option
1892 switches))
1895 "add"
1898 switches)
1899 )))
1901 )
1904 ;; Retrieve a copy of a saved version into a workfile
1907 switches)
1910 ;; Change buffers to get local value of vc-checkout-switches.
1914 vc-checkout-switches))
1915 ;; Save this buffer's default-directory
1916 ;; and use save-excursion to make sure it is restored
1917 ;; in the same buffer it was saved in.
1920 ;; Adjust the default-directory so that the check-out creates
1921 ;; the file in the right place.
1927 ;; Some SCCS implementations allow checking out directly to a
1928 ;; file using the -G option, but then some don't so use the
1929 ;; least common denominator approach and use the -p option
1930 ;; ala RCS.
1938 ;; Some shells make the "" dummy argument into $0
1939 ;; while others use the shell's name as $0 and
1940 ;; use the "" as $1. The if-statement
1941 ;; converts the latter case to the former.
1948 filename
1950 "-p"
1953 switches)
1960 switches)
1963 ;; RCS doesn't let us check out into arbitrary file names directly.
1964 ;; Use `co -p' and make stdout point to the correct file.
1972 ;; See the SCCS case, above, regarding the
1973 ;; if-statement.
1980 filename
1983 switches)
1987 ;; if we should go to the head of the trunk,
1988 ;; clear the default branch first
1991 ;; now do the checkout
1994 ;; If locking is not strict, force to overwrite
1995 ;; the writable workfile.
1999 ;; if no explicit revision was specified,
2000 ;; check out that of the working file
2003 nil)))
2004 switches)
2005 ;; determine the new workfile version
2013 ;; if necessary, adjust the default branch
2019 new-version))))))
2021 ;; CVS is much like RCS
2029 workfile
2031 "-p"
2032 switches)
2035 ;; default for verbose checkout: clear the sticky tag
2036 ;; so that the actual update will get the head of the trunk
2039 ;; If a revision was specified, check that out.
2043 "update"
2046 switches)
2047 ;; If no revision was specified, simply make the file writable.
2069 nil ;; RCS
2071 )
2074 ;; Register changes to FILE as level REV with explanatory COMMENT.
2075 ;; Automatically retrieves a read-only version of the file with
2076 ;; keywords expanded if vc-keep-workfiles is non-nil, otherwise
2077 ;; it deletes the workfile.
2078 ;; Adaptation for RCS branch support: if this is an explicit checkin,
2079 ;; or if the checkin creates a new branch, set the master file branch
2080 ;; accordingly.
2082 ;; "This log message intentionally left almost blank".
2083 ;; RCS 5.7 gripes about white-space-only comments too.
2087 ;; Change buffers to get local value of vc-checkin-switches.
2092 vc-checkin-switches)))
2093 ;; Clear the master-properties. Do that here, not at the
2094 ;; end, because if the check-in fails we want them to get
2095 ;; re-computed before the next try.
2098 ;; SCCS
2103 switches)
2108 )
2109 ;; RCS
2112 ;; if available, use the secure check-in option
2116 switches)
2120 ;; determine the new workfile version
2131 ;; if we got to a different branch, adjust the default
2132 ;; branch accordingly
2140 ;; If this is an old RCS release, we might have
2141 ;; to remove a remaining lock.
2143 ;; exit status of 1 is also accepted.
2144 ;; It means that the lock was removed before.
2147 ;; CVS
2149 ;; explicit check-in to the trunk requires a
2150 ;; double check-in (first unexplicit) (CVS-1.3)
2156 switches))
2160 switches))
2162 ;; The CVS output will be on top of this message.
2165 ;; determine and store the new workfile version
2174 ;; if this was an explicit check-in, remove the sticky tag
2183 ;; Revert file to latest checked-in version.
2184 ;; (for RCS, to workfile version)
2188 file
2189 ;; SCCS
2193 ;; RCS
2196 ;; CVS
2203 )
2206 ;; Steal the lock on the current workfile. Needs RCS 5.6.2 or later for -M.
2212 )
2216 )
2219 )
2222 ;; Undo the latest checkin.
2227 nil ;; this is never reached under CVS
2228 )
2230 )
2233 ;; Get change log associated with FILE.
2235 file
2241 ;; Assign to a FILE's latest version a given NAME.
2246 )
2247 )
2250 ;; Get a difference report between two versions of FILE.
2251 ;; Get only a brief comparison report if CMP, a difference report otherwise.
2254 diff-switches
2267 ;; If we know that --brief is not supported, don't try it.
2275 ;; If --brief didn't work, do a double-take and remember it
2276 ;; for the future.
2282 ;; If --brief DID work, remember that, too.
2285 status))
2286 ;; CVS is different.
2289 ;; This file is added but not yet committed; there is no master file.
2293 ;; we regard this as "changed".
2294 ;; diff it against /dev/null.
2298 diff-switches
2300 ;; cmp is not yet implemented -- we always do a full diff.
2306 diff-switches
2312 ;; Merge in any new changes made to FILE.
2316 file
2324 ;; CVS doesn't return an error code if conflicts are detected.
2325 ;; Since we want to warn the user about it (and possibly start
2326 ;; emerge later), scan the output and see if this occurred.
2332 )))
2336 "Check if the current file has any headers in it."
2342 (re-search-forward "\\$[A-Za-z\300-\326\330-\366\370-\377]+\\(: [\t -#%-\176\240-\377]*\\)?\\$" nil t) ;; RCS
2344 )
2345 ))
2347 ;; Back-end-dependent stuff ends here.
2349 ;; Set up key bindings for use while editing log messages
2352 "Minor mode for driving version-control tools.
2353 These bindings are added to the global keymap when you enter this mode:
2366 While you are entering a change log message for a version, the following
2367 additional bindings will be in effect.
2371 Whenever you do a checkin, your log comment is added to a ring of
2372 saved comments. These can be recalled as follows:
2379 Entry to the change-log submode calls the value of text-mode-hook, then
2380 the value of vc-log-mode-hook.
2382 Global user options:
2383 vc-initial-comment If non-nil, require user to enter a change
2384 comment upon first checkin of the file.
2386 vc-keep-workfiles Non-nil value prevents workfiles from being
2387 deleted when changes are checked in
2389 vc-suppress-confirm Suppresses some confirmation prompts,
2390 notably for reversions.
2392 vc-header-alist Which keywords to insert when adding headers
2395 RCS and CVS.
2397 vc-static-header-alist By default, version headers inserted in C files
2398 get stuffed in a static string area so that
2399 ident(RCS/CVS) or what(SCCS) can see them in
2400 the compiled object code. You can override
2401 this by setting this variable to nil, or change
2402 the header template by changing it.
2404 vc-command-messages if non-nil, display run messages from the
2405 actual version-control utilities (this is
2406 intended primarily for people hacking vc
2407 itself).
2408 "
2422 )
2424 ;; Initialization code, to be done just once at load-time
2426 nil
2433 )
2435 ;;; These things should probably be generally available
2438 "Walk recursively through DIRNAME.
2439 Invoke FUNC f ARGS on each non-directory file f underneath it."
2462 ;;; DEVELOPER'S NOTES ON CONCURRENCY PROBLEMS IN THIS CODE
2463 ;;;
2464 ;;; These may be useful to anyone who has to debug or extend the package.
2465 ;;; (Note that this information corresponds to versions 5.x. Some of it
2466 ;;; might have been invalidated by the additions to support branching
2467 ;;; and RCS keyword lookup. AS, 1995/03/24)
2468 ;;;
2469 ;;; A fundamental problem in VC is that there are time windows between
2470 ;;; vc-next-action's computations of the file's version-control state and
2471 ;;; the actions that change it. This is a window open to lossage in a
2472 ;;; multi-user environment; someone else could nip in and change the state
2473 ;;; of the master during it.
2474 ;;;
2475 ;;; The performance problem is that rlog/prs calls are very expensive; we want
2476 ;;; to avoid them as much as possible.
2477 ;;;
2478 ;;; ANALYSIS:
2479 ;;;
2480 ;;; The performance problem, it turns out, simplifies in practice to the
2481 ;;; problem of making vc-locking-user fast. The two other functions that call
2482 ;;; prs/rlog will not be so commonly used that the slowdown is a problem; one
2483 ;;; makes snapshots, the other deletes the calling user's last change in the
2484 ;;; master.
2485 ;;;
2486 ;;; The race condition implies that we have to either (a) lock the master
2487 ;;; during the entire execution of vc-next-action, or (b) detect and
2488 ;;; recover from errors resulting from dispatch on an out-of-date state.
2489 ;;;
2490 ;;; Alternative (a) appears to be infeasible. The problem is that we can't
2491 ;;; guarantee that the lock will ever be removed. Suppose a user starts a
2492 ;;; checkin, the change message buffer pops up, and the user, having wandered
2493 ;;; off to do something else, simply forgets about it?
2494 ;;;
2495 ;;; Alternative (b), on the other hand, works well with a cheap way to speed up
2496 ;;; vc-locking-user. Usually, if a file is registered, we can read its locked/
2497 ;;; unlocked state and its current owner from its permissions.
2498 ;;;
2499 ;;; This shortcut will fail if someone has manually changed the workfile's
2500 ;;; permissions; also if developers are munging the workfile in several
2501 ;;; directories, with symlinks to a master (in this latter case, the
2502 ;;; permissions shortcut will fail to detect a lock asserted from another
2503 ;;; directory).
2504 ;;;
2505 ;;; Note that these cases correspond exactly to the errors which could happen
2506 ;;; because of a competing checkin/checkout race in between two instances of
2507 ;;; vc-next-action.
2508 ;;;
2509 ;;; For VC's purposes, a workfile/master pair may have the following states:
2510 ;;;
2511 ;;; A. Unregistered. There is a workfile, there is no master.
2512 ;;;
2513 ;;; B. Registered and not locked by anyone.
2514 ;;;
2515 ;;; C. Locked by calling user and unchanged.
2516 ;;;
2517 ;;; D. Locked by the calling user and changed.
2518 ;;;
2519 ;;; E. Locked by someone other than the calling user.
2520 ;;;
2521 ;;; This makes for 25 states and 20 error conditions. Here's the matrix:
2522 ;;;
2523 ;;; VC's idea of state
2524 ;;; |
2525 ;;; V Actual state RCS action SCCS action Effect
2526 ;;; A B C D E
2527 ;;; A . 1 2 3 4 ci -u -t- admin -fb -i<file> initial admin
2528 ;;; B 5 . 6 7 8 co -l get -e checkout
2529 ;;; C 9 10 . 11 12 co -u unget; get revert
2530 ;;; D 13 14 15 . 16 ci -u -m<comment> delta -y<comment>; get checkin
2531 ;;; E 17 18 19 20 . rcs -u -M -l unget -n ; get -g steal lock
2532 ;;;
2533 ;;; All commands take the master file name as a last argument (not shown).
2534 ;;;
2535 ;;; In the discussion below, a "self-race" is a pathological situation in
2536 ;;; which VC operations are being attempted simultaneously by two or more
2537 ;;; Emacsen running under the same username.
2538 ;;;
2539 ;;; The vc-next-action code has the following windows:
2540 ;;;
2541 ;;; Window P:
2542 ;;; Between the check for existence of a master file and the call to
2543 ;;; admin/checkin in vc-buffer-admin (apparent state A). This window may
2544 ;;; never close if the initial-comment feature is on.
2545 ;;;
2546 ;;; Window Q:
2547 ;;; Between the call to vc-workfile-unchanged-p in and the immediately
2548 ;;; following revert (apparent state C).
2549 ;;;
2550 ;;; Window R:
2551 ;;; Between the call to vc-workfile-unchanged-p in and the following
2552 ;;; checkin (apparent state D). This window may never close.
2553 ;;;
2554 ;;; Window S:
2555 ;;; Between the unlock and the immediately following checkout during a
2556 ;;; revert operation (apparent state C). Included in window Q.
2557 ;;;
2558 ;;; Window T:
2559 ;;; Between vc-locking-user and the following checkout (apparent state B).
2560 ;;;
2561 ;;; Window U:
2562 ;;; Between vc-locking-user and the following revert (apparent state C).
2563 ;;; Includes windows Q and S.
2564 ;;;
2565 ;;; Window V:
2566 ;;; Between vc-locking-user and the following checkin (apparent state
2567 ;;; D). This window may never be closed if the user fails to complete the
2568 ;;; checkin message. Includes window R.
2569 ;;;
2570 ;;; Window W:
2571 ;;; Between vc-locking-user and the following steal-lock (apparent
2572 ;;; state E). This window may never close if the user fails to complete
2573 ;;; the steal-lock message. Includes window X.
2574 ;;;
2575 ;;; Window X:
2576 ;;; Between the unlock and the immediately following re-lock during a
2577 ;;; steal-lock operation (apparent state E). This window may never cloce
2578 ;;; if the user fails to complete the steal-lock message.
2579 ;;;
2580 ;;; Errors:
2581 ;;;
2582 ;;; Apparent state A ---
2583 ;;;
2584 ;;; 1. File looked unregistered but is actually registered and not locked.
2585 ;;;
2586 ;;; Potential cause: someone else's admin during window P, with
2587 ;;; caller's admin happening before their checkout.
2588 ;;;
2589 ;;; RCS: Prior to version 5.6.4, ci fails with message
2590 ;;; "no lock set by <user>". From 5.6.4 onwards, VC uses the new
2591 ;;; ci -i option and the message is "<file>,v: already exists".
2592 ;;; SCCS: admin will fail with error (ad19).
2593 ;;;
2594 ;;; We can let these errors be passed up to the user.
2595 ;;;
2596 ;;; 2. File looked unregistered but is actually locked by caller, unchanged.
2597 ;;;
2598 ;;; Potential cause: self-race during window P.
2599 ;;;
2600 ;;; RCS: Prior to version 5.6.4, reverts the file to the last saved
2601 ;;; version and unlocks it. From 5.6.4 onwards, VC uses the new
2602 ;;; ci -i option, failing with message "<file>,v: already exists".
2603 ;;; SCCS: will fail with error (ad19).
2604 ;;;
2605 ;;; Either of these consequences is acceptable.
2606 ;;;
2607 ;;; 3. File looked unregistered but is actually locked by caller, changed.
2608 ;;;
2609 ;;; Potential cause: self-race during window P.
2610 ;;;
2611 ;;; RCS: Prior to version 5.6.4, VC registers the caller's workfile as
2612 ;;; a delta with a null change comment (the -t- switch will be
2613 ;;; ignored). From 5.6.4 onwards, VC uses the new ci -i option,
2614 ;;; failing with message "<file>,v: already exists".
2615 ;;; SCCS: will fail with error (ad19).
2616 ;;;
2617 ;;; 4. File looked unregistered but is locked by someone else.
2618 ;;;
2619 ;;; Potential cause: someone else's admin during window P, with
2620 ;;; caller's admin happening *after* their checkout.
2621 ;;;
2622 ;;; RCS: Prior to version 5.6.4, ci fails with a
2623 ;;; "no lock set by <user>" message. From 5.6.4 onwards,
2624 ;;; VC uses the new ci -i option, failing with message
2625 ;;; "<file>,v: already exists".
2626 ;;; SCCS: will fail with error (ad19).
2627 ;;;
2628 ;;; We can let these errors be passed up to the user.
2629 ;;;
2630 ;;; Apparent state B ---
2631 ;;;
2632 ;;; 5. File looked registered and not locked, but is actually unregistered.
2633 ;;;
2634 ;;; Potential cause: master file got nuked during window P.
2635 ;;;
2636 ;;; RCS: will fail with "RCS/<file>: No such file or directory"
2637 ;;; SCCS: will fail with error ut4.
2638 ;;;
2639 ;;; We can let these errors be passed up to the user.
2640 ;;;
2641 ;;; 6. File looked registered and not locked, but is actually locked by the
2642 ;;; calling user and unchanged.
2643 ;;;
2644 ;;; Potential cause: self-race during window T.
2645 ;;;
2646 ;;; RCS: in the same directory as the previous workfile, co -l will fail
2647 ;;; with "co error: writable foo exists; checkout aborted". In any other
2648 ;;; directory, checkout will succeed.
2649 ;;; SCCS: will fail with ge17.
2650 ;;;
2651 ;;; Either of these consequences is acceptable.
2652 ;;;
2653 ;;; 7. File looked registered and not locked, but is actually locked by the
2654 ;;; calling user and changed.
2655 ;;;
2656 ;;; As case 6.
2657 ;;;
2658 ;;; 8. File looked registered and not locked, but is actually locked by another
2659 ;;; user.
2660 ;;;
2661 ;;; Potential cause: someone else checks it out during window T.
2662 ;;;
2663 ;;; RCS: co error: revision 1.3 already locked by <user>
2664 ;;; SCCS: fails with ge4 (in directory) or ut7 (outside it).
2665 ;;;
2666 ;;; We can let these errors be passed up to the user.
2667 ;;;
2668 ;;; Apparent state C ---
2669 ;;;
2670 ;;; 9. File looks locked by calling user and unchanged, but is unregistered.
2671 ;;;
2672 ;;; As case 5.
2673 ;;;
2674 ;;; 10. File looks locked by calling user and unchanged, but is actually not
2675 ;;; locked.
2676 ;;;
2677 ;;; Potential cause: a self-race in window U, or by the revert's
2678 ;;; landing during window X of some other user's steal-lock or window S
2679 ;;; of another user's revert.
2680 ;;;
2681 ;;; RCS: succeeds, refreshing the file from the identical version in
2682 ;;; the master.
2683 ;;; SCCS: fails with error ut4 (p file nonexistent).
2684 ;;;
2685 ;;; Either of these consequences is acceptable.
2686 ;;;
2687 ;;; 11. File is locked by calling user. It looks unchanged, but is actually
2688 ;;; changed.
2689 ;;;
2690 ;;; Potential cause: the file would have to be touched by a self-race
2691 ;;; during window Q.
2692 ;;;
2693 ;;; The revert will succeed, removing whatever changes came with
2694 ;;; the touch. It is theoretically possible that work could be lost.
2695 ;;;
2696 ;;; 12. File looks like it's locked by the calling user and unchanged, but
2697 ;;; it's actually locked by someone else.
2698 ;;;
2699 ;;; Potential cause: a steal-lock in window V.
2700 ;;;
2701 ;;; RCS: co error: revision <rev> locked by <user>; use co -r or rcs -u
2702 ;;; SCCS: fails with error un2
2703 ;;;
2704 ;;; We can pass these errors up to the user.
2705 ;;;
2706 ;;; Apparent state D ---
2707 ;;;
2708 ;;; 13. File looks like it's locked by the calling user and changed, but it's
2709 ;;; actually unregistered.
2710 ;;;
2711 ;;; Potential cause: master file got nuked during window P.
2712 ;;;
2713 ;;; RCS: Prior to version 5.6.4, checks in the user's version as an
2714 ;;; initial delta. From 5.6.4 onwards, VC uses the new ci -j
2715 ;;; option, failing with message "no such file or directory".
2716 ;;; SCCS: will fail with error ut4.
2717 ;;;
2718 ;;; This case is kind of nasty. Under RCS prior to version 5.6.4,
2719 ;;; VC may fail to detect the loss of previous version information.
2720 ;;;
2721 ;;; 14. File looks like it's locked by the calling user and changed, but it's
2722 ;;; actually unlocked.
2723 ;;;
2724 ;;; Potential cause: self-race in window V, or the checkin happening
2725 ;;; during the window X of someone else's steal-lock or window S of
2726 ;;; someone else's revert.
2727 ;;;
2728 ;;; RCS: ci will fail with "no lock set by <user>".
2729 ;;; SCCS: delta will fail with error ut4.
2730 ;;;
2731 ;;; 15. File looks like it's locked by the calling user and changed, but it's
2732 ;;; actually locked by the calling user and unchanged.
2733 ;;;
2734 ;;; Potential cause: another self-race --- a whole checkin/checkout
2735 ;;; sequence by the calling user would have to land in window R.
2736 ;;;
2737 ;;; SCCS: checks in a redundant delta and leaves the file unlocked as usual.
2738 ;;; RCS: reverts to the file state as of the second user's checkin, leaving
2739 ;;; the file unlocked.
2740 ;;;
2741 ;;; It is theoretically possible that work could be lost under RCS.
2742 ;;;
2743 ;;; 16. File looks like it's locked by the calling user and changed, but it's
2744 ;;; actually locked by a different user.
2745 ;;;
2746 ;;; RCS: ci error: no lock set by <user>
2747 ;;; SCCS: unget will fail with error un2
2748 ;;;
2749 ;;; We can pass these errors up to the user.
2750 ;;;
2751 ;;; Apparent state E ---
2752 ;;;
2753 ;;; 17. File looks like it's locked by some other user, but it's actually
2754 ;;; unregistered.
2755 ;;;
2756 ;;; As case 13.
2757 ;;;
2758 ;;; 18. File looks like it's locked by some other user, but it's actually
2759 ;;; unlocked.
2760 ;;;
2761 ;;; Potential cause: someone released a lock during window W.
2762 ;;;
2763 ;;; RCS: The calling user will get the lock on the file.
2764 ;;; SCCS: unget -n will fail with cm4.
2765 ;;;
2766 ;;; Either of these consequences will be OK.
2767 ;;;
2768 ;;; 19. File looks like it's locked by some other user, but it's actually
2769 ;;; locked by the calling user and unchanged.
2770 ;;;
2771 ;;; Potential cause: the other user relinquishing a lock followed by
2772 ;;; a self-race, both in window W.
2773 ;;;
2774 ;;; Under both RCS and SCCS, both unlock and lock will succeed, making
2775 ;;; the sequence a no-op.
2776 ;;;
2777 ;;; 20. File looks like it's locked by some other user, but it's actually
2778 ;;; locked by the calling user and changed.
2779 ;;;
2780 ;;; As case 19.
2781 ;;;
2782 ;;; PROBLEM CASES:
2783 ;;;
2784 ;;; In order of decreasing severity:
2785 ;;;
2786 ;;; Cases 11 and 15 are the only ones that potentially lose work.
2787 ;;; They would require a self-race for this to happen.
2788 ;;;
2789 ;;; Case 13 in RCS loses information about previous deltas, retaining
2790 ;;; only the information in the current workfile. This can only happen
2791 ;;; if the master file gets nuked in window P.
2792 ;;;
2793 ;;; Case 3 in RCS and case 15 under SCCS insert a redundant delta with
2794 ;;; no change comment in the master. This would require a self-race in
2795 ;;; window P or R respectively.
2796 ;;;
2797 ;;; Cases 2, 10, 19 and 20 do extra work, but make no changes.
2798 ;;;
2799 ;;; Unfortunately, it appears to me that no recovery is possible in these
2800 ;;; cases. They don't yield error messages, so there's no way to tell that
2801 ;;; a race condition has occurred.
2802 ;;;
2803 ;;; All other cases don't change either the workfile or the master, and
2804 ;;; trigger command errors which the user will see.
2805 ;;;
2806 ;;; Thus, there is no explicit recovery code.
2808 ;;; vc.el ends here