; * lisp/vc/vc.el: Comment fixes.

This commit is contained in:
Glenn Morris 2018-01-16 20:56:28 -05:00
parent f4e6b6e077
commit 74280624b9

View file

@ -63,15 +63,15 @@
;; ;;
;; When using SCCS, RCS, CVS: be careful not to do repo surgery, or ;; When using SCCS, RCS, CVS: be careful not to do repo surgery, or
;; operations like registrations and deletions and renames, outside VC ;; operations like registrations and deletions and renames, outside VC
;; while VC is running. The support for these systems was designed ;; while VC is running. The support for these systems was designed
;; when disks were much slower, and the code maintains a lot of ;; when disks were much slower, and the code maintains a lot of
;; internal state in order to reduce expensive operations to a ;; internal state in order to reduce expensive operations to a
;; minimum. Thus, if you mess with the repo while VC's back is turned, ;; minimum. Thus, if you mess with the repo while VC's back is turned,
;; VC may get seriously confused. ;; VC may get seriously confused.
;; ;;
;; When using Subversion or a later system, anything you do outside VC ;; When using Subversion or a later system, anything you do outside VC
;; *through the VCS tools* should safely interlock with VC ;; *through the VCS tools* should safely interlock with VC
;; operations. Under these VC does little state caching, because local ;; operations. Under these VC does little state caching, because local
;; operations are assumed to be fast. ;; operations are assumed to be fast.
;; ;;
;; The 'assumed to be fast' category includes SRC, even though it's ;; The 'assumed to be fast' category includes SRC, even though it's
@ -235,7 +235,7 @@
;; ;;
;; * checkin (files comment &optional rev) ;; * checkin (files comment &optional rev)
;; ;;
;; Commit changes in FILES to this backend. COMMENT is used as a ;; Commit changes in FILES to this backend. COMMENT is used as a
;; check-in comment. The implementation should pass the value of ;; check-in comment. The implementation should pass the value of
;; vc-checkin-switches to the backend command. The optional REV ;; vc-checkin-switches to the backend command. The optional REV
;; revision argument is only supported with some older VCSes, like ;; revision argument is only supported with some older VCSes, like
@ -257,7 +257,7 @@
;; that means to check out the head of the current branch; if it is ;; that means to check out the head of the current branch; if it is
;; the empty string, check out the head of the trunk. The ;; the empty string, check out the head of the trunk. The
;; implementation should pass the value of vc-checkout-switches to ;; implementation should pass the value of vc-checkout-switches to
;; the backend command. The 'editable' argument of older VC versions ;; the backend command. The 'editable' argument of older VC versions
;; is gone; all files are checked out editable. ;; is gone; all files are checked out editable.
;; ;;
;; * revert (file &optional contents-done) ;; * revert (file &optional contents-done)
@ -543,8 +543,8 @@
;;; Changes from the pre-25.1 API: ;;; Changes from the pre-25.1 API:
;; ;;
;; - INCOMPATIBLE CHANGE: The 'editable' optional argument of ;; - INCOMPATIBLE CHANGE: The 'editable' optional argument of
;; vc-checkout is gone. The upper level assumes that all files are ;; vc-checkout is gone. The upper level assumes that all files are
;; checked out editable. This moves closer to emulating modern ;; checked out editable. This moves closer to emulating modern
;; non-locking behavior even on very old VCSes. ;; non-locking behavior even on very old VCSes.
;; ;;
;; - INCOMPATIBLE CHANGE: The vc-register function and its backend ;; - INCOMPATIBLE CHANGE: The vc-register function and its backend
@ -577,11 +577,11 @@
;; only affected back ends were SCCS and RCS. ;; only affected back ends were SCCS and RCS.
;; ;;
;; - vc-stay-local-p and repository-hostname are no longer part ;; - vc-stay-local-p and repository-hostname are no longer part
;; of the public API. The vc-cvs-stay-local configuration variable ;; of the public API. The vc-cvs-stay-local configuration variable
;; remains and only affects the CVS back end. ;; remains and only affects the CVS back end.
;; ;;
;; - The init-revision function and the default-initial-revision ;; - The init-revision function and the default-initial-revision
;; variable are gone. These have't made sense on anything shipped ;; variable are gone. These haven't made sense on anything shipped
;; since RCS, and using them was a dumb stunt even on RCS. ;; since RCS, and using them was a dumb stunt even on RCS.
;; ;;
;; - workfile-unchanged-p is no longer a public back-end method. It ;; - workfile-unchanged-p is no longer a public back-end method. It
@ -596,11 +596,11 @@
;; when set to the (non-default) value nil. The original justification ;; when set to the (non-default) value nil. The original justification
;; for it (saving disk space) is long obsolete. ;; for it (saving disk space) is long obsolete.
;; ;;
;; - The rollback method (implemented by RCS and SCCS only) is gone. See ;; - The rollback method (implemented by RCS and SCCS only) is gone. See
;; the to-do note on uncommit. ;; the to-do note on uncommit.
;; ;;
;; - latest-on-branch-p is no longer a public method. It was to be used ;; - latest-on-branch-p is no longer a public method. It was to be used
;; for implementing rollback. RCS keeps its implementation (the only one) ;; for implementing rollback. RCS keeps its implementation (the only one)
;; for internal use. ;; for internal use.
@ -627,7 +627,7 @@
;; - Make sure the *vc-dir* buffer is updated after merge-branch operations. ;; - Make sure the *vc-dir* buffer is updated after merge-branch operations.
;; ;;
;; - add a generic mechanism for remembering the current branch names, ;; - add a generic mechanism for remembering the current branch names,
;; display the branch name in the mode-line. Replace ;; display the branch name in the mode-line. Replace
;; vc-cvs-sticky-tag with that. ;; vc-cvs-sticky-tag with that.
;; ;;
;; - Add a primitives for switching to a branch (creating it if required. ;; - Add a primitives for switching to a branch (creating it if required.
@ -644,7 +644,7 @@
;; ;;
;; - Second, `log-view-modify-change-comment' doesn't seem to support ;; - Second, `log-view-modify-change-comment' doesn't seem to support
;; modern backends at all because `log-view-extract-comment' ;; modern backends at all because `log-view-extract-comment'
;; unconditionally calls `log-view-current-file'. This should be easy to ;; unconditionally calls `log-view-current-file'. This should be easy to
;; fix. ;; fix.
;; ;;
;; - Third, doing message editing in log-view might be a natural way to go ;; - Third, doing message editing in log-view might be a natural way to go
@ -687,7 +687,7 @@
;; - add a function that calls vc-dir to `find-directory-functions'. ;; - add a function that calls vc-dir to `find-directory-functions'.
;; ;;
;; - vc-diff, vc-annotate, etc. need to deal better with unregistered ;; - vc-diff, vc-annotate, etc. need to deal better with unregistered
;; files. Now that unregistered and ignored files are shown in ;; files. Now that unregistered and ignored files are shown in
;; vc-dir, it is possible that these commands are called ;; vc-dir, it is possible that these commands are called
;; for unregistered/ignored files. ;; for unregistered/ignored files.
;; ;;