From 6c1b33a842742167c834df1606ca583e71ba8cb1 Mon Sep 17 00:00:00 2001 From: Philippe Proulx Date: Mon, 15 May 2017 22:13:25 -0400 Subject: [PATCH] Update logging guide: more about the WARN level MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit Signed-off-by: Philippe Proulx Signed-off-by: Jérémie Galarneau --- doc/logging-guide.adoc | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) 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. -- 2.34.1