Commit graph

113 commits

Author SHA1 Message Date
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
Chong Yidong
d366bd532d Edits to Display chapter of Emacs manual.
* doc/emacs/display.texi (Faces): Simplify discussion.  Move documentation
of list-faces-display here, from Standard Faces node.  Note
special role of `default' background.
(Standard Faces): Note special role of `default' background.  Note
that region face may be taken fom GTK.  Add xref to Text Display.
(Text Scale): Rename from "Temporary Face Changes".  Callers
changed.  Don't bother documenting variable-pitch-mode.
(Font Lock): Copyedits.  Remove font-lock-maximum-size.
(Useless Whitespace): Simplify description of
delete-trailing-whitespace.  Note active region case.
(Text Display): Fix description of escape-glyph face assignment.
Remove unibye mode discussion.  Update some parts for Unicode.
Move glyphless chars documentation to Lisp manual.

* doc/emacs/frames.texi (Tooltips): Document x-gtk-use-system-tooltips.

* doc/lispref/display.texi (Glyphless Chars): New node.
2011-10-17 21:42:28 -04:00
Martin Rudalics
c419f5cb55 Describe window quitting, configuration and parameter additions.
* windows.texi (Quitting Windows): New node.
(Window Configurations): Add descriptions of window-state-get
and window-state-put.
(Window Parameters): Describe variable ignore-window-parameters.
Sketch some window parameters currently in use.
* elisp.texi (Top): Update node listing.
2011-09-25 17:08:25 +02:00
Chong Yidong
9ec20d36df Document display-buffer-alist and related variables in Lisp manual.
* doc/lispref/windows.texi (Display Action Functions)
(Choosing Window Options): New nodes.
2011-09-24 23:32:51 -04:00
Chong Yidong
0e406a72ed Document display-buffer and other window changes in Lisp manual.
* doc/lispref/windows.texi (Window History): New node.  Move text here
from Buffers and Windows.
(Switching Buffers): Rename from Displaying Buffers, since we
don't document display-buffer here; callers changed.  Document
FORCE-SAME-WINDOW arg to switch-to-buffer and
switch-to-buffer-other-frame.  Delete duplicate
replace-buffer-in-windows doc.
(Choosing Window): Document display actions.
2011-09-24 18:49:32 -04:00
Martin Rudalics
b33b68a32c Document changes to windows code.
* frames.texi (Frames and Windows): Move section and rename to
Windows and Frames in windows.texi.
* windows.texi (Windows): Restructure.
(Basic Windows): Rewrite.  Explain live and internal windows and
normalization functions.
(Windows and Frames): Move section here from frames.texi.
Describe subwindows, window combinations, window tree, and
corresponding functions including window-list here.
(Window Sizes): Rename section from Size of Window and move it
up in chapter.  Describe total and body sizes and the
corresponding functions.  Explain new semantics of
window-min-height/-width.
(Resizing Windows): Move section up in chapter.  Describe new
resize functions.
(Splitting Windows): Describe new behavior of split-window,
split-window-above-each-other and split-window-side-by-side.
Provide examples.  Describe window-nest and window-splits
options.
(Deleting Windows): Minor rewrite.
(Selecting Windows): Minor rewrite.  Describe
frame-selected-window and set-frame-selected-window here.
(Cyclic Window Ordering): Minor rewrite.  Describe
window-list-1.
(Buffers and Windows): Rewrite.  Explain a window's previous and
next buffers and the corresponding functions.
* elisp.texi (Top): Update node listings for frames and windows
sections.
2011-09-23 11:12:53 +02:00
Chong Yidong
35137ed3a5 Document new Emacs 24 faces in Lisp manual.
* doc/lispref/display.texi (Basic Faces): New node.  Document new faces.

* doc/lispref/modes.texi (Major Mode Conventions): Move some text there.
(Mode Help): Remove major-mode var, duplicated in Major Modes.
2011-08-30 11:24:07 -04:00
Chong Yidong
3fd50d5c65 Update and edit manual sections on major modes.
* doc/emacs/modes.texi (Choosing Modes): auto-mode-case-fold is now t.

* doc/lispref/modes.texi (Basic Major Modes): New node.  Callers updated.
(Major Modes): Document fundamental-mode and major-mode.
(Major Mode Basics): Node deleted; text moved to Major Modes.
(Derived Modes): Document derived-mode-p.
2011-08-29 18:02:21 -04:00
Chong Yidong
c830e5aeea Remove frame-local vars from Lisp manual; obsolete since Emacs 22.3.
* display.texi (Window Systems): `window-system' is terminal-local.

* doc/lispref/frames.texi (Frame Parameters, Parameter Access): Don't mention
frame-local variables.

* doc/lispref/variables.texi (Buffer-Local Variables): Don't mention obsolete
frame-local variables.  (Frame-Local Variables): Node deleted.

* doc/lispref/elisp.texi (Top): Update node listing.
2011-07-12 13:33:18 -04:00
Lars Magne Ingebrigtsen
91223e541e * elisp.texi: Change "inferiors" to "subnodes" in three places 2011-07-12 14:50:42 +02:00
Glenn Morris
322b7dab59 Merge from emacs-23; up to 2010-06-16T23:27:20Z!jay.p.belanger@gmail.com. 2011-07-05 19:42:10 -07:00
Chong Yidong
3deead93c4 * customize.texi (Composite Types): Move alist/plist from Simple Types (Bug#7545).
* elisp.texi (Top): Update menu description.
2011-07-02 20:45:24 -04:00
Glenn Morris
ed7f1a6c5c Merge from emacs-23; up to 2010-06-12T11:17:12Z!eliz@gnu.org. 2011-05-29 15:41:06 -07:00
Chong Yidong
049bcbcba6 Tweaks to lisp manual to remove over/underflows in printed version.
* help.texi (Accessing Documentation):
* display.texi (Pixel Specification):
* processes.texi (Serial Ports, Serial Ports):
* nonascii.texi (Character Properties, Default Coding Systems):
* text.texi (Changing Properties, Special Properties):
* windows.texi (Window Start and End):
* modes.texi (SMIE Indentation Example, SMIE Tricks):
* keymaps.texi (Searching Keymaps, Tool Bar):
* minibuf.texi (Basic Completion):
* compile.texi (Eval During Compile):
* strings.texi (Formatting Strings): Tweaks to avoid overflowing
7x9 paper in printed manual.

* lists.texi (Sets And Lists): Fix misplaced text.
2011-05-29 13:18:46 -04:00
Glenn Morris
d2fc7e3d0f Merge from emacs-23; up to 2010-06-10T12:56:11Z!michael.albinus@gmx.de. 2011-05-12 00:07:06 -07:00
Stefan Monnier
bc3bea9cf0 * lispref/modes.texi (Region to Refontify): Rename from "Region to Fontify".
(Multiline Font Lock):
* lispref/vol2.texi (Top):
* lispref/vol1.texi (Top):
* lispref/elisp.texi (Top): Update menu accordingly.
2011-05-06 11:32:26 -03:00
Chong Yidong
5ef342304d Bump version to 23.3.50 2011-03-11 12:17:33 -05:00
Eli Zaretskii
63a329f81d Allow building manuals with Texinfo before v4.12.
doc/lispref/intro.texi (Acknowledgements): Convert to ISO-8859-1 encoding.
 doc/lispref/makefile.w32-in (MAKEINFO_OPTS): Add --enable-encoding.
 doc/lispref/elisp.texi: Use ISO-8859-1 in @documentencoding.
 doc/emacs/ack.texi (Acknowledgments): Convert to ISO-8859-1 encoding.  Use
 Texinfo @-commands for non Latin-1 characters.
 doc/emacs/emacs.texi: Use ISO-8859-1 in @documentencoding.
 doc/emacs/makefile.w32-in (MAKEINFO_OPTS): Add --enable-encoding.
2011-03-09 18:54:08 +02:00
Glenn Morris
80b005c767 Add missing piece of previous doc/ change.
* doc/lispref/elisp.texi: Set documentencoding.
2011-03-08 09:33:55 -08:00
Chong Yidong
120d9389bf Improve packaging documentation.
* package.texi (Packaging, Packaging Basics, Simple Packages)
(Multi-file Packages): Expand and clarify.
(Package Archives): Temporary placeholder node.

* elisp.texi (Top): Update node listing.
2011-03-06 10:54:36 -05:00
Chong Yidong
22770c84d5 Release logs for 23.3 release.
Regenerate configure and other release files.
2011-02-28 22:29:00 -05:00
Glenn Morris
67ab0163d6 Merge from emacs-23; up to 2010-06-01T01:49:15Z!monnier@iro.umontreal.ca 2011-02-19 11:40:59 -08:00
Eli Zaretskii
e979a521f3 Followup for fixing bug #7942.
doc/lispref/elisp.texi: Sync @dircategory with ../../info/dir.
 doc/lispintro/emacs-lisp-intro.texi: Sync @dircategory with ../../info/dir.
 doc/misc/ede.texi: Sync letter-case with ../../info/dir.
2011-02-18 21:03:59 +02:00
Chong Yidong
4648b91b09 Bump versio to 23.2.94.
Regenerate release files.
2011-02-14 23:01:16 -05:00
Chong Yidong
b4a8877000 Bump version to 23.2.93. 2011-01-31 22:14:15 -05:00
Chong Yidong
14beddf471 Merge changes from emacs-23 branch 2011-01-31 18:54:50 -05:00
Chong Yidong
61db307fee Shorten menu description of "Other Display Specs" lispref node (Bug#7816).
* vol1.texi (Top):
* vol2.texi (Top):
* elisp.texi (Top):
* display.texi (Display Property): Shorten the menu description of
the "Other Display Specs" node.
2011-01-28 14:19:36 -05:00
Glenn Morris
73b0cd5003 Convert consecutive FSF copyright years to ranges. 2011-01-24 20:08:28 -08:00
Chong Yidong
9f19b8ddfe Bump version to 23.2.92.
Regenerate AUTHORS, configure, and ldefs-boot.el.
2011-01-14 22:50:47 -05:00
Stefan Monnier
77ab81d054 Merge from emacs-23 2011-01-14 12:18:41 -05:00
Glenn Morris
5df4f04cd3 Add 2011 to FSF/AIST copyright years. 2011-01-02 15:50:46 -08:00
Chong Yidong
1f10e75066 Bump version to 23.2.91.
Regenerate configure and ldefs-boot.el.
2010-12-10 12:46:40 -05:00