Standardize some lispref menu entries.
[bpt/emacs.git] / doc / lispref / ChangeLog
index 33c41b0..5dd0283 100644 (file)
@@ -1,5 +1,448 @@
+2012-03-02  Glenn Morris  <rgm@gnu.org>
+
+       * elisp.texi, vol1.texi, vol2.texi: Standardize some menu entries.
+
+       * hooks.texi (Standard Hooks): General update.
+       Put related hooks together.  Add and remove items.
+       * commands.texi (Keyboard Macros): Remove cross-ref to Standard Hooks.
+       * modes.texi (Hooks): Tweak cross-ref description.
+
+2012-03-01  Michael Albinus  <michael.albinus@gmx.de>
+
+       * files.texi (Kinds of Files): The return value of file-equal-p is
+       unspecified, if FILE1 or FILE2 does not exist.
+
+2012-03-01  Glenn Morris  <rgm@gnu.org>
+
+       * hooks.texi (Standard Hooks): Remove mode-specific hooks.
+
+       * maps.texi (Standard Keymaps): General update.
+       Remove mode-specific maps, talk about the more general keymaps.
+       * help.texi (Help Functions): Add vindex for Helper-help-map.
+       * keymaps.texi (Active Keymaps): Minor rephrasing.
+
+2012-02-29  Glenn Morris  <rgm@gnu.org>
+
+       * elisp.texi, vol1.texi, vol2.texi: Use "" quotes in menus.
+
+2012-02-28  Thierry Volpiatto  <thierry.volpiatto@gmail.com>
+
+       * files.texi (Kinds of Files): Rename files-equal-p to file-equal-p.
+       Update changed behavior of file-subdir-of-p.
+
+2012-02-28  Glenn Morris  <rgm@gnu.org>
+
+       * advice.texi, anti.texi, display.texi, elisp.texi:
+       * processes.texi, variables.texi, vol1.texi, vol2.texi:
+       Standardize possessive apostrophe usage.
+
+       * locals.texi: Remove file.
+       * elisp.texi, vol1.texi, vol2.texi: Don't include locals.texi.
+       Remove menu entry.
+       * errors.texi, maps.texi: Adjust node pointers.
+       * internals.texi (Buffer Internals): Remove cross-refs to locals.texi.
+       * makefile.w32-in (srcs):
+       * Makefile.in (srcs): Remove locals.texi.
+
+       * frames.texi (Mouse Position): Fix cross-ref.
+
+2012-02-27  Chong Yidong  <cyd@gnu.org>
+
+       * buffers.texi (Creating Buffers): Clarify that
+       generate-new-buffer uses generate-new-buffer-names.
+       (Killing Buffers): Remove bogus example duplicating buffer-live-p.
+
+       * files.texi (Directory Names): Index entry for file name abbreviations.
+       (Relative File Names, File Name Expansion): Refer to it.
+       (Locating Files): Move locate-user-emacs-file documentation to
+       Standard File Names.
+       (Standard File Names): Add locate-user-emacs-file; update examples.
+
+2012-02-26  Michael Albinus  <michael.albinus@gmx.de>
+
+       * files.texi (Magic File Names): Add files-equal-p and file-subdir-of-p.
+
+2012-02-26  Chong Yidong  <cyd@gnu.org>
+
+       * files.texi (Kinds of Files): Improve documentation of
+       files-equal-p and file-subdir-of-p.
+
+2012-02-26  Glenn Morris  <rgm@gnu.org>
+
+       * intro.texi (Acknowledgements): Small changes.
+
+2012-02-25  Glenn Morris  <rgm@gnu.org>
+
+       * errors.texi: Don't try to list _all_ the error symbols.
+       Add circular-list, cl-assertion-failed, compression-error.
+       * elisp.texi, vol1.texi, vol2.texi:
+       * control.texi (Error Symbols): Tweak "Standard Errors" description.
+
+2012-02-25  Thierry Volpiatto  <thierry.volpiatto@gmail.com>
+
+       * files.texi (files-equal-p, file-subdir-of-p): New,
+       add initial documentation.
+
+2012-02-25  Chong Yidong  <cyd@gnu.org>
+
+       * files.texi (File Attributes): Document file-selinux-context.
+       (Changing Files): Link to it.
+       (Changing Files): Document set-file-selinux-context.
+
+       * backups.texi (Making Backups): Return value of backup-buffer is
+       changed.  Mention default value of backup-directory-alist.
+       (Rename or Copy): Note that backup-by-copying-when-mismatch is t.
+       (Auto-Saving): New minor mode behavior for auto-save-mode.
+       (Reverting): Add defvar for revert-buffer-in-progress-p.
+
+       * searching.texi (Regexp Backslash): Add index entry (Bug#10869).
+
+2012-02-24  Glenn Morris  <rgm@gnu.org>
+
+       * errors.texi (Standard Errors): Mention dbus-error.
+       For arith-error sub-classes, just use one cross-ref.
+
+2012-02-23  Alan Mackenzie  <acm@muc.de>
+
+       * modes.texi (Defining Minor Modes): Document the new keyword
+       :after-hook.
+
+2012-02-21  Chong Yidong  <cyd@gnu.org>
+
+       * 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.
+
+2012-02-19  Chong Yidong  <cyd@gnu.org>
+
+       * help.texi (Documentation, Documentation Basics, Help Functions):
+       Minor clarifications.
+       (Accessing Documentation): Clarify what documentation-property is
+       for.  Add xref to Keys in Documentation.
+
+       * tips.texi (Documentation Tips): Don't recommend using * in
+       docstrings.
+
+       * macros.texi (Defining Macros):
+       * modes.texi (Derived Modes): Say "documentation string" instead
+       of docstring.
+
+2012-02-18  Chong Yidong  <cyd@gnu.org>
+
+       * modes.texi (Tabulated List Mode): New node.
+       (Basic Major Modes): Add xref to it.
+
+       * processes.texi (Process Information): Mention Process Menu mode.
+
+2012-02-17  Chong Yidong  <cyd@gnu.org>
+
+       * syntax.texi (Motion via Parsing): Doc fix for scan-lists.
+
+2012-02-17  Glenn Morris  <rgm@gnu.org>
+
+       * hooks.texi (Standard Hooks): Fix cross-ref to Emacs manual.
+
+2012-02-16  Chong Yidong  <cyd@gnu.org>
+
+       * 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): Clarify scan-lists. Fix indentation.
+       (Parser State): Update for the new "c" comment style.  Fix
+       description of item 7 (comment style).
+
+       * 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.  Add xref to
+       Syntactic Font Lock node.
+
+2012-02-15  Chong Yidong  <cyd@gnu.org>
+
+       * 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.
+
+       * 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.
+       Remove duplicate tip about auto-mode-alist.
+       (Minor Modes): Rewrite introduction.
+       (Minor Mode Conventions): Copyedits.  Don't recommend
+       variable-only minor modes since few minor modes are like that.
+
+2012-02-15  Glenn Morris  <rgm@gnu.org>
+
+       * processes.texi (Network): Document open-network-stream :parameters.
+
+2012-02-14  Chong Yidong  <cyd@gnu.org>
+
+       * keymaps.texi (Format of Keymaps): The CACHE component of keymaps
+       was removed on 2009-09-10.  Update lisp-mode-map example.
+       (Inheritance and Keymaps): Minor clarification.
+       (Searching Keymaps): Remove out-of-place enumeration.
+       (Key Lookup): Remove unnecessary example (one was already given in
+       Format of Keymaps).
+       (Changing Key Bindings): Update suppress-keymap example.
+       (Menu Bar, Tool Bar): Copyedits.
+       (Tool Bar): Update tool-bar-map example.
+
+2012-02-12  Chong Yidong  <cyd@gnu.org>
+
+       * debugging.texi (Debugger Commands): Continuing is now allowed
+       for errors.
+
+2012-02-11  Chong Yidong  <cyd@gnu.org>
+
+       * display.texi (Fringe Indicators): Add xref to Fringe Bitmaps.
+       Move the list of standard bitmaps there.
+       (Fringe Cursors): Rewrite for clarity.
+       (Fringe Bitmaps): Consolidate the list of standard bitmaps here.
+
+       * commands.texi (Command Overview): Mention read-key.
+       (Using Interactive, Interactive Call): Minor clarifications.
+       (Function Keys, Click Events): Avoid "input stream" terminology.
+       (Click Events): Add xref to Window Sizes and Accessing Mouse.
+       Clarify column and row components.
+       (Accessing Mouse): Add xref to Click Events.  Minor fixes.
+       (Special Events): Copyedits.
+
+       * streams.texi (Input Streams): De-document get-file-char.
+       (Output Variables): Don't refer to old backquote syntax.
+
+       * 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.
+
+       * compile.texi (Compiler Errors): Move a paragraph here from
+       deleted node Compilation Errors.
+
+2012-02-10  Leo Liu  <sdl.web@gmail.com>
+
+       * control.texi (Handling Errors): Change condition-case-no-debug
+       to condition-case-unless-debug.
+
+2012-02-10  Chong Yidong  <cyd@gnu.org>
+
+       * 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.
+
+       * 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.
+
+       * objects.texi (Byte-Code Type): Add xref to Byte-Code Function
+       Objects.
+
+2012-02-10  Glenn Morris  <rgm@gnu.org>
+
+       * text.texi (Checksum/Hash): Rename node from MD5 Checksum.
+       Mention secure-hash.
+       * elisp.texi, vol1.texi, vol2.texi: Update menu entry.
+
+2012-02-10  Chong Yidong  <cyd@gnu.org>
+
+       * loading.texi (Loading): Don't emphasize "library" terminology.
+       (Library Search): load-path is not a user option.  Mention role of
+       -L option and packages.  Improve examples.
+       (Loading Non-ASCII): Don't mention unibyte Emacs, which is
+       obsolete.
+       (Autoload): Minor clarifications.
+
+2012-02-10  Glenn Morris  <rgm@gnu.org>
+
+       * files.texi (Magic File Names): Tweak remote-file-name-inhibit-cache.
+
+       * modes.texi (Basic Major Modes): Mention tabulated-list-mode.
+
+2012-02-08  Glenn Morris  <rgm@gnu.org>
+
+       * loading.texi (Named Features): Update the require example.
+
+2012-02-07  Glenn Morris  <rgm@gnu.org>
+
+       * modes.texi (Defining Minor Modes):
+       Expand on args of defined minor modes.
+
+2012-02-07  Chong Yidong  <cyd@gnu.org>
+
+       * variables.texi (Creating Buffer-Local): Minor clarification
+       to buffer-local-variables doc (Bug#10715).
+
+2012-02-07  Glenn Morris  <rgm@gnu.org>
+
+       * display.texi (ImageMagick Images): General update.
+       Move most details of imagemagick-render-type to the variable's doc.
+
+2012-02-06  Glenn Morris  <rgm@gnu.org>
+
+       * keymaps.texi (Tool Bar): Mention separators.
+       (Inheritance and Keymaps):
+       Mention make-composed-keymap and multiple inheritance.
+
+       * modes.texi (Running Hooks): Mention run-hook-wrapped.
+
+       * control.texi (Handling Errors):
+       Mention condition-case-no-debug and with-demoted-errors.
+
+2012-02-05  Chong Yidong  <cyd@gnu.org>
+
+       * customize.texi (Common Keywords): Minor clarifications.
+       Document custom-unlispify-remove-prefixes.
+       (Variable Definitions): Backquotes in defcustom seem to work fine
+       now.  Various other copyedits.
+       (Simple Types): Copyedits.  Document color selector.
+       (Composite Types): Copyedits.
+       (Splicing into Lists): Clarifications.
+
+       * eval.texi (Backquote): Move from macros.texi.
+
+       * 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.
+
+2012-02-05  Glenn Morris  <rgm@gnu.org>
+
+       * debugging.texi (Error Debugging): Mention debug-on-event default.
+
+2012-02-04  Glenn Morris  <rgm@gnu.org>
+
+       * backups.texi (Reverting): Mention revert-buffer-in-progress-p.
+
+       * debugging.texi (Error Debugging): Mention debug-on-event.
+       * commands.texi (Misc Events): Mention sigusr1,2 and debugging.
+
+       * modes.texi (Running Hooks): Try to clarify with-wrapper-hook.
+
+       * text.texi (Buffer Contents):
+       Update filter-buffer-substring description.
+
+2012-02-04  Chong Yidong  <cyd@gnu.org>
+
+       * 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.
+
+       * 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  Glenn Morris  <rgm@gnu.org>
+
+       * minibuf.texi (High-Level Completion): Updates for read-color.
+
+2012-02-03  Glenn Morris  <rgm@gnu.org>
+
+       * display.texi (GIF Images): Mention animation.
+       Remove commented-out old example of animation.
+       (Animated Images): New subsection.
+       * elisp.texi (Top):
+       * vol1.texi (Top):
+       * vol2.texi (Top): Add Animated Images menu entry.
+
+       * display.texi (Image Formats): Remove oddly specific information
+       on versions of image libraries.
+       (GIF Images, TIFF Images): Minor rephrasing.
+
+2012-02-02  Glenn Morris  <rgm@gnu.org>
+
+       * processes.texi (Synchronous Processes):
+       Mention call-process's :file gets overwritten.
+
+       * commands.texi (Reading One Event):
+       * help.texi (Help Functions): Document read-char-choice.
+
+       * hooks.texi (Standard Hooks):
+       * modes.texi (Keymaps and Minor Modes):
+       * text.texi (Commands for Insertion): Document post-self-insert-hook.
+
+       * hooks.texi (Standard Hooks): Add prog-mode-hook.
+
+       * hooks.texi (Standard Hooks):
+       * modes.texi (Major Mode Conventions, Mode Hooks):
+       Document change-major-mode-after-body-hook.
+
+2012-02-01  Glenn Morris  <rgm@gnu.org>
+
+       * modes.texi (Defining Minor Modes):
+       Mention disabling global minor modes on a per-major-mode basis.
+
+2012-01-31  Chong Yidong  <cyd@gnu.org>
+
+       * syntax.texi (Parsing Expressions): Clarify intro (Bug#10657).
+       (Parser State): Remove unnecessary statement (Bug#10661).
+
+       * eval.texi (Intro Eval): Add footnote about "sexp" terminology.
+
+2012-01-31  Glenn Morris  <rgm@gnu.org>
+
+       * modes.texi (Defining Minor Modes):
+       Document define-minor-mode's new :variable keyword.
+
+2012-01-29  Chong Yidong  <cyd@gnu.org>
+
+       * syntax.texi (Syntax Class Table): Tweak description of newline
+       char syntax (Bug#9619).
+
+       * numbers.texi (Predicates on Numbers): Fix wholenump/natnump
+       description (Bug#10189).
+
+2012-01-29  Glenn Morris  <rgm@gnu.org>
+
+       * files.texi (Changing Files): Document SELinux support.
+
+       * windows.texi (Window Sizes): Fix typo.
+
 2012-01-28  Chong Yidong  <cyd@gnu.org>
 
+       * display.texi (Fringe Indicators): Clarify fringe-indicator-alist
+       doc (Bug#8568).
+
        * frames.texi (Input Focus): Add NORECORD arg to
        select-frame-set-input-focus.  Clarify its role in select-frame.