From: Philippe Proulx <eeppeliteloop@gmail.com>
Date: Tue, 16 May 2017 02:13:25 +0000 (-0400)
Subject: Update logging guide: more about the WARN level
X-Git-Tag: v2.0.0-pre1~235
X-Git-Url: http://git.efficios.com/?p=babeltrace.git;a=commitdiff_plain;h=6c1b33a842742167c834df1606ca583e71ba8cb1

Update logging guide: more about the WARN level

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>
---

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.