Currently, there is no documentation for the difference between NOTICE, WARNING, and ERROR levels in watchdog. Probably because of that, they are used somewhat inconsistently throughout core. This patch attempts to provide some, which probably need to be agreed on and then a second patch can make the use of each consistent.

CommentFileSizeAuthor
#8 watchdog-document-constants-102603-8.patch3.49 KBwebchick
#5 watchdog-document-constants-102603-5.patch3.4 KBwebchick
#4 watchdog-document-constants-102603-4.patch2.98 KBwebchick
#3 watchdog-document-constants-102603-3.patch2.28 KBwebchick
watchdog-doc.patch1.01 KBwebchick

Comments

dries’s picture

dries commented
Status: Needs review » Fixed

Committed to CVS HEAD. Thanks.

Anonymous’s picture

(not verified) commented
Status: Fixed » Closed (fixed)
webchick’s picture

webchick
she/they
Primary language English
Location Vancouver 🇨🇦
commented
Version: 5.x-dev » 7.x-dev
Status: Closed (fixed) » Needs review
StatusFileSize
new watchdog-document-constants-102603-3.patch2.28 KB

Oops. These got un-documented when we switched to using standard error reporting. Let's try that again. ;)

webchick’s picture

webchick
she/they
Primary language English
Location Vancouver 🇨🇦
commented
StatusFileSize
new watchdog-document-constants-102603-4.patch2.98 KB

Actually, this is better.

1. Moved the reference to the RFC URL to the PHPDoc of watchdog_severity_levels() which, as a side effect, documented that function. :)

2. Fixed some pluralization inconsistency (thanks, Morbus!)

3. Separate the "Log message" and the "Thing: Defintion" with "--" to make it a bit more clear (thanks, Morbus!)

4. Moved the @see references to the constants themselves, rather than in that weird comment block above which won't be displayed anywhere.

5. Removed said weird comment block above.

webchick’s picture

webchick
she/they
Primary language English
Location Vancouver 🇨🇦
commented
StatusFileSize
new watchdog-document-constants-102603-5.patch3.4 KB

Oops. I misunderstood Morbus on #2. Setting back to the way things are pluralized in the RFC.

Note: "Notice" is inconsistent by being singular rather than plural, but we decided it's best to stick with what's in the RFC rather than deviate from it, even slightly. I'll go file a bug with IETF. ;)

morbus iff’s picture

morbus iff
they/them
commented
Status: Needs review » Reviewed & tested by the community

Together in IRC.

senpai’s picture

senpai commented

Second review, same as the first, a little bit louder, and a whole...

Never mind. RTBC via IRC chat.

webchick’s picture

webchick
she/they
Primary language English
Location Vancouver 🇨🇦
commented
StatusFileSize
new watchdog-document-constants-102603-8.patch3.49 KB

Patch is the same; only difference is it now references ietf.org rather than faqs.org for the RFC URL. I believe this is now every pedantic thing we could possibly fix about this documentation. Feels good. :)

Thanks, Morbus and Senpai! :)

webchick’s picture

webchick
she/they
Primary language English
Location Vancouver 🇨🇦
commented
Status: Reviewed & tested by the community » Fixed

Yay! This was committed as part of #101543: Document all constants.

Anonymous’s picture

Anonymous (not verified) commented
Status: Fixed » Closed (fixed)

Automatically closed -- issue fixed for two weeks with no activity.