Mercurial > emacs

changeset 2315:9e7ec92a4fdf

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Added or corrected Commentary headers
author Eric S. Raymond <esr@snark.thyrsus.com>
date Mon, 22 Mar 1993 16:53:22 +0000
parents a47c59ea019b
children 58b646d9fefc
files lisp/env.el lisp/help.el lisp/mail/rfc822.el lisp/mail/sendmail.el lisp/play/spook.el lisp/play/studly.el lisp/progmodes/simula.el lisp/register.el lisp/replace.el lisp/reposition.el lisp/rlogin.el lisp/rot13.el lisp/scroll-bar.el lisp/simple.el lisp/sort.el lisp/tabify.el lisp/textmodes/scribe.el lisp/textmodes/sgml-mode.el lisp/textmodes/spell.el lisp/textmodes/text-mode.el
diffstat 20 files changed, 124 insertions(+), 30 deletions(-) [+]
line wrap: on
line diff
--- a/lisp/env.el	Mon Mar 22 14:57:04 1993 +0000
+++ b/lisp/env.el	Mon Mar 22 16:53:22 1993 +0000
@@ -3,7 +3,7 @@
 ;;; Copyright Free Software Foundation 1991
 
 ;; Maintainer: FSF
-;; Keywords: extensions
+;; Keywords: processes, unix
 
 ;;; This file is part of GNU Emacs.
 
@@ -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:
+
+;; UNIX processes inherit a list of name-to-string associations from
+;; their parents called their `environment'; these are commonly used
+;; to control program options.  This package permits you to set
+;; environment variables to be passed to any sub-process run under Emacs.
+
 ;;; Code:
 
 ;;;###autoload
--- a/lisp/help.el	Mon Mar 22 14:57:04 1993 +0000
+++ b/lisp/help.el	Mon Mar 22 16:53:22 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 code implements GNU Emac's on-line help system, the one invoked by
+;;`M-x help-for-help'.
+
 ;;; Code:
 
 ;; Get the macro make-help-screen when this is compiled,
--- a/lisp/mail/rfc822.el	Mon Mar 22 14:57:04 1993 +0000
+++ b/lisp/mail/rfc822.el	Mon Mar 22 16:53:22 1993 +0000
@@ -22,6 +22,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:
+
+;; Support functions for parsing RFC-822 headers, used by mail and news
+;; modes.  
+
 ;;; Code:
 
 ;; uses address-start free, throws to address
--- a/lisp/mail/sendmail.el	Mon Mar 22 14:57:04 1993 +0000
+++ b/lisp/mail/sendmail.el	Mon Mar 22 16:53:22 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 mode provides mail-sending facilities from within Emacs.  It is
+;; documented in the Emacs user's manual.
+
 ;;; Code:
 
 ;;;###autoload
--- a/lisp/play/spook.el	Mon Mar 22 14:57:04 1993 +0000
+++ b/lisp/play/spook.el	Mon Mar 22 16:53:22 1993 +0000
@@ -4,6 +4,7 @@
 
 ;; Maintainer: FSF
 ;; Keywords: games
+;; Created: May 1987
 
 ;; This file is part of GNU Emacs.
 
@@ -26,8 +27,7 @@
 ; Steve Strassmann (straz@media-lab.media.mit.edu) didn't write
 ; this, and even if he did, he really didn't mean for you to use it
 ; in an anarchistic way.
-; May 1987
-
+;
 ; To use this:
 ;  Make sure you have the variable SPOOK-PHRASES-FILE pointing to 
 ;  a valid phrase file. Phrase files are in the same format as
@@ -38,7 +38,7 @@
 ;  Just before sending mail, do M-x spook.
 ;  A number of phrases will be inserted into your buffer, to help
 ;  give your message that extra bit of attractiveness for automated
-;  keyword scanners.
+;  keyword scanners.  Help defeat the NSA trunk trawler!
 
 ;;; Code:
 
--- a/lisp/play/studly.el	Mon Mar 22 14:57:04 1993 +0000
+++ b/lisp/play/studly.el	Mon Mar 22 16:53:22 1993 +0000
@@ -5,6 +5,12 @@
 
 ;; Keywords: games
 
+;;; Commentary:
+
+;; Functions to studlycapsify a region, word, or buffer.  Possibly the
+;; esoteric significance of studlycapsification escapes you; that is,
+;; you suffer from autostudlycapsifibogotification.  Too bad.
+
 ;;; Code:
 
 (defun studlify-region (begin end)
--- a/lisp/progmodes/simula.el	Mon Mar 22 14:57:04 1993 +0000
+++ b/lisp/progmodes/simula.el	Mon Mar 22 16:53:22 1993 +0000
@@ -26,7 +26,11 @@
 
 ;;; Commentary:
 
-;; Hans Henrik Eriksen may be reached at:
+;; A major mode for editing the Simula language.  It knows about Simula
+;; syntax and standard indentation commands.  It also provides convenient
+;; abbrevs for Simula keywords.
+;;
+;; Hans Henrik Eriksen (the author) may be reached at:
 ;;         Institutt for informatikk,
 ;;         Universitetet i Oslo
 
--- a/lisp/register.el	Mon Mar 22 14:57:04 1993 +0000
+++ b/lisp/register.el	Mon Mar 22 16:53:22 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 package of functions emulates and somewhat extends the venerable
+;; TECO's `register' feature, which permits you to save various useful
+;; pieces of buffer state to named variables.  The entry points are
+;; documented in the Emacs user's manual.
+
 ;;; Code:
 
 (defvar register-alist nil
--- a/lisp/replace.el	Mon Mar 22 14:57:04 1993 +0000
+++ b/lisp/replace.el	Mon Mar 22 16:53:22 1993 +0000
@@ -18,6 +18,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 supplies the string and regular-expression replace functions
+;; documented in the Emacs user's manual.
+
 ;;; Code:
 
 (defconst case-replace t "\
--- a/lisp/reposition.el	Mon Mar 22 14:57:04 1993 +0000
+++ b/lisp/reposition.el	Mon Mar 22 16:53:22 1993 +0000
@@ -3,6 +3,7 @@
 ;; Copyright (C) 1991 Free Software Foundation, Inc.
 
 ;; Author: Michael D. Ernst <mernst@theory.lcs.mit.edu>
+;; Created: Jan 1991
 ;; Maintainer: FSF
 
 ;; This file is part of GNU Emacs.
@@ -23,8 +24,6 @@
 
 ;;; Commentary:
 
-;;; Written by Michael D. Ernst, mernst@theory.lcs.mit.edu, Jan 1991.
-
 ;;; Reposition-window makes an entire function definition or comment visible,
 ;;; or, if it is already visible, places it at the top of the window;
 ;;; additional invocations toggle the visibility of comments preceding the
--- a/lisp/rlogin.el	Mon Mar 22 14:57:04 1993 +0000
+++ b/lisp/rlogin.el	Mon Mar 22 16:53:22 1993 +0000
@@ -3,28 +3,32 @@
 ;; Maintainer: Noah Friedman <friedman@prep.ai.mit.edu>
 ;; Keywords: unix, comm
 
-;;; Copyright (C) 1992 Free Software Foundation, Inc.
-;;;
-;;; This program is free software; you can redistribute it and/or modify
-;;; it under the terms of the GNU General Public License as published by
-;;; the Free Software Foundation; either version 2, or (at your option)
-;;; any later version.
-;;;
-;;; This program is distributed in the hope that it will be useful,
-;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
-;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-;;; GNU General Public License for more details.
-;;;
-;;; You should have received a copy of the GNU General Public License
-;;; along with this program; if not, you can either send email to this
-;;; program's author (see below) or write to:
-;;;
-;;;              The Free Software Foundation, Inc.
-;;;              675 Massachusetts Avenue.
-;;;              Cambridge, MA 02139, USA. 
-;;;
+;; Copyright (C) 1992 Free Software Foundation, Inc.
+;;
+;; This program is free software; you can redistribute it and/or modify
+;; it under the terms of the GNU General Public License as published by
+;; the Free Software Foundation; either version 2, or (at your option)
+;; any later version.
+;;
+;; This program is distributed in the hope that it will be useful,
+;; but WITHOUT ANY WARRANTY; without even the implied warranty of
+;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+;; GNU General Public License for more details.
+;;
+;; You should have received a copy of the GNU General Public License
+;; along with this program; if not, you can either send email to this
+;; program's author (see below) or write to:
+;;
+;;              The Free Software Foundation, Inc.
+;;              675 Massachusetts Avenue.
+;;              Cambridge, MA 02139, USA. 
+;;
 
-;;; Todo: add directory tracking using ange-ftp style patchnames for the cwd.
+;;; Commentary:
+
+;; Support for remote login over Internet using rlogin(1).
+;;
+;; Todo: add directory tracking using ange-ftp style patchnames for the cwd.
 
 ;;; Code:
 
--- a/lisp/rot13.el	Mon Mar 22 14:57:04 1993 +0000
+++ b/lisp/rot13.el	Mon Mar 22 16:53:22 1993 +0000
@@ -23,8 +23,13 @@
 
 ;; Commentary:
 
+;; The single entry point, `rot13-other-window', oerforms a Caesar cipher
+;; encrypt/decrypt on the current buffer and displays the result in another 
+;; window.  Rot13 encryption is sometimes used on USENET as a read-at-yur-
+;; own-risk wrapper for material some might consider offensive, such as
+;; ethnic humor.
+;;
 ;; Written by Howard Gayle.  See case-table.el for details.
-
 ;; This hack is mainly to show off the char table stuff.
 
 ;;; Code:
--- a/lisp/scroll-bar.el	Mon Mar 22 14:57:04 1993 +0000
+++ b/lisp/scroll-bar.el	Mon Mar 22 16:53:22 1993 +0000
@@ -23,6 +23,12 @@
 
 ;;; Code:
 
+;;; Commentary:
+
+;; Window-system-independent bindings of mouse clicks on the scroll bar.
+;; Presently emulates the scroll-bar behavior of xterm.
+;;; Code:
+
 (require 'mouse)
 
 
--- a/lisp/simple.el	Mon Mar 22 14:57:04 1993 +0000
+++ b/lisp/simple.el	Mon Mar 22 16:53:22 1993 +0000
@@ -18,6 +18,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:
+
+;; A grab-bag of basic Emacs commands not specifically related to some
+;; major mode or to file-handling.
+
 ;;; Code:
 
 (defun open-line (arg)
--- a/lisp/sort.el	Mon Mar 22 14:57:04 1993 +0000
+++ b/lisp/sort.el	Mon Mar 22 16:53:22 1993 +0000
@@ -22,6 +22,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 sorting facilities documented in the Emacs
+;;; user's manual.
+
 ;;; Code:
 
 (defun sort-subr (reverse nextrecfun endrecfun &optional startkeyfun endkeyfun)
--- a/lisp/tabify.el	Mon Mar 22 14:57:04 1993 +0000
+++ b/lisp/tabify.el	Mon Mar 22 16:53:22 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:
+
+;; Commands to optimize spaces to tabs or expand tabs to spaces in a region
+;; (`tabify' and `untabify').  The variable tab-width does the obvious.
+
 ;;; Code:
 
 ;;;###autoload
--- a/lisp/textmodes/scribe.el	Mon Mar 22 14:57:04 1993 +0000
+++ b/lisp/textmodes/scribe.el	Mon Mar 22 16:53:22 1993 +0000
@@ -21,6 +21,12 @@
 ;; It should be in a file named COPYING.  Among other things, the
 ;; copyright notice and this notice must be preserved on all copies.
 
+;;; Commentary:
+
+;; A major mode for editing source in written for the Scribe text formatter.
+;; Knows about Scribe syntax and standard layout rules.  The command to
+;; run Scribe on a buffer is bogus; someone interested should fix it.
+
 ;;; Code:
 
 (defvar scribe-mode-syntax-table nil
--- a/lisp/textmodes/sgml-mode.el	Mon Mar 22 14:57:04 1993 +0000
+++ b/lisp/textmodes/sgml-mode.el	Mon Mar 22 16:53:22 1993 +0000
@@ -24,6 +24,8 @@
 
 ;;; Commentary:
 
+;; Major mode for editing the SGML document-markup language.
+;;
 ;; Some suggestions for your .emacs file:
 ;;
 ;; (autoload 'sgml-mode "sgml-mode" "SGML mode" t)
--- a/lisp/textmodes/spell.el	Mon Mar 22 14:57:04 1993 +0000
+++ b/lisp/textmodes/spell.el	Mon Mar 22 16:53:22 1993 +0000
@@ -3,7 +3,7 @@
 ;; Copyright (C) 1985 Free Software Foundation, Inc.
 
 ;; Maintainer: FSF
-;; Keywords: wp
+;; Keywords: wp, unix
 
 ;; This file is part of GNU Emacs.
 
@@ -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 mode orovides an Emacs interface to the UNIX spell(1) program.
+;; Entry points are `spell-buffer', `spell-word', `spell-region' and
+;; `spell-string'.  These facilities are documented in the Emacs user's
+;; manual.
+
 ;;; Code:
 
 (defvar spell-command "spell"
--- a/lisp/textmodes/text-mode.el	Mon Mar 22 14:57:04 1993 +0000
+++ b/lisp/textmodes/text-mode.el	Mon Mar 22 16:53:22 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 provides the fundamental text mode documented in the
+;; Emacs user's manual.
+
 ;;; Code:
 
 (defvar text-mode-syntax-table nil