[2843] in Release_Engineering

home help back first fref pref prev next nref lref last post

Documentation fixes to discuss.el

daemon@ATHENA.MIT.EDU (Theodore Ts'o)
Fri May 29 14:29:03 1992

Date: Fri, 29 May 92 14:28:36 -0400
From: tytso@Athena.MIT.EDU (Theodore Ts'o)
To: rel-eng@Athena.MIT.EDU
Reply-To: tytso@Athena.MIT.EDU

What follows is a patch file to discuss.el, which fixes some
documentation problems in the file.  The RCS change log from the discuss
sources reads:

; Revision 2.8  92/05/16  01:12:57  srz
; Documentation fixes, as suggested by rjbarbal.  Also gratuitous "." at the
; end of documentation strings.  We must be GC (grammatically correct).

Only the documentation strings have been modified; no emacs-lisp code
should be affected by this patch.

After this patch, the substantive difference between the discuss source
tree and the athena tree is a patch in discuss-misc.el which fixes a
minor bug in discuss-add-mtg which is currently not in the Athena tree.
This patch fixes a minor bug in discuss-add-mtg.  The RCS change log
from that reads:

revision 1.8
date: 1992/04/18 07:39:18;  author: tytso;  state: Exp;  lines: +9 -5
Merged in Calvin's patch so that both the long and and the short name
of a meeting is added to the completion list when it is added

						- Ted

P.S.  When you apply this patch, you will need to apply it -R, since it
was created by taking diff file and editing it.  I've tested it and it
does the right thing, though.

*** ./discuss.el	Fri May 29 13:16:46 1992
--- /source/athena/athena.bin/discuss/edsc/discuss.el	Thu Apr 16 14:28:33 1992
***************
*** 204,220 ****
  discuss-delete-trn.")
  
  (defvar discuss-mtgs-mode-map nil
!   "Keymap used by the meetings-list mode of the discuss subsystem.")
  
  (defvar discuss-list-mode-map nil
!   "Keymap used by the transaction-list mode of the discuss subsystem.")
  
  (defvar discuss-trn-mode-map nil
!   "Keymap used by the transaction mode of the discuss subsystem.")
  
  (defvar discuss-main-buffer "*meetings*"
    "Name of main buffer for discuss, which holds a list of the current
! meetings.")
  
  (defvar discuss-version nil "Version of discuss code loaded.")
  (defun discuss-version nil (interactive) (message discuss-version))
--- 159,175 ----
  discuss-delete-trn.")
  
  (defvar discuss-mtgs-mode-map nil
!   "Keymap used by the meetings-list mode of the discuss subsystem")
  
  (defvar discuss-list-mode-map nil
!   "Keymap used by the transaction-list mode of the discuss subsystem")
  
  (defvar discuss-trn-mode-map nil
!   "Keymap used by the transaction mode of the discuss subsystem")
  
  (defvar discuss-main-buffer "*meetings*"
    "Name of main buffer for discuss, which holds a list of the current
! meetings")
  
  (defvar discuss-version nil "Version of discuss code loaded.")
  (defun discuss-version nil (interactive) (message discuss-version))
***************
*** 229,235 ****
    "Internal hook to call when discuss subprocess returns an error.")
  
  (defvar discuss-in-progress nil
!   "t if a request to the slave subprocess is outstanding.")
  
  (defvar discuss-form nil
    "Lisp form returned by the subprocess.")
--- 184,190 ----
    "Internal hook to call when discuss subprocess returns an error.")
  
  (defvar discuss-in-progress nil
!   "t if a request to the slave subprocess is outstanding")
  
  (defvar discuss-form nil
    "Lisp form returned by the subprocess.")
***************
*** 238,247 ****
    "Meeting list.")
  
  (defvar discuss-meeting-completion-list nil
!   "Meeting list changed into the right format for completion-read.")
  
  (defvar discuss-show-num 0
!   "Current discuss transaction number.")
  
  (defvar discuss-meeting nil
    "Buffer-local variable containing the name of the meeting of a discuss
--- 193,202 ----
    "Meeting list.")
  
  (defvar discuss-meeting-completion-list nil
!   "Meeting list changed into the right format for completion-read")
  
  (defvar discuss-show-num 0
!   "Current discuss transaction number")
  
  (defvar discuss-meeting nil
    "Buffer-local variable containing the name of the meeting of a discuss
***************
*** 253,262 ****
  transaction buffer.")
  
  (defvar discuss-cur-mtg-buf nil
!   "Name of buffer for current Discuss meeting.")
  
  (defvar discuss-cur-direction 0
!   "Current discuss direction.")
  
  (defvar discuss-async t
    "*Run discuss commands asynchronously.
--- 208,217 ----
  transaction buffer.")
  
  (defvar discuss-cur-mtg-buf nil
!   "Name of buffer for current Discuss meeting")
  
  (defvar discuss-cur-direction 0
!   "Current discuss direction")
  
  (defvar discuss-async t
    "*Run discuss commands asynchronously.
***************
*** 269,274 ****
--- 224,232 ----
    "Contains error message returned by edsc process.  If nil, means last 
  request completed successfully.")
  
+ (defvar discuss-pathname "/usr/athena/etc/edsc"
+   "*Name of program to run as slave process for discuss.")
+ 
  
  ;;; Major modes defined by this package.
  
***************
*** 279,288 ****
  This looks a lot like RMAIL.  This works by using ``edsc'' as a subjob.
  
  The following commands are available:
! SPC,n   go to next meeting that has unread transactions
! DEL,p   go to previous meeting has unread transactions
! l	list meetings
! g	go to meeting listed on line
  a	add meeting
  d	delete meeting
  c	mark a meeting as read (catch up)
--- 237,248 ----
  This looks a lot like RMAIL.  This works by using ``edsc'' as a subjob.
  
  The following commands are available:
! n	go to next line.
! p	go to previous line.
! SPC     go to next meeting that has unread transactions
! DEL     go to previous meeting has unread transactions
! l	list meetings.
! g	go to meeting listed on line.
  a	add meeting
  d	delete meeting
  c	mark a meeting as read (catch up)
***************
*** 333,339 ****
  g	Goto transaction.
  d	Delete transaction (and move forwards).
  C-d	Delete transaction (and move backwards).
! R	Retrieve transaction.
  q       Quit meeting.
  r	Reply to this transaction.
  f	Forward this transaction via mail.
--- 293,299 ----
  g	Goto transaction.
  d	Delete transaction (and move forwards).
  C-d	Delete transaction (and move backwards).
! R	Retrieve transaction
  q       Quit meeting.
  r	Reply to this transaction.
  f	Forward this transaction via mail.
***************
*** 380,386 ****
  ;;; Entry points typically entered through key sequences.
  
  (defun discuss-list-meetings ()
!   "List discuss meetings."
    (interactive)
    (message "Listing meetings..."
    (switch-to-buffer (get-buffer discuss-main-buffer))
--- 340,346 ----
  ;;; Entry points typically entered through key sequences.
  
  (defun discuss-list-meetings ()
!   "List discuss meetings"
    (interactive)
    (message "Listing meetings..."
    (switch-to-buffer (get-buffer discuss-main-buffer))
***************
*** 478,484 ****
    (bury-buffer discuss-main-buffer))
  
  (defun discuss-goto (&optional meeting)
!   "Go to a meeting."
    (interactive (list (if (or current-prefix-arg
  			     (not (equal (buffer-name) discuss-main-buffer))
  			     (= (point) 1))
--- 438,444 ----
    (bury-buffer discuss-main-buffer))
  
  (defun discuss-goto (&optional meeting)
!   "Go to a meeting"
    (interactive (list (if (or current-prefix-arg
  			     (not (equal (buffer-name) discuss-main-buffer))
  			     (= (point) 1))
***************
*** 568,574 ****
  ;;; This should be cleaned up.  -- TYT
  ;;;
  (defun discuss-stat (&optional meeting)
!   "Go to a meeting."
    (interactive (list (if (eq (current-buffer) discuss-cur-mtg-buf)
  			 discuss-meeting
  		       (if (or current-prefix-arg
--- 528,534 ----
  ;;; This should be cleaned up.  -- TYT
  ;;;
  (defun discuss-stat (&optional meeting)
!   "Go to a meeting"
    (interactive (list (if (eq (current-buffer) discuss-cur-mtg-buf)
  			 discuss-meeting
  		       (if (or current-prefix-arg
***************
*** 643,649 ****
  	  ))))
  
  (defun discuss-update ()
!   "Update Discuss display to show new transactions."
    (interactive)
    (discuss-send-cmd (format "(gmi %s)\n" discuss-meeting)
  		    'discuss-end-of-update 'discuss-read-form))
--- 603,609 ----
  	  ))))
  
  (defun discuss-update ()
!   "Update Discuss display to show new transactions"
    (interactive)
    (discuss-send-cmd (format "(gmi %s)\n" discuss-meeting)
  		    'discuss-end-of-update 'discuss-read-form))
***************
*** 764,770 ****
      (discuss-show-trn last)))
  
  (defun discuss-toggle-trn-flag ()
!   "Toggle the per-transaction flag."
    (interactive)
    (let ((old-flag (nth 13 discuss-current-transaction-info)))
      (if old-flag
--- 724,730 ----
      (discuss-show-trn last)))
  
  (defun discuss-toggle-trn-flag ()
!   "Toggle the per-transaction flag"
    (interactive)
    (let ((old-flag (nth 13 discuss-current-transaction-info)))
      (if old-flag
***************
*** 798,804 ****
      (discuss-leave-mtg)))
  
  (defun discuss-leave-mtg ()
!   "Leave the current discuss meeting."
    (interactive)
    (if (buffer-name discuss-cur-mtg-buf)
        (progn
--- 758,764 ----
      (discuss-leave-mtg)))
  
  (defun discuss-leave-mtg ()
!   "Leave the current discuss meeting"
    (interactive)
    (if (buffer-name discuss-cur-mtg-buf)
        (progn
***************
*** 916,922 ****
    (discuss-show-trn discuss-current-transaction))
  
  (defun discuss-retrieve-trn (trn-num)
-   "Retrieve a deleted transaction."
    (interactive "nTransaction to retrieve: ")
    (setq discuss-current-transaction trn-num)
    (message "Retrieving %d...." trn-num)
--- 876,881 ----
***************
*** 988,994 ****
  	discuss-in-progress nil))
  
  (defun discuss-send-cmd (cmd &optional end-func filter-func unwind-func)
!   "Send an command to the edsc process."
    (if (not discuss-process)
        (let ((process-connection-type nil))
  	(if (not (file-exists-p discuss-pathname))
--- 947,953 ----
  	discuss-in-progress nil))
  
  (defun discuss-send-cmd (cmd &optional end-func filter-func unwind-func)
!   "Send an command to the edsc process"
    (if (not discuss-process)
        (let ((process-connection-type nil))
  	(if (not (file-exists-p discuss-pathname))
***************
*** 1264,1276 ****
      (set-buffer buffer)))
  
  (defun discuss-forward-meeting (&optional quiet)
-   "Find the next changed meeting in the discuss *meetings* buffer, or wrap."
    (interactive)
    (let ((discuss-DWIM nil))
      (discuss-next-meeting quiet)))
  
  (defun discuss-prev-meeting ()
!   "Find the previous changed meeting in the discuss *meetings* buffer, or wrap."
    (interactive)
    (beginning-of-line)
    (if (not (re-search-backward "^ c " nil t))
--- 1223,1234 ----
      (set-buffer buffer)))
  
  (defun discuss-forward-meeting (&optional quiet)
    (interactive)
    (let ((discuss-DWIM nil))
      (discuss-next-meeting quiet)))
  
  (defun discuss-prev-meeting ()
!   "Find the next changed meeting in the discuss *meetings* buffer, or wrap."
    (interactive)
    (beginning-of-line)
    (if (not (re-search-backward "^ c " nil t))

home help back first fref pref prev next nref lref last post