* doc/lispref/modes.texi (Auto-Indentation): New section to document SMIE.

(Major Mode Conventions):
* doc/lispref/text.texi (Mode-Specific Indent): Refer to it.

1 files changed, 106 insertions, 100 deletions

diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog
index 6efa8466563..b27efdda941 100644
--- a/doc/lispref/ChangeLog
+++ b/doc/lispref/ChangeLog
@@ -1,3 +1,9 @@
+2010-12-07  Stefan Monnier  <monnier@iro.umontreal.ca>
+
+        * modes.texi (Auto-Indentation): New section to document SMIE.
+        (Major Mode Conventions):
+        * text.texi (Mode-Specific Indent): Refer to it.
+
 2010-12-04  Eli Zaretskii  <eliz@gnu.org>
 
         * display.texi (Other Display Specs): Document left-fringe and
@@ -12,8 +18,8 @@
 
 2010-11-21  Chong Yidong  <cyd@stupidchicken.com>
 
-        * nonascii.texi (Converting Representations): Document
-        byte-to-string.
+        * nonascii.texi (Converting Representations):
+        Document byte-to-string.
 
         * strings.texi (Creating Strings): Don't mention semi-obsolete
         function char-to-string.
@@ -44,8 +50,8 @@
 
         * customize.texi (Composite Types): Lower-case index entry.
 
-        * loading.texi (How Programs Do Loading): Document
-        load-file-name.  (Bug#7346)
+        * loading.texi (How Programs Do Loading):
+        Document load-file-name.  (Bug#7346)
 
 2010-11-10  Glenn Morris  <rgm@gnu.org>
 
@@ -152,8 +158,8 @@
 
         * keymaps.texi (Menu Bar): Document :advertised-binding property.
 
-        * functions.texi (Obsolete Functions): Document
-        set-advertised-calling-convention.
+        * functions.texi (Obsolete Functions):
+        Document set-advertised-calling-convention.
 
         * minibuf.texi (Basic Completion): Document completion-in-region.
         (Programmed Completion): Document completion-annotate-function.
@@ -278,8 +284,8 @@
         * minibuf.texi (Basic Completion): 4th arg to all-completions is
         obsolete.
 
-        * processes.texi (Process Buffers): Document
-        process-kill-buffer-query-function.
+        * processes.texi (Process Buffers):
+        Document process-kill-buffer-query-function.
 
 2009-12-05  Glenn Morris  <rgm@gnu.org>
 
@@ -726,8 +732,8 @@
         (Suspending Emacs): Mark suspend-emacs as a command.
         (Processor Run Time): Mark emacs-uptime and emacs-init-time as
         commands.
-        (Terminal Output): Remove obsolete function baud-rate.  Document
-        TERMINAL arg for send-string-to-terminal.
+        (Terminal Output): Remove obsolete function baud-rate.
+        Document TERMINAL arg for send-string-to-terminal.
 
         * nonascii.texi (Terminal I/O Encoding): Document TERMINAL arg for
         terminal-coding-system and set-terminal-coding-system.
@@ -831,8 +837,8 @@
 2009-05-09  Eli Zaretskii  <eliz@gnu.org>
 
         * nonascii.texi (Default Coding Systems): Document
-        find-auto-coding, set-auto-coding, and auto-coding-alist.  Add
-        indexing.
+        find-auto-coding, set-auto-coding, and auto-coding-alist.
+        Add indexing.
         (Lisp and Coding Systems): Add index entries.
 
 2009-05-09  Martin Rudalics  <rudalics@gmx.at>
@@ -874,8 +880,8 @@
 
 2009-04-22  Chong Yidong  <cyd@stupidchicken.com>
 
-        * os.texi (Command-Line Arguments): Document
-        command-line-args-left.
+        * os.texi (Command-Line Arguments):
+        Document command-line-args-left.
         (Suspending Emacs): Adapt text to multi-tty case.  Document use of
         terminal objects for tty arguments.
         (Startup Summary): Add xref to Session Management.
@@ -951,13 +957,13 @@
 2009-04-09  Chong Yidong  <cyd@stupidchicken.com>
 
         * text.texi (Yank Commands): Note that yank uses push-mark.
-        (Filling): Clarify REGION argument of fill-paragraph.  Document
-        fill-forward-paragraph-function.
+        (Filling): Clarify REGION argument of fill-paragraph.
+        Document fill-forward-paragraph-function.
         (Special Properties): Remove "new in Emacs 22" declaration.
         (Clickable Text): Merge with Links and Mouse-1 node.
 
-        * display.texi (Button Properties, Button Buffer Commands): Change
-        xref to Clickable Text.
+        * display.texi (Button Properties, Button Buffer Commands):
+        Change xref to Clickable Text.
 
         * tips.texi (Key Binding Conventions): Change xref to Clickable
         Text.
@@ -1019,8 +1025,8 @@
 
 2009-03-29  Chong Yidong  <cyd@stupidchicken.com>
 
-        * help.texi (Accessing Documentation, Help Functions): Remove
-        information about long-obsolete Emacs versions.
+        * help.texi (Accessing Documentation, Help Functions):
+        Remove information about long-obsolete Emacs versions.
 
         * modes.texi (Mode Line Variables): The default values of the mode
         line variables are now more complicated.
@@ -1063,8 +1069,8 @@
 2009-03-23  Chong Yidong  <cyd@stupidchicken.com>
 
         * minibuf.texi (Intro to Minibuffers): Remove long-obsolete info
-        about minibuffers in old Emacs versions.  Copyedits.  Emphasize
-        that enable-recursive-minibuffers defaults to nil.
+        about minibuffers in old Emacs versions.  Copyedits.
+        Emphasize that enable-recursive-minibuffers defaults to nil.
         (Text from Minibuffer): Simplify introduction.
 
 2009-03-22  Alan Mackenzie  <acm@muc.de>
@@ -1118,8 +1124,8 @@
         * customize.texi (Common Keywords): It's not necessary to use :tag
         to remove hyphens, as custom-unlispify-tag-name does it
         automatically.
-        (Variable Definitions): Link to File Local Variables.  Document
-        customized-value symbol property.
+        (Variable Definitions): Link to File Local Variables.
+        Document customized-value symbol property.
         (Customization Types): Move menu to end of node.
 
 2009-03-10  Chong Yidong  <cyd@stupidchicken.com>
@@ -1230,8 +1236,8 @@
         * text.texi (Commands for Insertion):
         * commands.texi (Event Mod):
         * keymaps.texi (Searching Keymaps):
-        * nonascii.texi (Translation of Characters): Reinstate
-        documentation of translation-table-for-input.
+        * nonascii.texi (Translation of Characters):
+        Reinstate documentation of translation-table-for-input.
         (Explicit Encoding): Document the `charset' text property produced
         by decode-coding-region and decode-coding-string.
 
@@ -1260,8 +1266,8 @@
 2009-01-22  Chong Yidong  <cyd@stupidchicken.com>
 
         * files.texi (Format Conversion Piecemeal): Clarify behavior of
-        write-region-annotate-functions.  Document
-        write-region-post-annotation-function.
+        write-region-annotate-functions.
+        Document write-region-post-annotation-function.
 
 2009-01-19  Chong Yidong  <cyd@stupidchicken.com>
 
@@ -1328,8 +1334,8 @@
 
         * processes.texi (Serial Ports): Improve wording, suggested by RMS.
 
-        * nonascii.texi (Lisp and Coding Systems): Document
-        inhibit-null-byte-detection and inhibit-iso-escape-detection.
+        * nonascii.texi (Lisp and Coding Systems):
+        Document inhibit-null-byte-detection and inhibit-iso-escape-detection.
         (Character Properties): Improve wording.
 
 2009-01-09  Chong Yidong  <cyd@stupidchicken.com>
@@ -1337,8 +1343,8 @@
         * display.texi (Font Lookup): Remove obsolete function
         x-font-family-list.  x-list-fonts accepts Fontconfig/GTK syntax.
         (Low-Level Font): Rename from Fonts, move to end of Faces section.
-        (Font Selection): Reorder order of variable descriptions.  Minor
-        clarifications.
+        (Font Selection): Reorder order of variable descriptions.
+        Minor clarifications.
 
         * elisp.texi (Top): Update node listing.
 
@@ -1359,8 +1365,8 @@
         * elisp.texi: Update node listing.
 
         * display.texi (Faces): Put Font Selection node after Auto Faces.
-        (Face Attributes): Don't link to Font Lookup.  Document
-        font-family-list.
+        (Face Attributes): Don't link to Font Lookup.
+        Document font-family-list.
         (Fonts): New node.
 
 2009-01-08  Jason Rumney  <jasonr@gnu.org>
@@ -1588,8 +1594,8 @@
         * windows.texi (Window Hooks): Remove *-end-trigger-functions
         vars, which are obsolete.  Mention jit-lock-register.
 
-        * modes.texi (Other Font Lock Variables): Document
-        jit-lock-register and jit-lock-unregister.
+        * modes.texi (Other Font Lock Variables):
+        Document jit-lock-register and jit-lock-unregister.
 
         * frames.texi (Color Parameters): Document alpha parameter.
 
@@ -1661,8 +1667,8 @@
 2008-11-01  Eli Zaretskii  <eliz@gnu.org>
 
         * nonascii.texi (Text Representations): Rewrite to make consistent
-        with Emacs 23 internal representation of characters.  Document
-        `unibyte-string'.
+        with Emacs 23 internal representation of characters.
+        Document `unibyte-string'.
 
 2008-10-28  Chong Yidong  <cyd@stupidchicken.com>
 
@@ -1775,8 +1781,8 @@
 
         * processes.texi (Synchronous Processes): Document `process-lines'.
 
-        * customize.texi (Variable Definitions): Document
-        `custom-reevaluate-setting'.
+        * customize.texi (Variable Definitions):
+        Document `custom-reevaluate-setting'.
 
 2008-10-18  Martin Rudalics  <rudalics@gmx.at>
 
@@ -1792,13 +1798,13 @@
         * maps.texi (Standard Keymaps): Document `multi-query-replace-map'
         and `search-map'.
 
-        * searching.texi (Search and Replace): Document
-        `replace-search-function' and `replace-re-search-function'.
+        * searching.texi (Search and Replace):
+        Document `replace-search-function' and `replace-re-search-function'.
         Document `multi-query-replace-map'.
 
         * minibuf.texi (Text from Minibuffer): Document `read-regexp'.
-        (Completion Commands, Reading File Names): Rename
-        `minibuffer-local-must-match-filename-map' to
+        (Completion Commands, Reading File Names):
+        Rename `minibuffer-local-must-match-filename-map' to
         `minibuffer-local-filename-must-match-map'.
         (Minibuffer Completion): The `require-match' argument to
         `completing-read' can now have the value `confirm-only'.
@@ -2143,7 +2149,7 @@
 
 2007-12-30  Richard Stallman  <rms@gnu.org>
 
-        * commands.texi (Accessing Mouse): Renamed from Accessing Events.
+        * commands.texi (Accessing Mouse): Rename from Accessing Events.
         (Accessing Scroll): New node broken out of Accessing Mouse.
 
 2007-12-28  Richard Stallman  <rms@gnu.org>
@@ -2187,8 +2193,8 @@
 
 2007-11-29  Glenn Morris  <rgm@gnu.org>
 
-        * functions.texi (Declaring Functions): Add findex.  Mention
-        `external' files.
+        * functions.texi (Declaring Functions): Add findex.
+        Mention `external' files.
 
 2007-11-26  Juanma Barranquero  <lekktu@gmail.com>
 
@@ -2315,8 +2321,8 @@
         * display.texi (Display Property): Explain some display specs
         don't let you move point in.
 
-        * frames.texi (Cursor Parameters): Describe
-        cursor-in-non-selected-windows here.  Explain more values.
+        * frames.texi (Cursor Parameters):
+        Describe cursor-in-non-selected-windows here.  Explain more values.
 
         * windows.texi (Basic Windows): Don't describe
         cursor-in-non-selected-windows here.
@@ -2395,8 +2401,8 @@
 
 2007-08-16  Richard Stallman  <rms@gnu.org>
 
-        * processes.texi (Asynchronous Processes): Clarify
-        doc of start-file-process.
+        * processes.texi (Asynchronous Processes):
+        Clarify doc of start-file-process.
 
 2007-08-08  Martin Rudalics  <rudalics@gmx.at>
 
@@ -2463,8 +2469,8 @@
 
 2007-06-27  Richard Stallman  <rms@gnu.org>
 
-        * files.texi (Format Conversion Piecemeal): Clarify
-        `after-insert-file-functions' calling convention.
+        * files.texi (Format Conversion Piecemeal):
+        Clarify `after-insert-file-functions' calling convention.
 
 2007-06-27  Michael Albinus  <michael.albinus@gmx.de>
 
@@ -2519,8 +2525,8 @@
 
 2007-05-30  Nick Roberts  <nickrob@snap.net.nz>
 
-        * commands.texi (Click Events): Layout more logically.  Describe
-        width and height.
+        * commands.texi (Click Events): Layout more logically.
+        Describe width and height.
         (Drag Events, Motion Events): Update to new format for position.
 
 2007-06-02  Richard Stallman  <rms@gnu.org>
@@ -2926,8 +2932,8 @@
 
 2007-03-05  Richard Stallman  <rms@gnu.org>
 
-        * variables.texi (File Local Variables): Update
-        enable-local-variables values.
+        * variables.texi (File Local Variables):
+        Update enable-local-variables values.
 
 2007-03-04  Richard Stallman  <rms@gnu.org>
 
@@ -2998,8 +3004,8 @@
 2007-02-03  Eli Zaretskii  <eliz@gnu.org>
 
         * elisp.texi (Top): Make the detailed menu headers compliant with
-        Texinfo guidelines and with what texnfo-upd.el expects.  Add
-        comments to prevent people from inadvertently modifying the key
+        Texinfo guidelines and with what texnfo-upd.el expects.
+        Add comments to prevent people from inadvertently modifying the key
         parts needed by `texinfo-multiple-files-update'.
 
 2007-02-02  Eli Zaretskii  <eliz@gnu.org>
@@ -3086,8 +3092,8 @@
 
 2006-12-24  Richard Stallman  <rms@gnu.org>
 
-        * customize.texi (Variable Definitions): Document
-        new name custom-add-frequent-value.
+        * customize.texi (Variable Definitions):
+        Document new name custom-add-frequent-value.
 
 2006-12-19  Kim F. Storm  <storm@cua.dk>
 
@@ -3386,8 +3392,8 @@
 
 2006-09-01  Chong Yidong  <cyd@stupidchicken.com>
 
-        * buffers.texi (Buffer Modification): Document
-        buffer-chars-modified-tick.
+        * buffers.texi (Buffer Modification):
+        Document buffer-chars-modified-tick.
 
 2006-08-31  Richard Stallman  <rms@gnu.org>
 
@@ -3449,7 +3455,7 @@
 2006-08-12  Chong Yidong  <cyd@stupidchicken.com>
 
         * text.texi (Near Point): Say "cursor" not "terminal cursor".
-        (Commands for Insertion): Removed split-line since it's not
+        (Commands for Insertion): Remove split-line since it's not
         relevant for Lisp programming.
         (Yank Commands): Rewrite introduction.
         (Undo): Clarify.
@@ -3480,7 +3486,7 @@
         (Major Mode Basics): Mention define-derived-mode explicitly.
         (Major Mode Conventions): Rebinding RET is OK for some modes.
         Mention change-major-mode-hook and after-change-major-mode-hook.
-        (Example Major Modes): Moved to end of Modes section.
+        (Example Major Modes): Move to end of Modes section.
         (Mode Line Basics): Clarify.
         (Mode Line Data): Mention help-echo and local-map in strings.
         Explain reason for treatment of non-risky variables.
@@ -3979,7 +3985,7 @@
 
 2006-05-25  Chong Yidong  <cyd@stupidchicken.com>
 
-        * keymaps.texi (Key Sequences): Renamed from Keymap Terminology.
+        * keymaps.texi (Key Sequences): Rename from Keymap Terminology.
         Explain string and vector representations of key sequences.
 
         * keymaps.texi (Changing Key Bindings):
@@ -4028,8 +4034,8 @@
 
 2006-05-15  Oliver Scholz  <epameinondas@gmx.de>  (tiny change)
 
-        * nonascii.texi (Explicit Encoding): Fix
-        typo (encoding<->decoding).
+        * nonascii.texi (Explicit Encoding):
+        Fix typo (encoding<->decoding).
 
 2006-05-14  Richard Stallman  <rms@gnu.org>
 
@@ -4079,8 +4085,8 @@
 
 2006-05-09  Richard Stallman  <rms@gnu.org>
 
-        * variables.texi (File Local Variables): Document
-        safe-local-eval-forms and safe-local-eval-function.
+        * variables.texi (File Local Variables):
+        Document safe-local-eval-forms and safe-local-eval-function.
 
 2006-05-07  Kim F. Storm  <storm@cua.dk>
 
@@ -4564,8 +4570,8 @@
 
 2005-12-03  Eli Zaretskii  <eliz@gnu.org>
 
-        * hooks.texi (Standard Hooks): Add index entries.  Mention
-        `compilation-finish-functions'.
+        * hooks.texi (Standard Hooks): Add index entries.
+        Mention `compilation-finish-functions'.
 
 2005-11-27  Richard M. Stallman  <rms@gnu.org>
 
@@ -4788,8 +4794,8 @@
         buffer-local.
         (Undo): Note that buffer-undo-list is buffer-local.
 
-        * windows.texi (Buffers and Windows): Document
-        buffer-display-count.
+        * windows.texi (Buffers and Windows):
+        Document buffer-display-count.
 
 2005-09-06  Richard M. Stallman  <rms@gnu.org>
 
@@ -5030,7 +5036,7 @@
 
         * display.texi (Displaying Messages): New node, with most
         of what was in The Echo Area.
-        (Progress): Moved under The Echo Area.
+        (Progress): Move under The Echo Area.
         (Logging Messages): New node with new text.
         (Echo Area Customization): New node, the rest of what was
         in The Echo Area.  Document message-truncate-lines with @defvar.
@@ -6345,8 +6351,8 @@
         (Scroll Bars): Add scroll-bar-mode and scroll-bar-width.
         (Usual Display): Move tab-width up.
 
-        * customize.texi (Variable Definitions): Replace
-        show-paren-mode example with tooltip-mode.
+        * customize.texi (Variable Definitions):
+        Replace show-paren-mode example with tooltip-mode.
         (Simple Types, Composite Types, Defining New Types):
         Minor cleanups.
 
@@ -6582,8 +6588,8 @@
         (Display Fringe Bitmaps): New node.
         (Images): Add 'Image Slices' to menu.
         (Image Descriptors): Add `:pointer' and `:map' properties.
-        (Showing Images): Add slice arg to `insert-image'.  Add
-        'insert-sliced-image'.
+        (Showing Images): Add slice arg to `insert-image'.
+        Add 'insert-sliced-image'.
 
 2004-09-20  Richard M. Stallman  <rms@gnu.org>
 
@@ -6596,8 +6602,8 @@
 
 2004-09-07  Luc Teirlinck  <teirllm@auburn.edu>
 
-        * locals.texi (Standard Buffer-Local Variables): Add
-        `buffer-auto-save-file-format'.
+        * locals.texi (Standard Buffer-Local Variables):
+        Add `buffer-auto-save-file-format'.
         * internals.texi (Buffer Internals): Describe new
         auto_save_file_format field of the buffer structure.
         * files.texi (Format Conversion): `auto-save-file-format' has been
@@ -6985,8 +6991,8 @@
 
 2004-04-05  Jesper Harder  <harder@ifa.au.dk>
 
-        * variables.texi (Variable Aliases): Mention
-        cyclic-variable-indirection.
+        * variables.texi (Variable Aliases):
+        Mention cyclic-variable-indirection.
 
         * errors.texi (Standard Errors): Ditto.
 
@@ -7165,7 +7171,7 @@
 
 2004-02-07  Jan Djärv  <jan.h.d@swipnet.se>
 
-        * positions.texi (Text Lines): Added missing end defun.
+        * positions.texi (Text Lines): Add missing end defun.
 
 2004-02-07  Kim F. Storm  <storm@cua.dk>
 
@@ -7188,12 +7194,12 @@
         read-minibuffer.
         (Minibuffer History): Clarify description of cons values for
         HISTORY arguments.
-        (Basic Completion): Various corrections and clarifications.  Add
-        completion-regexp-list.
+        (Basic Completion): Various corrections and clarifications.
+        Add completion-regexp-list.
         (Minibuffer Completion): Correct and clarify description of
         completing-read.
-        (Completion Commands): Mention Partial Completion mode.  Various
-        other minor changes.
+        (Completion Commands): Mention Partial Completion mode.
+        Various other minor changes.
         (High-Level Completion): Various corrections and clarifications.
         (Reading File Names): Ditto.
         (Minibuffer Misc): Ditto.
@@ -7268,8 +7274,8 @@
 
         * functions.texi: Various small changes in addition to the
         following.
-        (What Is a Function): `functionp' returns nil for macros.  Clarify
-        behavior of this and following functions for symbol arguments.
+        (What Is a Function): `functionp' returns nil for macros.
+        Clarify behavior of this and following functions for symbol arguments.
         (Function Documentation): Add `\' in front of (fn @var{arglist})
         and explain why.
         (Defining Functions): Mention DOCSTRING argument to `defalias'.
@@ -8065,7 +8071,7 @@
 
 2003-01-31  Joe Buehler  <jhpb@draco.hekimian.com>
 
-        * os.texi (System Environment): Added cygwin system-type.
+        * os.texi (System Environment): Add cygwin system-type.
 
 2003-01-25  Richard M. Stallman  <rms@gnu.org>
 
@@ -8098,7 +8104,7 @@
 
         * README: Target for Info file is `make info'.
 
-        * files.texi (File Name Components): Fixed typos in
+        * files.texi (File Name Components): Fix typos in
         `file-name-sans-extension'.
         (Magic File Names): Complete list of operations for magic file
         name handlers.
@@ -8114,7 +8120,7 @@
 
 2002-08-05  Per Abrahamsen  <abraham@dina.kvl.dk>
 
-        * customize.texi (Splicing into Lists): Fixed example.
+        * customize.texi (Splicing into Lists): Fix example.
         Reported by Fabrice Bauzac <fabrice.bauzac@wanadoo.fr>.
 
 2002-06-17  Juanma Barranquero  <lektu@terra.es>
@@ -8154,8 +8160,8 @@
 
 2001-11-17  Eli Zaretskii  <eliz@is.elta.co.il>
 
-        * permute-index: Don't depend on csh-specific features.  Replace
-        the interpreter name with /bin/sh.
+        * permute-index: Don't depend on csh-specific features.
+        Replace the interpreter name with /bin/sh.
 
         * two-volume-cross-refs.txt: New file.
         * two.el: New file.
@@ -8293,8 +8299,8 @@
         * numbers.texi (Integer Basics): Document CL style read syntax for
         integers in bases other than 10.
 
-        * positions.texi (List Motion): Document
-        open-paren-in-column-0-is-defun-start.
+        * positions.texi (List Motion):
+        Document open-paren-in-column-0-is-defun-start.
 
         * lists.texi (Sets And Lists): Document member-ignore-case.
 
@@ -8489,7 +8495,7 @@
 1995-06-19  Richard Stallman  <rms@mole.gnu.ai.mit.edu>
 
         * Makefile (VERSION): Update version number.
-        (maintainer-clean): Renamed from realclean.
+        (maintainer-clean): Rename from realclean.
 
 1995-06-07  Karl Heuer  <kwzh@nutrimat.gnu.ai.mit.edu>
 
@@ -8561,11 +8567,11 @@
 
 1991-11-26  Richard Stallman  (rms@mole.gnu.ai.mit.edu)
 
-        * Makefile (srcs): Added index.perm.
+        * Makefile (srcs): Add index.perm.
         (elisp.dvi): Remove erroneous shell comment.
         Expect output of permute-index in permuted.fns.
         Save old elisp.aux in elisp.oaux.
-        (clean): Added index.texi to be deleted.
+        (clean): Add index.texi to be deleted.
 
 1990-08-11  Richard Stallman  (rms@sugar-bombs.ai.mit.edu)