1
0
mirror of https://git.savannah.gnu.org/git/emacs.git synced 2024-12-17 10:06:13 +00:00
Commit Graph

144 Commits

Author SHA1 Message Date
Glenn Morris
5887564d5b Move generalized variable documentation from misc/cl.texi to lispref
* doc/lispref/variables.texi (Generalized Variables): New section,
adapted from misc/cl.texi.

* doc/lispref/elisp.texi (Top): Add Generalized Variables to menu.

* doc/lispref/lists.texi (List Elements, List Variables):
Mention generalized variables.

* doc/misc/cl.texi (Control Structure): Update for setf now being in core.
(Setf Extensions): Rename from Basic Setf.  Move much of the
former content to lispref/variables.texi.
(Modify Macros): Move pop, push details to lispref/variables.texi.
(Customizing Setf): Copyedits for setf etc being in core.
(Modify Macros, Efficiency Concerns, Porting Common Lisp):
Further namespaces updates.
2012-10-27 15:42:07 -07:00
Chong Yidong
75e8f9d2de Improve documentation of easy-menu-define.
* lisp/emacs-lisp/easymenu.el (easy-menu-define): Doc fix.

* doc/lispref/keymaps.texi (Toolkit Differences): Node deleted.
(Easy Menu): New node.

Fixes: debbugs:12628
2012-10-24 11:48:50 +08:00
Chong Yidong
48de8b1221 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.
2012-09-30 17:18:38 +08:00
Chong Yidong
ed1f0bd388 Doc fixes for defface and friends.
* lisp/cus-edit.el (custom-unlispify-remove-prefixes): Add warning.

* lisp/custom.el (defface): Doc fix.

* doc/lispref/customize.texi (Customization): Define customization more
carefully.
(Common Keywords): Add xref to Constant Variables.

* doc/lispref/display.texi (Faces): Discuss anonymous faces.
(Face Attributes): Tweak intro.
(Defining Faces): Move after the Face Attributes node.  Copyedits.
(Displaying Faces): Describe role of inheritance.

* doc/lispref/variables.texi (Defining Variables): Link to defcustom's node
instead of the higher-level Customization chapter.

Fixes: debbugs:11440
2012-09-18 13:14:42 +08:00
Chong Yidong
02676e5d3d Doc fixes and improvements for syntax tables.
* src/syntax.c (Fmodify_syntax_entry): Doc fix.

* doc/lispref/syntax.texi (Syntax Basics): Rearrange the text for clarity.
Fix description of syntax table inheritance.
(Syntax Table Functions): Don't refer to internal contents of
syntax table, since that is not explained yet.  Copyedits.
(Standard Syntax Tables): Node deleted.
(Syntax Table Internals): Misc clarifications.  Improve table
formatting.

* doc/lispref/keymaps.texi (Inheritance and Keymaps):
* doc/lispref/text.texi (Sticky Properties): Tweak index entry.
2012-08-04 22:33:00 +08:00
Paul Eggert
09ae5da1b8 Prefer typical American spelling for "acknowledgment". 2012-07-24 22:48:19 -07:00
Chong Yidong
d4913798ad Misc fixes for Lisp manual.
* doc/lispref/intro.texi (A Sample Function Description): Fix incorrect
markup, undoing previous change.
(A Sample Variable Description): Minor clarifications and markup
improvements.

* doc/lispref/elisp.texi (Top):
* doc/lispref/text.texi (Text): Fix menu order.
2012-07-06 12:25:04 +08:00
Chong Yidong
41b7f8bc6c Merge changes from emacs-24; up to 2012-04-26T02:03:19Z!ueno@unixuser.org 2012-06-17 13:13:40 +08:00
Chong Yidong
84f4a53180 More minor manual copyedits to fix 7x9 manual underfull/overfull hboxes.
* doc/emacs/emacs.texi: Remove urlcolor setting.

* doc/lispref/elisp.texi, vol1.texi, vol2.texi: Remove urlcolor setting.

* doc/lispref/vol2.texi: Include package.texi.
2012-06-11 14:48:47 +08:00
Glenn Morris
ecc6530da9 Nuke hand-written node pointers in doc/lispref
Let makeinfo figure them out, as is recommended.
2012-05-26 18:34:14 -07:00
Glenn Morris
5b6eebcf2b Remove the need for lispref vol1.texi and vol2.texi
* vol1.texi, vol2.texi: Remove files.
* elisp.texi: Add VOL1,2 conditionals equivalent to vol1,2.texi
* two-volume.make: Use elisp.texi as input rather than vol1,2.texi.
2012-05-08 20:11:41 -07:00
Glenn Morris
ca4b98faff Stop keeping 3 copies of the lispref menu structure for no reason
vol1.texi and vol2.texi are only used to generate TeX output, and this
constructs its own table of contents and does not use the @menu stuff.

* vol1.texi, vol2.texi: No need to keep menus in these files.
* elisp.texi, anti.texi: Comments.
2012-05-07 23:38:27 -07:00
Chong Yidong
eceeb5fca6 Merge from emacs-24; up to 2012-04-20T05:47:55Z!eliz@gnu.org 2012-05-05 12:32:58 +08:00
Glenn Morris
cfed8eeb2f * elisp.texi (DATE): Forgot to change the month in 2012-04-21 change. 2012-05-04 00:04:40 -07:00
Glenn Morris
bbba8869a2 Only print the edition number of the manuals in the TeX version
Frankly, I think the edition conveys little to no information.
The version number of Emacs is much more relevant.
No-one seems to know what the rules are for updating the edition anyway...

* doc/emacs/emacs.texi (@copying): Only print EDITION in the TeX version.

* doc/lispref/elisp.texi (@copying):
* doc/lispref/intro.texi (Introduction): Only print VERSION in the TeX version.
2012-05-01 00:38:15 -07:00
Glenn Morris
cf98857824 Some menu fixes for doc/lispref
* doc/lispref/elisp.texi, doc/lispref/vol1.texi, doc/lispref/vol2.texi:
Some fixes for detailed menu.

* doc/lispref/modes.texi (Major Modes, Auto-Indentation):
* doc/lispref/buffers.texi (Buffers): Some fixes for menu descriptions.
2012-04-26 13:56:38 -04:00
Glenn Morris
1a72be4624 Add "et al." to authors for emacs and elisp manuals.
This seems only fair, since there have been a large number of
contributors since the original ones.

* doc/emacs/emacs.texi:
* doc/lispref/book-spine.texi, doc/lispref/elisp.texi, doc/lispref/vol1.texi:
* doc/lispref/vol2.texi:
Add "et al." to authors.
2012-04-25 20:48:08 -04:00
Glenn Morris
0dc91072e3 Bump lispref version
* doc/lispref/elisp.texi, doc/lispref/vol1.texi, doc/lispref/vol2.texi:
Bump VERSION and DATE (in case we forgoet to do it later).
I don't know what VERSION means, but it should be bigger than before.
Note that README no longer mentions these.
2012-04-20 20:46:58 -04:00
Glenn Morris
b58b1df840 More small edits for doc/lispref/minibuf.texi
* doc/lispref/elisp.texi, doc/lispref/vol1.texi, doc/lispref/vol2.texi:
* doc/lispref/minibuf.texi (Completion):
Update "High-Level Completion" description.

* doc/lispref/minibuf.texi (Basic Completion):
No need to describe obarrays here.
Don't mention obsolete `nospace' argument of all-completions.
(Minibuffer Completion, Completion Commands, Reading File Names)
(Completion Variables): Copyedits.
(Completion Commands): Mention parent keymaps.
Remove obsolete minibuffer-local-filename-must-match-map.
(High-Level Completion): Remove read-variable's almost
word-for-word duplication of read-command.
2012-04-19 21:37:14 -04:00
Glenn Morris
c0ea08d2d1 More small edits for doc/lispref/minibuf.texi
* doc/lispref/minibuf.texi (Object from Minibuffer):
Remove overly pedantic paragraph.
(Minibuffer History): Copyedits.  Add face-name-history.
(Initial Input, Yes-or-No Queries, Multiple Queries)
(Minibuffer Windows, Minibuffer Misc): Copyedits.
(Yes-or-No Queries): Tweak example.
(Minibuffer Commands): Add next-complete-history-element.
(Minibuffer Misc): Mention minibuffer-message-timeout, and
minibuffer-inactive-mode.

* doc/lispref/minibuf.texi (Minibuffers):
* doc/lispref/elisp.texi, doc/lispref/vol1.texi, doc/lispref/vol2.texi:
Fix minibuffer subsection order.

* lisp/subr.el: Comment.
2012-04-18 23:04:05 -07:00
Chong Yidong
81927dd2a4 New Lisp manual nodes, Applying Customizations and Custom Themes.
* doc/lispref/customize.texi (Applying Customizations):
(Custom Themes): New nodes.

* doc/lispref/display.texi (Defining Faces): Reference custom-set-faces.

* doc/lispref/modes.texi (Defining Minor Modes, Defining Minor Modes):
* doc/lispref/os.texi (Startup Summary): Copyedits.

* doc/emacs/custom.texi (Creating Custom Themes): Add reference to Custom
Themes node in Lisp manual.

* lisp/custom.el (custom-theme-set-variables): Doc fix.
2012-04-12 22:50:58 +08:00
Glenn Morris
48cac0510d Update lispref antinews menu descriptions per comment in anti.texi 2012-04-05 14:32:38 -04:00
Chong Yidong
321cc491c5 Document completion-extra-properties in Lisp manual.
* doc/lispref/minibuf.texi (Programmed Completion): Remove obsolete variable
completion-annotate-function.
(Completion Variables): Rename from Completion Styles.  Document
completion-extra-properties.  Document completion-styles-alist
change.

* lisp/minibuffer.el (completion-extra-properties): Doc fix.
2012-04-04 17:19:32 +08:00
Chong Yidong
3d439cd10f Several miscellaneous doc changes.
* doc/lispref/display.texi (Delayed Warnings): New node.

* doc/misc/gnus-faq.texi (FAQ 8-2): Mention EasyPG.

* doc/misc/gnus.texi: Reduce references to obsolete pgg library.
(Security): Note that epg is now the default.

* doc/misc/message.texi (Using PGP/MIME): Note that epg is now the default.

* doc/misc/nxml-mode.texi (Completion): C-RET is no longer bound to
nxml-complete.

* lisp/subr.el (delayed-warnings-hook): Doc fix.

* src/keyboard.c (Vdelayed_warnings_list): Doc fix.
2012-04-04 15:54:02 +08:00
Michael Albinus
9ff687e181 * os.texi (Terminal-Specific): Fix typo.
(Notifications): New section.

* elisp.texi (Top):
* vol1.texi (Top):
* vol2.texi (Top): Add "Notifications" and "Dynamic Libraries"
menu entries.
2012-04-03 10:10:17 +02:00
Chong Yidong
9a69676ae6 Updates to Display chapter of Lisp manual.
* doc/lispref/display.texi (Fringes): Note that fringes are shown on graphical
displays only.
(Fringe Size/Pos, Fringe Bitmaps, Making Buttons): Clarifications.
(Replacing Specs): Clarify example.
(Manipulating Buttons): Note that button-at can return a marker.
(Buttons): Minor rewrite.
(Character Display): New node.  Consolidate all character display
related nodes into its subsections.
(Usual Display): Character 127 is also affected by ctl-arrow.
(Display Tables): Improve example.

* lisp/button.el (button-at): Minor addition to docstring.
2012-03-25 15:58:59 +08:00
Chong Yidong
483ab23014 More updates to Text chapter of Lisp manual.
* doc/lispref/text.texi (Mode-Specific Indent): Document new behavior of
indent-for-tab-command.  Document tab-always-indent.
(Special Properties): Copyedits.
(Checksum/Hash): Improve secure-hash doc.  Do not recommend MD5.
(Parsing HTML/XML): Rename from Parsing HTML.  Update doc of
libxml-parse-html-region.
2012-03-08 13:27:03 +08:00
Chong Yidong
a08a07e339 Update Frames chapter of Lisp manager. Document clipboard manager.
* doc/emacs/killing.texi (Clipboard): Document clipboard manager.

* doc/lispref/windows.texi (Basic Windows, Coordinates and Windows)
(Coordinates and Windows):
* display.texi (Refresh Screen, Line Height, Face Attributes)
(Overlay Arrow, Beeping, Glyphless Chars): Likewise.

* doc/lispref/frames.texi (Frames): Remove little-used "terminal frame" and
"window frame" terminology.
(Frame Parameters, Font and Color Parameters, Initial Parameters)
(Size and Position, Visibility of Frames): Callers changed.
(Frames): Clarify which terminals in framep are graphical.
(Initial Parameters): --geometry is not the only option which adds
to initial-frame-alist.
(Position Parameters): Note that icon-left and icon-top are for
old window managers only.
(Size Parameters): Sizes are in characters even on graphical
displays.
(Management Parameters): Note that window-id and outer-window-id
can't really be changed, and that auto-raise isn't always obeyed.
(Cursor Parameters): Document cursor-type explicitly.
(Size and Position): The aliases set-screen-height and
set-screen-width have been deleted.
(Visibility of Frames): Mention "minimization".

* doc/lispref/os.texi (Startup Summary): Minor clarifications.
(Startup Summary, Suspending Emacs): Standardize on "text
terminal" terminology.
2012-03-04 14:50:18 +08:00
Glenn Morris
ea16568d87 Checked lispref/abbrevs.texi
* doc/lispref/abbrevs.texi: Small copyedits throughout.
(Abbrev Mode): Remove this section, folding it into the top-level.
(Abbrev Tables): Don't mention irrelevant return values.
(Abbrev Expansion): Add cross-ref for wrapper hooks.
(Standard Abbrev Tables): Emacs Lisp mode now has its own table.
(Abbrev Table Properties): Update nil :regexp description.

* lisp/abbrev.el (copy-abbrev-table, abbrev-table-p)
(abbrev-minor-mode-table-alist, define-abbrev, abbrev-insert)
(expand-abbrev, define-abbrev-table): Doc fixes.

* admin/FOR-RELEASE: Related markup.
2012-03-03 18:45:04 -08:00
Glenn Morris
4186e87785 Standardize some lispref menu entries. 2012-03-01 21:54:47 -05:00
Glenn Morris
775b55af35 Use "" quotes in menus
This is already used in most places. ``...'' does not get specially
converted by texinfo in @menu descriptions.

* doc/emacs/emacs.texi, doc/emacs/help.texi, doc/emacs/text.texi:
* doc/lispref/elisp.texi, doc/lispref/vol1.texi, doc/lispref/vol2.texi:
* doc/misc/sem-user.texi, doc/misc/url.texi, doc/misc/woman.texi:
Use "" quotes in menus.
2012-02-29 00:11:23 -08:00
Glenn Morris
44e97401cd Standardize possessive apostrophe usage in manuals, docs, and comments
Ref: http://lists.gnu.org/archive/html/emacs-devel/2012-02/msg00649.html
2012-02-28 00:17:21 -08:00
Glenn Morris
2915737190 Remove lispref/locals.texi
Ref: http://lists.gnu.org/archive/html/emacs-devel/2012-02/msg00702.html

* doc/lispref/locals.texi: Remove file.
* doc/lispref/elisp.texi, doc/lispref/vol1.texi, doc/lispref/vol2.texi:
Don't include locals.texi.  Remove menu entry.
* doc/lispref/errors.texi, doc/lispref/maps.texi: Adjust node pointers.
* doc/lispref/internals.texi (Buffer Internals):
Remove cross-refs to locals.texi.
* doc/lispref/Makefile.in (srcs): Remove locals.texi.

* admin/FOR-RELEASE: Related markup.
2012-02-27 20:17:02 -08:00
Glenn Morris
7e05b1ec63 Checked errors.texi
* doc/lispref/errors.texi: Don't try to list _all_ the error symbols.
Add circular-list, cl-assertion-failed, compression-error.
* doc/lispref/elisp.texi, doc/lispref/vol1.texi, doc/lispref/vol2.texi:
* doc/lispref/control.texi (Error Symbols): Tweak "Standard Errors" description.
* admin/FOR-RELEASE: Related markup.
2012-02-25 12:59:46 -08:00
Chong Yidong
a59225b146 Update Files chapter in Lisp manual.
* doc/lispref/files.texi (Files): Mention magic file names as arguments.
(Reading from Files): Copyedits.
(File Attributes): Mention how to change file modes.
(Changing Files): Use standard "file permissions" terminology.
Add xref to File Attributes node.
(Locating Files): Document locate-user-emacs-file.
(Unique File Names): Recommend against using make-temp-name.

* src/buffer.c (Fget_file_buffer): Protect against invalid file
handler return value.

* src/fileio.c (Vfile_name_handler_alist): Doc fix.
2012-02-21 21:24:48 +08:00
Chong Yidong
8376d7c25a Updates to Documentation chapter of Lisp manual.
* doc/lispref/help.texi (Documentation, Documentation Basics, Help Functions):
Minor clarifications.
(Accessing Documentation): Clarify what documentation-property is
for.  Add xref to Keys in Documentation.

* doc/lispref/macros.texi (Defining Macros):
* doc/lispref/modes.texi (Derived Modes): Say "documentation string" instead
of docstring.

* doc/lispref/tips.texi (Documentation Tips): Don't recommend using * in
docstrings.
2012-02-19 13:54:33 +08:00
Chong Yidong
82233bead8 Give Tabulated List mode its own Lisp manual node.
* modes.texi (Tabulated List Mode): New node.
(Basic Major Modes): Add xref to it.

* processes.texi (Process Information): Mention Process Menu mode.
2012-02-18 21:38:33 +08:00
Chong Yidong
4230351b56 Update Syntax chapter of Lisp manual.
* doc/lispref/syntax.texi (Syntax Tables, Syntax Descriptors)
(Syntax Table Functions): Copyedits.
(Syntax Basics): Don't repeat the material in the preceding node.
(Syntax Class Table): Use a table.
(Syntax Properties): Document syntax-propertize-function and
syntax-propertize-extend-region-functions.
(Motion via Parsing): Fix indentation.
(Parser State): Update for the new "c" comment style.  Fix
description of item 7 (comment style).

* doc/lispref/modes.texi (Syntactic Font Lock): Add xref to Syntactic Font Lock node.
2012-02-16 22:43:41 +08:00
Chong Yidong
f700caa38b Updates to Font Lock docs in Lisp manual.
* doc/lispref/modes.texi (Minor Modes): Update how mode commands should treat
arguments now.
(Mode Line Basics): Clarify force-mode-line-update.
(Mode Line Top): Note that the example is not realistic.
(Mode Line Variables, Mode Line Data, %-Constructs, Header Lines)
(Emulating Mode Line): Use "mode line" instead of "mode-line", and
"mode line construct" instead of "mode line specification".
(Syntactic Font Lock): Remove mention of obsolete variable
font-lock-syntactic-keywords.
(Setting Syntax Properties): Node deleted.
(Font Lock Mode): Note that Font Lock mode is a minor mode.
(Font Lock Basics): Note that syntactic fontification falls back
on `syntax-table'.
(Search-based Fontification): Emphasize that font-lock-keywords
should not be set directly.
(Faces for Font Lock): Avoid some confusing terminology.
(Syntactic Font Lock): Minor clarifications.
2012-02-16 14:04:38 +08:00
Chong Yidong
60236b0dca Docstring and manual updates for completion-at-point-functions.
* doc/lispref/minibuf.texi (Basic Completion): Define "completion table".
Move completion-in-region to Completion in Buffers node.
(Completion Commands): Use "completion table" terminology.
(Completion in Buffers): New node.

* doc/lispref/modes.texi (Hooks): add-hook can be used for abnormal hooks too.
(Setting Hooks): Update minor mode usage example.
(Major Mode Conventions): Note that completion-at-point-functions
should be altered locally.  Add xref to Completion in Buffers.

* lisp/minibuffer.el (completion-at-point-functions): Doc fix.
2012-02-15 21:45:02 +08:00
Chong Yidong
355cabc6c7 Update Debugging chapter of Lisp manual.
* doc/emacs/debugging.texi (Debugging): Copyedits.  Describe testcover, ERT.
(Error Debugging): Note that debug-ignored-errors overrides list
values of debug-on-error too.  Add xref to Signaling Errors.  Note
that debug-on-signal is not customizable.  Mention
condition-case-unless-debug.
(Compilation Errors): Node deleted.

* doc/emacs/compile.texi (Compiler Errors): Move a paragraph here from
deleted node Compilation Errors.
2012-02-11 14:17:22 +08:00
Chong Yidong
25dec36509 Update Compilation and Advice chapters in Lisp manual.
* doc/lispref/advice.texi (Defining Advice): Clarify ad-unadvise.
(Activation of Advice): Specifying the ACTIVATE flag in defadvice
is not abnormal.
(Advising Primitives): Node deleted; ad-define-subr-args has been
removed.

* doc/lispref/compile.texi (Speed of Byte-Code): Use float-time in example.
(Compilation Functions): Note that the log uses Compilation mode.
Don't discuss the contents of byte-code function object here.
(Compilation Functions): De-document internal function byte-code.
(Docs and Compilation): Minor clarifications.

* doc/lispref/objects.texi (Byte-Code Type): Add xref to Byte-Code Function
Objects.

* lisp/emacs-lisp/advice.el: Update commentary to reflect deletion of
ad-define-subr-args
2012-02-10 23:50:11 +08:00
Glenn Morris
5f5e4ea10c Document secure-hash
* doc/lispref/text.texi (Checksum/Hash): Rename node from MD5 Checksum.
Mention secure-hash.
* doc/lispref/elisp.texi, doc/lispref/vol1.texi, doc/lispref/vol2.texi:
Update menu entry.
* etc/NEWS: Related markup.
2012-02-10 00:51:37 -08:00
Chong Yidong
03988c98df Updates to Macros and Customization chapters of Lisp manual.
* doc/lispref/customize.texi (Common Keywords): Minor clarifications.
Document custom-unlispify-remove-prefixes.
(Variable Definitions): Backquotes in defcustom seem to work fine
now.  Various other copyedits.

* doc/lispref/macros.texi (Expansion): Minor clarification.
(Backquote): Move node to eval.texi.
(Defining Macros): Move an example from Backquote node.
(Argument Evaluation): No need to mention Pascal.
(Indenting Macros): Add xref to Defining Macros.

* doc/lispref/eval.texi (Backquote): Move from macros.texi.

* lisp/custom.el (defcustom): Doc fix.
2012-02-05 14:44:47 +08:00
Chong Yidong
735cc5ca6f Update Functions chapter of Lisp manual; document closures.
* doc/emacs/functions.texi (What Is a Function): Add closures.  Mention
"return value" terminology.  Add xref for command-execute.  Remove
unused "keystroke command" terminology.
(Lambda Expressions): Give a different example than in the
following subsection.  Add xref to Anonymous Functions.
(Function Documentation): Remove gratuitous markup.
(Function Names): Move introductory text to `What Is a Function'.
(Defining Functions): Fix defun argument spec.
(Anonymous Functions): Document lambda macro explicitly.  Mention
effects on lexical binding.
(Function Cells): Downplay direct usage of fset.
(Closures): New node.
(Inline Functions): Remove "open-code" terminology.
(Declaring Functions): Minor tweak; .m is not C code.

* doc/emacs/variables.texi (Variables): Don't refer to "global value".
(Local Variables, Void Variables): Copyedits.
(Lexical Binding): Minor clarification of example.
(File Local Variables): Mention :safe and :risky defcustom args.
(Lexical Binding): Add xref to Closures node.
2012-02-04 22:56:32 +08:00
Glenn Morris
eea14f31d1 Document animated image API
* doc/lispref/display.texi (GIF Images): Mention animation.
Remove commented-out old example of animation.
(Animated Images): New subsection.
* doc/lispref/elisp.texi (Top):
* doc/lispref/vol1.texi (Top):
* doc/lispref/vol2.texi (Top): Add Animated Images menu entry.

* lisp/image-mode.el (image-animate-loop, image-toggle-animation): Doc fixes.

* lisp/image.el (image-animated-p): Doc fix.  Use image-animated-types.
(image-animate-timeout): Doc fix.

* etc/NEWS: Markup.
2012-02-03 00:44:30 -08:00
Chong Yidong
1021c7615d Update Variables chapter of Lisp manual to handle lexical binding.
* doc/lispref/variables.texi (Variables, Local Variables, Void Variables):
Edit to make the descriptions less specific to dynamic binding.
(Local Variables): Default max-specpdl-size is now 1300.
(Defining Variables): Edits for lexical scoping.  Delete
information about starting docstrings with *.  De-document
user-variable-p.
(Tips for Defining): Remove an unimportant discussion of quitting
in the middle of a load.
(Accessing Variables, Setting Variables): Discuss lexical binding.
(Variable Scoping): Rewrite.
(Scope, Extent, Impl of Scope): Nodes deleted.
(Dynamic Binding): New node, with material from Scope, Extent, and
Impl of Scope nodes.
(Dynamic Binding Tips): Rename from Using Scoping.
(Lexical Binding): Rewrite.
(Using Lexical Binding): Rename from Converting to Lexical
Binding.  Convert to subsection.

* doc/lispref/customize.texi (Variable Definitions): Add custom-variable-p.
Move user-variable-p documentation here.
2012-01-25 00:08:00 +08:00
Chong Yidong
31cbea1d3d Update several Lisp manual chapters.
* doc/lispref/eval.texi (Intro Eval, Symbol Forms): Minor tweaks for
correctness with lexical scoping.
(Eval): Copyedits.

* doc/lispref/sequences.texi (Sequence Functions): Don't repeat the
introduction already given in the parent.
(Vectors): Copyedits.
(Rings): Move from lists.texi.  Note that this is specific to the
ring package.

* doc/lispref/lists.texi (Cons Cells): Copyedits.
(List Elements): Mention push.
(List Variables): Mention pop.
(Rings): Move to sequences.texi.

* doc/lispref/strings.texi (Text Comparison): Minor qualification.

* doc/lispref/symbols.texi (Definitions, Symbol Components): Mention variable
scoping issues.
(Plists and Alists): Copyedits.
2012-01-23 12:23:50 +08:00
Glenn Morris
acaf905b11 Add 2012 to FSF copyright years for Emacs files 2012-01-05 01:46:05 -08:00
Paul Eggert
333f9019e2 Spelling fixes. 2011-12-11 21:32:49 -08:00