WATCHDOG_* constants not documented properly

It looks like these are already documented in Drupal 7.

Your patch for Drupal 6 is OK, except the part at the top:

 /**
+ * Log message severity -- Emergency: system is unusable.
  *
- * Severity levels, as defined in RFC 3164 http://www.faqs.org/rfcs/rfc3164.html
  * @see watchdog()
  * @see watchdog_severity_levels()
  */

I think this should be removed, because this doc header isn't attached to any file or function or constant.

Actually, I misread this -- it is on EMERG. Duh.

No mention of the RFC anymore?

Agreed, we should have the reference to the RFC in there. This is also missing in Drupal 7.

So for Drupal 7, the issue is that all of these WATCHDOG_* need to have a reference put in to the RFC (see the patch above - the line that was removed).

Then for Drupal 6 we need a patch that is just like the above but leaving in or adding the reference to the RFC.

Should be a good project for a novice doc contributor.

subscribe

The updated patch is attached.

updated patch is attached

You have to set the status back to "needs review" to launch the test bot. :)

The patch isn't correct though. We are looking for a Drupal 7 patch that puts back in the line that said

Severity levels, as defined in RFC 3164 http://www.faqs.org/rfcs/rfc3164.html

It looks like each declaration is now commented properly, but the bit about the RFC is still missing.

I don't think this patch really fixes the D7 issue. All of the individual WATCHDOG_* constants need a reference to the RFC.

Each individual one?

Grammar fix.

Hmmm...

So think about where this will be displayed, a page like:
http://api.drupal.org/api/constant/WATCHDOG_ERROR/7

I don't think saying "These constant definitions..." makes sense in that context, because you are just documenting a single constant.

Come to think of it, the summary line is also not very good:

Log message severity -- Error: error conditions.

I don't think it should be plural, and it seems very awkward to me. Maybe we should make all of these something like this:

Watchdog log message severity constant indicating an error condition.

Thoughts?

Pick those nits, dawg.

The text describing the severities are just copy-and-pasted from the RFC. I think they're fine, and (as seen in #15 and #16) I tend to be picky about such things.

#18: 696696-watchdog-constants-4-D7.patch queued for re-testing.

I'm happy with the patch in #18. Thanks!

I think the test bot is broken. This is a doc-only patch and obviously didn't affect the database being dropped (whatever that means).

#18: 696696-watchdog-constants-4-D7.patch queued for re-testing.

Committed to CVS HEAD. Thanks!

Needs port to Drupal 6. It won't be the patch above exactly, but the resulting sections of doc should be the same.

D6 patch.

Looks good to me, thanks again!

Thanks, committed.

The D6 commit accidentally renamed the constant WATCHDOG_EMERG to WATCHDOG_EMERGENCY.

Follow-up patch to revert this.

Oops. Sorry about that.

Committed, thank you.