diff options
author | Hugo Hörnquist <hugo@lysator.liu.se> | 2023-10-10 00:16:27 +0200 |
---|---|---|
committer | Hugo Hörnquist <hugo@lysator.liu.se> | 2023-10-10 00:16:27 +0200 |
commit | 019426ecacf4c85936acafb7e5494b29f9e0d4c4 (patch) | |
tree | 90ad21cafad6f97ba2fb7129d158f10f43093bc3 /doc/ref/calp/error.texi | |
parent | Fix `prop` for multi-valued items. (diff) | |
download | calp-019426ecacf4c85936acafb7e5494b29f9e0d4c4.tar.gz calp-019426ecacf4c85936acafb7e5494b29f9e0d4c4.tar.xz |
Include calp documentation.
A bad gitignore ignored much more than it should have. Now updated to
only ignore top level binary.
Diffstat (limited to 'doc/ref/calp/error.texi')
-rw-r--r-- | doc/ref/calp/error.texi | 55 |
1 files changed, 55 insertions, 0 deletions
diff --git a/doc/ref/calp/error.texi b/doc/ref/calp/error.texi new file mode 100644 index 00000000..a8937b84 --- /dev/null +++ b/doc/ref/calp/error.texi @@ -0,0 +1,55 @@ +@node Errors and Conditions +@section Errors and Conditions + +@subsection ``Special'' Errors + +@deftp{Error type} return +Thrown in some sub-mains to quickly return from the sub-function. +Should possibly be replaced by an explicit return-continuation. +@end deftp + +@deftp{Error type} warning fmt args +Thrown when @code{warnings-are-errors} is true. + +@ref{warning} for more information. +@end deftp + +@deftp{Error type} max-page page-number +@end deftp + +@subsection ``Regular'' Errors +All below mentioned error types behave as expected, e.g., they are +produced through @code{scm-error}. + +@deftp{Error Type} configuration-error +Thrown by (calp util config), in some scenarios. +@TODO{Better documentation} +@end deftp + +@deftp{Error Type} c-parse-error +Errors thrown by our make-shift C parser. +@end deftp + +@deftp{Error Type} decoding-error +thrown by base64 in some cases +@end deftp + +@deftp{Error Type} parse-error +Thrown by some things related to parsing, but not all. +@TODO{normalize parsing errors further} +@end deftp + +@deftp{Error Type} graph-error +The first element of data is guaranteed to be the graph which caused +the error. +@end deftp + +@deftp{Error Type} missing-helper +A helper program we wanted was missing, could be resolved by somehow +downloading it into one of the searched locations. + +@example +data : (program-name : string) + , (searched-locations : (list string)) +@end example +@end deftp |