From: Glenn Morris Date: Sat, 25 Feb 2012 20:59:46 +0000 (-0800) Subject: Checked errors.texi X-Git-Tag: emacs-pretest-24.0.94~15 X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=7e05b1ec635842490a459b300a0e4194d7035c27;p=emacs.git 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. --- diff --git a/admin/FOR-RELEASE b/admin/FOR-RELEASE index 607353dd75e..1401bad10d2 100644 --- a/admin/FOR-RELEASE +++ b/admin/FOR-RELEASE @@ -194,7 +194,7 @@ debugging.texi cyd display.texi edebug.texi elisp.texi -errors.texi +errors.texi rgm eval.texi cyd files.texi cyd frames.texi diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog index deeaa2a28f9..6dcd4aa0c5d 100644 --- a/doc/lispref/ChangeLog +++ b/doc/lispref/ChangeLog @@ -1,3 +1,10 @@ +2012-02-25 Glenn Morris + + * 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 * files.texi (files-equal-p, file-subdir-of-p): New, diff --git a/doc/lispref/control.texi b/doc/lispref/control.texi index c23c93300a6..8c45a1a4faf 100644 --- a/doc/lispref/control.texi +++ b/doc/lispref/control.texi @@ -1234,7 +1234,7 @@ make it possible to categorize errors at various levels of generality when you write an error handler. Using error symbols alone would eliminate all but the narrowest level of classification. - @xref{Standard Errors}, for a list of all the standard error symbols + @xref{Standard Errors}, for a list of the main error symbols and their conditions. @node Cleanups diff --git a/doc/lispref/elisp.texi b/doc/lispref/elisp.texi index 05245331af2..70646294656 100644 --- a/doc/lispref/elisp.texi +++ b/doc/lispref/elisp.texi @@ -170,7 +170,7 @@ Appendices * Tips:: Advice and coding conventions for Emacs Lisp. * GNU Emacs Internals:: Building and dumping Emacs; internal data structures. -* Standard Errors:: List of all error symbols. +* Standard Errors:: List of main error symbols. * Standard Buffer-Local Variables:: List of variables buffer-local in all buffers. * Standard Keymaps:: List of standard keymaps. diff --git a/doc/lispref/errors.texi b/doc/lispref/errors.texi index fcf4ec24af7..17ea389e093 100644 --- a/doc/lispref/errors.texi +++ b/doc/lispref/errors.texi @@ -7,7 +7,7 @@ @appendix Standard Errors @cindex standard errors - Here is the complete list of the error symbols in standard Emacs, + Here is a list of the more important error symbols in standard Emacs, grouped by concept. The list includes each symbol's message (on the @code{error-message} property of the symbol) and a cross reference to a description of how the error can occur. @@ -24,6 +24,15 @@ conditions, that means it has none. As a special exception, the error symbol @code{quit} does not have the condition @code{error}, because quitting is not considered an error. +@c You can grep for "(put 'foo 'error-conditions ...) to find +@c examples defined in Lisp. Eg soap-client.el, sasl.el. + Most of these error symbols are defined in C (mainly @file{data.c}), +but some are defined in Lisp. For example, the file @file{userlock.el} +defines the @code{file-locked} and @code{file-supersession} errors. +Several of the specialized Lisp libraries distributed with Emacs +define their own error symbols. We do not attempt to list of all +those here. + @xref{Errors}, for an explanation of how errors are generated and handled. @@ -54,10 +63,16 @@ sequence or buffer.@* @code{"Buffer is read-only"}@* @xref{Read Only Buffers}. -@ignore @item circular-list @code{"List contains a loop"}@* -@end ignore +This happens when some operations (e.g. resolving face names) +encounter circular structures.@* +@xref{Circular Objects}. + +@item cl-assertion-failed +@code{"Assertion failed"}@* +This happens when the @code{assert} macro fails a test.@* +@xref{Assertions,,, cl, Common Lisp Extensions}. @item coding-system-error @code{"Invalid coding system"}@* @@ -105,14 +120,23 @@ do have @code{error-message} properties, and if no data is provided, the @code{error-message} property @emph{is} used.@* @xref{Files}. +@c jka-compr.el +@item compression-error +This is a subcategory of @code{file-error}, which results from +problems handling a compressed file.@* +@xref{How Programs Do Loading}. + +@c userlock.el @item file-locked This is a subcategory of @code{file-error}.@* @xref{File Locks}. +@c userlock.el @item file-supersession This is a subcategory of @code{file-error}.@* @xref{Modification Time}. +@c net/ange-ftp.el @item ftp-error This is a subcategory of @code{file-error}, which results from problems in accessing a remote file using ftp.@* @@ -130,6 +154,7 @@ in accessing a remote file using ftp.@* @code{"Invalid regexp"}@* @xref{Regular Expressions}. +@c simple.el @item mark-inactive @code{"The mark is not active now"}@* @xref{The Mark}. @@ -139,6 +164,7 @@ in accessing a remote file using ftp.@* @xref{Catch and Throw}. @ignore +@c Not actually used for anything? Probably definition should be removed. @item protected-field @code{"Attempt to modify a protected field"} @end ignore @@ -160,6 +186,7 @@ and any symbols that start with @samp{:}, may not be changed.@* @xref{Constant Variables, , Variables that Never Change}. +@c simple.el @item text-read-only @code{"Text is read-only"}@* This is a subcategory of @code{buffer-read-only}.@* diff --git a/doc/lispref/vol1.texi b/doc/lispref/vol1.texi index addc4bd6d69..2a596dd51e8 100644 --- a/doc/lispref/vol1.texi +++ b/doc/lispref/vol1.texi @@ -187,7 +187,7 @@ Appendices * Tips:: Advice and coding conventions for Emacs Lisp. * GNU Emacs Internals:: Building and dumping Emacs; internal data structures. -* Standard Errors:: List of all error symbols. +* Standard Errors:: List of main error symbols. * Standard Buffer-Local Variables:: List of variables buffer-local in all buffers. * Standard Keymaps:: List of standard keymaps. diff --git a/doc/lispref/vol2.texi b/doc/lispref/vol2.texi index 0f6b020db49..538ae7a6d9b 100644 --- a/doc/lispref/vol2.texi +++ b/doc/lispref/vol2.texi @@ -186,7 +186,7 @@ Appendices * Tips:: Advice and coding conventions for Emacs Lisp. * GNU Emacs Internals:: Building and dumping Emacs; internal data structures. -* Standard Errors:: List of all error symbols. +* Standard Errors:: List of main error symbols. * Standard Buffer-Local Variables:: List of variables buffer-local in all buffers. * Standard Keymaps:: List of standard keymaps.