aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorHugo Hörnquist <hugo@lysator.liu.se>2023-10-18 13:59:39 +0200
committerHugo Hörnquist <hugo@lysator.liu.se>2023-10-18 13:59:39 +0200
commit88fe78acc63adaff2d25e81b369f1395290e0e18 (patch)
treee139e89695c3b01fa421e5578776bb4b96f08fe2 /doc
parentMove (vcomponent duration) to new object system. (diff)
downloadcalp-88fe78acc63adaff2d25e81b369f1395290e0e18.tar.gz
calp-88fe78acc63adaff2d25e81b369f1395290e0e18.tar.xz
Add "unreachable".
Diffstat (limited to 'doc')
-rw-r--r--doc/ref/general/util-exceptions.texi11
1 files changed, 11 insertions, 0 deletions
diff --git a/doc/ref/general/util-exceptions.texi b/doc/ref/general/util-exceptions.texi
index 34ba33f9..4c2b432d 100644
--- a/doc/ref/general/util-exceptions.texi
+++ b/doc/ref/general/util-exceptions.texi
@@ -38,3 +38,14 @@ signal SIGINT, which kills the program.
@defun filter-stack pred? stack
@c TODO document me
@end defun
+
+
+@defun unreachable procedure fmt args
+Marks that a code path should be unreachable. Throws an exception
+which should never be caught (an @code{(exit -1)} would also have
+worked, but would make debugging harder).
+
+@var{procedure} is the procedure which reached an ``impossible''
+state, @var{fmt} a format string, and @var{args} arguments to that
+format string.
+@end defun