summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJennifer Hodgdon2015-01-10 22:00:08 (GMT)
committer Jennifer Hodgdon2015-01-10 22:00:08 (GMT)
commite1634ecb4b29e2ddabe236fe588d8e1c1071cedd (patch)
treed225e1378bf043e1adfe7caedd4c399f859fee77
parentcad5d03a80e4ade09947986b136f7e17791ed481 (diff)
Issue #2387745 by zealfire, joachim: docs for watchdog() should state character limits, and give error levels6.x
-rw-r--r--includes/bootstrap.inc14
1 files changed, 12 insertions, 2 deletions
diff --git a/includes/bootstrap.inc b/includes/bootstrap.inc
index c8d6739..53fc41e 100644
--- a/includes/bootstrap.inc
+++ b/includes/bootstrap.inc
@@ -938,6 +938,8 @@ function request_uri() {
* @param $type
* The category to which this message belongs. Can be any string, but the
* general practice is to use the name of the module calling watchdog().
+ * The $type parameter is limited to 16 characters; anything longer is
+ * truncated.
* @param $message
* The message to store in the log. See t() for documentation
* on how $message and $variables interact. Keep $message
@@ -947,8 +949,16 @@ function request_uri() {
* NULL if message is already translated or not possible to
* translate.
* @param $severity
- * The severity of the message, as per RFC 3164. Possible values are
- * WATCHDOG_ERROR, WATCHDOG_WARNING, etc.
+ * The severity of the message; one of the following values as defined in
+ * @link http://www.faqs.org/rfcs/rfc3164.html RFC 3164: @endlink
+ * - WATCHDOG_EMERGENCY: Emergency, system is unusable.
+ * - WATCHDOG_ALERT: Alert, action must be taken immediately.
+ * - WATCHDOG_CRITICAL: Critical conditions.
+ * - WATCHDOG_ERROR: Error conditions.
+ * - WATCHDOG_WARNING: Warning conditions.
+ * - WATCHDOG_NOTICE: (default) Normal but significant conditions.
+ * - WATCHDOG_INFO: Informational messages.
+ * - WATCHDOG_DEBUG: Debug-level messages.
* @param $link
* A link to associate with the message.
*