Documentation for $g_allow_signup and $g_send_reset_password

dregad · dregad · commit babcb8bf0809 · 2012-08-14T18:51:31.000+02:00
Improves documentation and comments in config_defaults_inc.php, to
reflect the dependency between these 2 variables and the consequences of
having g_send_reset_password = OFF.

Fixes #6263
diff --git a/config_defaults_inc.php b/config_defaults_inc.php
@@ -292,8 +292,10 @@
  ****************************/
 
 /**
- * allow users to signup for their own accounts.
- * Mail settings must be correctly configured in order for this to work
+ * Allow users to signup for their own accounts.
+ * If ON, then $g_send_reset_password must be ON as well, and mail settings
+ * must be correctly configured
+ * @see $g_send_reset_password
  * @global int $g_allow_signup
  */
 $g_allow_signup			= ON;
@@ -315,9 +317,10 @@
 $g_notify_new_user_created_threshold_min = ADMINISTRATOR;
 
 /**
- * if ON users will be sent their password when reset.
- * if OFF the password will be set to blank. If set to ON, mail settings must be
- * correctly configured.
+ * If ON, users will be sent their password when their account is created
+ * or password reset (this requires mail settings to be correctly configured).
+ * If OFF, then the Administrator will have to provide a password when
+ * creating new accounts, and the password will be set to blank when reset.
  * @global int $g_send_reset_password
  */
 $g_send_reset_password	= ON;
diff --git a/docbook/Admin_Guide/en-US/Configuration.xml b/docbook/Admin_Guide/en-US/Configuration.xml
@@ -280,8 +280,12 @@
             <varlistentry>
                 <term>$g_allow_signup</term>
                 <listitem>
-                    <para>Allow users to signup for their own accounts. Default is ON.
-                    </para>
+					<para>Allow users to signup for their own accounts.
+					</para>
+					<para>If ON (default), then $g_send_reset_password must be ON
+						as well, and mail settings must be correctly configured
+						(see <xref linkend="admin.config.email" />).
+					</para>
                 </listitem>
             </varlistentry>
 
@@ -306,11 +310,14 @@
             <varlistentry>
                 <term>$g_send_reset_password</term>
                 <listitem>
-                    <para>When set to ON, MantisBT will email the users their new
-                        passwords when their accounts are reset. If set to OFF, the
-                        password will be reset to blank and no e-mail will be sent. Default
-                        is ON.
-                    </para>
+					<para>If ON (default), users will be sent their password when
+						their account is created or password reset (this requires
+						mail settings to be correctly configured).
+					</para>
+					<para>If OFF, then the Administrator will have to provide
+						a password when creating new accounts, and the password
+						will be set to blank when reset.
+					</para>
                 </listitem>
             </varlistentry>
 
@@ -596,11 +603,11 @@
                 <term>$g_email_send_using_cronjob</term>
                 <listitem>
                     <para>Disables sending of emails as soon as an action is performed.
-			Emails are instead queued and must be sent by running 
+			Emails are instead queued and must be sent by running
 			scripts/send_emails.php periodically. This script can only be
 			executed from the CLI, not from the web interface, for security
 			reasons.</para>
-		    <para>Enabling this option can help with performance problems if large 
+			<para>Enabling this option can help with performance problems if large
 			numbers of emails are generated or mail delivery is slow by not
 			delaying page execution when sending emails.</para>
                 </listitem>
diff --git a/docbook/Admin_Guide/en-US/User_Management.xml b/docbook/Admin_Guide/en-US/User_Management.xml
@@ -142,9 +142,13 @@
 	$g_default_new_account_access_level configuration option).  The signup
 	process can be enabled / disabled using the $g_allow_signup
 	configuration option, which is enabled by default.</para>
-
-        <para>If email notifications ($g_enable_email_notification) is
-        set to ON, users with access level about
+	<para>If user signup is enabled, then it is required that
+	$g_send_reset_password is ON as well, and the e-mail settings properly
+	configured
+	(see <xref linkend="admin.config.email" />).
+	</para>
+	<para>If email notifications ($g_enable_email_notification) is
+	set to ON, users with access level about
 	$g_notify_new_user_created_threshold_min will get a
 	notification that a user account has been created.  Information
 	about the user like user name, email address, IP address are included in
