gnustep/libs-base
0
0
Fork 0
mirror of https://github.com/gnustep/libs-base.git synced 2025-05-07 23:10:44 +00:00
Code Issues Projects Releases Packages Wiki Activity

Improve documentation

Browse source 
git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/base/branches/stable@26987 72102866-910b-0410-8b05-ffd578937521
This commit is contained in:
Richard Frith-MacDonald 2008-10-29 06:39:49 +00:00
parent 35aac6a72e
commit eb221daa74
2 changed files with 30 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
ChangeLog
View file

@ -2,6 +2,7 @@
* Source/NSException.m: Fix stacktrace to be available when built * Source/NSException.m: Fix stacktrace to be available when built
without DEBUG=YES. Check environment variable to activate/deactivate. without DEBUG=YES. Check environment variable to activate/deactivate.
* Documentation/Basegsdoc: Improve documentation of stack trace.
2008-10-29 Richard Frith-Macdonald <rfm@gnu.org> 2008-10-29 Richard Frith-Macdonald <rfm@gnu.org>

32
Documentation/Base.gsdoc
View file

@ -272,9 +272,35 @@ notice and this notice are preserved.
<term>GNUSTEP_STACK_TRACE</term> <term>GNUSTEP_STACK_TRACE</term>
<desc> <desc>
<p> <p>
When this is set to <em>YES</em> a stack trace is When this is set to <em>YES</em> a human readable stack trace
added to the output of the description method of (with function names and line numbers) is added to the output
a raised exception object. of the description method of a raised exception object.<br />
This only works if gnustep was built with support for it
using libbfd, so it may not be available on all systems.
</p>
<p>
When this is set to <em>NO</em> the raw stack trace provided
by [NSException-callStackReturnAddresses] is didsabled.<br />
The possible reasons for disabling this are:<br />
1. that the feature is implemented using a function of the
gcc complier to provide stack addresses, and the function is
buggy on some systems/compiler versions, and will cause a
signal to be sent which would crash your program if not caught.
The GNUstep code catches the signal and recovers using a signal
handler, but there have been two reports of this not working
with no known cause.<br />
2. that you have code which uses exceptions in a way in which
they were not designed to be used ... so that they are
routinely and frquently called rather than being called only
occasionally when exceptional conditions occur. In this case
you may want to disable the stack frame generation implicit
in each raised exception, in order to improve performance.
</p>
<p>
When this is not set, or is set to a non-boolean value, the
stack trace handling on exceptionsis MacOS-X compatible ...
stack return addresses are available but a human readable
traceback is not logged.
</p> </p>
</desc> </desc>
<term>GNUSTEP_STRING_ENCODING</term> <term>GNUSTEP_STRING_ENCODING</term>