X-Git-Url: https://ruderich.org/simon/gitweb/?p=coloredstderr%2Fcoloredstderr.git;a=blobdiff_plain;f=README;h=6bedd742c33faf44818ec01e06029d20f8cc19ec;hp=e00fdfaf2be4186fa4cafdabed62511049ecf06c;hb=d5b84811d2f4bded83211984c839a096872608af;hpb=b24bd8dc4367f3adc443e4acb954326f38098c53 diff --git a/README b/README index e00fdfa..6bedd74 100644 --- a/README +++ b/README @@ -73,8 +73,12 @@ DEBUG To enable debug mode, configure coloredstderr with '--enable-debug'. +*Important:* Debug mode enables `assert()`s in the code which might abort the +process if an error condition is detected! + Debug mode is slower than normal mode. To log only warnings without the -overhead of debug mode use '--enable-warnings'. +overhead of debug mode use '--enable-warnings'. `assert()`s are not enabled +with '--enable-warnings', so it's safe to use. Debug messages are written to the file `colored_stderr_debug_log.txt` in the current working directory _if_ it exists. If it exists debug messages are