From 5f5fb466630db9dc8e17895c90ed74105852e827 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Bj=C3=B6rn-Egil=20Dahlberg?=
Date: Fri, 21 Oct 2016 15:44:49 +0200
Subject: erl_interface: Remove CDATA tag except for example code
---
lib/erl_interface/doc/src/erl_error.xml | 32 ++++++++++++++++----------------
1 file changed, 16 insertions(+), 16 deletions(-)
(limited to 'lib/erl_interface/doc/src/erl_error.xml')
diff --git a/lib/erl_interface/doc/src/erl_error.xml b/lib/erl_interface/doc/src/erl_error.xml
index a85969d7ff..8139c9b343 100644
--- a/lib/erl_interface/doc/src/erl_error.xml
+++ b/lib/erl_interface/doc/src/erl_error.xml
@@ -40,9 +40,9 @@
by W. Richard Stevens.
These functions are all called in the same manner as
- , that is, with a string containing format
+ printf(), that is, with a string containing format
specifiers followed by a list of corresponding arguments. All output from
- these functions is to .
+ these functions is to stderr.
@@ -54,7 +54,7 @@
The message provided by the caller is printed. This
- function is simply a wrapper for .
+ function is simply a wrapper for fprintf().
@@ -105,37 +105,37 @@
Error Reporting
Most functions in Erl_Interface report failures to the caller by
returning some otherwise meaningless value (typically
-
+ NULL
or a negative number). As this only tells you that things did not
- go well, examine the error code in if you
+ go well, examine the error code in erl_errno if you
want to find out more about the failure.
volatile interl_errno
- Variable contains the
+ Variable erl_errno contains the
Erl_Interface error number. You can change the value if you wish.
- is initially (at program startup) zero
+
erl_errno is initially (at program startup) zero
and is then set by many Erl_Interface functions on failure to
a non-zero error code to indicate what kind of error it
encountered. A successful function call can change
- (by calling some other function that
+ erl_errno (by calling some other function that
fails), but no function does never set it to zero. This means
- that you cannot use to see if a
+ that you cannot use erl_errno to see if a
function call failed. Instead, each function reports failure
in its own way (usually by returning a negative number or
- ), in which case you can examine
- for details.
- uses the error codes defined in your
- system's ]]>.
+ NULL), in which case you can examine
+ erl_errno for details.
+ erl_errno uses the error codes defined in your
+ system's <errno.h>.
- is a "modifiable lvalue" (just
- like ISO C defines to be) rather than a
+
erl_errno is a "modifiable lvalue" (just
+ like ISO C defines errno to be) rather than a
variable. This means it can be implemented as a macro
- (expanding to, for example, ).
+ (expanding to, for example, *_erl_errno()).
For reasons of thread safety (or task safety), this is exactly what
we do on most platforms.
--
cgit v1.2.3