annotate lispref/errors.texi @ 25536:2cfdaebe325c

Fix comment about conventions for Lisp files.

@c -*-texinfo-*-
@c This is part of the GNU Emacs Lisp Reference Manual.
@c Copyright (C) 1990, 1991, 1992, 1993 Free Software Foundation, Inc. 
@c See the file elisp.texi for copying conditions.
@setfilename ../info/errors
@node Standard Errors, Standard Buffer-Local Variables, GNU Emacs Internals, Top
@appendix Standard Errors

  Here is the complete list of the 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.

  Each error symbol has an @code{error-conditions} property that is a
list of symbols.  Normally this list includes the error symbol itself
and the symbol @code{error}.  Occasionally it includes additional
symbols, which are intermediate classifications, narrower than
@code{error} but broader than a single error symbol.  For example, all
the errors in accessing files have the condition @code{file-error}.  If
we do not say here that a certain error symbol has additional error
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.

  @xref{Errors}, for an explanation of how errors are generated and
handled.

@table @code
@item @var{symbol}
@var{string}; @var{reference}.

@item error
@code{"error"}@*
@xref{Errors}.

@item quit
@code{"Quit"}@*
@xref{Quitting}.

@item args-out-of-range
@code{"Args out of range"}@*
@xref{Sequences Arrays Vectors}.

@item arith-error
@code{"Arithmetic error"}@*
See @code{/} and @code{%} in @ref{Numbers}.

@item beginning-of-buffer
@code{"Beginning of buffer"}@*
@xref{Motion}.

@item buffer-read-only
@code{"Buffer is read-only"}@*
@xref{Read Only Buffers}.

@item cyclic-function-indirection
@code{"Symbol's chain of function indirections\@* contains a loop"}@*
@xref{Function Indirection}.

@item end-of-buffer
@code{"End of buffer"}@*
@xref{Motion}.

@item end-of-file
@code{"End of file during parsing"}@*
Note that this is not a @code{file-error}
because it pertains to the Lisp reader, not to file I/O.
@xref{Input Functions}.

@item file-already-exists
This is a @code{file-error}.@*
@xref{Writing to Files}.

@item file-date-error
This is a subcategory of @code{file-error}.  It occurs when
@code{copy-file} tries and fails to set the last-modification time of
the output file.  @xref{Changing Files}.

@item file-error
This error and its subcategories do not have error-strings, because the
error message is constructed from the data items alone when the error
condition @code{file-error} is present.@*
@xref{Files}.

@item file-locked     
This is a @code{file-error}.@*
@xref{File Locks}.

@item file-supersession
This is a @code{file-error}.@*
@xref{Modification Time}.

@item invalid-function
@code{"Invalid function"}@*
@xref{Classifying Lists}.

@item invalid-read-syntax
@code{"Invalid read syntax"}@*
@xref{Input Functions}.

@item invalid-regexp
@code{"Invalid regexp"}@*
@xref{Regular Expressions}.

@item mark-inactive
@code{"Mark inactive"}@*
@xref{The Mark}.

@item no-catch
@code{"No catch for tag"}@*
@xref{Catch and Throw}.

@item scan-error
@code{"Scan error"}@*
This happens when certain syntax-parsing functions
find invalid syntax or mismatched parentheses.@*
@xref{List Motion}, and @ref{Parsing Expressions}.

@item search-failed
@code{"Search failed"}@*
@xref{Searching and Matching}.

@item setting-constant
@code{"Attempt to set a constant symbol"}@* 
The values of the symbols @code{nil} and @code{t},
and any symbols that start with @samp{:},
may not be changed.@*
@xref{Constant Variables, , Variables that Never Change}.

@item undefined-color
@code{"Undefined color"}@*
@xref{Color Names}.

@item void-function
@code{"Symbol's function definition is void"}@*
@xref{Function Cells}.

@item void-variable
@code{"Symbol's value as variable is void"}@*
@xref{Accessing Variables}.

@item wrong-number-of-arguments
@code{"Wrong number of arguments"}@*
@xref{Classifying Lists}.

@item wrong-type-argument
@code{"Wrong type argument"}@*
@xref{Type Predicates}.
@end table

  These kinds of error, which are classified as special cases of
@code{arith-error}, can occur on certain systems for invalid use of
mathematical functions.

@table @code
@item domain-error
@code{"Arithmetic domain error"}@*
@xref{Math Functions}.

@item overflow-error
@code{"Arithmetic overflow error"}@*
@xref{Math Functions}.

@item range-error
@code{"Arithmetic range error"}@*
@xref{Math Functions}.

@item singularity-error
@code{"Arithmetic singularity error"}@*
@xref{Math Functions}.

@item underflow-error
@code{"Arithmetic underflow error"}@*
@xref{Math Functions}.
@end table