emacs: lisp/log-edit.el annotate

author	Kim F. Storm <storm@cua.dk>
date	Tue, 02 Mar 2004 11:09:29 +0000 (2004-03-02)
parents	2ea08fedb58f
children	ae0720c5c65c

rev	line source
28088 b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	1 ;;; log-edit.el --- Major mode for editing CVS commit messages
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	2
51063 66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 49616 diff changeset	3 ;; Copyright (C) 1999,2000,2003 Free Software Foundation, Inc.
28088 b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	4
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	5 ;; Author: Stefan Monnier <monnier@cs.yale.edu>
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	6 ;; Keywords: pcl-cvs cvs commit log
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	7
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	8 ;; This file is part of GNU Emacs.
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	9
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	10 ;; GNU Emacs is free software; you can redistribute it and/or modify
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	11 ;; it under the terms of the GNU General Public License as published by
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	12 ;; the Free Software Foundation; either version 2, or (at your option)
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	13 ;; any later version.
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	14
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	15 ;; GNU Emacs is distributed in the hope that it will be useful,
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	18 ;; GNU General Public License for more details.
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	19
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	20 ;; You should have received a copy of the GNU General Public License
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	21 ;; along with GNU Emacs; see the file COPYING. If not, write to the
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	23 ;; Boston, MA 02111-1307, USA.
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	24
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	25 ;;; Commentary:
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	26
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	27 ;; Todo:
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	28
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	29 ;; - Move in VC's code
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	30 ;; - Add compatibility for VC's hook variables
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	31
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	32 ;;; Code:
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	33
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	34 (eval-when-compile (require 'cl))
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	35 (require 'add-log) ; for all the ChangeLog goodies
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	36 (require 'pcvs-util)
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	37 (require 'ring)
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	38
49597 e88404e8f2cf Trailing whitespace deleted. Juanma Barranquero <lekktu@gmail.com> parents: 40478 diff changeset	39 ;;;;
28088 b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	40 ;;;; Global Variables
49597 e88404e8f2cf Trailing whitespace deleted. Juanma Barranquero <lekktu@gmail.com> parents: 40478 diff changeset	41 ;;;;
28088 b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	42
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	43 (defgroup log-edit nil
32816 f4923452ea45 (log-edit): Add :version and a :group for vc. Dave Love <fx@gnu.org> parents: 29398 diff changeset	44 "Major mode for editing RCS and CVS commit messages."
28088 b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	45 :group 'pcl-cvs
32816 f4923452ea45 (log-edit): Add :version and a :group for vc. Dave Love <fx@gnu.org> parents: 29398 diff changeset	46 :group 'vc ; It's used by VC.
f4923452ea45 (log-edit): Add :version and a :group for vc. Dave Love <fx@gnu.org> parents: 29398 diff changeset	47 :version "21.1"
28088 b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	48 :prefix "log-edit-")
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	49
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	50 ;; compiler pacifiers
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	51 (defvar cvs-buffer)
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	52
51063 66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 49616 diff changeset	53
66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 49616 diff changeset	54 ;; The main keymap
66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 49616 diff changeset	55
28088 b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	56 (easy-mmode-defmap log-edit-mode-map
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	57 `(("\C-c\C-c" . log-edit-done)
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	58 ("\C-c\C-a" . log-edit-insert-changelog)
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	59 ("\C-c\C-f" . log-edit-show-files)
51368 cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 51065 diff changeset	60 ("\M-n" . log-edit-next-comment)
cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 51065 diff changeset	61 ("\M-p" . log-edit-previous-comment)
cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 51065 diff changeset	62 ("\M-r" . log-edit-comment-search-backward)
cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 51065 diff changeset	63 ("\M-s" . log-edit-comment-search-forward)
51065 35933dc8e248 Don't require vc.el anymore. Stefan Monnier <monnier@iro.umontreal.ca> parents: 51063 diff changeset	64 ("\C-c?" . log-edit-mode-help))
34405 ef4ba02580f0 (log-edit-parent-buffer): New var. Stefan Monnier <monnier@iro.umontreal.ca> parents: 34304 diff changeset	65 "Keymap for the `log-edit-mode' (to edit version control log messages)."
51065 35933dc8e248 Don't require vc.el anymore. Stefan Monnier <monnier@iro.umontreal.ca> parents: 51063 diff changeset	66 :group 'log-edit)
35933dc8e248 Don't require vc.el anymore. Stefan Monnier <monnier@iro.umontreal.ca> parents: 51063 diff changeset	67
35933dc8e248 Don't require vc.el anymore. Stefan Monnier <monnier@iro.umontreal.ca> parents: 51063 diff changeset	68 ;; Compatibility with old names. Should we bother ?
35933dc8e248 Don't require vc.el anymore. Stefan Monnier <monnier@iro.umontreal.ca> parents: 51063 diff changeset	69 (defvar vc-log-mode-map log-edit-mode-map)
35933dc8e248 Don't require vc.el anymore. Stefan Monnier <monnier@iro.umontreal.ca> parents: 51063 diff changeset	70 (defvar vc-log-entry-mode vc-log-mode-map)
28088 b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	71
33180 8700cd9cdd26 (log-edit-menu): New menu. Stefan Monnier <monnier@iro.umontreal.ca> parents: 33061 diff changeset	72 (easy-menu-define log-edit-menu log-edit-mode-map
8700cd9cdd26 (log-edit-menu): New menu. Stefan Monnier <monnier@iro.umontreal.ca> parents: 33061 diff changeset	73 "Menu used for `log-edit-mode'."
8700cd9cdd26 (log-edit-menu): New menu. Stefan Monnier <monnier@iro.umontreal.ca> parents: 33061 diff changeset	74 '("Log-Edit"
8700cd9cdd26 (log-edit-menu): New menu. Stefan Monnier <monnier@iro.umontreal.ca> parents: 33061 diff changeset	75 ["Done" log-edit-done
8700cd9cdd26 (log-edit-menu): New menu. Stefan Monnier <monnier@iro.umontreal.ca> parents: 33061 diff changeset	76 :help "Exit log-edit and proceed with the actual action."]
8700cd9cdd26 (log-edit-menu): New menu. Stefan Monnier <monnier@iro.umontreal.ca> parents: 33061 diff changeset	77 "--"
8700cd9cdd26 (log-edit-menu): New menu. Stefan Monnier <monnier@iro.umontreal.ca> parents: 33061 diff changeset	78 ["Insert ChangeLog" log-edit-insert-changelog]
8700cd9cdd26 (log-edit-menu): New menu. Stefan Monnier <monnier@iro.umontreal.ca> parents: 33061 diff changeset	79 ["Add to ChangeLog" log-edit-add-to-changelog]
8700cd9cdd26 (log-edit-menu): New menu. Stefan Monnier <monnier@iro.umontreal.ca> parents: 33061 diff changeset	80 "--"
8700cd9cdd26 (log-edit-menu): New menu. Stefan Monnier <monnier@iro.umontreal.ca> parents: 33061 diff changeset	81 ["List files" log-edit-show-files
8700cd9cdd26 (log-edit-menu): New menu. Stefan Monnier <monnier@iro.umontreal.ca> parents: 33061 diff changeset	82 :help "Show the list of relevant files."]
8700cd9cdd26 (log-edit-menu): New menu. Stefan Monnier <monnier@iro.umontreal.ca> parents: 33061 diff changeset	83 "--"
51368 cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 51065 diff changeset	84 ["Previous comment" log-edit-previous-comment]
cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 51065 diff changeset	85 ["Next comment" log-edit-next-comment]
cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 51065 diff changeset	86 ["Search comment forward" log-edit-comment-search-forward]
cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 51065 diff changeset	87 ["Search comment backward" log-edit-comment-search-backward]))
33180 8700cd9cdd26 (log-edit-menu): New menu. Stefan Monnier <monnier@iro.umontreal.ca> parents: 33061 diff changeset	88
33061 3cbd3cc4cc8b (log-edit-confirm): Fix the default. Stefan Monnier <monnier@iro.umontreal.ca> parents: 32816 diff changeset	89 (defcustom log-edit-confirm 'changed
28088 b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	90 "*If non-nil, `log-edit-done' will request confirmation.
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	91 If 'changed, only request confirmation if the list of files has
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	92 changed since the beginning of the log-edit session."
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	93 :group 'log-edit
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	94 :type '(choice (const changed) (const t) (const nil)))
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	95
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	96 (defcustom log-edit-keep-buffer nil
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	97 "*If non-nil, don't hide the buffer after `log-edit-done'."
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	98 :group 'log-edit
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	99 :type 'boolean)
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	100
49616 43c9ef374660 (cvs-commit-buffer-require-final-newline, cvs-changelog-full-paragraphs): Add Juanma Barranquero <lekktu@gmail.com> parents: 49597 diff changeset	101 (defvar cvs-commit-buffer-require-final-newline t)
43c9ef374660 (cvs-commit-buffer-require-final-newline, cvs-changelog-full-paragraphs): Add Juanma Barranquero <lekktu@gmail.com> parents: 49597 diff changeset	102 (make-obsolete-variable 'cvs-commit-buffer-require-final-newline
43c9ef374660 (cvs-commit-buffer-require-final-newline, cvs-changelog-full-paragraphs): Add Juanma Barranquero <lekktu@gmail.com> parents: 49597 diff changeset	103 'log-edit-require-final-newline)
28088 b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	104
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	105 (defcustom log-edit-require-final-newline
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	106 cvs-commit-buffer-require-final-newline
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	107 "*Enforce a newline at the end of commit log messages.
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	108 Enforce it silently if t, query if non-nil and don't do anything if nil."
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	109 :group 'log-edit
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	110 :type '(choice (const ask) (const t) (const nil)))
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	111
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	112 (defcustom log-edit-setup-invert nil
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	113 "*Non-nil means `log-edit' should invert the meaning of its SETUP arg.
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	114 If SETUP is 'force, this variable has no effect."
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	115 :group 'log-edit
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	116 :type 'boolean)
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	117
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	118 (defcustom log-edit-hook '(log-edit-insert-cvs-template
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	119 log-edit-insert-changelog)
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	120 "*Hook run at the end of `log-edit'."
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	121 :group 'log-edit
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	122 :type '(hook :options (log-edit-insert-cvs-template
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	123 log-edit-insert-changelog)))
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	124
28340 b90fe8a937ae (log-edit-mode-hook): Fix typo. Stefan Monnier <monnier@iro.umontreal.ca> parents: 28338 diff changeset	125 (defcustom log-edit-mode-hook (if (boundp 'vc-log-mode-hook) vc-log-mode-hook)
28088 b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	126 "*Hook run when entering `log-edit-mode'."
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	127 :group 'log-edit
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	128 :type 'hook)
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	129
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	130 (defcustom log-edit-done-hook nil
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	131 "*Hook run before doing the actual commit.
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	132 This hook can be used to cleanup the message, enforce various
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	133 conventions, or to allow recording the message in some other database,
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	134 such as a bug-tracking system. The list of files about to be committed
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	135 can be obtained from `log-edit-files'."
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	136 :group 'log-edit
36616 61f696f7e5f9 (log-edit-common-indent): New var. Stefan Monnier <monnier@iro.umontreal.ca> parents: 34652 diff changeset	137 :type '(hook :options (log-edit-set-common-indentation
28088 b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	138 log-edit-add-to-changelog)))
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	139
49616 43c9ef374660 (cvs-commit-buffer-require-final-newline, cvs-changelog-full-paragraphs): Add Juanma Barranquero <lekktu@gmail.com> parents: 49597 diff changeset	140 (defvar cvs-changelog-full-paragraphs t)
43c9ef374660 (cvs-commit-buffer-require-final-newline, cvs-changelog-full-paragraphs): Add Juanma Barranquero <lekktu@gmail.com> parents: 49597 diff changeset	141 (make-obsolete-variable 'cvs-changelog-full-paragraphs
43c9ef374660 (cvs-commit-buffer-require-final-newline, cvs-changelog-full-paragraphs): Add Juanma Barranquero <lekktu@gmail.com> parents: 49597 diff changeset	142 'log-edit-changelog-full-paragraphs)
28860 40a22b85650e (cvs-changelog-full-paragraphs): Mark obsolete. Stefan Monnier <monnier@iro.umontreal.ca> parents: 28340 diff changeset	143
40a22b85650e (cvs-changelog-full-paragraphs): Mark obsolete. Stefan Monnier <monnier@iro.umontreal.ca> parents: 28340 diff changeset	144 (defvar log-edit-changelog-full-paragraphs cvs-changelog-full-paragraphs
40a22b85650e (cvs-changelog-full-paragraphs): Mark obsolete. Stefan Monnier <monnier@iro.umontreal.ca> parents: 28340 diff changeset	145 "*If non-nil, include full ChangeLog paragraphs in the log.
28088 b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	146 This may be set in the ``local variables'' section of a ChangeLog, to
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	147 indicate the policy for that ChangeLog.
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	148
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	149 A ChangeLog paragraph is a bunch of log text containing no blank lines;
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	150 a paragraph usually describes a set of changes with a single purpose,
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	151 but perhaps spanning several functions in several files. Changes in
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	152 different paragraphs are unrelated.
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	153
28860 40a22b85650e (cvs-changelog-full-paragraphs): Mark obsolete. Stefan Monnier <monnier@iro.umontreal.ca> parents: 28340 diff changeset	154 You could argue that the log entry for a file should contain the
28088 b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	155 full ChangeLog paragraph mentioning the change to the file, even though
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	156 it may mention other files, because that gives you the full context you
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	157 need to understand the change. This is the behaviour you get when this
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	158 variable is set to t.
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	159
28860 40a22b85650e (cvs-changelog-full-paragraphs): Mark obsolete. Stefan Monnier <monnier@iro.umontreal.ca> parents: 28340 diff changeset	160 On the other hand, you could argue that the log entry for a change
28088 b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	161 should contain only the text for the changes which occurred in that
28860 40a22b85650e (cvs-changelog-full-paragraphs): Mark obsolete. Stefan Monnier <monnier@iro.umontreal.ca> parents: 28340 diff changeset	162 file, because the log is per-file. This is the behaviour you get
28088 b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	163 when this variable is set to nil.")
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	164
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	165 ;;;; Internal global or buffer-local vars
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	166
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	167 (defconst log-edit-files-buf "log-edit-files")
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	168 (defvar log-edit-initial-files nil)
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	169 (defvar log-edit-callback nil)
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	170 (defvar log-edit-listfun nil)
34405 ef4ba02580f0 (log-edit-parent-buffer): New var. Stefan Monnier <monnier@iro.umontreal.ca> parents: 34304 diff changeset	171 (defvar log-edit-parent-buffer nil)
28088 b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	172
51368 cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 51065 diff changeset	173 ;;; Originally taken from VC-Log mode
51063 66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 49616 diff changeset	174
51368 cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 51065 diff changeset	175 (defconst log-edit-maximum-comment-ring-size 32
51063 66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 49616 diff changeset	176 "Maximum number of saved comments in the comment ring.")
51368 cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 51065 diff changeset	177 (defvar log-edit-comment-ring (make-ring log-edit-maximum-comment-ring-size))
cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 51065 diff changeset	178 (defvar log-edit-comment-ring-index nil)
cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 51065 diff changeset	179 (defvar log-edit-last-comment-match "")
51063 66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 49616 diff changeset	180
51368 cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 51065 diff changeset	181 (defun log-edit-new-comment-index (stride len)
51063 66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 49616 diff changeset	182 "Return the comment index STRIDE elements from the current one.
51368 cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 51065 diff changeset	183 LEN is the length of `log-edit-comment-ring'."
51063 66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 49616 diff changeset	184 (mod (cond
51368 cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 51065 diff changeset	185 (log-edit-comment-ring-index (+ log-edit-comment-ring-index stride))
51063 66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 49616 diff changeset	186 ;; Initialize the index on the first use of this command
66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 49616 diff changeset	187 ;; so that the first M-p gets index 0, and the first M-n gets
66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 49616 diff changeset	188 ;; index -1.
66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 49616 diff changeset	189 ((> stride 0) (1- stride))
66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 49616 diff changeset	190 (t stride))
66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 49616 diff changeset	191 len))
66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 49616 diff changeset	192
51368 cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 51065 diff changeset	193 (defun log-edit-previous-comment (arg)
51063 66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 49616 diff changeset	194 "Cycle backwards through comment history.
66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 49616 diff changeset	195 With a numeric prefix ARG, go back ARG comments."
66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 49616 diff changeset	196 (interactive "*p")
51368 cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 51065 diff changeset	197 (let ((len (ring-length log-edit-comment-ring)))
51063 66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 49616 diff changeset	198 (if (<= len 0)
66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 49616 diff changeset	199 (progn (message "Empty comment ring") (ding))
51065 35933dc8e248 Don't require vc.el anymore. Stefan Monnier <monnier@iro.umontreal.ca> parents: 51063 diff changeset	200 ;; Don't use `erase-buffer' because we don't want to `widen'.
35933dc8e248 Don't require vc.el anymore. Stefan Monnier <monnier@iro.umontreal.ca> parents: 51063 diff changeset	201 (delete-region (point-min) (point-max))
51368 cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 51065 diff changeset	202 (setq log-edit-comment-ring-index (log-edit-new-comment-index arg len))
cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 51065 diff changeset	203 (message "Comment %d" (1+ log-edit-comment-ring-index))
cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 51065 diff changeset	204 (insert (ring-ref log-edit-comment-ring log-edit-comment-ring-index)))))
51063 66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 49616 diff changeset	205
51368 cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 51065 diff changeset	206 (defun log-edit-next-comment (arg)
51063 66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 49616 diff changeset	207 "Cycle forwards through comment history.
66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 49616 diff changeset	208 With a numeric prefix ARG, go forward ARG comments."
66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 49616 diff changeset	209 (interactive "*p")
51368 cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 51065 diff changeset	210 (log-edit-previous-comment (- arg)))
51063 66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 49616 diff changeset	211
51368 cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 51065 diff changeset	212 (defun log-edit-comment-search-backward (str &optional stride)
51063 66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 49616 diff changeset	213 "Search backwards through comment history for substring match of STR.
66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 49616 diff changeset	214 If the optional argument STRIDE is present, that is a step-width to use
66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 49616 diff changeset	215 when going through the comment ring."
66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 49616 diff changeset	216 ;; Why substring rather than regexp ? -sm
66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 49616 diff changeset	217 (interactive
51368 cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 51065 diff changeset	218 (list (read-string "Comment substring: " nil nil log-edit-last-comment-match)))
51063 66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 49616 diff changeset	219 (unless stride (setq stride 1))
66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 49616 diff changeset	220 (if (string= str "")
51368 cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 51065 diff changeset	221 (setq str log-edit-last-comment-match)
cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 51065 diff changeset	222 (setq log-edit-last-comment-match str))
51063 66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 49616 diff changeset	223 (let* ((str (regexp-quote str))
51368 cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 51065 diff changeset	224 (len (ring-length log-edit-comment-ring))
cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 51065 diff changeset	225 (n (log-edit-new-comment-index stride len)))
51063 66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 49616 diff changeset	226 (while (progn (when (or (>= n len) (< n 0)) (error "Not found"))
51368 cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 51065 diff changeset	227 (not (string-match str (ring-ref log-edit-comment-ring n))))
51063 66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 49616 diff changeset	228 (setq n (+ n stride)))
51368 cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 51065 diff changeset	229 (setq log-edit-comment-ring-index n)
cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 51065 diff changeset	230 (log-edit-previous-comment 0)))
51063 66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 49616 diff changeset	231
51368 cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 51065 diff changeset	232 (defun log-edit-comment-search-forward (str)
51063 66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 49616 diff changeset	233 "Search forwards through comment history for a substring match of STR."
66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 49616 diff changeset	234 (interactive
51368 cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 51065 diff changeset	235 (list (read-string "Comment substring: " nil nil log-edit-last-comment-match)))
cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 51065 diff changeset	236 (log-edit-comment-search-backward str -1))
51063 66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 49616 diff changeset	237
51368 cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 51065 diff changeset	238 (defun log-edit-comment-to-change-log (&optional whoami file-name)
51063 66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 49616 diff changeset	239 "Enter last VC comment into the change log for the current file.
66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 49616 diff changeset	240 WHOAMI (interactive prefix) non-nil means prompt for user name
66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 49616 diff changeset	241 and site. FILE-NAME is the name of the change log; if nil, use
66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 49616 diff changeset	242 `change-log-default-name'.
66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 49616 diff changeset	243
51368 cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 51065 diff changeset	244 This may be useful as a `log-edit-checkin-hook' to update change logs
51063 66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 49616 diff changeset	245 automatically."
66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 49616 diff changeset	246 (interactive (if current-prefix-arg
66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 49616 diff changeset	247 (list current-prefix-arg
66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 49616 diff changeset	248 (prompt-for-change-log-name))))
66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 49616 diff changeset	249 (let (;; Extract the comment first so we get any error before doing anything.
51368 cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 51065 diff changeset	250 (comment (ring-ref log-edit-comment-ring 0))
51063 66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 49616 diff changeset	251 ;; Don't let add-change-log-entry insert a defun name.
66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 49616 diff changeset	252 (add-log-current-defun-function 'ignore)
66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 49616 diff changeset	253 end)
66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 49616 diff changeset	254 ;; Call add-log to do half the work.
66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 49616 diff changeset	255 (add-change-log-entry whoami file-name t t)
66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 49616 diff changeset	256 ;; Insert the VC comment, leaving point before it.
66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 49616 diff changeset	257 (setq end (save-excursion (insert comment) (point-marker)))
66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 49616 diff changeset	258 (if (looking-at "\\s *\\s(")
66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 49616 diff changeset	259 ;; It starts with an open-paren, as in "(foo): Frobbed."
66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 49616 diff changeset	260 ;; So remove the ": " add-log inserted.
66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 49616 diff changeset	261 (delete-char -2))
66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 49616 diff changeset	262 ;; Canonicalize the white space between the file name and comment.
66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 49616 diff changeset	263 (just-one-space)
66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 49616 diff changeset	264 ;; Indent rest of the text the same way add-log indented the first line.
66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 49616 diff changeset	265 (let ((indentation (current-indentation)))
66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 49616 diff changeset	266 (save-excursion
66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 49616 diff changeset	267 (while (< (point) end)
66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 49616 diff changeset	268 (forward-line 1)
66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 49616 diff changeset	269 (indent-to indentation))
66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 49616 diff changeset	270 (setq end (point))))
66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 49616 diff changeset	271 ;; Fill the inserted text, preserving open-parens at bol.
51065 35933dc8e248 Don't require vc.el anymore. Stefan Monnier <monnier@iro.umontreal.ca> parents: 51063 diff changeset	272 (let ((paragraph-start (concat paragraph-start "\\\|\\s *\\s(")))
51063 66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 49616 diff changeset	273 (beginning-of-line)
66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 49616 diff changeset	274 (fill-region (point) end))
66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 49616 diff changeset	275 ;; Canonicalize the white space at the end of the entry so it is
66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 49616 diff changeset	276 ;; separated from the next entry by a single blank line.
66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 49616 diff changeset	277 (skip-syntax-forward " " end)
66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 49616 diff changeset	278 (delete-char (- (skip-syntax-backward " ")))
66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 49616 diff changeset	279 (or (eobp) (looking-at "\n\n")
66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 49616 diff changeset	280 (insert "\n"))))
66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 49616 diff changeset	281
51368 cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 51065 diff changeset	282 ;; Compatibility with old names.
cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 51065 diff changeset	283 (defvaralias 'vc-comment-ring 'log-edit-comment-ring)
cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 51065 diff changeset	284 (make-obsolete-variable 'vc-comment-ring 'log-edit-comment-ring "21.5")
cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 51065 diff changeset	285 (defvaralias 'vc-comment-ring-index 'log-edit-comment-ring-index)
cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 51065 diff changeset	286 (make-obsolete-variable 'vc-comment-ring-index 'log-edit-comment-ring-index "21.5")
cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 51065 diff changeset	287 (defalias 'vc-previous-comment 'log-edit-previous-comment)
cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 51065 diff changeset	288 (make-obsolete 'vc-previous-comment 'log-edit-previous-comment "21.5")
cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 51065 diff changeset	289 (defalias 'vc-next-comment 'log-edit-next-comment)
cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 51065 diff changeset	290 (make-obsolete 'vc-next-comment 'log-edit-next-comment "21.5")
cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 51065 diff changeset	291 (defalias 'vc-comment-search-reverse 'log-edit-comment-search-backward)
cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 51065 diff changeset	292 (make-obsolete 'vc-comment-search-reverse 'log-edit-comment-search-backward "21.5")
cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 51065 diff changeset	293 (defalias 'vc-comment-search-forward 'log-edit-comment-search-forward)
cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 51065 diff changeset	294 (make-obsolete 'vc-comment-search-forward 'log-edit-comment-search-forward "21.5")
cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 51065 diff changeset	295 (defalias 'vc-comment-to-change-log 'log-edit-comment-to-change-log)
cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 51065 diff changeset	296 (make-obsolete 'vc-comment-to-change-log 'log-edit-comment-to-change-log "21.5")
cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 51065 diff changeset	297
34405 ef4ba02580f0 (log-edit-parent-buffer): New var. Stefan Monnier <monnier@iro.umontreal.ca> parents: 34304 diff changeset	298 ;;;
ef4ba02580f0 (log-edit-parent-buffer): New var. Stefan Monnier <monnier@iro.umontreal.ca> parents: 34304 diff changeset	299 ;;; Actual code
ef4ba02580f0 (log-edit-parent-buffer): New var. Stefan Monnier <monnier@iro.umontreal.ca> parents: 34304 diff changeset	300 ;;;
28088 b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	301
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	302 ;;;###autoload
34405 ef4ba02580f0 (log-edit-parent-buffer): New var. Stefan Monnier <monnier@iro.umontreal.ca> parents: 34304 diff changeset	303 (defun log-edit (callback &optional setup listfun buffer &rest ignore)
28088 b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	304 "Setup a buffer to enter a log message.
33061 3cbd3cc4cc8b (log-edit-confirm): Fix the default. Stefan Monnier <monnier@iro.umontreal.ca> parents: 32816 diff changeset	305 \\<log-edit-mode-map>The buffer will be put in `log-edit-mode'.
28088 b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	306 If SETUP is non-nil, the buffer is then erased and `log-edit-hook' is run.
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	307 Mark and point will be set around the entire contents of the
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	308 buffer so that it is easy to kill the contents of the buffer with \\[kill-region].
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	309 Once you're done editing the message, pressing \\[log-edit-done] will call
34405 ef4ba02580f0 (log-edit-parent-buffer): New var. Stefan Monnier <monnier@iro.umontreal.ca> parents: 34304 diff changeset	310 `log-edit-done' which will end up calling CALLBACK to do the actual commit.
ef4ba02580f0 (log-edit-parent-buffer): New var. Stefan Monnier <monnier@iro.umontreal.ca> parents: 34304 diff changeset	311 LISTFUN if non-nil is a function of no arguments returning the list of files
ef4ba02580f0 (log-edit-parent-buffer): New var. Stefan Monnier <monnier@iro.umontreal.ca> parents: 34304 diff changeset	312 that are concerned by the current operation (using relative names).
ef4ba02580f0 (log-edit-parent-buffer): New var. Stefan Monnier <monnier@iro.umontreal.ca> parents: 34304 diff changeset	313 If BUFFER is non-nil `log-edit' will jump to that buffer, use it to edit the
ef4ba02580f0 (log-edit-parent-buffer): New var. Stefan Monnier <monnier@iro.umontreal.ca> parents: 34304 diff changeset	314 log message and go back to the current buffer when done. Otherwise, it
ef4ba02580f0 (log-edit-parent-buffer): New var. Stefan Monnier <monnier@iro.umontreal.ca> parents: 34304 diff changeset	315 uses the current buffer."
ef4ba02580f0 (log-edit-parent-buffer): New var. Stefan Monnier <monnier@iro.umontreal.ca> parents: 34304 diff changeset	316 (let ((parent (current-buffer)))
ef4ba02580f0 (log-edit-parent-buffer): New var. Stefan Monnier <monnier@iro.umontreal.ca> parents: 34304 diff changeset	317 (if buffer (pop-to-buffer buffer))
ef4ba02580f0 (log-edit-parent-buffer): New var. Stefan Monnier <monnier@iro.umontreal.ca> parents: 34304 diff changeset	318 (when (and log-edit-setup-invert (not (eq setup 'force)))
ef4ba02580f0 (log-edit-parent-buffer): New var. Stefan Monnier <monnier@iro.umontreal.ca> parents: 34304 diff changeset	319 (setq setup (not setup)))
ef4ba02580f0 (log-edit-parent-buffer): New var. Stefan Monnier <monnier@iro.umontreal.ca> parents: 34304 diff changeset	320 (when setup (erase-buffer))
ef4ba02580f0 (log-edit-parent-buffer): New var. Stefan Monnier <monnier@iro.umontreal.ca> parents: 34304 diff changeset	321 (log-edit-mode)
ef4ba02580f0 (log-edit-parent-buffer): New var. Stefan Monnier <monnier@iro.umontreal.ca> parents: 34304 diff changeset	322 (set (make-local-variable 'log-edit-callback) callback)
ef4ba02580f0 (log-edit-parent-buffer): New var. Stefan Monnier <monnier@iro.umontreal.ca> parents: 34304 diff changeset	323 (set (make-local-variable 'log-edit-listfun) listfun)
ef4ba02580f0 (log-edit-parent-buffer): New var. Stefan Monnier <monnier@iro.umontreal.ca> parents: 34304 diff changeset	324 (if buffer (set (make-local-variable 'log-edit-parent-buffer) parent))
40478 4d0323a1ed72 (log-edit): Run hook after `log-edit-files'. Stefan Monnier <monnier@iro.umontreal.ca> parents: 37694 diff changeset	325 (set (make-local-variable 'log-edit-initial-files) (log-edit-files))
34405 ef4ba02580f0 (log-edit-parent-buffer): New var. Stefan Monnier <monnier@iro.umontreal.ca> parents: 34304 diff changeset	326 (when setup (run-hooks 'log-edit-hook))
ef4ba02580f0 (log-edit-parent-buffer): New var. Stefan Monnier <monnier@iro.umontreal.ca> parents: 34304 diff changeset	327 (goto-char (point-min)) (push-mark (point-max))
ef4ba02580f0 (log-edit-parent-buffer): New var. Stefan Monnier <monnier@iro.umontreal.ca> parents: 34304 diff changeset	328 (message (substitute-command-keys
ef4ba02580f0 (log-edit-parent-buffer): New var. Stefan Monnier <monnier@iro.umontreal.ca> parents: 34304 diff changeset	329 "Press \\[log-edit-done] when you are done editing."))))
28088 b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	330
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	331 (define-derived-mode log-edit-mode text-mode "Log-Edit"
28338 8da42323f5d5 (log-edit-mode-map): Inherit from vc-log-mode-map Stefan Monnier <monnier@iro.umontreal.ca> parents: 28088 diff changeset	332 "Major mode for editing version-control log messages.
8da42323f5d5 (log-edit-mode-map): Inherit from vc-log-mode-map Stefan Monnier <monnier@iro.umontreal.ca> parents: 28088 diff changeset	333 When done editing the log entry, just type \\[log-edit-done] which
8da42323f5d5 (log-edit-mode-map): Inherit from vc-log-mode-map Stefan Monnier <monnier@iro.umontreal.ca> parents: 28088 diff changeset	334 will trigger the actual commit of the file(s).
8da42323f5d5 (log-edit-mode-map): Inherit from vc-log-mode-map Stefan Monnier <monnier@iro.umontreal.ca> parents: 28088 diff changeset	335 Several other handy support commands are provided of course and
8da42323f5d5 (log-edit-mode-map): Inherit from vc-log-mode-map Stefan Monnier <monnier@iro.umontreal.ca> parents: 28088 diff changeset	336 the package from which this is used might also provide additional
8da42323f5d5 (log-edit-mode-map): Inherit from vc-log-mode-map Stefan Monnier <monnier@iro.umontreal.ca> parents: 28088 diff changeset	337 commands (under C-x v for VC, for example).
8da42323f5d5 (log-edit-mode-map): Inherit from vc-log-mode-map Stefan Monnier <monnier@iro.umontreal.ca> parents: 28088 diff changeset	338
29375 429ae71326c2 (log-edit-mode): Make vc-comment-ring-index local. Stefan Monnier <monnier@iro.umontreal.ca> parents: 29042 diff changeset	339 \\{log-edit-mode-map}"
51368 cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 51065 diff changeset	340 (make-local-variable 'log-edit-comment-ring-index))
28088 b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	341
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	342 (defun log-edit-hide-buf (&optional buf where)
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	343 (when (setq buf (get-buffer (or buf log-edit-files-buf)))
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	344 (let ((win (get-buffer-window buf where)))
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	345 (if win (ignore-errors (delete-window win))))
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	346 (bury-buffer buf)))
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	347
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	348 (defun log-edit-done ()
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	349 "Finish editing the log message and commit the files.
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	350 If you want to abort the commit, simply delete the buffer."
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	351 (interactive)
29042 09b4758f4aea (log-edit-done): Cleanup trailing empty lines. Stefan Monnier <monnier@iro.umontreal.ca> parents: 28860 diff changeset	352 ;; Get rid of trailing empty lines
09b4758f4aea (log-edit-done): Cleanup trailing empty lines. Stefan Monnier <monnier@iro.umontreal.ca> parents: 28860 diff changeset	353 (goto-char (point-max))
09b4758f4aea (log-edit-done): Cleanup trailing empty lines. Stefan Monnier <monnier@iro.umontreal.ca> parents: 28860 diff changeset	354 (skip-syntax-backward " ")
09b4758f4aea (log-edit-done): Cleanup trailing empty lines. Stefan Monnier <monnier@iro.umontreal.ca> parents: 28860 diff changeset	355 (when (equal (char-after) ?\n) (forward-char 1))
09b4758f4aea (log-edit-done): Cleanup trailing empty lines. Stefan Monnier <monnier@iro.umontreal.ca> parents: 28860 diff changeset	356 (delete-region (point) (point-max))
09b4758f4aea (log-edit-done): Cleanup trailing empty lines. Stefan Monnier <monnier@iro.umontreal.ca> parents: 28860 diff changeset	357 ;; Check for final newline
34405 ef4ba02580f0 (log-edit-parent-buffer): New var. Stefan Monnier <monnier@iro.umontreal.ca> parents: 34304 diff changeset	358 (if (and (> (point-max) (point-min))
ef4ba02580f0 (log-edit-parent-buffer): New var. Stefan Monnier <monnier@iro.umontreal.ca> parents: 34304 diff changeset	359 (/= (char-before (point-max)) ?\n)
28088 b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	360 (or (eq log-edit-require-final-newline t)
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	361 (and log-edit-require-final-newline
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	362 (y-or-n-p
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	363 (format "Buffer %s does not end in newline. Add one? "
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	364 (buffer-name))))))
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	365 (save-excursion
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	366 (goto-char (point-max))
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	367 (insert ?\n)))
29375 429ae71326c2 (log-edit-mode): Make vc-comment-ring-index local. Stefan Monnier <monnier@iro.umontreal.ca> parents: 29042 diff changeset	368 (let ((comment (buffer-string)))
51368 cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 51065 diff changeset	369 (when (or (ring-empty-p log-edit-comment-ring)
cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 51065 diff changeset	370 (not (equal comment (ring-ref log-edit-comment-ring 0))))
cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 51065 diff changeset	371 (ring-insert log-edit-comment-ring comment)))
28088 b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	372 (let ((win (get-buffer-window log-edit-files-buf)))
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	373 (if (and log-edit-confirm
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	374 (not (and (eq log-edit-confirm 'changed)
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	375 (equal (log-edit-files) log-edit-initial-files)))
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	376 (progn
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	377 (log-edit-show-files)
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	378 (not (y-or-n-p "Really commit ? "))))
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	379 (progn (when (not win) (log-edit-hide-buf))
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	380 (message "Oh, well! Later maybe?"))
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	381 (run-hooks 'log-edit-done-hook)
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	382 (log-edit-hide-buf)
34405 ef4ba02580f0 (log-edit-parent-buffer): New var. Stefan Monnier <monnier@iro.umontreal.ca> parents: 34304 diff changeset	383 (unless (or log-edit-keep-buffer (not log-edit-parent-buffer))
ef4ba02580f0 (log-edit-parent-buffer): New var. Stefan Monnier <monnier@iro.umontreal.ca> parents: 34304 diff changeset	384 (cvs-bury-buffer (current-buffer) log-edit-parent-buffer))
28088 b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	385 (call-interactively log-edit-callback))))
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	386
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	387 (defun log-edit-files ()
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	388 "Return the list of files that are about to be committed."
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	389 (ignore-errors (funcall log-edit-listfun)))
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	390
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	391
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	392 (defun log-edit-insert-changelog ()
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	393 "Insert a log message by looking at the ChangeLog.
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	394 The idea is to write your ChangeLog entries first, and then use this
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	395 command to commit your changes.
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	396
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	397 To select default log text, we:
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	398 - find the ChangeLog entries for the files to be checked in,
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	399 - verify that the top entry in the ChangeLog is on the current date
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	400 and by the current user; if not, we don't provide any default text,
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	401 - search the ChangeLog entry for paragraphs containing the names of
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	402 the files we're checking in, and finally
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	403 - use those paragraphs as the log text."
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	404 (interactive)
28860 40a22b85650e (cvs-changelog-full-paragraphs): Mark obsolete. Stefan Monnier <monnier@iro.umontreal.ca> parents: 28340 diff changeset	405 (log-edit-insert-changelog-entries (log-edit-files))
36616 61f696f7e5f9 (log-edit-common-indent): New var. Stefan Monnier <monnier@iro.umontreal.ca> parents: 34652 diff changeset	406 (log-edit-set-common-indentation)
28860 40a22b85650e (cvs-changelog-full-paragraphs): Mark obsolete. Stefan Monnier <monnier@iro.umontreal.ca> parents: 28340 diff changeset	407 (goto-char (point-min))
40a22b85650e (cvs-changelog-full-paragraphs): Mark obsolete. Stefan Monnier <monnier@iro.umontreal.ca> parents: 28340 diff changeset	408 (when (looking-at "\\*\\s-+")
40a22b85650e (cvs-changelog-full-paragraphs): Mark obsolete. Stefan Monnier <monnier@iro.umontreal.ca> parents: 28340 diff changeset	409 (forward-line 1)
40a22b85650e (cvs-changelog-full-paragraphs): Mark obsolete. Stefan Monnier <monnier@iro.umontreal.ca> parents: 28340 diff changeset	410 (when (not (re-search-forward "^\\*\\s-+" nil t))
40a22b85650e (cvs-changelog-full-paragraphs): Mark obsolete. Stefan Monnier <monnier@iro.umontreal.ca> parents: 28340 diff changeset	411 (goto-char (point-min))
40a22b85650e (cvs-changelog-full-paragraphs): Mark obsolete. Stefan Monnier <monnier@iro.umontreal.ca> parents: 28340 diff changeset	412 (skip-chars-forward "^():")
29042 09b4758f4aea (log-edit-done): Cleanup trailing empty lines. Stefan Monnier <monnier@iro.umontreal.ca> parents: 28860 diff changeset	413 (skip-chars-forward ": ")
28860 40a22b85650e (cvs-changelog-full-paragraphs): Mark obsolete. Stefan Monnier <monnier@iro.umontreal.ca> parents: 28340 diff changeset	414 (delete-region (point-min) (point)))))
28088 b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	415
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	416 (defun log-edit-mode-help ()
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	417 "Provide help for the `log-edit-mode-map'."
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	418 (interactive)
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	419 (if (eq last-command 'log-edit-mode-help)
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	420 (describe-function major-mode)
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	421 (message
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	422 (substitute-command-keys
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	423 "Type `\\[log-edit-done]' to finish commit. Try `\\[describe-function] log-edit-done' for more help."))))
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	424
36616 61f696f7e5f9 (log-edit-common-indent): New var. Stefan Monnier <monnier@iro.umontreal.ca> parents: 34652 diff changeset	425 (defcustom log-edit-common-indent 0
61f696f7e5f9 (log-edit-common-indent): New var. Stefan Monnier <monnier@iro.umontreal.ca> parents: 34652 diff changeset	426 "Minimum indentation to use in `log-edit-set-common-indentation'."
61f696f7e5f9 (log-edit-common-indent): New var. Stefan Monnier <monnier@iro.umontreal.ca> parents: 34652 diff changeset	427 :group 'log-edit
61f696f7e5f9 (log-edit-common-indent): New var. Stefan Monnier <monnier@iro.umontreal.ca> parents: 34652 diff changeset	428 :type 'integer)
61f696f7e5f9 (log-edit-common-indent): New var. Stefan Monnier <monnier@iro.umontreal.ca> parents: 34652 diff changeset	429
61f696f7e5f9 (log-edit-common-indent): New var. Stefan Monnier <monnier@iro.umontreal.ca> parents: 34652 diff changeset	430 (defun log-edit-set-common-indentation ()
61f696f7e5f9 (log-edit-common-indent): New var. Stefan Monnier <monnier@iro.umontreal.ca> parents: 34652 diff changeset	431 "(Un)Indent the current buffer rigidly to `log-edit-common-indent'."
28088 b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	432 (save-excursion
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	433 (let ((common (point-max)))
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	434 (goto-char (point-min))
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	435 (while (< (point) (point-max))
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	436 (if (not (looking-at "^[ \t]*$"))
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	437 (setq common (min common (current-indentation))))
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	438 (forward-line 1))
36616 61f696f7e5f9 (log-edit-common-indent): New var. Stefan Monnier <monnier@iro.umontreal.ca> parents: 34652 diff changeset	439 (indent-rigidly (point-min) (point-max)
61f696f7e5f9 (log-edit-common-indent): New var. Stefan Monnier <monnier@iro.umontreal.ca> parents: 34652 diff changeset	440 (- log-edit-common-indent common)))))
28088 b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	441
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	442 (defun log-edit-show-files ()
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	443 "Show the list of files to be committed."
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	444 (interactive)
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	445 (let* ((files (log-edit-files))
34405 ef4ba02580f0 (log-edit-parent-buffer): New var. Stefan Monnier <monnier@iro.umontreal.ca> parents: 34304 diff changeset	446 (buf (get-buffer-create log-edit-files-buf)))
28088 b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	447 (with-current-buffer buf
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	448 (log-edit-hide-buf buf 'all)
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	449 (setq buffer-read-only nil)
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	450 (erase-buffer)
33232 abfd948c10d4 (log-edit-show-files): Use cvs-insert-strings. Stefan Monnier <monnier@iro.umontreal.ca> parents: 33180 diff changeset	451 (cvs-insert-strings files)
28088 b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	452 (setq buffer-read-only t)
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	453 (goto-char (point-min))
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	454 (save-selected-window
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	455 (cvs-pop-to-buffer-same-frame buf)
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	456 (shrink-window-if-larger-than-buffer)
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	457 (selected-window)))))
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	458
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	459 (defun log-edit-insert-cvs-template ()
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	460 "Insert the template specified by the CVS administrator, if any."
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	461 (interactive)
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	462 (when (file-readable-p "CVS/Template")
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	463 (insert-file-contents "CVS/Template")))
49597 e88404e8f2cf Trailing whitespace deleted. Juanma Barranquero <lekktu@gmail.com> parents: 40478 diff changeset	464
28088 b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	465
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	466 (defun log-edit-add-to-changelog ()
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	467 "Insert this log message into the appropriate ChangeLog file."
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	468 (interactive)
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	469 ;; Yuck!
51368 cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 51065 diff changeset	470 (unless (string= (buffer-string) (ring-ref log-edit-comment-ring 0))
cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 51065 diff changeset	471 (ring-insert log-edit-comment-ring (buffer-string)))
28088 b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	472 (dolist (f (log-edit-files))
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	473 (let ((buffer-file-name (expand-file-name f)))
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	474 (save-excursion
51368 cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring) Stefan Monnier <monnier@iro.umontreal.ca> parents: 51065 diff changeset	475 (log-edit-comment-to-change-log)))))
28088 b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	476
49597 e88404e8f2cf Trailing whitespace deleted. Juanma Barranquero <lekktu@gmail.com> parents: 40478 diff changeset	477 ;;;;
28088 b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	478 ;;;; functions for getting commit message from ChangeLog a file...
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	479 ;;;; Courtesy Jim Blandy
49597 e88404e8f2cf Trailing whitespace deleted. Juanma Barranquero <lekktu@gmail.com> parents: 40478 diff changeset	480 ;;;;
28088 b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	481
28860 40a22b85650e (cvs-changelog-full-paragraphs): Mark obsolete. Stefan Monnier <monnier@iro.umontreal.ca> parents: 28340 diff changeset	482 (defun log-edit-narrow-changelog ()
28088 b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	483 "Narrow to the top page of the current buffer, a ChangeLog file.
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	484 Actually, the narrowed region doesn't include the date line.
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	485 A \"page\" in a ChangeLog file is the area between two dates."
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	486 (or (eq major-mode 'change-log-mode)
28860 40a22b85650e (cvs-changelog-full-paragraphs): Mark obsolete. Stefan Monnier <monnier@iro.umontreal.ca> parents: 28340 diff changeset	487 (error "log-edit-narrow-changelog: current buffer isn't a ChangeLog"))
28088 b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	488
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	489 (goto-char (point-min))
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	490
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	491 ;; Skip date line and subsequent blank lines.
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	492 (forward-line 1)
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	493 (if (looking-at "[ \t\n]*\n")
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	494 (goto-char (match-end 0)))
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	495
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	496 (let ((start (point)))
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	497 (forward-page 1)
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	498 (narrow-to-region start (point))
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	499 (goto-char (point-min))))
b442dfc3cef0 * empty log message * Stefan Monnier <monnier@iro.umontreal.ca> parents: diff changeset	500

28088

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

1 ;;; log-edit.el --- Major mode for editing CVS commit messages

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

2

51063

66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 49616

diff changeset

28088

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

4

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

5 ;; Author: Stefan Monnier <monnier@cs.yale.edu>

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

6 ;; Keywords: pcl-cvs cvs commit log

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

7

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

8 ;; This file is part of GNU Emacs.

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

9

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

10 ;; GNU Emacs is free software; you can redistribute it and/or modify

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

11 ;; it under the terms of the GNU General Public License as published by

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

12 ;; the Free Software Foundation; either version 2, or (at your option)

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

13 ;; any later version.

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

14

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

15 ;; GNU Emacs is distributed in the hope that it will be useful,

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

18 ;; GNU General Public License for more details.

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

19

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

20 ;; You should have received a copy of the GNU General Public License

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

21 ;; along with GNU Emacs; see the file COPYING. If not, write to the

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

23 ;; Boston, MA 02111-1307, USA.

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

24

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

25 ;;; Commentary:

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

26

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

27 ;; Todo:

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

28

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

29 ;; - Move in VC's code

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

30 ;; - Add compatibility for VC's hook variables

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

31

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

32 ;;; Code:

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

33

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

34 (eval-when-compile (require 'cl))

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

35 (require 'add-log) ; for all the ChangeLog goodies

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

36 (require 'pcvs-util)

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

37 (require 'ring)

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

38

49597

e88404e8f2cf Trailing whitespace deleted.

Juanma Barranquero <lekktu@gmail.com>

parents: 40478

diff changeset

39 ;;;;

28088

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

40 ;;;; Global Variables

49597

e88404e8f2cf Trailing whitespace deleted.

Juanma Barranquero <lekktu@gmail.com>

parents: 40478

diff changeset

41 ;;;;

28088

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

42

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

43 (defgroup log-edit nil

32816

f4923452ea45 (log-edit): Add :version and a :group for vc.

Dave Love <fx@gnu.org>

parents: 29398

diff changeset

44 "Major mode for editing RCS and CVS commit messages."

28088

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

45 :group 'pcl-cvs

32816

f4923452ea45 (log-edit): Add :version and a :group for vc.

Dave Love <fx@gnu.org>

parents: 29398

diff changeset

46 :group 'vc ; It's used by VC.

f4923452ea45 (log-edit): Add :version and a :group for vc.

Dave Love <fx@gnu.org>

parents: 29398

diff changeset

47 :version "21.1"

28088

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

48 :prefix "log-edit-")

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

49

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

50 ;; compiler pacifiers

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

51 (defvar cvs-buffer)

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

52

51063

66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 49616

diff changeset

53

66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 49616

diff changeset

54 ;; The main keymap

66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 49616

diff changeset

55

28088

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

56 (easy-mmode-defmap log-edit-mode-map

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

57 `(("\C-c\C-c" . log-edit-done)

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

58 ("\C-c\C-a" . log-edit-insert-changelog)

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

59 ("\C-c\C-f" . log-edit-show-files)

51368

cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 51065

diff changeset

60 ("\M-n" . log-edit-next-comment)

cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 51065

diff changeset

61 ("\M-p" . log-edit-previous-comment)

cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 51065

diff changeset

62 ("\M-r" . log-edit-comment-search-backward)

cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 51065

diff changeset

63 ("\M-s" . log-edit-comment-search-forward)

51065

35933dc8e248 Don't require vc.el anymore.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 51063

diff changeset

64 ("\C-c?" . log-edit-mode-help))

34405

ef4ba02580f0 (log-edit-parent-buffer): New var.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 34304

diff changeset

65 "Keymap for the `log-edit-mode' (to edit version control log messages)."

51065

35933dc8e248 Don't require vc.el anymore.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 51063

diff changeset

66 :group 'log-edit)

35933dc8e248 Don't require vc.el anymore.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 51063

diff changeset

67

35933dc8e248 Don't require vc.el anymore.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 51063

diff changeset

68 ;; Compatibility with old names. Should we bother ?

35933dc8e248 Don't require vc.el anymore.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 51063

diff changeset

69 (defvar vc-log-mode-map log-edit-mode-map)

35933dc8e248 Don't require vc.el anymore.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 51063

diff changeset

70 (defvar vc-log-entry-mode vc-log-mode-map)

28088

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

71

33180

8700cd9cdd26 (log-edit-menu): New menu.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 33061

diff changeset

72 (easy-menu-define log-edit-menu log-edit-mode-map

8700cd9cdd26 (log-edit-menu): New menu.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 33061

diff changeset

73 "Menu used for `log-edit-mode'."

8700cd9cdd26 (log-edit-menu): New menu.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 33061

diff changeset

74 '("Log-Edit"

8700cd9cdd26 (log-edit-menu): New menu.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 33061

diff changeset

75 ["Done" log-edit-done

8700cd9cdd26 (log-edit-menu): New menu.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 33061

diff changeset

76 :help "Exit log-edit and proceed with the actual action."]

8700cd9cdd26 (log-edit-menu): New menu.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 33061

diff changeset

77 "--"

8700cd9cdd26 (log-edit-menu): New menu.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 33061

diff changeset

78 ["Insert ChangeLog" log-edit-insert-changelog]

8700cd9cdd26 (log-edit-menu): New menu.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 33061

diff changeset

79 ["Add to ChangeLog" log-edit-add-to-changelog]

8700cd9cdd26 (log-edit-menu): New menu.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 33061

diff changeset

80 "--"

8700cd9cdd26 (log-edit-menu): New menu.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 33061

diff changeset

81 ["List files" log-edit-show-files

8700cd9cdd26 (log-edit-menu): New menu.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 33061

diff changeset

82 :help "Show the list of relevant files."]

8700cd9cdd26 (log-edit-menu): New menu.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 33061

diff changeset

83 "--"

51368

cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 51065

diff changeset

84 ["Previous comment" log-edit-previous-comment]

cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 51065

diff changeset

85 ["Next comment" log-edit-next-comment]

cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 51065

diff changeset

86 ["Search comment forward" log-edit-comment-search-forward]

cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 51065

diff changeset

87 ["Search comment backward" log-edit-comment-search-backward]))

33180

8700cd9cdd26 (log-edit-menu): New menu.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 33061

diff changeset

88

33061

3cbd3cc4cc8b (log-edit-confirm): Fix the default.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 32816

diff changeset

89 (defcustom log-edit-confirm 'changed

28088

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

90 "*If non-nil, `log-edit-done' will request confirmation.

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

91 If 'changed, only request confirmation if the list of files has

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

92 changed since the beginning of the log-edit session."

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

93 :group 'log-edit

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

94 :type '(choice (const changed) (const t) (const nil)))

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

95

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

96 (defcustom log-edit-keep-buffer nil

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

97 "*If non-nil, don't hide the buffer after `log-edit-done'."

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

98 :group 'log-edit

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

99 :type 'boolean)

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

100

49616

43c9ef374660 (cvs-commit-buffer-require-final-newline, cvs-changelog-full-paragraphs): Add

Juanma Barranquero <lekktu@gmail.com>

parents: 49597

diff changeset

101 (defvar cvs-commit-buffer-require-final-newline t)

43c9ef374660 (cvs-commit-buffer-require-final-newline, cvs-changelog-full-paragraphs): Add

Juanma Barranquero <lekktu@gmail.com>

parents: 49597

diff changeset

102 (make-obsolete-variable 'cvs-commit-buffer-require-final-newline

43c9ef374660 (cvs-commit-buffer-require-final-newline, cvs-changelog-full-paragraphs): Add

Juanma Barranquero <lekktu@gmail.com>

parents: 49597

diff changeset

103 'log-edit-require-final-newline)

28088

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

104

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

105 (defcustom log-edit-require-final-newline

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

106 cvs-commit-buffer-require-final-newline

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

107 "*Enforce a newline at the end of commit log messages.

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

108 Enforce it silently if t, query if non-nil and don't do anything if nil."

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

109 :group 'log-edit

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

110 :type '(choice (const ask) (const t) (const nil)))

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

111

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

112 (defcustom log-edit-setup-invert nil

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

113 "*Non-nil means `log-edit' should invert the meaning of its SETUP arg.

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

114 If SETUP is 'force, this variable has no effect."

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

115 :group 'log-edit

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

116 :type 'boolean)

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

117

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

118 (defcustom log-edit-hook '(log-edit-insert-cvs-template

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

119 log-edit-insert-changelog)

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

120 "*Hook run at the end of `log-edit'."

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

121 :group 'log-edit

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

122 :type '(hook :options (log-edit-insert-cvs-template

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

123 log-edit-insert-changelog)))

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

124

28340

b90fe8a937ae (log-edit-mode-hook): Fix typo.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 28338

diff changeset

125 (defcustom log-edit-mode-hook (if (boundp 'vc-log-mode-hook) vc-log-mode-hook)

28088

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

126 "*Hook run when entering `log-edit-mode'."

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

127 :group 'log-edit

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

128 :type 'hook)

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

129

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

130 (defcustom log-edit-done-hook nil

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

131 "*Hook run before doing the actual commit.

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

132 This hook can be used to cleanup the message, enforce various

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

133 conventions, or to allow recording the message in some other database,

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

134 such as a bug-tracking system. The list of files about to be committed

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

135 can be obtained from `log-edit-files'."

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

136 :group 'log-edit

36616

61f696f7e5f9 (log-edit-common-indent): New var.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 34652

diff changeset

137 :type '(hook :options (log-edit-set-common-indentation

28088

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

138 log-edit-add-to-changelog)))

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

139

49616

43c9ef374660 (cvs-commit-buffer-require-final-newline, cvs-changelog-full-paragraphs): Add

Juanma Barranquero <lekktu@gmail.com>

parents: 49597

diff changeset

140 (defvar cvs-changelog-full-paragraphs t)

43c9ef374660 (cvs-commit-buffer-require-final-newline, cvs-changelog-full-paragraphs): Add

Juanma Barranquero <lekktu@gmail.com>

parents: 49597

diff changeset

141 (make-obsolete-variable 'cvs-changelog-full-paragraphs

43c9ef374660 (cvs-commit-buffer-require-final-newline, cvs-changelog-full-paragraphs): Add

Juanma Barranquero <lekktu@gmail.com>

parents: 49597

diff changeset

142 'log-edit-changelog-full-paragraphs)

28860

40a22b85650e (cvs-changelog-full-paragraphs): Mark obsolete.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 28340

diff changeset

143

40a22b85650e (cvs-changelog-full-paragraphs): Mark obsolete.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 28340

diff changeset

144 (defvar log-edit-changelog-full-paragraphs cvs-changelog-full-paragraphs

40a22b85650e (cvs-changelog-full-paragraphs): Mark obsolete.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 28340

diff changeset

145 "*If non-nil, include full ChangeLog paragraphs in the log.

28088

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

146 This may be set in the ``local variables'' section of a ChangeLog, to

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

147 indicate the policy for that ChangeLog.

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

148

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

149 A ChangeLog paragraph is a bunch of log text containing no blank lines;

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

150 a paragraph usually describes a set of changes with a single purpose,

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

151 but perhaps spanning several functions in several files. Changes in

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

152 different paragraphs are unrelated.

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

153

28860

40a22b85650e (cvs-changelog-full-paragraphs): Mark obsolete.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 28340

diff changeset

154 You could argue that the log entry for a file should contain the

28088

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

155 full ChangeLog paragraph mentioning the change to the file, even though

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

156 it may mention other files, because that gives you the full context you

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

157 need to understand the change. This is the behaviour you get when this

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

158 variable is set to t.

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

159

28860

40a22b85650e (cvs-changelog-full-paragraphs): Mark obsolete.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 28340

diff changeset

160 On the other hand, you could argue that the log entry for a change

28088

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

161 should contain only the text for the changes which occurred in that

28860

40a22b85650e (cvs-changelog-full-paragraphs): Mark obsolete.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 28340

diff changeset

162 file, because the log is per-file. This is the behaviour you get

28088

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

163 when this variable is set to nil.")

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

164

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

165 ;;;; Internal global or buffer-local vars

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

166

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

167 (defconst log-edit-files-buf "*log-edit-files*")

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

168 (defvar log-edit-initial-files nil)

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

169 (defvar log-edit-callback nil)

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

170 (defvar log-edit-listfun nil)

34405

ef4ba02580f0 (log-edit-parent-buffer): New var.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 34304

diff changeset

171 (defvar log-edit-parent-buffer nil)

28088

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

172

51368

cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 51065

diff changeset

173 ;;; Originally taken from VC-Log mode

51063

66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 49616

diff changeset

174

51368

cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 51065

diff changeset

175 (defconst log-edit-maximum-comment-ring-size 32

51063

66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 49616

diff changeset

176 "Maximum number of saved comments in the comment ring.")

51368

cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 51065

diff changeset

177 (defvar log-edit-comment-ring (make-ring log-edit-maximum-comment-ring-size))

cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 51065

diff changeset

178 (defvar log-edit-comment-ring-index nil)

cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 51065

diff changeset

179 (defvar log-edit-last-comment-match "")

51063

66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 49616

diff changeset

180

51368

cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 51065

diff changeset

181 (defun log-edit-new-comment-index (stride len)

51063

66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 49616

diff changeset

182 "Return the comment index STRIDE elements from the current one.

51368

cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 51065

diff changeset

183 LEN is the length of `log-edit-comment-ring'."

51063

66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 49616

diff changeset

184 (mod (cond

51368

cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 51065

diff changeset

185 (log-edit-comment-ring-index (+ log-edit-comment-ring-index stride))

51063

66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 49616

diff changeset

186 ;; Initialize the index on the first use of this command

66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 49616

diff changeset

187 ;; so that the first M-p gets index 0, and the first M-n gets

66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 49616

diff changeset

188 ;; index -1.

66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 49616

diff changeset

189 ((> stride 0) (1- stride))

66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 49616

diff changeset

190 (t stride))

66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 49616

diff changeset

191 len))

66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 49616

diff changeset

192

51368

cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 51065

diff changeset

193 (defun log-edit-previous-comment (arg)

51063

66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 49616

diff changeset

194 "Cycle backwards through comment history.

66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 49616

diff changeset

195 With a numeric prefix ARG, go back ARG comments."

66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 49616

diff changeset

196 (interactive "*p")

51368

cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 51065

diff changeset

197 (let ((len (ring-length log-edit-comment-ring)))

51063

66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 49616

diff changeset

198 (if (<= len 0)

66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 49616

diff changeset

199 (progn (message "Empty comment ring") (ding))

51065

35933dc8e248 Don't require vc.el anymore.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 51063

diff changeset

200 ;; Don't use `erase-buffer' because we don't want to `widen'.

35933dc8e248 Don't require vc.el anymore.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 51063

diff changeset

201 (delete-region (point-min) (point-max))

51368

cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 51065

diff changeset

202 (setq log-edit-comment-ring-index (log-edit-new-comment-index arg len))

cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 51065

diff changeset

203 (message "Comment %d" (1+ log-edit-comment-ring-index))

cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 51065

diff changeset

204 (insert (ring-ref log-edit-comment-ring log-edit-comment-ring-index)))))

51063

66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 49616

diff changeset

205

51368

cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 51065

diff changeset

206 (defun log-edit-next-comment (arg)

51063

66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 49616

diff changeset

207 "Cycle forwards through comment history.

66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 49616

diff changeset

208 With a numeric prefix ARG, go forward ARG comments."

66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 49616

diff changeset

209 (interactive "*p")

51368

cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 51065

diff changeset

210 (log-edit-previous-comment (- arg)))

51063

66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 49616

diff changeset

211

51368

cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 51065

diff changeset

212 (defun log-edit-comment-search-backward (str &optional stride)

51063

66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 49616

diff changeset

213 "Search backwards through comment history for substring match of STR.

66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 49616

diff changeset

214 If the optional argument STRIDE is present, that is a step-width to use

66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 49616

diff changeset

215 when going through the comment ring."

66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 49616

diff changeset

216 ;; Why substring rather than regexp ? -sm

66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 49616

diff changeset

217 (interactive

51368

cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 51065

diff changeset

218 (list (read-string "Comment substring: " nil nil log-edit-last-comment-match)))

51063

66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 49616

diff changeset

219 (unless stride (setq stride 1))

66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 49616

diff changeset

220 (if (string= str "")

51368

cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 51065

diff changeset

221 (setq str log-edit-last-comment-match)

cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 51065

diff changeset

222 (setq log-edit-last-comment-match str))

51063

66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 49616

diff changeset

223 (let* ((str (regexp-quote str))

51368

cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 51065

diff changeset

224 (len (ring-length log-edit-comment-ring))

cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 51065

diff changeset

225 (n (log-edit-new-comment-index stride len)))

51063

66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 49616

diff changeset

226 (while (progn (when (or (>= n len) (< n 0)) (error "Not found"))

51368

cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 51065

diff changeset

227 (not (string-match str (ring-ref log-edit-comment-ring n))))

51063

66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 49616

diff changeset

228 (setq n (+ n stride)))

51368

cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 51065

diff changeset

229 (setq log-edit-comment-ring-index n)

cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 51065

diff changeset

230 (log-edit-previous-comment 0)))

51063

66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 49616

diff changeset

231

51368

cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 51065

diff changeset

232 (defun log-edit-comment-search-forward (str)

51063

66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 49616

diff changeset

233 "Search forwards through comment history for a substring match of STR."

66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 49616

diff changeset

234 (interactive

51368

cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 51065

diff changeset

235 (list (read-string "Comment substring: " nil nil log-edit-last-comment-match)))

cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 51065

diff changeset

236 (log-edit-comment-search-backward str -1))

51063

66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 49616

diff changeset

237

51368

cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 51065

diff changeset

238 (defun log-edit-comment-to-change-log (&optional whoami file-name)

51063

66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 49616

diff changeset

239 "Enter last VC comment into the change log for the current file.

66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 49616

diff changeset

240 WHOAMI (interactive prefix) non-nil means prompt for user name

66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 49616

diff changeset

241 and site. FILE-NAME is the name of the change log; if nil, use

66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 49616

diff changeset

242 `change-log-default-name'.

66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 49616

diff changeset

243

51368

cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 51065

diff changeset

244 This may be useful as a `log-edit-checkin-hook' to update change logs

51063

66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 49616

diff changeset

245 automatically."

66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 49616

diff changeset

246 (interactive (if current-prefix-arg

66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 49616

diff changeset

247 (list current-prefix-arg

66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 49616

diff changeset

248 (prompt-for-change-log-name))))

66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 49616

diff changeset

249 (let (;; Extract the comment first so we get any error before doing anything.

51368

cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 51065

diff changeset

250 (comment (ring-ref log-edit-comment-ring 0))

51063

66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 49616

diff changeset

251 ;; Don't let add-change-log-entry insert a defun name.

66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 49616

diff changeset

252 (add-log-current-defun-function 'ignore)

66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 49616

diff changeset

253 end)

66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 49616

diff changeset

254 ;; Call add-log to do half the work.

66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 49616

diff changeset

255 (add-change-log-entry whoami file-name t t)

66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 49616

diff changeset

256 ;; Insert the VC comment, leaving point before it.

66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 49616

diff changeset

257 (setq end (save-excursion (insert comment) (point-marker)))

66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 49616

diff changeset

258 (if (looking-at "\\s *\\s(")

66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 49616

diff changeset

259 ;; It starts with an open-paren, as in "(foo): Frobbed."

66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 49616

diff changeset

260 ;; So remove the ": " add-log inserted.

66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 49616

diff changeset

261 (delete-char -2))

66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 49616

diff changeset

262 ;; Canonicalize the white space between the file name and comment.

66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 49616

diff changeset

263 (just-one-space)

66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 49616

diff changeset

264 ;; Indent rest of the text the same way add-log indented the first line.

66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 49616

diff changeset

265 (let ((indentation (current-indentation)))

66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 49616

diff changeset

266 (save-excursion

66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 49616

diff changeset

267 (while (< (point) end)

66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 49616

diff changeset

268 (forward-line 1)

66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 49616

diff changeset

269 (indent-to indentation))

66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 49616

diff changeset

270 (setq end (point))))

66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 49616

diff changeset

271 ;; Fill the inserted text, preserving open-parens at bol.

51065

35933dc8e248 Don't require vc.el anymore.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 51063

diff changeset

272 (let ((paragraph-start (concat paragraph-start "\\|\\s *\\s(")))

51063

66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 49616

diff changeset

273 (beginning-of-line)

66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 49616

diff changeset

274 (fill-region (point) end))

66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 49616

diff changeset

275 ;; Canonicalize the white space at the end of the entry so it is

66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 49616

diff changeset

276 ;; separated from the next entry by a single blank line.

66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 49616

diff changeset

277 (skip-syntax-forward " " end)

66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 49616

diff changeset

278 (delete-char (- (skip-syntax-backward " ")))

66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 49616

diff changeset

279 (or (eobp) (looking-at "\n\n")

66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 49616

diff changeset

280 (insert "\n"))))

66dd7f2dd70a (vc-log-mode-map, vc-maximum-comment-ring-size, vc-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 49616

diff changeset

281

51368

cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 51065

diff changeset

282 ;; Compatibility with old names.

cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 51065

diff changeset

283 (defvaralias 'vc-comment-ring 'log-edit-comment-ring)

cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 51065

diff changeset

284 (make-obsolete-variable 'vc-comment-ring 'log-edit-comment-ring "21.5")

cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 51065

diff changeset

285 (defvaralias 'vc-comment-ring-index 'log-edit-comment-ring-index)

cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 51065

diff changeset

286 (make-obsolete-variable 'vc-comment-ring-index 'log-edit-comment-ring-index "21.5")

cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 51065

diff changeset

287 (defalias 'vc-previous-comment 'log-edit-previous-comment)

cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 51065

diff changeset

288 (make-obsolete 'vc-previous-comment 'log-edit-previous-comment "21.5")

cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 51065

diff changeset

289 (defalias 'vc-next-comment 'log-edit-next-comment)

cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 51065

diff changeset

290 (make-obsolete 'vc-next-comment 'log-edit-next-comment "21.5")

cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 51065

diff changeset

291 (defalias 'vc-comment-search-reverse 'log-edit-comment-search-backward)

cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 51065

diff changeset

292 (make-obsolete 'vc-comment-search-reverse 'log-edit-comment-search-backward "21.5")

cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 51065

diff changeset

293 (defalias 'vc-comment-search-forward 'log-edit-comment-search-forward)

cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 51065

diff changeset

294 (make-obsolete 'vc-comment-search-forward 'log-edit-comment-search-forward "21.5")

cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 51065

diff changeset

295 (defalias 'vc-comment-to-change-log 'log-edit-comment-to-change-log)

cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 51065

diff changeset

296 (make-obsolete 'vc-comment-to-change-log 'log-edit-comment-to-change-log "21.5")

cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 51065

diff changeset

297

34405

ef4ba02580f0 (log-edit-parent-buffer): New var.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 34304

diff changeset

298 ;;;

ef4ba02580f0 (log-edit-parent-buffer): New var.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 34304

diff changeset

299 ;;; Actual code

ef4ba02580f0 (log-edit-parent-buffer): New var.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 34304

diff changeset

300 ;;;

28088

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

301

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

302 ;;;###autoload

34405

ef4ba02580f0 (log-edit-parent-buffer): New var.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 34304

diff changeset

303 (defun log-edit (callback &optional setup listfun buffer &rest ignore)

28088

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

304 "Setup a buffer to enter a log message.

33061

3cbd3cc4cc8b (log-edit-confirm): Fix the default.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 32816

diff changeset

305 \\<log-edit-mode-map>The buffer will be put in `log-edit-mode'.

28088

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

306 If SETUP is non-nil, the buffer is then erased and `log-edit-hook' is run.

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

307 Mark and point will be set around the entire contents of the

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

308 buffer so that it is easy to kill the contents of the buffer with \\[kill-region].

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

309 Once you're done editing the message, pressing \\[log-edit-done] will call

34405

ef4ba02580f0 (log-edit-parent-buffer): New var.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 34304

diff changeset

310 `log-edit-done' which will end up calling CALLBACK to do the actual commit.

ef4ba02580f0 (log-edit-parent-buffer): New var.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 34304

diff changeset

311 LISTFUN if non-nil is a function of no arguments returning the list of files

ef4ba02580f0 (log-edit-parent-buffer): New var.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 34304

diff changeset

312 that are concerned by the current operation (using relative names).

ef4ba02580f0 (log-edit-parent-buffer): New var.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 34304

diff changeset

313 If BUFFER is non-nil `log-edit' will jump to that buffer, use it to edit the

ef4ba02580f0 (log-edit-parent-buffer): New var.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 34304

diff changeset

314 log message and go back to the current buffer when done. Otherwise, it

ef4ba02580f0 (log-edit-parent-buffer): New var.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 34304

diff changeset

315 uses the current buffer."

ef4ba02580f0 (log-edit-parent-buffer): New var.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 34304

diff changeset

316 (let ((parent (current-buffer)))

ef4ba02580f0 (log-edit-parent-buffer): New var.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 34304

diff changeset

317 (if buffer (pop-to-buffer buffer))

ef4ba02580f0 (log-edit-parent-buffer): New var.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 34304

diff changeset

318 (when (and log-edit-setup-invert (not (eq setup 'force)))

ef4ba02580f0 (log-edit-parent-buffer): New var.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 34304

diff changeset

319 (setq setup (not setup)))

ef4ba02580f0 (log-edit-parent-buffer): New var.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 34304

diff changeset

320 (when setup (erase-buffer))

ef4ba02580f0 (log-edit-parent-buffer): New var.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 34304

diff changeset

321 (log-edit-mode)

ef4ba02580f0 (log-edit-parent-buffer): New var.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 34304

diff changeset

322 (set (make-local-variable 'log-edit-callback) callback)

ef4ba02580f0 (log-edit-parent-buffer): New var.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 34304

diff changeset

323 (set (make-local-variable 'log-edit-listfun) listfun)

ef4ba02580f0 (log-edit-parent-buffer): New var.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 34304

diff changeset

324 (if buffer (set (make-local-variable 'log-edit-parent-buffer) parent))

40478

4d0323a1ed72 (log-edit): Run hook after `log-edit-files'.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 37694

diff changeset

325 (set (make-local-variable 'log-edit-initial-files) (log-edit-files))

34405

ef4ba02580f0 (log-edit-parent-buffer): New var.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 34304

diff changeset

326 (when setup (run-hooks 'log-edit-hook))

ef4ba02580f0 (log-edit-parent-buffer): New var.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 34304

diff changeset

327 (goto-char (point-min)) (push-mark (point-max))

ef4ba02580f0 (log-edit-parent-buffer): New var.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 34304

diff changeset

328 (message (substitute-command-keys

ef4ba02580f0 (log-edit-parent-buffer): New var.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 34304

diff changeset

329 "Press \\[log-edit-done] when you are done editing."))))

28088

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

330

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

331 (define-derived-mode log-edit-mode text-mode "Log-Edit"

28338

8da42323f5d5 (log-edit-mode-map): Inherit from vc-log-mode-map

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 28088

diff changeset

332 "Major mode for editing version-control log messages.

8da42323f5d5 (log-edit-mode-map): Inherit from vc-log-mode-map

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 28088

diff changeset

333 When done editing the log entry, just type \\[log-edit-done] which

8da42323f5d5 (log-edit-mode-map): Inherit from vc-log-mode-map

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 28088

diff changeset

334 will trigger the actual commit of the file(s).

8da42323f5d5 (log-edit-mode-map): Inherit from vc-log-mode-map

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 28088

diff changeset

335 Several other handy support commands are provided of course and

8da42323f5d5 (log-edit-mode-map): Inherit from vc-log-mode-map

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 28088

diff changeset

336 the package from which this is used might also provide additional

8da42323f5d5 (log-edit-mode-map): Inherit from vc-log-mode-map

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 28088

diff changeset

337 commands (under C-x v for VC, for example).

8da42323f5d5 (log-edit-mode-map): Inherit from vc-log-mode-map

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 28088

diff changeset

338

29375

429ae71326c2 (log-edit-mode): Make vc-comment-ring-index local.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 29042

diff changeset

339 \\{log-edit-mode-map}"

51368

cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 51065

diff changeset

340 (make-local-variable 'log-edit-comment-ring-index))

28088

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

341

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

342 (defun log-edit-hide-buf (&optional buf where)

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

343 (when (setq buf (get-buffer (or buf log-edit-files-buf)))

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

344 (let ((win (get-buffer-window buf where)))

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

345 (if win (ignore-errors (delete-window win))))

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

346 (bury-buffer buf)))

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

347

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

348 (defun log-edit-done ()

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

349 "Finish editing the log message and commit the files.

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

350 If you want to abort the commit, simply delete the buffer."

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

351 (interactive)

29042

09b4758f4aea (log-edit-done): Cleanup trailing empty lines.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 28860

diff changeset

352 ;; Get rid of trailing empty lines

09b4758f4aea (log-edit-done): Cleanup trailing empty lines.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 28860

diff changeset

353 (goto-char (point-max))

09b4758f4aea (log-edit-done): Cleanup trailing empty lines.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 28860

diff changeset

354 (skip-syntax-backward " ")

09b4758f4aea (log-edit-done): Cleanup trailing empty lines.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 28860

diff changeset

355 (when (equal (char-after) ?\n) (forward-char 1))

09b4758f4aea (log-edit-done): Cleanup trailing empty lines.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 28860

diff changeset

356 (delete-region (point) (point-max))

09b4758f4aea (log-edit-done): Cleanup trailing empty lines.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 28860

diff changeset

357 ;; Check for final newline

34405

ef4ba02580f0 (log-edit-parent-buffer): New var.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 34304

diff changeset

358 (if (and (> (point-max) (point-min))

ef4ba02580f0 (log-edit-parent-buffer): New var.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 34304

diff changeset

359 (/= (char-before (point-max)) ?\n)

28088

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

360 (or (eq log-edit-require-final-newline t)

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

361 (and log-edit-require-final-newline

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

362 (y-or-n-p

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

363 (format "Buffer %s does not end in newline. Add one? "

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

364 (buffer-name))))))

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

365 (save-excursion

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

366 (goto-char (point-max))

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

367 (insert ?\n)))

29375

429ae71326c2 (log-edit-mode): Make vc-comment-ring-index local.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 29042

diff changeset

368 (let ((comment (buffer-string)))

51368

cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 51065

diff changeset

369 (when (or (ring-empty-p log-edit-comment-ring)

cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 51065

diff changeset

370 (not (equal comment (ring-ref log-edit-comment-ring 0))))

cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 51065

diff changeset

371 (ring-insert log-edit-comment-ring comment)))

28088

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

372 (let ((win (get-buffer-window log-edit-files-buf)))

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

373 (if (and log-edit-confirm

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

374 (not (and (eq log-edit-confirm 'changed)

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

375 (equal (log-edit-files) log-edit-initial-files)))

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

376 (progn

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

377 (log-edit-show-files)

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

378 (not (y-or-n-p "Really commit ? "))))

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

379 (progn (when (not win) (log-edit-hide-buf))

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

380 (message "Oh, well! Later maybe?"))

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

381 (run-hooks 'log-edit-done-hook)

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

382 (log-edit-hide-buf)

34405

ef4ba02580f0 (log-edit-parent-buffer): New var.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 34304

diff changeset

383 (unless (or log-edit-keep-buffer (not log-edit-parent-buffer))

ef4ba02580f0 (log-edit-parent-buffer): New var.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 34304

diff changeset

384 (cvs-bury-buffer (current-buffer) log-edit-parent-buffer))

28088

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

385 (call-interactively log-edit-callback))))

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

386

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

387 (defun log-edit-files ()

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

388 "Return the list of files that are about to be committed."

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

389 (ignore-errors (funcall log-edit-listfun)))

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

390

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

391

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

392 (defun log-edit-insert-changelog ()

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

393 "Insert a log message by looking at the ChangeLog.

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

394 The idea is to write your ChangeLog entries first, and then use this

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

395 command to commit your changes.

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

396

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

397 To select default log text, we:

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

398 - find the ChangeLog entries for the files to be checked in,

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

399 - verify that the top entry in the ChangeLog is on the current date

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

400 and by the current user; if not, we don't provide any default text,

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

401 - search the ChangeLog entry for paragraphs containing the names of

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

402 the files we're checking in, and finally

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

403 - use those paragraphs as the log text."

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

404 (interactive)

28860

40a22b85650e (cvs-changelog-full-paragraphs): Mark obsolete.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 28340

diff changeset

405 (log-edit-insert-changelog-entries (log-edit-files))

36616

61f696f7e5f9 (log-edit-common-indent): New var.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 34652

diff changeset

406 (log-edit-set-common-indentation)

28860

40a22b85650e (cvs-changelog-full-paragraphs): Mark obsolete.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 28340

diff changeset

407 (goto-char (point-min))

40a22b85650e (cvs-changelog-full-paragraphs): Mark obsolete.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 28340

diff changeset

408 (when (looking-at "\\*\\s-+")

40a22b85650e (cvs-changelog-full-paragraphs): Mark obsolete.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 28340

diff changeset

409 (forward-line 1)

40a22b85650e (cvs-changelog-full-paragraphs): Mark obsolete.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 28340

diff changeset

410 (when (not (re-search-forward "^\\*\\s-+" nil t))

40a22b85650e (cvs-changelog-full-paragraphs): Mark obsolete.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 28340

diff changeset

411 (goto-char (point-min))

40a22b85650e (cvs-changelog-full-paragraphs): Mark obsolete.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 28340

diff changeset

412 (skip-chars-forward "^():")

29042

09b4758f4aea (log-edit-done): Cleanup trailing empty lines.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 28860

diff changeset

413 (skip-chars-forward ": ")

28860

40a22b85650e (cvs-changelog-full-paragraphs): Mark obsolete.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 28340

diff changeset

414 (delete-region (point-min) (point)))))

28088

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

415

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

416 (defun log-edit-mode-help ()

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

417 "Provide help for the `log-edit-mode-map'."

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

418 (interactive)

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

419 (if (eq last-command 'log-edit-mode-help)

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

420 (describe-function major-mode)

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

421 (message

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

422 (substitute-command-keys

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

423 "Type `\\[log-edit-done]' to finish commit. Try `\\[describe-function] log-edit-done' for more help."))))

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

424

36616

61f696f7e5f9 (log-edit-common-indent): New var.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 34652

diff changeset

425 (defcustom log-edit-common-indent 0

61f696f7e5f9 (log-edit-common-indent): New var.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 34652

diff changeset

426 "Minimum indentation to use in `log-edit-set-common-indentation'."

61f696f7e5f9 (log-edit-common-indent): New var.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 34652

diff changeset

427 :group 'log-edit

61f696f7e5f9 (log-edit-common-indent): New var.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 34652

diff changeset

428 :type 'integer)

61f696f7e5f9 (log-edit-common-indent): New var.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 34652

diff changeset

429

61f696f7e5f9 (log-edit-common-indent): New var.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 34652

diff changeset

430 (defun log-edit-set-common-indentation ()

61f696f7e5f9 (log-edit-common-indent): New var.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 34652

diff changeset

431 "(Un)Indent the current buffer rigidly to `log-edit-common-indent'."

28088

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

432 (save-excursion

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

433 (let ((common (point-max)))

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

434 (goto-char (point-min))

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

435 (while (< (point) (point-max))

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

436 (if (not (looking-at "^[ \t]*$"))

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

437 (setq common (min common (current-indentation))))

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

438 (forward-line 1))

36616

61f696f7e5f9 (log-edit-common-indent): New var.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 34652

diff changeset

439 (indent-rigidly (point-min) (point-max)

61f696f7e5f9 (log-edit-common-indent): New var.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 34652

diff changeset

440 (- log-edit-common-indent common)))))

28088

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

441

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

442 (defun log-edit-show-files ()

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

443 "Show the list of files to be committed."

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

444 (interactive)

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

445 (let* ((files (log-edit-files))

34405

ef4ba02580f0 (log-edit-parent-buffer): New var.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 34304

diff changeset

446 (buf (get-buffer-create log-edit-files-buf)))

28088

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

447 (with-current-buffer buf

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

448 (log-edit-hide-buf buf 'all)

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

449 (setq buffer-read-only nil)

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

450 (erase-buffer)

33232

abfd948c10d4 (log-edit-show-files): Use cvs-insert-strings.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 33180

diff changeset

451 (cvs-insert-strings files)

28088

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

452 (setq buffer-read-only t)

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

453 (goto-char (point-min))

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

454 (save-selected-window

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

455 (cvs-pop-to-buffer-same-frame buf)

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

456 (shrink-window-if-larger-than-buffer)

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

457 (selected-window)))))

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

458

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

459 (defun log-edit-insert-cvs-template ()

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

460 "Insert the template specified by the CVS administrator, if any."

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

461 (interactive)

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

462 (when (file-readable-p "CVS/Template")

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

463 (insert-file-contents "CVS/Template")))

49597

e88404e8f2cf Trailing whitespace deleted.

Juanma Barranquero <lekktu@gmail.com>

parents: 40478

diff changeset

464

28088

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

465

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

466 (defun log-edit-add-to-changelog ()

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

467 "Insert this log message into the appropriate ChangeLog file."

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

468 (interactive)

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

469 ;; Yuck!

51368

cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 51065

diff changeset

470 (unless (string= (buffer-string) (ring-ref log-edit-comment-ring 0))

cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 51065

diff changeset

471 (ring-insert log-edit-comment-ring (buffer-string)))

28088

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

472 (dolist (f (log-edit-files))

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

473 (let ((buffer-file-name (expand-file-name f)))

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

474 (save-excursion

51368

cc73795bc08a (log-edit-maximum-comment-ring-size, log-edit-comment-ring)

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 51065

diff changeset

475 (log-edit-comment-to-change-log)))))

28088

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

476

49597

e88404e8f2cf Trailing whitespace deleted.

Juanma Barranquero <lekktu@gmail.com>

parents: 40478

diff changeset

477 ;;;;

28088

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

478 ;;;; functions for getting commit message from ChangeLog a file...

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

479 ;;;; Courtesy Jim Blandy

49597

e88404e8f2cf Trailing whitespace deleted.

Juanma Barranquero <lekktu@gmail.com>

parents: 40478

diff changeset

480 ;;;;

28088

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

481

28860

40a22b85650e (cvs-changelog-full-paragraphs): Mark obsolete.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 28340

diff changeset

482 (defun log-edit-narrow-changelog ()

28088

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

483 "Narrow to the top page of the current buffer, a ChangeLog file.

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

484 Actually, the narrowed region doesn't include the date line.

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

485 A \"page\" in a ChangeLog file is the area between two dates."

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

486 (or (eq major-mode 'change-log-mode)

28860

40a22b85650e (cvs-changelog-full-paragraphs): Mark obsolete.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 28340

diff changeset

487 (error "log-edit-narrow-changelog: current buffer isn't a ChangeLog"))

28088

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

488

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

489 (goto-char (point-min))

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

490

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

491 ;; Skip date line and subsequent blank lines.

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

492 (forward-line 1)

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

493 (if (looking-at "[ \t\n]*\n")

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

494 (goto-char (match-end 0)))

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

495

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

496 (let ((start (point)))

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

497 (forward-page 1)

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

498 (narrow-to-region start (point))

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

499 (goto-char (point-min))))

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

500

28860

40a22b85650e (cvs-changelog-full-paragraphs): Mark obsolete.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 28340

diff changeset

501 (defun log-edit-changelog-paragraph ()

28088

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

502 "Return the bounds of the ChangeLog paragraph containing point.

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

503 If we are between paragraphs, return the previous paragraph."

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

504 (save-excursion

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

505 (beginning-of-line)

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

506 (if (looking-at "^[ \t]*$")

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

507 (skip-chars-backward " \t\n" (point-min)))

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

508 (list (progn

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

509 (if (re-search-backward "^[ \t]*\n" nil 'or-to-limit)

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

510 (goto-char (match-end 0)))

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

511 (point))

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

512 (if (re-search-forward "^[ \t\n]*$" nil t)

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

513 (match-beginning 0)

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

514 (point)))))

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

515

28860

40a22b85650e (cvs-changelog-full-paragraphs): Mark obsolete.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 28340

diff changeset

516 (defun log-edit-changelog-subparagraph ()

28088

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

517 "Return the bounds of the ChangeLog subparagraph containing point.

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

518 A subparagraph is a block of non-blank lines beginning with an asterisk.

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

519 If we are between sub-paragraphs, return the previous subparagraph."

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

520 (save-excursion

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

521 (end-of-line)

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

522 (if (search-backward "*" nil t)

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

523 (list (progn (beginning-of-line) (point))

32816

f4923452ea45 (log-edit): Add :version and a :group for vc.

Dave Love <fx@gnu.org>

parents: 29398

diff changeset

524 (progn

28088

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

525 (forward-line 1)

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

526 (if (re-search-forward "^[ \t]*[\n*]" nil t)

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

527 (match-beginning 0)

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

528 (point-max))))

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

529 (list (point) (point)))))

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

530

28860

40a22b85650e (cvs-changelog-full-paragraphs): Mark obsolete.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 28340

diff changeset

531 (defun log-edit-changelog-entry ()

28088

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

532 "Return the bounds of the ChangeLog entry containing point.

28860

40a22b85650e (cvs-changelog-full-paragraphs): Mark obsolete.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 28340

diff changeset

533 The variable `log-edit-changelog-full-paragraphs' decides whether an

28088

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

534 \"entry\" is a paragraph or a subparagraph; see its documentation string

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

535 for more details."

28860

40a22b85650e (cvs-changelog-full-paragraphs): Mark obsolete.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 28340

diff changeset

536 (if log-edit-changelog-full-paragraphs

40a22b85650e (cvs-changelog-full-paragraphs): Mark obsolete.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 28340

diff changeset

537 (log-edit-changelog-paragraph)

40a22b85650e (cvs-changelog-full-paragraphs): Mark obsolete.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 28340

diff changeset

538 (log-edit-changelog-subparagraph)))

28088

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

539

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

540 (defvar user-full-name)

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

541 (defvar user-mail-address)

28860

40a22b85650e (cvs-changelog-full-paragraphs): Mark obsolete.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 28340

diff changeset

542 (defun log-edit-changelog-ours-p ()

28088

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

543 "See if ChangeLog entry at point is for the current user, today.

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

544 Return non-nil iff it is."

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

545 ;; Code adapted from add-change-log-entry.

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

546 (let ((name (or (and (boundp 'add-log-full-name) add-log-full-name)

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

547 (and (fboundp 'user-full-name) (user-full-name))

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

548 (and (boundp 'user-full-name) user-full-name)))

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

549 (mail (or (and (boundp 'add-log-mailing-address) add-log-mailing-address)

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

550 ;;(and (fboundp 'user-mail-address) (user-mail-address))

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

551 (and (boundp 'user-mail-address) user-mail-address)))

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

552 (time (or (and (boundp 'add-log-time-format)

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

553 (functionp add-log-time-format)

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

554 (funcall add-log-time-format))

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

555 (format-time-string "%Y-%m-%d"))))

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

556 (looking-at (regexp-quote (format "%s %s <%s>" time name mail)))))

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

557

28860

40a22b85650e (cvs-changelog-full-paragraphs): Mark obsolete.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 28340

diff changeset

558 (defun log-edit-changelog-entries (file)

28088

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

559 "Return the ChangeLog entries for FILE, and the ChangeLog they came from.

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

560 The return value looks like this:

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

561 (LOGBUFFER (ENTRYSTART . ENTRYEND) ...)

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

562 where LOGBUFFER is the name of the ChangeLog buffer, and each

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

563 $ENTRYSTART . ENTRYEND$ pair is a buffer region."

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

564 (save-excursion

32816

f4923452ea45 (log-edit): Add :version and a :group for vc.

Dave Love <fx@gnu.org>

parents: 29398

diff changeset

565 (let ((changelog-file-name

28088

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

566 (let ((default-directory

52791

2ea08fedb58f (log-edit-changelog-entries): Prefer local value of

Andreas Schwab <schwab@suse.de>

parents: 52401

diff changeset

567 (file-name-directory (expand-file-name file)))

2ea08fedb58f (log-edit-changelog-entries): Prefer local value of

Andreas Schwab <schwab@suse.de>

parents: 52401

diff changeset

568 (visiting-buffer (find-buffer-visiting file)))

2ea08fedb58f (log-edit-changelog-entries): Prefer local value of

Andreas Schwab <schwab@suse.de>

parents: 52401

diff changeset

569 ;; If there is a buffer visiting FILE, and it has a local

2ea08fedb58f (log-edit-changelog-entries): Prefer local value of

Andreas Schwab <schwab@suse.de>

parents: 52401

diff changeset

570 ;; value for `change-log-default-name', use that.

2ea08fedb58f (log-edit-changelog-entries): Prefer local value of

Andreas Schwab <schwab@suse.de>

parents: 52401

diff changeset

571 (if (and visiting-buffer

2ea08fedb58f (log-edit-changelog-entries): Prefer local value of

Andreas Schwab <schwab@suse.de>

parents: 52401

diff changeset

572 (local-variable-p 'change-log-default-name

2ea08fedb58f (log-edit-changelog-entries): Prefer local value of

Andreas Schwab <schwab@suse.de>

parents: 52401

diff changeset

573 visiting-buffer))

2ea08fedb58f (log-edit-changelog-entries): Prefer local value of

Andreas Schwab <schwab@suse.de>

parents: 52401

diff changeset

574 (save-excursion

2ea08fedb58f (log-edit-changelog-entries): Prefer local value of

Andreas Schwab <schwab@suse.de>

parents: 52401

diff changeset

575 (set-buffer visiting-buffer)

2ea08fedb58f (log-edit-changelog-entries): Prefer local value of

Andreas Schwab <schwab@suse.de>

parents: 52401

diff changeset

576 change-log-default-name)

2ea08fedb58f (log-edit-changelog-entries): Prefer local value of

Andreas Schwab <schwab@suse.de>

parents: 52401

diff changeset

577 ;; `find-change-log' uses `change-log-default-name' if set

2ea08fedb58f (log-edit-changelog-entries): Prefer local value of

Andreas Schwab <schwab@suse.de>

parents: 52401

diff changeset

578 ;; and sets it before exiting, so we need to work around

2ea08fedb58f (log-edit-changelog-entries): Prefer local value of

Andreas Schwab <schwab@suse.de>

parents: 52401

diff changeset

579 ;; that memoizing which is undesired here

2ea08fedb58f (log-edit-changelog-entries): Prefer local value of

Andreas Schwab <schwab@suse.de>

parents: 52401

diff changeset

580 (setq change-log-default-name nil)

2ea08fedb58f (log-edit-changelog-entries): Prefer local value of

Andreas Schwab <schwab@suse.de>

parents: 52401

diff changeset

581 (find-change-log)))))

28088

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

582 (set-buffer (find-file-noselect changelog-file-name))

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

583 (unless (eq major-mode 'change-log-mode) (change-log-mode))

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

584 (goto-char (point-min))

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

585 (if (looking-at "\\s-*\n") (goto-char (match-end 0)))

28860

40a22b85650e (cvs-changelog-full-paragraphs): Mark obsolete.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 28340

diff changeset

586 (if (not (log-edit-changelog-ours-p))

28088

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

587 (list (current-buffer))

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

588 (save-restriction

28860

40a22b85650e (cvs-changelog-full-paragraphs): Mark obsolete.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 28340

diff changeset

589 (log-edit-narrow-changelog)

28088

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

590 (goto-char (point-min))

49597

e88404e8f2cf Trailing whitespace deleted.

Juanma Barranquero <lekktu@gmail.com>

parents: 40478

diff changeset

591

28088

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

592 ;; Search for the name of FILE relative to the ChangeLog. If that

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

593 ;; doesn't occur anywhere, they're not using full relative

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

594 ;; filenames in the ChangeLog, so just look for FILE; we'll accept

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

595 ;; some false positives.

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

596 (let ((pattern (file-relative-name

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

597 file (file-name-directory changelog-file-name))))

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

598 (if (or (string= pattern "")

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

599 (not (save-excursion

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

600 (search-forward pattern nil t))))

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

601 (setq pattern (file-name-nondirectory file)))

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

602

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

603 (let (texts)

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

604 (while (search-forward pattern nil t)

28860

40a22b85650e (cvs-changelog-full-paragraphs): Mark obsolete.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 28340

diff changeset

605 (let ((entry (log-edit-changelog-entry)))

28088

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

606 (push entry texts)

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

607 (goto-char (elt entry 1))))

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

608

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

609 (cons (current-buffer) texts))))))))

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

610

28860

40a22b85650e (cvs-changelog-full-paragraphs): Mark obsolete.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 28340

diff changeset

611 (defun log-edit-changelog-insert-entries (buffer regions)

28088

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

612 "Insert those regions in BUFFER specified in REGIONS.

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

613 Sort REGIONS front-to-back first."

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

614 (let ((regions (sort regions 'car-less-than-car))

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

615 (last))

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

616 (dolist (region regions)

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

617 (when (and last (< last (car region))) (newline))

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

618 (setq last (elt region 1))

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

619 (apply 'insert-buffer-substring buffer region))))

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

620

28860

40a22b85650e (cvs-changelog-full-paragraphs): Mark obsolete.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 28340

diff changeset

621 (defun log-edit-insert-changelog-entries (files)

28088

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

622 "Given a list of files FILES, insert the ChangeLog entries for them."

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

623 (let ((buffer-entries nil))

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

624

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

625 ;; Add each buffer to buffer-entries, and associate it with the list

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

626 ;; of entries we want from that file.

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

627 (dolist (file files)

28860

40a22b85650e (cvs-changelog-full-paragraphs): Mark obsolete.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 28340

diff changeset

628 (let* ((entries (log-edit-changelog-entries file))

28088

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

629 (pair (assq (car entries) buffer-entries)))

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

630 (if pair

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

631 (setcdr pair (cvs-union (cdr pair) (cdr entries)))

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

632 (push entries buffer-entries))))

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

633

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

634 ;; Now map over each buffer in buffer-entries, sort the entries for

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

635 ;; each buffer, and extract them as strings.

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

636 (dolist (buffer-entry buffer-entries)

28860

40a22b85650e (cvs-changelog-full-paragraphs): Mark obsolete.

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 28340

diff changeset

637 (log-edit-changelog-insert-entries (car buffer-entry) (cdr buffer-entry))

28088

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

638 (when (cdr buffer-entry) (newline)))))

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

639

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

640 (provide 'log-edit)

28338

8da42323f5d5 (log-edit-mode-map): Inherit from vc-log-mode-map

Stefan Monnier <monnier@iro.umontreal.ca>

parents: 28088

diff changeset

641

52401

695cf19ef79e Add arch taglines

Miles Bader <miles@gnu.org>

parents: 51368

diff changeset

642 ;;; arch-tag: 8089b39c-983b-4e83-93cd-ed0a64c7fdcc

28088

b442dfc3cef0 *** empty log message ***

Stefan Monnier <monnier@iro.umontreal.ca>

parents:

diff changeset

643 ;;; log-edit.el ends here

Mercurial > emacs

annotate lisp/log-edit.el @ 54236:418982e727f9