diff options
author | Chong Yidong <cyd@gnu.org> | 2012-09-30 17:18:38 +0800 |
---|---|---|
committer | Chong Yidong <cyd@gnu.org> | 2012-09-30 17:18:38 +0800 |
commit | 48de8b12215e22390db1bc822e809708070ab938 (patch) | |
tree | 125595be25583796bec86a019f75c8049164133e /doc/lispref/help.texi | |
parent | 5938d5196d09aff887aa74603c102b1f303a613a (diff) | |
download | emacs-48de8b12215e22390db1bc822e809708070ab938.tar.gz emacs-48de8b12215e22390db1bc822e809708070ab938.tar.bz2 emacs-48de8b12215e22390db1bc822e809708070ab938.zip |
Update docs for a bunch of 24.3 changes.
* doc/emacs/killing.texi (Rectangles): Document copy-rectangle-as-kill.
* doc/emacs/search.texi (Special Isearch): Document the lax space search
feature and M-s SPC.
(Regexp Search): Move main search-whitespace-regexp description to
Special Isearch.
(Replace): Document replace-lax-whitespace.
* doc/emacs/basic.texi (Position Info): Document C-u M-=.
(Moving Point): Document move-to-column.
* doc/emacs/display.texi (Useless Whitespace): Add delete-trailing-lines.
* doc/emacs/misc.texi (emacsclient Options): Document the effect of
initial-buffer-choice on client frames. Document server-auth-dir.
Do not document server-host, which is bad security practice.
* doc/emacs/building.texi (Lisp Libraries): Docstring lookups can trigger
autoloading. Document help-enable-auto-load.
* doc/emacs/mini.texi (Yes or No Prompts): New node.
* doc/emacs/ack.texi (Acknowledgments): Remove obsolete packages.
* doc/lispref/commands.texi (Click Events): Define "mouse position list".
Remove mention of unimplemented horizontal scroll bars.
(Drag Events, Motion Events): Refer to "mouse position list".
(Accessing Mouse): Document posnp.
* doc/lispref/errors.texi (Standard Errors): Tweak arith-error description.
Tweak markup. Remove domain-error and friends, which seem to be
unused after the floating-point code revamp.
* doc/lispref/functions.texi (Obsolete Functions): Obsolescence also affects
documentation commands. Various clarifications.
(Declare Form): New node.
* doc/lispref/loading.texi (Autoload):
* doc/lispref/help.texi (Documentation Basics): The special sequences can
trigger autoloading.
* doc/lispref/macros.texi (Defining Macros): Move description of `declare' to
Declare Form node.
* doc/lispref/numbers.texi (Integer Basics): Copyedits.
(Float Basics): Consider IEEE floating point always available.
(Random Numbers): Document actual limits.
(Arithmetic Operations): Clarify division by zero. Don't mention
the machine-independence of negative division since it does not
happen in practice.
* doc/lispref/os.texi (Idle Timers): Minor clarifications.
(User Identification): Add system-users and system-groups.
* doc/lispref/strings.texi (String Basics): Copyedits.
* lisp/minibuffer.el (minibuffer-local-filename-syntax): Doc fix.
* lisp/server.el (server-host): Document the security implications.
(server-auth-key): Doc fix.
* lisp/startup.el (initial-buffer-choice): Doc fix.
* src/fns.c (Frandom): Doc fix.
Diffstat (limited to 'doc/lispref/help.texi')
-rw-r--r-- | doc/lispref/help.texi | 16 |
1 files changed, 11 insertions, 5 deletions
diff --git a/doc/lispref/help.texi b/doc/lispref/help.texi index 5dd8f3c11f5..1375a057a5a 100644 --- a/doc/lispref/help.texi +++ b/doc/lispref/help.texi @@ -58,11 +58,17 @@ use @kbd{C-h f} (@code{describe-function}) or @kbd{C-h v} are many other conventions for documentation strings; see @ref{Documentation Tips}. - Documentation strings can contain several special substrings, which -stand for key bindings to be looked up in the current keymaps when the -documentation is displayed. This allows documentation strings to refer -to the keys for related commands and be accurate even when a user -rearranges the key bindings. (@xref{Keys in Documentation}.) + Documentation strings can contain several special text sequences, +referring to key bindings which are looked up in the current keymaps +when the user views the documentation. This allows the help commands +to display the correct keys even if a user rearranges the default key +bindings. @xref{Keys in Documentation}. + + In the documentation string of an autoloaded command +(@pxref{Autoload}), these special text sequences have an additional +special effect: they cause @kbd{C-h f} (@code{describe-function}) on +the command to trigger autoloading. (This is needed for correctly +setting up the hyperlinks in the @file{*Help*} buffer). @vindex emacs-lisp-docstring-fill-column Emacs Lisp mode fills documentation strings to the width |