From dc350b5463e7d64a46d7f90143c2d001be99e280 Mon Sep 17 00:00:00 2001
From: Brion Vibber <brion@pobox.com>
Date: Mon, 29 Nov 2010 14:15:25 -0800
Subject: Work in progress on nickname validation changes. lib/nickname.php
 appears to have been destroyed by NetBeans and will be rewritten shortly.
 Sigh.

---
 lib/common.php | 11 +++++++++++
 1 file changed, 11 insertions(+)

(limited to 'lib/common.php')

diff --git a/lib/common.php b/lib/common.php
index cd4fbfb15..d89180718 100644
--- a/lib/common.php
+++ b/lib/common.php
@@ -117,6 +117,17 @@ require_once 'markdown.php';
 
 // XXX: other formats here
 
+/**
+ * Avoid the NICKNAME_FMT constant; use the Nickname class instead.
+ *
+ * Nickname::DISPLAY_FMT is more suitable for inserting into regexes;
+ * note that it includes the [] and repeating bits, so should be wrapped
+ * directly in a capture paren usually.
+ *
+ * For validation, use Nickname::validate() etc.
+ *
+ * @deprecated
+ */
 define('NICKNAME_FMT', VALIDATE_NUM.VALIDATE_ALPHA_LOWER);
 
 require_once INSTALLDIR.'/lib/util.php';
-- 
cgit v1.2.3-54-g00ecf