From 46cba7cc5b25c11bf9f58da1447f59a9dc4e1bd5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fredrik=20H=C3=BCbinette=20=28Hubbe=29?= <hubbe@hubbe.net> Date: Thu, 12 Dec 1996 19:55:05 -0800 Subject: [PATCH] some documentation fixes Rev: doc/internal/low_level/low_level:1.2 Rev: doc/internal/pike/SETJMP:1.2 Rev: doc/internal/pike/SET_ONERROR:1.2 Rev: doc/internal/pike/UNSETJMP:1.2 Rev: doc/internal/pike/UNSET_ONERROR:1.2 Rev: doc/internal/pike/data_types:1.1 Rev: doc/internal/pike/error:1.3 Rev: doc/internal/pike/error_handling:1.1 Rev: doc/internal/pike/fatal:1.2 Rev: doc/internal/pike/frame:1.2 Rev: doc/internal/pike/throw:1.2 Rev: doc/internal/pike/type_field:1.2 Rev: doc/internal/pike/types:1.2 --- doc/internal/low_level/low_level | 2 +- doc/internal/pike/SETJMP | 4 +--- doc/internal/pike/SET_ONERROR | 3 +++ doc/internal/pike/UNSETJMP | 3 +++ doc/internal/pike/UNSET_ONERROR | 3 +++ doc/internal/pike/data_types | 10 ++++++++++ doc/internal/pike/error | 2 +- doc/internal/pike/error_handling | 21 +++++++++++++++++++++ doc/internal/pike/fatal | 2 +- doc/internal/pike/frame | 2 +- doc/internal/pike/throw | 2 +- doc/internal/pike/type_field | 3 +++ doc/internal/pike/types | 2 +- 13 files changed, 50 insertions(+), 9 deletions(-) create mode 100644 doc/internal/pike/data_types create mode 100644 doc/internal/pike/error_handling diff --git a/doc/internal/low_level/low_level b/doc/internal/low_level/low_level index 768e9f3c41..0dcf146cb7 100644 --- a/doc/internal/low_level/low_level +++ b/doc/internal/low_level/low_level @@ -1,7 +1,7 @@ NAME low_level - low level routines supplied by pike -DESCRIPTIONS +DESCRIPTION These functions are here to help you write fast and portable modules. Pike itself also uses them for the same purpose. diff --git a/doc/internal/pike/SETJMP b/doc/internal/pike/SETJMP index 6283a08c64..fc99dba109 100644 --- a/doc/internal/pike/SETJMP +++ b/doc/internal/pike/SETJMP @@ -40,10 +40,8 @@ EXAMPLE UNSETJMP(foo) } - - KEYWORDS - internals + error_handling SEE ALSO throw, error, UNSETJMP, SET_ONERROR, UNSET_ONERROR diff --git a/doc/internal/pike/SET_ONERROR b/doc/internal/pike/SET_ONERROR index b49be06079..911f7cd7c7 100644 --- a/doc/internal/pike/SET_ONERROR +++ b/doc/internal/pike/SET_ONERROR @@ -34,5 +34,8 @@ EXAMPLE UNSET_ONERROR(tmp); } +KEYWORDS + error_handling + SEE ALSO UNSET_ONERROR, error diff --git a/doc/internal/pike/UNSETJMP b/doc/internal/pike/UNSETJMP index 64835503eb..41a50bfb30 100644 --- a/doc/internal/pike/UNSETJMP +++ b/doc/internal/pike/UNSETJMP @@ -5,5 +5,8 @@ DESCRIPTION This macro cleans up after calling SETJMP. See the page for SETJMP for more details. +KEYWORDS + error_handling + SEE ALSO SETJMP diff --git a/doc/internal/pike/UNSET_ONERROR b/doc/internal/pike/UNSET_ONERROR index 663bfd3340..9f01e64995 100644 --- a/doc/internal/pike/UNSET_ONERROR +++ b/doc/internal/pike/UNSET_ONERROR @@ -5,5 +5,8 @@ DESCRIPTION This function cleans up after a SET_ONERROR call. See SET_ONERROR for more details. +KEYWORDS + error_handling + SEE ALSO SET_ONERROR, SETJMP diff --git a/doc/internal/pike/data_types b/doc/internal/pike/data_types new file mode 100644 index 0000000000..2b9f4bb4dd --- /dev/null +++ b/doc/internal/pike/data_types @@ -0,0 +1,10 @@ +NAME + data_types - Pike internal data types + +DESCRIPTION + Of course the Pike source uses a lot of data types except for those + that represents mappings, arrays, strings etc. Callbacks, stack frames + and type fields are just the beginning. + +KEYWORDS + internals diff --git a/doc/internal/pike/error b/doc/internal/pike/error index 47dcea7dca..8ad505563d 100644 --- a/doc/internal/pike/error +++ b/doc/internal/pike/error @@ -15,7 +15,7 @@ DESCRIPTION resent active catch() call. KEYWORDS - internals + error_handling SEE ALSO SET_ONERROR, fatal, throw diff --git a/doc/internal/pike/error_handling b/doc/internal/pike/error_handling new file mode 100644 index 0000000000..2b70fadd4e --- /dev/null +++ b/doc/internal/pike/error_handling @@ -0,0 +1,21 @@ +NAME + error_handling - how to error handling works inside Pike + +DESCRIPTION + Error handling in Pike is implemented with the setjmp/longjmp + functionality. This means that functions that can cause errors + will NOT return if an error occurs. Special care has to be taken + so that no memory is left unfreed if an error occurs. Almost all + functions that can cause Pike code to be executed can cause an + error. Also functions that implements Pike operators / functions + can cause errors. If you are paranoid you should assume that all + functions can cause errors. You may also read the code for the + function to see if there are any calls to error() in it. If the + function is documented in this manual, it will say if the function + can cause errors. + +KEYWORDS + internals + + + diff --git a/doc/internal/pike/fatal b/doc/internal/pike/fatal index 397feae1be..f36e49b6d6 100644 --- a/doc/internal/pike/fatal +++ b/doc/internal/pike/fatal @@ -15,7 +15,7 @@ DESCRIPTION sometimes be a lot better... KEYWORDS - internal + error_handling SEE ALSO error diff --git a/doc/internal/pike/frame b/doc/internal/pike/frame index 7d9e6bccec..3cc2e22ab4 100644 --- a/doc/internal/pike/frame +++ b/doc/internal/pike/frame @@ -16,4 +16,4 @@ DESCRIPTION for you if you have done add_storage() earlier. KEYWORDS - internals + data_types diff --git a/doc/internal/pike/throw b/doc/internal/pike/throw index e5ee768eab..c0163214d6 100644 --- a/doc/internal/pike/throw +++ b/doc/internal/pike/throw @@ -14,7 +14,7 @@ DESCRIPTION not return. See SETJMP for more details. KEYWORDS - internals + error_handling SEE ALSO SETJMP, error diff --git a/doc/internal/pike/type_field b/doc/internal/pike/type_field index 84bbbe69e2..05e1fec029 100644 --- a/doc/internal/pike/type_field +++ b/doc/internal/pike/type_field @@ -13,5 +13,8 @@ DESCRIPTION explicitly, so if you don't know what types are involved you should use -1 for the type field. +KEYWORDS + data_types + SEE ALSO mapping, array, svalue diff --git a/doc/internal/pike/types b/doc/internal/pike/types index 25fad092ce..ba9074561d 100644 --- a/doc/internal/pike/types +++ b/doc/internal/pike/types @@ -27,7 +27,7 @@ DESCRIPTION together. KEYWORDS - internals + data_types SEE ALSO add_function, add_efun \ No newline at end of file -- GitLab