aboutsummaryrefslogtreecommitdiffstats
path: root/lisp
diff options
context:
space:
mode:
authorGlenn Morris2014-06-28 19:33:50 -0700
committerGlenn Morris2014-06-28 19:33:50 -0700
commita27e8c78c03a911db68885f0beffb69250fc75fe (patch)
tree5242904a7d105a39a33eba2dad8c093da390929b /lisp
parent64de2916ca9a68bed19ea24115231b7c457760ec (diff)
downloademacs-a27e8c78c03a911db68885f0beffb69250fc75fe.tar.gz
emacs-a27e8c78c03a911db68885f0beffb69250fc75fe.zip
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. Fixes: debbugs:17803
Diffstat (limited to 'lisp')
-rw-r--r--lisp/ChangeLog8
-rw-r--r--lisp/cus-edit.el2
-rw-r--r--lisp/ehelp.el2
-rw-r--r--lisp/emulation/viper.el2
-rw-r--r--lisp/finder.el2
-rw-r--r--lisp/help.el10
-rw-r--r--lisp/progmodes/f90.el4
-rw-r--r--lisp/progmodes/pascal.el4
-rw-r--r--lisp/vc/ediff-mult.el4
-rw-r--r--lisp/vc/ediff-ptch.el2
-rw-r--r--lisp/vc/ediff.el2
11 files changed, 25 insertions, 17 deletions
diff --git a/lisp/ChangeLog b/lisp/ChangeLog
index 90cb951681c..1a1f91b0e3d 100644
--- a/lisp/ChangeLog
+++ b/lisp/ChangeLog
@@ -1,5 +1,13 @@
12014-06-29 Glenn Morris <rgm@gnu.org> 12014-06-29 Glenn Morris <rgm@gnu.org>
2 2
3 * cus-edit.el (help):
4 * finder.el (finder-known-keywords):
5 * help.el (help-for-help-internal):
6 * vc/ediff-mult.el (ediff-meta-buffer-verbose-message)
7 (ediff-redraw-registry-buffer):
8 * vc/ediff-ptch.el (ediff-patch-file-internal):
9 Doc fixes re "online" help. (Bug#17803)
10
3 * progmodes/idlwave.el (idlwave): Update url-link for custom group. 11 * progmodes/idlwave.el (idlwave): Update url-link for custom group.
4 (idlwave-mode): Doc URL update. 12 (idlwave-mode): Doc URL update.
5 13
diff --git a/lisp/cus-edit.el b/lisp/cus-edit.el
index 212e29069eb..b54898a171c 100644
--- a/lisp/cus-edit.el
+++ b/lisp/cus-edit.el
@@ -324,7 +324,7 @@
324 :group 'emacs) 324 :group 'emacs)
325 325
326(defgroup help nil 326(defgroup help nil
327 "Support for on-line help systems." 327 "Support for Emacs help systems."
328 :group 'emacs) 328 :group 'emacs)
329 329
330(defgroup multimedia nil 330(defgroup multimedia nil
diff --git a/lisp/ehelp.el b/lisp/ehelp.el
index dd6c6c4cb28..46db552c3f5 100644
--- a/lisp/ehelp.el
+++ b/lisp/ehelp.el
@@ -25,7 +25,7 @@
25;;; Commentary: 25;;; Commentary:
26 26
27;; This package provides a pre-packaged `Electric Help Mode' for 27;; This package provides a pre-packaged `Electric Help Mode' for
28;; browsing on-line help screens. There is one entry point, 28;; browsing Emacs help screens. There is one entry point,
29;; `with-electric-help'; all you have to give it is a no-argument 29;; `with-electric-help'; all you have to give it is a no-argument
30;; function that generates the actual text of the help into the current 30;; function that generates the actual text of the help into the current
31;; buffer. 31;; buffer.
diff --git a/lisp/emulation/viper.el b/lisp/emulation/viper.el
index 650b8acbb81..d1353bdc8fa 100644
--- a/lisp/emulation/viper.el
+++ b/lisp/emulation/viper.el
@@ -107,7 +107,7 @@
107;; ---------------- 107;; ----------------
108;; Bug reports and ideas contributed by many users have helped 108;; Bug reports and ideas contributed by many users have helped
109;; improve Viper and the various versions of VIP. 109;; improve Viper and the various versions of VIP.
110;; See the on-line manual for a complete list of contributors. 110;; See the manual for a complete list of contributors.
111;; 111;;
112;; 112;;
113;;; Notes: 113;;; Notes:
diff --git a/lisp/finder.el b/lisp/finder.el
index 092a2ddd8a4..bb5b441e26d 100644
--- a/lisp/finder.el
+++ b/lisp/finder.el
@@ -52,7 +52,7 @@
52 (frames . "Emacs frames and window systems") 52 (frames . "Emacs frames and window systems")
53 (games . "games, jokes and amusements") 53 (games . "games, jokes and amusements")
54 (hardware . "interfacing with system hardware") 54 (hardware . "interfacing with system hardware")
55 (help . "on-line help systems") 55 (help . "Emacs help systems")
56 (hypermedia . "links between text or other media types") 56 (hypermedia . "links between text or other media types")
57 (i18n . "internationalization and character-set support") 57 (i18n . "internationalization and character-set support")
58 (internal . "code for Emacs internals, build process, defaults") 58 (internal . "code for Emacs internals, build process, defaults")
diff --git a/lisp/help.el b/lisp/help.el
index 72a95244716..fa2a4f207e0 100644
--- a/lisp/help.el
+++ b/lisp/help.el
@@ -23,7 +23,7 @@
23 23
24;;; Commentary: 24;;; Commentary:
25 25
26;; This code implements GNU Emacs's on-line help system, the one invoked by 26;; This code implements GNU Emacs's built-in help system, the one invoked by
27;; `M-x help-for-help'. 27;; `M-x help-for-help'.
28 28
29;;; Code: 29;;; Code:
@@ -202,13 +202,13 @@ d PATTERN Show a list of functions, variables, and other items whose
202 documentation matches the PATTERN (a list of words or a regexp). 202 documentation matches the PATTERN (a list of words or a regexp).
203e Go to the *Messages* buffer which logs echo-area messages. 203e Go to the *Messages* buffer which logs echo-area messages.
204f FUNCTION Display documentation for the given function. 204f FUNCTION Display documentation for the given function.
205F COMMAND Show the on-line manual's section that describes the command. 205F COMMAND Show the Emacs manual's section that describes the command.
206g Display information about the GNU project. 206g Display information about the GNU project.
207h Display the HELLO file which illustrates various scripts. 207h Display the HELLO file which illustrates various scripts.
208i Start the Info documentation reader: read on-line manuals. 208i Start the Info documentation reader: read included manuals.
209I METHOD Describe a specific input method, or RET for current. 209I METHOD Describe a specific input method, or RET for current.
210k KEYS Display the full documentation for the key sequence. 210k KEYS Display the full documentation for the key sequence.
211K KEYS Show the on-line manual's section for the command bound to KEYS. 211K KEYS Show the Emacs manual's section for the command bound to KEYS.
212l Show last 300 input keystrokes (lossage). 212l Show last 300 input keystrokes (lossage).
213L LANG-ENV Describes a specific language environment, or RET for current. 213L LANG-ENV Describes a specific language environment, or RET for current.
214m Display documentation of current minor modes and current major mode, 214m Display documentation of current minor modes and current major mode,
@@ -218,7 +218,7 @@ p TOPIC Find packages matching a given topic keyword.
218P PACKAGE Describe the given Emacs Lisp package. 218P PACKAGE Describe the given Emacs Lisp package.
219r Display the Emacs manual in Info mode. 219r Display the Emacs manual in Info mode.
220s Display contents of current syntax table, plus explanations. 220s Display contents of current syntax table, plus explanations.
221S SYMBOL Show the section for the given symbol in the on-line manual 221S SYMBOL Show the section for the given symbol in the Info manual
222 for the programming language used in this buffer. 222 for the programming language used in this buffer.
223t Start the Emacs learn-by-doing tutorial. 223t Start the Emacs learn-by-doing tutorial.
224v VARIABLE Display the given variable's documentation and value. 224v VARIABLE Display the given variable's documentation and value.
diff --git a/lisp/progmodes/f90.el b/lisp/progmodes/f90.el
index 6aee713dd86..215b8d8358e 100644
--- a/lisp/progmodes/f90.el
+++ b/lisp/progmodes/f90.el
@@ -71,8 +71,8 @@
71;; For example: 71;; For example:
72;; (add-to-list 'auto-mode-alist '("\\.f\\'" . f90-mode)) 72;; (add-to-list 'auto-mode-alist '("\\.f\\'" . f90-mode))
73 73
74;; Once you have entered f90-mode, you may get more info by using 74;; Once you have entered f90-mode, you can get more info by using
75;; the command describe-mode (C-h m). For online help use 75;; the command describe-mode (C-h m). For help use
76;; C-h f <Name of function you want described>, or 76;; C-h f <Name of function you want described>, or
77;; C-h v <Name of variable you want described>. 77;; C-h v <Name of variable you want described>.
78 78
diff --git a/lisp/progmodes/pascal.el b/lisp/progmodes/pascal.el
index cedc2986eda..f32d4641af0 100644
--- a/lisp/progmodes/pascal.el
+++ b/lisp/progmodes/pascal.el
@@ -26,8 +26,8 @@
26;; ===== 26;; =====
27 27
28;; Emacs should enter Pascal mode when you find a Pascal source file. 28;; Emacs should enter Pascal mode when you find a Pascal source file.
29;; When you have entered Pascal mode, you may get more info by pressing 29;; When you have entered Pascal mode, you can get more info by pressing
30;; C-h m. You may also get online help describing various functions by: 30;; C-h m. You can also get help describing various functions by:
31;; C-h f <Name of function you want described> 31;; C-h f <Name of function you want described>
32 32
33;; If you want to customize Pascal mode to fit you better, you may add 33;; If you want to customize Pascal mode to fit you better, you may add
diff --git a/lisp/vc/ediff-mult.el b/lisp/vc/ediff-mult.el
index 9837c20b84d..56ff13fbbb6 100644
--- a/lisp/vc/ediff-mult.el
+++ b/lisp/vc/ediff-mult.el
@@ -140,7 +140,7 @@ Useful commands (type ? to hide them and free up screen):
140 uh/um:\tunmark all sessions marked for hiding/operation 140 uh/um:\tunmark all sessions marked for hiding/operation
141 n,SPC:\tnext session 141 n,SPC:\tnext session
142 p,DEL:\tprevious session 142 p,DEL:\tprevious session
143 E:\tbrowse Ediff on-line manual 143 E:\tbrowse Ediff manual
144 T:\ttoggle truncation of long file names 144 T:\ttoggle truncation of long file names
145 q:\tquit this session group 145 q:\tquit this session group
146") 146")
@@ -1464,7 +1464,7 @@ Useful commands:
1464 R in any Ediff session: display session registry 1464 R in any Ediff session: display session registry
1465 n,SPC: next session 1465 n,SPC: next session
1466 p,DEL: previous session 1466 p,DEL: previous session
1467 E: browse Ediff on-line manual 1467 E: browse Ediff manual
1468 q: bury registry 1468 q: bury registry
1469 1469
1470 1470
diff --git a/lisp/vc/ediff-ptch.el b/lisp/vc/ediff-ptch.el
index d1332351a74..bb6ab1062c1 100644
--- a/lisp/vc/ediff-ptch.el
+++ b/lisp/vc/ediff-ptch.el
@@ -735,7 +735,7 @@ The second problem might be due to an incompatibility among these settings:
735 ediff-patch-program = %S ediff-patch-options = %S 735 ediff-patch-program = %S ediff-patch-options = %S
736 ediff-backup-extension = %S ediff-backup-specs = %S 736 ediff-backup-extension = %S ediff-backup-specs = %S
737 737
738See Ediff on-line manual for more details on these variables. 738See Ediff manual for more details on these variables.
739In particular, check the documentation for `ediff-backup-specs'. 739In particular, check the documentation for `ediff-backup-specs'.
740 740
741In any of the above cases, Ediff doesn't compare files automatically. 741In any of the above cases, Ediff doesn't compare files automatically.
diff --git a/lisp/vc/ediff.el b/lisp/vc/ediff.el
index 927a3ba7fb6..5418039143f 100644
--- a/lisp/vc/ediff.el
+++ b/lisp/vc/ediff.el
@@ -64,7 +64,7 @@
64;; compressed files. Details are given below. 64;; compressed files. Details are given below.
65 65
66;; Finally, Ediff supports directory-level comparison, merging and patching. 66;; Finally, Ediff supports directory-level comparison, merging and patching.
67;; See the on-line manual for details. 67;; See the Ediff manual for details.
68 68
69;; This package builds upon the ideas borrowed from emerge.el and several 69;; This package builds upon the ideas borrowed from emerge.el and several
70;; Ediff's functions are adaptations from emerge.el. Much of the functionality 70;; Ediff's functions are adaptations from emerge.el. Much of the functionality