procyberian/emacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Doc and comment fixes re "online" help

Browse source 
* 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.

Fixes: debbugs:17803
This commit is contained in:
Glenn Morris 2014-06-28 19:33:50 -07:00
parent 64de2916ca
commit a27e8c78c0
23 changed files with 71 additions and 40 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
doc/emacs/ChangeLog
View file

@ -1,3 +1,9 @@
2014-06-29 Glenn Morris <rgm@gnu.org>
* help.texi (Misc Help):
* trouble.texi (Checklist): "Online" help doesn't mean what it
used to any more.
2014-06-08 Glenn Morris <rgm@gnu.org>
* entering.texi (Entering Emacs): Small fix re initial-buffer-choice.

3
doc/emacs/help.texi
View file

@ -490,8 +490,7 @@ currently in use. @xref{Coding Systems}.
@kindex C-h i
@findex info
@cindex Info
@cindex manuals, on-line
@cindex on-line manuals
@cindex 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

2
doc/emacs/trouble.texi
View file

@ -847,7 +847,7 @@ conclusion from our observations.
@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

5
doc/lispintro/ChangeLog
View file

@ -1,3 +1,8 @@
2014-06-29 Glenn Morris <rgm@gnu.org>
* 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 <rgm@gnu.org>
* emacs-lisp-intro.texi (X11 Colors): Don't use setq with hooks.

8
doc/lispintro/emacs-lisp-intro.texi
View file

@ -903,7 +903,7 @@ file, @file{cl.el}, that adds many Common Lisp features to Emacs Lisp.)
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 @@ specialized library, such as a law library or an engineering library,
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
@file{rmail@dots{}} files provide code for reading electronic mail.)
In @cite{The GNU Emacs Manual}, you will see sentences such as ``The
@ -18685,9 +18685,9 @@ easy-to-read description of Emacs Lisp. It is written not only for
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.

5
doc/lispref/ChangeLog
View file

@ -1,3 +1,8 @@
2014-06-29 Glenn Morris <rgm@gnu.org>
* help.texi (Help Functions): "Online" help doesn't mean what it
used to any more.
2014-06-26 Glenn Morris <rgm@gnu.org>
* minibuf.texi (Intro to Minibuffers): Batch mode is basic.

2
doc/lispref/help.texi
View file

@ -508,7 +508,7 @@ non-@code{nil}, the return value is always a vector.
@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.

3
doc/misc/ChangeLog
View file

@ -1,5 +1,8 @@
2014-06-29 Glenn Morris <rgm@gnu.org>
* 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 <sdl.web@gmail.com>

6
doc/misc/info.texi
View file

@ -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 @@ modify this GNU manual.''
@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 @@ program on a computer, so that you can try Info commands while reading
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

22
doc/misc/mh-e.texi
View file

@ -227,7 +227,7 @@ have, see @ref{Getting Started}.
@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 @@ This chapter begins the meat of the manual which goes into more detail
about every MH-E command and option.
@cindex Emacs, info
@cindex Emacs, online help
@cindex Emacs, built-in help
@cindex info
@cindex online help
@cindex built-in help
@findex describe-mode
@findex mh-help
@kindex ?
@ -1083,12 +1083,12 @@ summaries at the beginning of each chapter. In case you have or would
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 summary@footnote{This
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 @@ exist,
@c Yes, some of the stuff in the following sections is redundant, but
@c TeX barfs if the @ifs are inside the @footnote.
@iftex
@footnote{The @cite{GNU Emacs Lisp Reference Manual} may be available
online in the Info system by typing @kbd{C-h i m Emacs Lisp
@footnote{The @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
@footnote{@xref{Top, 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 @@ Lisp directory on your system (such as
@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 @@ see the section
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

5
etc/ChangeLog
View file

@ -1,3 +1,8 @@
2014-06-29 Glenn Morris <rgm@gnu.org>
* refcards/calccard.tex (section{Getting Help}):
Meaning of "on-line" has changed.
2014-06-27 Glenn Morris <rgm@gnu.org>
* publicsuffix.txt: Update from source.

2
etc/refcards/calccard.tex
View file

@ -297,7 +297,7 @@ \section{Getting Help}
\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}

8
lisp/ChangeLog
View file

@ -1,5 +1,13 @@
2014-06-29 Glenn Morris <rgm@gnu.org>
* 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.

2
lisp/cus-edit.el
View file

@ -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

2
lisp/ehelp.el
View file

@ -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.

2
lisp/emulation/viper.el
View file

@ -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:

2
lisp/finder.el
View file

@ -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")

10
lisp/help.el
View file

@ -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 @@ d PATTERN Show a list of functions, variables, and other items whose
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 TOPIC Find packages matching a given topic keyword.
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.

4
lisp/progmodes/f90.el
View file

@ -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>.

4
lisp/progmodes/pascal.el
View file

@ -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

4
lisp/vc/ediff-mult.el
View file

@ -140,7 +140,7 @@ Useful commands (type ? to hide them and free up screen):
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 @@ Useful commands:
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

2
lisp/vc/ediff-ptch.el
View file

@ -735,7 +735,7 @@ The second problem might be due to an incompatibility among these settings:
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.

2
lisp/vc/ediff.el
View file

@ -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