Mercurial > emacs

changeset 2308:f287613dfc28

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Added or corrected Commentary sections
author Eric S. Raymond <esr@snark.thyrsus.com>
date Mon, 22 Mar 1993 05:42:35 +0000
parents 10e417efb12a
children ff0b2a4e5c94
files lisp/=man.el lisp/=netunam.el lisp/emulation/mlconvert.el lisp/emulation/mlsupport.el lisp/mouse.el lisp/novice.el lisp/options.el lisp/play/mpuz.el lisp/progmodes/modula2.el lisp/progmodes/prolog.el lisp/rect.el lisp/textmodes/nroff-mode.el lisp/textmodes/ooutline.el lisp/textmodes/page.el lisp/textmodes/paragraphs.el lisp/textmodes/picture.el
diffstat 16 files changed, 101 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/lisp/=man.el	Mon Mar 22 03:27:18 1993 +0000
+++ b/lisp/=man.el	Mon Mar 22 05:42:35 1993 +0000
@@ -21,6 +21,11 @@
 ;; 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 an equivalent of the UNIX man(1) command within
+;; Emacs.  The single entry point is `manual-entry'.
+
 ;;; Code:
 
 ;;;###autoload
--- a/lisp/=netunam.el	Mon Mar 22 03:27:18 1993 +0000
+++ b/lisp/=netunam.el	Mon Mar 22 05:42:35 1993 +0000
@@ -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:
+
+;; Use the Remote File Access (RFA) facility of HP-UX from Emacs.
+
 ;;; Code:
 
 (defconst rfa-node-directory "/net/"
--- a/lisp/emulation/mlconvert.el	Mon Mar 22 03:27:18 1993 +0000
+++ b/lisp/emulation/mlconvert.el	Mon Mar 22 05:42:35 1993 +0000
@@ -3,7 +3,7 @@
 ;; Copyright (C) 1985 Free Software Foundation, Inc.
 
 ;; Maintainer: FSF
-;; Keywords: extensions
+;; Keywords: emulations
 
 ;; This file is part of GNU Emacs.
 
@@ -21,6 +21,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 conversts Mocklisp code written under a Gosling or UniPress
+;; Emacs for use with GNU Emacs.  The translated code will require runtime
+;; support from the mlsupport.el equivalent.
+
 ;;; Code:
 
 ;;;###autoload
--- a/lisp/emulation/mlsupport.el	Mon Mar 22 03:27:18 1993 +0000
+++ b/lisp/emulation/mlsupport.el	Mon Mar 22 05:42:35 1993 +0000
@@ -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 equivalents of certain primitives from Gosling
+;; Emacs (including the commercial UniPress versions).  These have an
+;; ml- prefix to distinguish them from native GNU Emacs functions with
+;; similar names.  The oackage mlconvert.el translates Mocklisp code
+;; to use these names.
+
 ;;; Code:
 
 (defmacro ml-defun (&rest defs)
--- a/lisp/mouse.el	Mon Mar 22 03:27:18 1993 +0000
+++ b/lisp/mouse.el	Mon Mar 22 05:42:35 1993 +0000
@@ -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 various useful commands (including help
+;; system access) through the mouse.  All this code assumes that mouse
+;; interpretation has been abstracted into Emacs input events.
+;;
+;; The code is rather X-dependent.
+
 ;;; Code:
 
 ;;; Utility functions.
--- a/lisp/novice.el	Mon Mar 22 03:27:18 1993 +0000
+++ b/lisp/novice.el	Mon Mar 22 05:42:35 1993 +0000
@@ -21,6 +21,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 mode provides a hook which is, by default, attached to various
+;; putatively dangerous commands in a (probably futile) attempt to
+;; prevent lusers from shooting themselves in the feet.
+
 ;;; Code:
 
 ;; This function is called (by autoloading)
--- a/lisp/options.el	Mon Mar 22 03:27:18 1993 +0000
+++ b/lisp/options.el	Mon Mar 22 05:42:35 1993 +0000
@@ -20,6 +20,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 code provides functions to list and edit the values of all global
+;; option variables known to loaded Emacs Lisp code.  There are two entry
+;; points, `list-options' and `edit' options'.  The latter enters a major
+;; mode specifically for editing option values.  Do `M-x describe-mode' in
+;; that context for more details.
+
 ;;; Code:
 
 ;;;###autoload
--- a/lisp/play/mpuz.el	Mon Mar 22 03:27:18 1993 +0000
+++ b/lisp/play/mpuz.el	Mon Mar 22 05:42:35 1993 +0000
@@ -22,6 +22,13 @@
 ;; file named COPYING.  Among other things, the copyright notice
 ;; and this notice must be preserved on all copies.
 
+;;; Commentary:
+
+;; When this package is loaded, `M-x mpuz' generates a random multiplication
+;; puzzle.  This is a multiplication example in which each digit has been
+;; consistently replaced with some letter.  Your job is to reconstruct
+;; the original digits.  Type `?' while the mode is active for detailed help.
+
 ;;; Code:
 
 (random t)				; randomize
--- a/lisp/progmodes/modula2.el	Mon Mar 22 03:27:18 1993 +0000
+++ b/lisp/progmodes/modula2.el	Mon Mar 22 05:42:35 1993 +0000
@@ -11,6 +11,12 @@
 ;; Author Mick Jordan
 ;; amended Peter Robinson
 
+;;; Commentary:
+
+;; A major mode for editing Modula-2 code.  It provides convenient abbrevs
+;; for Modula-2 keywords, knows about the standard layout rules, and supports
+;; a native compile command.
+
 ;;; Code:
 
 ;;; Added by Tom Perrine (TEP)
--- a/lisp/progmodes/prolog.el	Mon Mar 22 03:27:18 1993 +0000
+++ b/lisp/progmodes/prolog.el	Mon Mar 22 05:42:35 1993 +0000
@@ -21,6 +21,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 provides a major mode for editing Prolog.  It knows
+;; about Prolog syntax and comments, and can send regions to an inferior
+;; Prolog interpreter process.
+
 ;;; Code:
 
 (defvar prolog-mode-syntax-table nil)
--- a/lisp/rect.el	Mon Mar 22 03:27:18 1993 +0000
+++ b/lisp/rect.el	Mon Mar 22 05:42:35 1993 +0000
@@ -21,6 +21,11 @@
 ;; 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 the operations on rectangles that are ocumented
+;; in the Emacs manual.
+
 ;;; Code:
 
 (defun operate-on-rectangle (function start end coerce-tabs)
--- a/lisp/textmodes/nroff-mode.el	Mon Mar 22 03:27:18 1993 +0000
+++ b/lisp/textmodes/nroff-mode.el	Mon Mar 22 05:42:35 1993 +0000
@@ -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 is a major mode for editing nroff source code.  It knows
+;; about various nroff constructs, ms, mm, and me macros, and will fill
+;; and indent paragraphs properly in their presence.  It also includes
+;; a command to count text lines (excluding nroff constructs), a command
+;; to center a line, and movement commands that know how to skip macros.
+
 ;;; Code:
 
 (defvar nroff-mode-abbrev-table nil
--- a/lisp/textmodes/ooutline.el	Mon Mar 22 03:27:18 1993 +0000
+++ b/lisp/textmodes/ooutline.el	Mon Mar 22 05:42:35 1993 +0000
@@ -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 is a major mode for editing outline-format documents.
+;; An outline can be `abstracted' to show headers at any given level,
+;; with all stuff below hidden.  See the Emacs manual for details.
+
 ;;; Code:
 
 ;; Jan '86, Some new features added by Peter Desnoyers and rewritten by RMS.
--- a/lisp/textmodes/page.el	Mon Mar 22 03:27:18 1993 +0000
+++ b/lisp/textmodes/page.el	Mon Mar 22 05:42:35 1993 +0000
@@ -20,6 +20,11 @@
 ;; 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 code provides the page-oriented movement and selection commands
+;; documented in the Emacs manual.
+
 ;;; Code:
 
 (defun forward-page (&optional count)
--- a/lisp/textmodes/paragraphs.el	Mon Mar 22 03:27:18 1993 +0000
+++ b/lisp/textmodes/paragraphs.el	Mon Mar 22 05:42:35 1993 +0000
@@ -21,6 +21,11 @@
 ;; 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 the paragraph-oriented commands documented in the
+;; Emacs manual.
+
 ;;; Code:
 
 (defconst paragraph-start "^[ \t\n\f]" "\
--- a/lisp/textmodes/picture.el	Mon Mar 22 03:27:18 1993 +0000
+++ b/lisp/textmodes/picture.el	Mon Mar 22 05:42:35 1993 +0000
@@ -21,6 +21,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 code provides the picture-mode commands documented in the Emacs 
+;; manual.  The screen is treated as a semi-infinite quarter-plane with
+;; support for rectangle operations and `etch-a-sketch' character
+;; insertion in any of eight directions.
+
 ;;; Code:
 
 (defun move-to-column-force (column)