X-Git-Url: http://git.efficios.com/?a=blobdiff_plain;f=doc%2Flogging-guide.adoc;h=2c5ce39caf9997d8923bbcb05b973ad3e2fcdb0f;hb=6c1b33a842742167c834df1606ca583e71ba8cb1;hp=edfbf0074ef2ebe58a625cefe2ef780e048a7719;hpb=ec159b1e42a1b16c174c729dd36da1c1e4202f69;p=babeltrace.git diff --git a/doc/logging-guide.adoc b/doc/logging-guide.adoc index edfbf007..2c5ce39c 100644 --- a/doc/logging-guide.adoc +++ b/doc/logging-guide.adoc @@ -567,10 +567,15 @@ least exit cleanly. |_WARN_ |A logic error which still allows the execution to continue. + +_WARN_-level logging statements are for any error or weird action that +is directly or indirectly caused by the user. For example, not having +enough memory is beyond user control. | -* Unexpected values for function parameters. -* Other user-induced errors (the user does not honor a function's - preconditions). +* Not honoring a public function's preconditions (NULL parameters, + index out of bounds, etc.). +* Adding an invalid event class to a stream class which is already + part of a trace. + For example, the caller tries to set a property of a frozen stream class.