From 2a21914c07e885ca117d5c9de8dec9bc21bdbcad Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Kjell=20Hedstr=C3=B6m?= Date: Thu, 24 May 2018 16:50:55 -0600 Subject: [PATCH] Update API.markdown Added description: disable fatal signal handling --- API.markdown | 31 +++++++++++++------------------ 1 file changed, 13 insertions(+), 18 deletions(-) diff --git a/API.markdown b/API.markdown index 321731e..0864d74 100644 --- a/API.markdown +++ b/API.markdown @@ -22,7 +22,7 @@ Most of the API that you need for using g3log is described in this readme. For m * [TOWRITE: Custom fatal handling](#fatal_custom_handling) * [TOWRITE: Pre fatal hook](#fatal_pre_hook) * [TOWRITE: Override of signal handling](#fatal_signalhandler_override) - * [TOWRITE: Disable fatal handling](#fatal_handling_disabled) + * [Disable fatal handling](#fatal_handling_disabled) * Build Options @@ -298,26 +298,21 @@ The default behaviour for G3log is to catch several fatal events before they for ``` - - - ### TOWRITE: Windows - Windows fatal handling also deals with fatal signals just like Linux. In addition to fatal signals it also deals with unhandled exceptions, vectored exceptions. Windows fatal handling is handled in [crashhandler.hpp](src/g3log/crashhandler.hpp), [crashhandler_windows.cpp](src/crashhandler_windows.cpp), [stacktrace_windows.hpp](src/g3log/stacktrace_windows.hpp), [stacktrace_windows.cpp](src/stacktrace_windows.cpp) - - - An example of a Windows stackdump as shown in the output from the fatal example g3log-FATAL-sigsegv. - - .... MISSING CONTENT..... since my Windows computer is gone! - - - - - - - ### TOWRITE: Custom fatal handling ### TOWRITE: Pre fatal hook ### TOWRITE: Override of signal handling - ### TOWRITE: Disable fatal handling + ### Disable fatal handling + Fatal signal handling can be disabled with a CMake option: `ENABLE_FATAL_SIGNALHANDLING`. See [Options.cmake](https://github.com/KjellKod/g3log/blob/master/Options.cmake) for more details + + + ### Windows + Windows fatal handling also deals with fatal signals just like Linux. In addition to fatal signals it also deals with unhandled exceptions, vectored exceptions. Windows fatal handling is handled in [crashhandler.hpp](src/g3log/crashhandler.hpp), [crashhandler_windows.cpp](src/crashhandler_windows.cpp), [stacktrace_windows.hpp](src/g3log/stacktrace_windows.hpp), [stacktrace_windows.cpp](src/stacktrace_windows.cpp) + + An example of a Windows stackdump as shown in the output from the fatal example g3log-FATAL-sigsegv. + + + +