emacs-diffs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[Emacs-diffs] emacs-24 r117325: Doc and comment fixes re "online" help


From: Glenn Morris
Subject: [Emacs-diffs] emacs-24 r117325: Doc and comment fixes re "online" help
Date: Sun, 29 Jun 2014 02:34:17 +0000
User-agent: Bazaar (2.6b2)

------------------------------------------------------------
revno: 117325
revision-id: address@hidden
parent: address@hidden
fixes bug: http://debbugs.gnu.org/17803
committer: Glenn Morris <address@hidden>
branch nick: emacs-24
timestamp: Sat 2014-06-28 19:33:50 -0700
message:
  Doc and comment fixes re "online" help
  
  * doc/emacs/help.texi (Misc Help):
  * doc/emacs/trouble.texi (Checklist):
  * doc/lispintro/emacs-lisp-intro.texi (Note for Novices, Finding More)
  (Conclusion):
  * doc/lispref/help.texi (Help Functions):
  * doc/misc/info.texi, doc/misc/mh-e.texi:
  * etc/refcards/calccard.tex (section{Getting Help}):
  * lisp/cus-edit.el (help):
  * lisp/finder.el (finder-known-keywords):
  * lisp/help.el (help-for-help-internal):
  * lisp/vc/ediff-mult.el (ediff-meta-buffer-verbose-message)
  (ediff-redraw-registry-buffer):
  * lisp/vc/ediff-ptch.el (ediff-patch-file-internal):
  Doc fixes re "online" help.
modified:
  doc/emacs/ChangeLog            changelog-20091113204419-o5vbwnq5f7feedwu-6227
  doc/emacs/help.texi            help.texi-20091113204419-o5vbwnq5f7feedwu-6256
  doc/emacs/trouble.texi         
trouble.texi-20091113204419-o5vbwnq5f7feedwu-6279
  doc/lispintro/ChangeLog        changelog-20091113204419-o5vbwnq5f7feedwu-6128
  doc/lispintro/emacs-lisp-intro.texi 
emacslispintro.texi-20091113204419-o5vbwnq5f7feedwu-6143
  doc/lispref/ChangeLog          changelog-20091113204419-o5vbwnq5f7feedwu-6155
  doc/lispref/help.texi          help.texi-20091113204419-o5vbwnq5f7feedwu-6185
  doc/misc/ChangeLog             changelog-20091113204419-o5vbwnq5f7feedwu-6331
  doc/misc/info.texi             info.texi-20091113204419-o5vbwnq5f7feedwu-6308
  doc/misc/mh-e.texi             mhe.texi-20091113204419-o5vbwnq5f7feedwu-6311
  etc/ChangeLog                  changelog-20091113204419-o5vbwnq5f7feedwu-1485
  etc/refcards/calccard.tex      
calccard.tex-20091113204419-o5vbwnq5f7feedwu-5124
  lisp/ChangeLog                 changelog-20091113204419-o5vbwnq5f7feedwu-1432
  lisp/cus-edit.el               cusedit.el-20091113204419-o5vbwnq5f7feedwu-1091
  lisp/ehelp.el                  ehelp.el-20091113204419-o5vbwnq5f7feedwu-65
  lisp/emulation/viper.el        viper.el-20091113204419-o5vbwnq5f7feedwu-841
  lisp/finder.el                 finder.el-20091113204419-o5vbwnq5f7feedwu-499
  lisp/help.el                   help.el-20091113204419-o5vbwnq5f7feedwu-280
  lisp/progmodes/f90.el          f90.el-20091113204419-o5vbwnq5f7feedwu-827
  lisp/progmodes/pascal.el       pascal.el-20091113204419-o5vbwnq5f7feedwu-636
  lisp/vc/ediff-mult.el          
ediffmult.el-20091113204419-o5vbwnq5f7feedwu-904
  lisp/vc/ediff-ptch.el          
ediffptch.el-20091113204419-o5vbwnq5f7feedwu-987
  lisp/vc/ediff.el               ediff.el-20091113204419-o5vbwnq5f7feedwu-769
=== modified file 'doc/emacs/ChangeLog'
--- a/doc/emacs/ChangeLog       2014-06-08 17:46:51 +0000
+++ b/doc/emacs/ChangeLog       2014-06-29 02:33:50 +0000
@@ -1,3 +1,9 @@
+2014-06-29  Glenn Morris  <address@hidden>
+
+       * help.texi (Misc Help):
+       * trouble.texi (Checklist): "Online" help doesn't mean what it
+       used to any more.
+
 2014-06-08  Glenn Morris  <address@hidden>
 
        * entering.texi (Entering Emacs): Small fix re initial-buffer-choice.

=== modified file 'doc/emacs/help.texi'
--- a/doc/emacs/help.texi       2014-06-08 01:37:23 +0000
+++ b/doc/emacs/help.texi       2014-06-29 02:33:50 +0000
@@ -490,8 +490,7 @@
 @kindex C-h i
 @findex info
 @cindex Info
address@hidden manuals, on-line
address@hidden on-line manuals
address@hidden manuals, included
   @kbd{C-h i} (@code{info}) runs the Info program, which browses
 structured documentation files.  The entire Emacs manual is available
 within Info, along with many other manuals for the GNU system.  Type

=== modified file 'doc/emacs/trouble.texi'
--- a/doc/emacs/trouble.texi    2014-05-02 12:28:10 +0000
+++ b/doc/emacs/trouble.texi    2014-06-29 02:33:50 +0000
@@ -847,7 +847,7 @@
 @item
 If the bug is that the Emacs Manual or the Emacs Lisp Reference Manual
 fails to describe the actual behavior of Emacs, or that the text is
-confusing, copy in the text from the online manual which you think is
+confusing, copy in the text from the manual which you think is
 at fault.  If the section is small, just the section name is enough.
 
 @item

=== modified file 'doc/lispintro/ChangeLog'
--- a/doc/lispintro/ChangeLog   2014-02-25 03:11:11 +0000
+++ b/doc/lispintro/ChangeLog   2014-06-29 02:33:50 +0000
@@ -1,3 +1,8 @@
+2014-06-29  Glenn Morris  <address@hidden>
+
+       * emacs-lisp-intro.texi (Note for Novices, Finding More, Conclusion):
+       "Online" help doesn't mean what it used to any more.
+
 2014-02-25  Glenn Morris  <address@hidden>
 
        * emacs-lisp-intro.texi (X11 Colors): Don't use setq with hooks.

=== modified file 'doc/lispintro/emacs-lisp-intro.texi'
--- a/doc/lispintro/emacs-lisp-intro.texi       2014-02-25 03:11:11 +0000
+++ b/doc/lispintro/emacs-lisp-intro.texi       2014-06-29 02:33:50 +0000
@@ -903,7 +903,7 @@
 If you don't know GNU Emacs, you can still read this document
 profitably.  However, I recommend you learn Emacs, if only to learn to
 move around your computer screen.  You can teach yourself how to use
-Emacs with the on-line tutorial.  To use it, type @kbd{C-h t}.  (This
+Emacs with the built-in tutorial.  To use it, type @kbd{C-h t}.  (This
 means you press and release the @key{CTRL} key and the @kbd{h} at the
 same time, and then press and release @kbd{t}.)
 
@@ -4657,7 +4657,7 @@
 rather than a general library.  Each library, or file, contains
 functions that relate to a particular topic or activity, such as
 @file{abbrev.el} for handling abbreviations and other typing
-shortcuts, and @file{help.el} for on-line help.  (Sometimes several
+shortcuts, and @file{help.el} for help.  (Sometimes several
 libraries provide code for a single activity, as the various
 @address@hidden files provide code for reading electronic mail.)
 In @cite{The GNU Emacs Manual}, you will see sentences such as ``The
@@ -18685,9 +18685,9 @@
 experts, but for people who know what you know.  (The @cite{Reference
 Manual} comes with the standard GNU Emacs distribution.  Like this
 introduction, it comes as a Texinfo source file, so you can read it
-on-line and as a typeset, printed book.)
+on your computer and as a typeset, printed book.)
 
-Go to the other on-line help that is part of GNU Emacs: the on-line
+Go to the other built-in help that is part of GNU Emacs: the built-in
 documentation for all functions and variables, and @code{find-tag},
 the program that takes you to sources.
 

=== modified file 'doc/lispref/ChangeLog'
--- a/doc/lispref/ChangeLog     2014-06-26 19:00:42 +0000
+++ b/doc/lispref/ChangeLog     2014-06-29 02:33:50 +0000
@@ -1,3 +1,8 @@
+2014-06-29  Glenn Morris  <address@hidden>
+
+       * help.texi (Help Functions): "Online" help doesn't mean what it
+       used to any more.
+
 2014-06-26  Glenn Morris  <address@hidden>
 
        * minibuf.texi (Intro to Minibuffers): Batch mode is basic.

=== modified file 'doc/lispref/help.texi'
--- a/doc/lispref/help.texi     2014-03-16 09:26:58 +0000
+++ b/doc/lispref/help.texi     2014-06-29 02:33:50 +0000
@@ -508,7 +508,7 @@
 @node Help Functions
 @section Help Functions
 
-  Emacs provides a variety of on-line help functions, all accessible to
+  Emacs provides a variety of built-in help functions, all accessible to
 the user as subcommands of the prefix @kbd{C-h}.  For more information
 about them, see @ref{Help, , Help, emacs, The GNU Emacs Manual}.  Here
 we describe some program-level interfaces to the same information.

=== modified file 'doc/misc/ChangeLog'
--- a/doc/misc/ChangeLog        2014-06-29 02:17:17 +0000
+++ b/doc/misc/ChangeLog        2014-06-29 02:33:50 +0000
@@ -1,5 +1,8 @@
 2014-06-29  Glenn Morris  <address@hidden>
 
+       * info.texi, mh-e.texi: "Online help" doesn't mean what it
+       used to any more.
+
        * idlwave.texi (Introduction): Comment out dead http screenshot links.
 
 2014-06-23  Leo Liu  <address@hidden>

=== modified file 'doc/misc/info.texi'
--- a/doc/misc/info.texi        2014-06-08 19:30:13 +0000
+++ b/doc/misc/info.texi        2014-06-29 02:33:50 +0000
@@ -12,7 +12,7 @@
 @comment %**end of header
 
 @copying
-This file describes how to use Info, the on-line, menu-driven GNU
+This file describes how to use Info, the menu-driven GNU
 documentation system.
 
 Copyright @copyright{} 1989, 1992, 1996--2014 Free Software Foundation, Inc.
@@ -51,7 +51,7 @@
 @node Top
 @top Info: An Introduction
 
-The GNU Project distributes most of its on-line manuals in the
+The GNU Project distributes most of its manuals in the
 @dfn{Info format}, which you read using an @dfn{Info reader}.  You are
 probably using an Info reader to read this now.
 
@@ -98,7 +98,7 @@
 about them.  Reading it on paper or with an HTML browser is less
 effective, since you must take it on faith that the commands described
 really do what the manual says.  By all means go through this manual
-now that you have it; but please try going through the on-line version
+now that you have it; but please try going through the Info version
 as well.
 
 @cindex Info reader, how to invoke

=== modified file 'doc/misc/mh-e.texi'
--- a/doc/misc/mh-e.texi        2014-06-08 23:39:23 +0000
+++ b/doc/misc/mh-e.texi        2014-06-29 02:33:50 +0000
@@ -227,7 +227,7 @@
 @kindex C-h t
 
 If you don't already use GNU Emacs but want to learn more, you can
-read an online tutorial by starting GNU Emacs and typing @kbd{C-h t}
+read a built-in tutorial by starting GNU Emacs and typing @kbd{C-h t}
 (@code{help-with-tutorial}). (To learn about this notation, see
 @ref{Conventions}.) If you want to take the plunge, consult the
 @iftex
@@ -1066,9 +1066,9 @@
 about every MH-E command and option.
 
 @cindex Emacs, info
address@hidden Emacs, online help
address@hidden Emacs, built-in help
 @cindex info
address@hidden online help
address@hidden built-in help
 @findex describe-mode
 @findex mh-help
 @kindex ?
@@ -1083,12 +1083,12 @@
 like to rebind the keys, the command summaries also list the
 associated Emacs Lisp function. Furthermore, even if you're stranded
 on a desert island with a laptop and are without your manuals, you can
-get a summary of all these commands with GNU Emacs online help: use
+get a summary of all these commands with GNU Emacs built-in help: use
 @kbd{C-h m} (@code{describe-mode}) for a brief summary of commands,
 @kbd{?} (@code{mh-help}) for an even briefer address@hidden
 help appears in a buffer called @file{*MH-E Help*}
 (@pxref{Miscellaneous}).} (@kbd{C-c ?} in MH-Letter mode), or @kbd{C-h
-i} to read this manual via Info. The online help is quite good; try
+i} to read this manual via Info. The built-in help is quite good; try
 running @kbd{C-h C-h}. This brings up a list of available help topics,
 one of which displays the documentation for a given key (like @kbd{C-h
 k C-n}). Another useful help feature is to view the manual section
@@ -1120,21 +1120,21 @@
 @c Yes, some of the stuff in the following sections is redundant, but
 @c TeX barfs if the @ifs are inside the @footnote.
 @iftex
address@hidden @cite{GNU Emacs Lisp Reference Manual} may be available
-online in the Info system by typing @kbd{C-h i m Emacs Lisp
address@hidden @cite{GNU Emacs Lisp Reference Manual} should be available
+via the Info system by typing @kbd{C-h i m Emacs Lisp
 @key{RET}}. It is also available online at @*
 @uref{http://www.gnu.org/software/emacs/manual/elisp.html}.}
 @end iftex
 @ifinfo
 @address@hidden, The GNU Emacs Lisp Reference Manual, , elisp, GNU
-Emacs Lisp Reference Manual}, which may be available online in the
+Emacs Lisp Reference Manual}, which should be available via the
 Info system. It is also available online at
 @uref{http://www.gnu.org/software/emacs/manual/elisp.html}.}
 @end ifinfo
 @ifhtml
 @footnote{The
 @uref{http://www.gnu.org/software/emacs/manual/elisp.html,
-The GNU Emacs Lisp Reference Manual} may also be available online in
+The GNU Emacs Lisp Reference Manual} should be available via
 the Info system by typing @kbd{C-h i m Emacs Lisp @key{RET}}.}
 @end ifhtml
 and you can look at the code itself for examples. Look in the Emacs
@@ -1142,7 +1142,7 @@
 @file{/usr/local/share/emacs/lisp/mh-e}) and find all the @file{mh-*.el}
 files there. When calling MH-E and other Emacs Lisp functions directly
 from Emacs Lisp code, you'll need to know the correct arguments. Use
-the online help for this. For example, try @kbd{C-h f
+the built-in help for this. For example, try @kbd{C-h f
 mh-execute-commands @key{RET}}. If you write your own functions,
 please do not prefix your symbols (variables and functions) with
 @samp{mh-}. This prefix is reserved for the MH-E package. To avoid
@@ -6405,7 +6405,7 @@
 The Menu Bar} in @cite{The GNU Emacs Manual}.
 @end ifhtml
 
-The Emacs manual describes how to get online help for a particular
+The Emacs manual describes how to get help for a particular
 menu item. You can also look up a menu item in the index of this
 manual in two ways: all of the menu items are listed alphabetically,
 and you can also browse all of the items under the index entry

=== modified file 'etc/ChangeLog'
--- a/etc/ChangeLog     2014-06-27 00:33:00 +0000
+++ b/etc/ChangeLog     2014-06-29 02:33:50 +0000
@@ -1,3 +1,8 @@
+2014-06-29  Glenn Morris  <address@hidden>
+
+       * refcards/calccard.tex (section{Getting Help}):
+       Meaning of "on-line" has changed.
+
 2014-06-27  Glenn Morris  <address@hidden>
 
        * publicsuffix.txt: Update from source.

=== modified file 'etc/refcards/calccard.tex'
--- a/etc/refcards/calccard.tex 2014-01-01 07:43:34 +0000
+++ b/etc/refcards/calccard.tex 2014-06-29 02:33:50 +0000
@@ -297,7 +297,7 @@
 \key{describe key briefly}{h c}
 \key{describe key fully}{h k}
 \key{describe function or command}{h f}
-\key{read on-line manual}{h i{\rm\enskip or\enskip}\calcprefix i}
+\key{read Info manual}{h i{\rm\enskip or\enskip}\calcprefix i}
 \key{read full Calc summary}{h s{\rm\enskip or\enskip}\calcprefix s}
 
 \section{Error Recovery}

=== modified file 'lisp/ChangeLog'
--- a/lisp/ChangeLog    2014-06-29 02:17:17 +0000
+++ b/lisp/ChangeLog    2014-06-29 02:33:50 +0000
@@ -1,5 +1,13 @@
 2014-06-29  Glenn Morris  <address@hidden>
 
+       * cus-edit.el (help):
+       * finder.el (finder-known-keywords):
+       * help.el (help-for-help-internal):
+       * vc/ediff-mult.el (ediff-meta-buffer-verbose-message)
+       (ediff-redraw-registry-buffer):
+       * vc/ediff-ptch.el (ediff-patch-file-internal):
+       Doc fixes re "online" help.  (Bug#17803)
+
        * progmodes/idlwave.el (idlwave): Update url-link for custom group.
        (idlwave-mode): Doc URL update.
 

=== modified file 'lisp/cus-edit.el'
--- a/lisp/cus-edit.el  2014-02-10 01:34:22 +0000
+++ b/lisp/cus-edit.el  2014-06-29 02:33:50 +0000
@@ -324,7 +324,7 @@
   :group 'emacs)
 
 (defgroup help nil
-  "Support for on-line help systems."
+  "Support for Emacs help systems."
   :group 'emacs)
 
 (defgroup multimedia nil

=== modified file 'lisp/ehelp.el'
--- a/lisp/ehelp.el     2014-02-10 01:34:22 +0000
+++ b/lisp/ehelp.el     2014-06-29 02:33:50 +0000
@@ -25,7 +25,7 @@
 ;;; Commentary:
 
 ;; This package provides a pre-packaged `Electric Help Mode' for
-;; browsing on-line help screens.  There is one entry point,
+;; browsing Emacs 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 current
 ;; buffer.

=== modified file 'lisp/emulation/viper.el'
--- a/lisp/emulation/viper.el   2014-01-27 02:02:28 +0000
+++ b/lisp/emulation/viper.el   2014-06-29 02:33:50 +0000
@@ -107,7 +107,7 @@
 ;;  ----------------
 ;;  Bug reports and ideas contributed by many users have helped
 ;;  improve Viper and the various versions of VIP.
-;;  See the on-line manual for a complete list of contributors.
+;;  See the manual for a complete list of contributors.
 ;;
 ;;
 ;;; Notes:

=== modified file 'lisp/finder.el'
--- a/lisp/finder.el    2014-03-14 20:41:01 +0000
+++ b/lisp/finder.el    2014-06-29 02:33:50 +0000
@@ -52,7 +52,7 @@
     (frames     . "Emacs frames and window systems")
     (games     . "games, jokes and amusements")
     (hardware  . "interfacing with system hardware")
-    (help      . "on-line help systems")
+    (help      . "Emacs help systems")
     (hypermedia . "links between text or other media types")
     (i18n      . "internationalization and character-set support")
     (internal  . "code for Emacs internals, build process, defaults")

=== modified file 'lisp/help.el'
--- a/lisp/help.el      2014-04-08 19:48:38 +0000
+++ b/lisp/help.el      2014-06-29 02:33:50 +0000
@@ -23,7 +23,7 @@
 
 ;;; Commentary:
 
-;; This code implements GNU Emacs's on-line help system, the one invoked by
+;; This code implements GNU Emacs's built-in help system, the one invoked by
 ;; `M-x help-for-help'.
 
 ;;; Code:
@@ -202,13 +202,13 @@
               documentation matches the PATTERN (a list of words or a regexp).
 e           Go to the *Messages* buffer which logs echo-area messages.
 f FUNCTION  Display documentation for the given function.
-F COMMAND   Show the on-line manual's section that describes the command.
+F COMMAND   Show the Emacs manual's section that describes the command.
 g           Display information about the GNU project.
 h           Display the HELLO file which illustrates various scripts.
-i           Start the Info documentation reader: read on-line manuals.
+i           Start the Info documentation reader: read included manuals.
 I METHOD    Describe a specific input method, or RET for current.
 k KEYS      Display the full documentation for the key sequence.
-K KEYS      Show the on-line manual's section for the command bound to KEYS.
+K KEYS      Show the Emacs manual's section for the command bound to KEYS.
 l           Show last 300 input keystrokes (lossage).
 L LANG-ENV  Describes a specific language environment, or RET for current.
 m           Display documentation of current minor modes and current major 
mode,
@@ -218,7 +218,7 @@
 P PACKAGE   Describe the given Emacs Lisp package.
 r           Display the Emacs manual in Info mode.
 s           Display contents of current syntax table, plus explanations.
-S SYMBOL    Show the section for the given symbol in the on-line manual
+S SYMBOL    Show the section for the given symbol in the Info manual
               for the programming language used in this buffer.
 t           Start the Emacs learn-by-doing tutorial.
 v VARIABLE  Display the given variable's documentation and value.

=== modified file 'lisp/progmodes/f90.el'
--- a/lisp/progmodes/f90.el     2014-01-01 07:43:34 +0000
+++ b/lisp/progmodes/f90.el     2014-06-29 02:33:50 +0000
@@ -71,8 +71,8 @@
 ;; For example:
 ;; (add-to-list 'auto-mode-alist '("\\.f\\'" . f90-mode))
 
-;; Once you have entered f90-mode, you may get more info by using
-;; the command describe-mode (C-h m). For online help use
+;; Once you have entered f90-mode, you can get more info by using
+;; the command describe-mode (C-h m).  For help use
 ;; C-h f <Name of function you want described>, or
 ;; C-h v <Name of variable you want described>.
 

=== modified file 'lisp/progmodes/pascal.el'
--- a/lisp/progmodes/pascal.el  2014-04-10 13:56:28 +0000
+++ b/lisp/progmodes/pascal.el  2014-06-29 02:33:50 +0000
@@ -26,8 +26,8 @@
 ;; =====
 
 ;; Emacs should enter Pascal mode when you find a Pascal source file.
-;; When you have entered Pascal mode, you may get more info by pressing
-;; C-h m. You may also get online help describing various functions by:
+;; When you have entered Pascal mode, you can get more info by pressing
+;; C-h m.  You can also get help describing various functions by:
 ;; C-h f <Name of function you want described>
 
 ;; If you want to customize Pascal mode to fit you better, you may add

=== modified file 'lisp/vc/ediff-mult.el'
--- a/lisp/vc/ediff-mult.el     2014-01-01 07:43:34 +0000
+++ b/lisp/vc/ediff-mult.el     2014-06-29 02:33:50 +0000
@@ -140,7 +140,7 @@
  uh/um:\tunmark all sessions marked for hiding/operation
  n,SPC:\tnext session
  p,DEL:\tprevious session
-     E:\tbrowse Ediff on-line manual
+     E:\tbrowse Ediff manual
      T:\ttoggle truncation of long file names
      q:\tquit this session group
 ")
@@ -1464,7 +1464,7 @@
      R in any Ediff session:   display session registry
      n,SPC: next session
      p,DEL: previous session
-         E: browse Ediff on-line manual
+         E: browse Ediff manual
          q: bury registry
 
 

=== modified file 'lisp/vc/ediff-ptch.el'
--- a/lisp/vc/ediff-ptch.el     2014-01-01 07:43:34 +0000
+++ b/lisp/vc/ediff-ptch.el     2014-06-29 02:33:50 +0000
@@ -735,7 +735,7 @@
     ediff-patch-program    = %S             ediff-patch-options    = %S
     ediff-backup-extension = %S             ediff-backup-specs     = %S
 
-See Ediff on-line manual for more details on these variables.
+See Ediff manual for more details on these variables.
 In particular, check the documentation for `ediff-backup-specs'.
 
 In any of the above cases, Ediff doesn't compare files automatically.

=== modified file 'lisp/vc/ediff.el'
--- a/lisp/vc/ediff.el  2014-04-02 07:07:11 +0000
+++ b/lisp/vc/ediff.el  2014-06-29 02:33:50 +0000
@@ -64,7 +64,7 @@
 ;; compressed files.  Details are given below.
 
 ;; Finally, Ediff supports directory-level comparison, merging and patching.
-;; See the on-line manual for details.
+;; See the Ediff manual for details.
 
 ;; This package builds upon the ideas borrowed from emerge.el and several
 ;; Ediff's functions are adaptations from emerge.el.  Much of the functionality


reply via email to

[Prev in Thread] Current Thread [Next in Thread]