Commit e41b2db1 authored by Eric S. Raymond's avatar Eric S. Raymond

Added or corrected Commentary sections

parent 33d92c1f
......@@ -20,6 +20,10 @@
;; along with GNU Emacs; see the file COPYING. If not, write to
;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
;;; Commentary:
;; This facility is documented in the Emacs Manual.
;;; Code:
(defconst only-global-abbrevs nil "\
......
......@@ -166,8 +166,8 @@ Variable `ada-indent' controls the number of spaces for indent/undent."
(setq comment-column 41)
(make-local-variable 'comment-start-skip)
(setq comment-start-skip "--+ *")
(make-local-variable 'comment-indent-hook)
(setq comment-indent-hook 'c-comment-indent)
(make-local-variable 'comment-indent-function)
(setq comment-indent-function 'c-comment-indent)
(make-local-variable 'parse-sexp-ignore-comments)
(setq parse-sexp-ignore-comments t)
(run-hooks 'ada-mode-hook))
......
......@@ -20,6 +20,10 @@
;; along with GNU Emacs; see the file COPYING. If not, write to
;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
;;; Commentary:
;; This facility is documented in the Emacs Manual.
;;; Code:
;;;###autoload
......
......@@ -24,14 +24,18 @@
;;; Commentary:
;;; Written by dmb%morgoth@harvard.harvard.edu (address is old)
;;; (David M. Brown at Goldberg-Zoino & Associates, Inc.)
;;; Thanks to cph@kleph.ai.mit.edu for assistance
;;; To do:
;;; Smooth initialization process by grokking local variables list
;;; at end of buffer or parsing buffer using whitespace as delimiters.
;;; Make 'array-copy-column-right faster.
;; Commands for editing a buffer interpreted as a rectangular array
;; or matrix of whitespace-separated strings. You specify the array
;; dimensions and some other parameters at startup time.
;; Written by dmb%morgoth@harvard.harvard.edu (address is old)
;; (David M. Brown at Goldberg-Zoino & Associates, Inc.)
;; Thanks to cph@kleph.ai.mit.edu for assistance
;; To do:
;; Smooth initialization process by grokking local variables list
;; at end of buffer or parsing buffer using whitespace as delimiters.
;; Make 'array-copy-column-right faster.
;;; Code:
......
......@@ -49,8 +49,6 @@
;;; Duke University Medical Center
;;; Durham, NC 27710
;;; (crm@cs.duke.edu,mcnc!duke!crm)
;;;
;;; Date: Fri Jul 1 16:15:31 EDT 1988
;;; Code:
......
......@@ -20,6 +20,13 @@
;; along with GNU Emacs; see the file COPYING. If not, write to
;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
;;; Commentary:
;; Edit, delete, or change attributes of all currently active Emacs
;; buffers from a list summarizing thir state. A good way to browse
;; any special or scratch buffers you have loaded, since you can't find
;; them by filename.
;;; Code:
; Put buffer *Buffer List* into proper mode right away
......
......@@ -72,62 +72,65 @@
;; '((lambda ()
;; (define-key cmulisp-mode-map "\C-ct" 'favorite-cmd))))
;;; Brief Command Documentation:
;;;============================================================================
;;; Comint Mode Commands: (common to cmulisp and all comint-derived modes)
;;;
;;; m-p comint-previous-input Cycle backwards in input history
;;; m-n comint-next-input Cycle forwards
;;; m-c-r comint-previous-input-matching Search backwards in input history
;;; return comint-send-input
;;; c-a comint-bol Beginning of line; skip prompt.
;;; c-d comint-delchar-or-maybe-eof Delete char unless at end of buff.
;;; c-c c-u comint-kill-input ^u
;;; c-c c-w backward-kill-word ^w
;;; c-c c-c comint-interrupt-subjob ^c
;;; c-c c-z comint-stop-subjob ^z
;;; c-c c-\ comint-quit-subjob ^\
;;; c-c c-o comint-kill-output Delete last batch of process output
;;; c-c c-r comint-show-output Show last batch of process output
;;; send-invisible Read line w/o echo & send to proc
;;; comint-continue-subjob Useful if you accidentally suspend
;;; top-level job.
;;; comint-mode-hook is the comint mode hook.
;;; CMU Lisp Mode Commands:
;;; c-m-x lisp-send-defun This binding is a gnu convention.
;;; c-c c-l lisp-load-file Prompt for file name; tell Lisp to load it.
;;; c-c c-k lisp-compile-file Prompt for file name; tell Lisp to kompile it.
;;; Filename completion is available, of course.
;;;
;;; Additionally, these commands are added to the key bindings of Lisp mode:
;;; c-m-x lisp-eval-defun This binding is a gnu convention.
;;; c-c c-e lisp-eval-defun Send the current defun to Lisp process.
;;; c-x c-e lisp-eval-last-sexp Send the previous sexp to Lisp process.
;;; c-c c-r lisp-eval-region Send the current region to Lisp process.
;;; c-c c-c lisp-compile-defun Compile the current defun in Lisp process.
;;; c-c c-z switch-to-lisp Switch to the Lisp process buffer.
;;; c-c c-l lisp-load-file (See above. In a Lisp file buffer, default
;;; c-c c-k lisp-compile-file is to load/compile the current file.)
;;; c-c c-d lisp-describe-sym Query Lisp for a symbol's description.
;;; c-c c-a lisp-show-arglist Query Lisp for function's arglist.
;;; c-c c-f lisp-show-function-documentation Query Lisp for a function's doc.
;;; c-c c-v lisp-show-variable-documentation Query Lisp for a variable's doc.
;;; cmulisp Fires up the Lisp process.
;;; lisp-compile-region Compile all forms in the current region.
;;;
;;; CMU Lisp Mode Variables:
;;; cmulisp-filter-regexp Match this => don't get saved on input hist
;;; inferior-lisp-program Name of Lisp program run-lisp executes
;;; inferior-lisp-load-command Customises lisp-load-file
;;; cmulisp-mode-hook
;;; inferior-lisp-prompt Initialises comint-prompt-regexp.
;;; Backwards compatibility.
;;; lisp-source-modes Anything loaded into a buffer that's in
;;; one of these modes is considered Lisp
;;; source by lisp-load/compile-file.
;; Brief Command Documentation:
;;============================================================================
;; Comint Mode Commands: (common to cmulisp and all comint-derived modes)
;;
;; m-p comint-previous-input Cycle backwards in input history
;; m-n comint-next-input Cycle forwards
;; m-c-r comint-previous-input-matching Search backwards in input history
;; return comint-send-input
;; c-a comint-bol Beginning of line; skip prompt.
;; c-d comint-delchar-or-maybe-eof Delete char unless at end of buff.
;; c-c c-u comint-kill-input ^u
;; c-c c-w backward-kill-word ^w
;; c-c c-c comint-interrupt-subjob ^c
;; c-c c-z comint-stop-subjob ^z
;; c-c c-\ comint-quit-subjob ^\
;; c-c c-o comint-kill-output Delete last batch of process output
;; c-c c-r comint-show-output Show last batch of process output
;; send-invisible Read line w/o echo & send to proc
;; comint-continue-subjob Useful if you accidentally suspend
;; top-level job.
;; comint-mode-hook is the comint mode hook.
;; CMU Lisp Mode Commands:
;; c-m-x lisp-send-defun This binding is a gnu convention.
;; c-c c-l lisp-load-file Prompt for file name; tell Lisp to load it.
;; c-c c-k lisp-compile-file Prompt for file name; tell Lisp to kompile it.
;; Filename completion is available, of course.
;;
;; Additionally, these commands are added to the key bindings of Lisp mode:
;; c-m-x lisp-eval-defun This binding is a gnu convention.
;; c-c c-e lisp-eval-defun Send the current defun to Lisp process.
;; c-x c-e lisp-eval-last-sexp Send the previous sexp to Lisp process.
;; c-c c-r lisp-eval-region Send the current region to Lisp process.
;; c-c c-c lisp-compile-defun Compile the current defun in Lisp process.
;; c-c c-z switch-to-lisp Switch to the Lisp process buffer.
;; c-c c-l lisp-load-file (See above. In a Lisp file buffer, default
;; c-c c-k lisp-compile-file is to load/compile the current file.)
;; c-c c-d lisp-describe-sym Query Lisp for a symbol's description.
;; c-c c-a lisp-show-arglist Query Lisp for function's arglist.
;; c-c c-f lisp-show-function-documentation Query Lisp for a function's doc.
;; c-c c-v lisp-show-variable-documentation Query Lisp for a variable's doc.
;; cmulisp Fires up the Lisp process.
;; lisp-compile-region Compile all forms in the current region.
;;
;; CMU Lisp Mode Variables:
;; cmulisp-filter-regexp Match this => don't get saved on input hist
;; inferior-lisp-program Name of Lisp program run-lisp executes
;; inferior-lisp-load-command Customises lisp-load-file
;; cmulisp-mode-hook
;; inferior-lisp-prompt Initialises comint-prompt-regexp.
;; Backwards compatibility.
;; lisp-source-modes Anything loaded into a buffer that's in
;; one of these modes is considered Lisp
;; source by lisp-load/compile-file.
;;; Code:
(require 'comint)
;;; Read the rest of this file for more information.
......
;;; cmuscheme.el --- Scheme process in a buffer. Adapted from tea.el.
;;; Copyright (C) 1988 Free Software Foundation, Inc.
;; Copyright (C) 1988 Free Software Foundation, Inc.
;; Author: Olin Shivers <olin.shivers@cs.cmu.edu>
;; Keywords: processes, lisp
......
;;; comint.el --- general command interpreter in a window stuff
;; Copyright (C) 1988, 1990, 1992, 1993 Free Software Foundation, Inc.
;; Author: Olin Shivers <shivers@cs.cmu.edu>
......
......@@ -20,6 +20,13 @@
;; along with GNU Emacs; see the file COPYING. If not, write to
;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
;;; Commentary:
;; This package provides one entry point, compare-windows. It compares
;; text starting from point in two adjacent windows, advancing point
;; until it finds a difference. Option variables permit you to ignore
;; whitespace differences, or case differences, or both.
;;; Code:
(defvar compare-windows-whitespace " \t\n"
......
......@@ -20,6 +20,12 @@
;; along with GNU Emacs; see the file COPYING. If not, write to
;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
;;; Commentary:
;; This package helps you explore differences between files, using the
;; UNIX command diff(1). The commands are `diff' and `diff-backup'.
;; You can specify options with `diff-switches'.
;;; Code:
(require 'compile)
......
......@@ -22,6 +22,10 @@
;;; Commentary:
;; The parts of dired mode not normally used. This is a space-saving hack
;; to avoid having to load a large mode when all that's wanted are a few
;; functions.
;; Rewritten in 1990/1991 to add tree features, file marking and
;; sorting by Sebastian Kremer <sk@thp.uni-koeln.de>.
;; Finished up by rms in 1992.
......
......@@ -23,6 +23,9 @@
;;; Commentary:
;; This is a major mode for directory browsing and editing. It is
;; documented in the Emacs manual.
;; Rewritten in 1990/1991 to add tree features, file marking and
;; sorting by Sebastian Kremer <sk@thp.uni-koeln.de>.
;; Finished up by rms in 1992.
......
......@@ -22,8 +22,9 @@
;;; Commentary:
;; who says one can't have typeout windows in gnu emacs?
;; like ^r select buffer from its emacs lunar or tmacs libraries.
;; Who says one can't have typeout windows in GNU Emacs? The entry
;; point, `electric-buffer-list' works like ^r select buffer from the
;; ITS Emacs lunar or tmacs libraries.
;;; Code:
......
......@@ -21,6 +21,14 @@
;; along with GNU Emacs; see the file COPYING. If not, write to
;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
;;; Commentary:
;; This package provides a pre-packaged `Electric Help Mode' for
;; browsing on-line help screens. There is one entry point,
;; `with-electric-help'; All you have to give it is a no-argument
;; function that generates the actual text of the help into the urrent
;; buffer.
;;; Code:
(require 'electric)
......
......@@ -21,6 +21,13 @@
;;; 02139, USA.
;;;
;;; Commentary;:
;; This code helps GNU Emacs maintainers keep the autoload.el file up to
;; date. It interprets magic cookies of the form ";;;###autoload" in
;; lisp source files in various useful ways. To learn more, read the
;; source; if you're going to use this, you'd better be able to.
;;; Code:
(defun make-autoload (form file)
......
......@@ -28,6 +28,12 @@
;; along with GNU Emacs; see the file COPYING. If not, write to
;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
;;; Commentary:
;; The Emacs Lisp byte compiler. This crunches lisp source into a sort
;; of p-code which takes up less space and can be interpreted faster.
;; The user entry points are byte-compile-file and byte-recompile-directory.
;;; Code:
;;; ========================================================================
......
;;; cl-indent.el --- enhanced lisp-indent mode
;; Copyright (C) 1987 Free Software Foundation, Inc.
;; Written by Richard Mlynarik July 1987
;; Author: Richard Mlynark <mly@eddie.mit.edu>
;; Created: July 1987
;; Maintainer: FSF
;; Keywords: lisp, tools
;; This file is part of GNU Emacs.
;; GNU Emacs is free software; you can redistribute it and/or modify
......@@ -25,6 +25,12 @@
;;; Commentary:
;; This package supplies a single entry point, common-lisp-indent-function,
;; which performs indentation in the preferred style for Common Lisp code.
;; To enable it:
;;
;; (setq lisp-indent-function 'common-lisp-indent-function)
;;>> TODO
;; :foo
;; bar
......@@ -41,8 +47,6 @@
;;; Code:
;;; Hairy lisp indentation.
(defvar lisp-indent-maximum-backtracking 3
"*Maximum depth to backtrack out from a sublist for structured indentation.
If this variable is 0, no backtracking will occur and forms such as flet
......@@ -466,10 +470,4 @@ by `lisp-body-indent'.")
;(put 'with-condition-handler 'common-lisp-indent-function '((1 4 ((* 1))) (2 &body)))
;(put 'condition-case 'common-lisp-indent-function '((1 4) (* 2 ((0 1) (1 3) (2 &body)))))
;;;; Turn it on.
;(setq lisp-indent-function 'common-lisp-indent-function)
;; To disable this stuff, (setq lisp-indent-function 'lisp-indent-function)
;;; cl-indent.el ends here
......@@ -21,6 +21,10 @@
;; along with GNU Emacs; see the file COPYING. If not, write to
;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
;;; Commentary:
;; This is a major mode documented in the Emacs manual.
;;; Code:
(defvar debug-function-list nil
......
......@@ -25,9 +25,14 @@
;;; Commentary:
;;; Original version by Doug Cutting (doug@csli.stanford.edu)
;;; Substantially modified by Jamie Zawinski <jwz@lucid.com> for
;;; the new lapcode-based byte compiler.
;; The single entry point, `disassemble', disassembles a code object generated
;; by the Emacs Lisp byte-compiler. This doesn't invert the compilation
;; operation, not by a long shot, but it's useful for debugging.
;;
;; Original version by Doug Cutting (doug@csli.stanford.edu)
;; Substantially modified by Jamie Zawinski <jwz@lucid.com> for
;; the new lapcode-based byte compiler.
;;; Code:
......
......@@ -5,6 +5,10 @@
;; Author: Daniel LaLiberte <liberte@cs.uiuc.edu>
;; Keywords: lisp, tools, maint
;; This is Dan's 2.5 version with some header comments rearranged to separate
;; the Change Log from the Commentary (so the package-finder code can browse
;; the Commentary).
;; This file is part of GNU Emacs.
;; GNU Emacs is distributed in the hope that it will be useful,
......@@ -41,17 +45,30 @@
;;; Contents:
;;; =========
;;; Change list
;;; Installation
;;; Todo list
;;; Change list
;;; Utilities
;;; Parser
;;; Debugger
;;;================================================================
;;; Change list
;;; -----------
;;; Installation
;;; ------------
;; Put edebug.el in some directory in your load-path and byte-compile it.
;; Put the following forms in your .emacs file.
;; (define-key emacs-lisp-mode-map "\^Xx" 'edebug-defun)
;; (autoload 'edebug-defun "edebug")
;; (autoload 'edebug-debug "edebug")
;; (setq debugger 'edebug-debug)
;; ... other options, described in the next section.
;; Evaluate a defun for edebug with edebug-defun.
;; Evaluate your function normally.
;; Use the "?" command in edebug to describe other commands.
;; See edebug.texinfo for more instructions.
;;; Change Log:
;;; Revision 2.5 91/07/25 13:32:53 liberte
;;; Doc string cleanup.
......@@ -171,23 +188,6 @@
;;; Initial revision
;;;
;;; Installation
;;; ------------
;; Put edebug.el in some directory in your load-path and byte-compile it.
;; Put the following forms in your .emacs file.
;; (define-key emacs-lisp-mode-map "\^Xx" 'edebug-defun)
;; (autoload 'edebug-defun "edebug")
;; (autoload 'edebug-debug "edebug")
;; (setq debugger 'edebug-debug)
;; ... other options, described in the next section.
;; Evaluate a defun for edebug with edebug-defun.
;; Evaluate your function normally.
;; Use the "?" command in edebug to describe other commands.
;; See edebug.texinfo for more instructions.
;;; Code:
......
......@@ -23,6 +23,13 @@
;;; Code:
;;; Commentary:
;; The base major mode for editing Lisp code (used also for Emacs Lisp).
;; This mode is documented in the Emacs manual
;;; Code:
(defvar lisp-mode-syntax-table nil "")
(defvar emacs-lisp-mode-syntax-table nil "")
(defvar lisp-mode-abbrev-table nil "")
......@@ -94,8 +101,8 @@
(setq comment-start-skip ";+ *")
(make-local-variable 'comment-column)
(setq comment-column 40)
(make-local-variable 'comment-indent-hook)
(setq comment-indent-hook 'lisp-comment-indent))
(make-local-variable 'comment-indent-function)
(setq comment-indent-function 'lisp-comment-indent))
(defvar shared-lisp-mode-map ()
"Keymap for commands shared by all sorts of Lisp modes.")
......
......@@ -21,6 +21,10 @@
;; along with GNU Emacs; see the file COPYING. If not, write to
;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
;;; Commentary:
;; Lisp ediing commands to go with Lisp major mode.
;;; Code:
(defvar defun-prompt-regexp nil
......
;;; emerge.el --- merge diffs under Emacs control
;;; The author has placed this file in the public domain.
;; Author: Dale R. Worley <drw@math.mit.edu>
......@@ -7,120 +8,8 @@
;;; Commentary:
; - Changes from version 3 to version 4
;
; More configuration variables are marked as user options.
;
; Code is included for an improved version of make-auto-save-file-name
; which eliminates many problems with the default version. See the
; documentation of emerge-make-auto-save-file-name to see how to
; activate it.
;
; Emerge now works with Gnu diff3, which can produce the groups of lines
; from the various files in the order 1, 2, 3 or 1, 3, 2.
;
; Added x f command to show what files or buffers are being operated on.
;
; The merge buffer now starts read-only, which being in fast mode it
; should be.
;
; When merging buffers, Emerge writes their contents into temporary
; files in the directory $TMPDIR (if it is defined), or /tmp by default.
;
; Added x j command to join two differences.
;
; Added x s command to split a difference into two differences.
;
; Added emerge-version variable and function to report the version of Emerge
; being run.
;
; Added x t command to trim unchanged lines off top and bottom of
; difference region.
;
; Added x d, x a, and x b commands to locate the differences at or near
; a given location in one of the buffers.
;
; Emerge no longer tries to copy the minor modes from the A buffer to
; the merge buffer, only the major mode.
;
; The programs executed to find the differences between versions of the file
; are no longer controlled by emerge-diff/diff3-command, but rather by:
; emerge-diff-program
; Variable: *Name of the program which compares two files.
; emerge-diff3-program
; Variable: *Name of the program which compares an ancestor file
; (first argument) and two variant files (second and third arguments).
; emerge-diff-options
; Variable: *Options to be passed to emerge-diff/diff3-program.
;
; The names of the files are expanded (see expand-file-name) before being
; passed to emerge-diff/diff3-program, so diff need not invoked under a shell
; that understands '~', for instance.
;
; If the diff/diff3 program reports errors, the user is notified and the
; errors are displayed.
;
; The command "0j" can be used to suppress the flags from showing in the buffers.
;
; A discussion of the effect of the merge flags on indentation of code
; has been added to the documentation.
;
; If kill-fix.el is loaded, Emerge control variables new have their
; 'preserved' property set, so setting the major mode in the merge
; buffer doesn't destroy Emerge's state.
;
; Added x c, x C, and x x commands to allow the A and B versions to be
; combined into #ifdef - #endif forms.
;
; Replaced calls of "ding" to calls of "error" where appropriate.
;
; Added x m command to allow major mode of merge buffer to be changed.
;
; Added x 1 command to shrink the merge window to one line.
;
; Added emerge-startup-hook to allow customization.
;
; Fixed a bug that is activated when a remote merge request is made when
; the minibuffer window is selected.
;
; - Changes from version 2 to version 3
;
; The directory into which temporary files are written is now controlled
; by a user option (emerge-temp-file-prefix).
;
; The A and B versions of the difference can be loaded into the kill
; ring with the "c a" and "c b" commands.
;
; The A and B versions of the difference can be inserted into the merge
; buffer with the "i a" and "i b" commands.
;
; The difference region of the merge buffer can be surrounded by the
; point and mark with the "m" command.
;
; The three windows can be scrolled together with the "^", "v", "<",
; ">", and "|" commands.
;
; The "s s" and "s a" commands report the state of the option in the
; echo area. Similarly, the "f" and "e" commands report what they do in
; the echo area.
;
; The "q" command has been revamped, and its behavior is now controlled
; by the manner in which Emerge is started. In particular, if you wish
; to write the merge buffer into a file upon exiting, invoke
; emerge-files[-with-ancestor] with a prefix argument, and it will
; prompt you for the file name. Then exiting will write the merge
; buffer to the file, unless "q" is given a prefix argument.
;
; The "i a" and "i b" commands now work in fast mode.
;
; The modifications that Emerge makes to save-buffer and write-file are
; described.
;
; Emerge now handles merging narrowed buffers correctly.
;
; Emerge now isn't fooled when the buffer visiting a file is not the
; same as the file on disk.
;
;; This package assists you in reconciling differences between pair of files.
; - Starting
;
; To start Emerge, you must run one of four commands:
......@@ -558,6 +447,122 @@
;
; ================================================================
;;; Change Log:
; - Changes from version 3 to version 4
;
; More configuration variables are marked as user options.
;
; Code is included for an improved version of make-auto-save-file-name
; which eliminates many problems with the default version. See the