Skip to content
Permalink

Comparing changes

Choose two branches to see what’s changed or to start a new pull request. If you need to, you can also or learn more about diff comparisons.

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also . Learn more about diff comparisons here.
base repository: mantisbt/mantisbt
Failed to load repositories. Confirm that selected base ref is valid, then try again.
Loading
base: 00dbc6140581
Choose a base ref
...
head repository: mantisbt/mantisbt
Failed to load repositories. Confirm that selected head ref is valid, then try again.
Loading
compare: 6890b5ac1ece
Choose a head ref
  • 2 commits
  • 7 files changed
  • 2 contributors

Commits on Aug 14, 2012

  1. Documentation for $g_allow_signup and $g_send_reset_password 

    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
    @dregad
    dregad committed Aug 14, 2012
    Copy the full SHA
    bbdad50 View commit details

  2. Documentation: Lots of minor spelling corrections 

    Backported from master 3081622
    @mgrdcm @dregad
    mgrdcm authored and dregad committed Aug 14, 2012
    Copy the full SHA
    6890b5a View commit details
13 changes: 8 additions & 5 deletions config_defaults_inc.php
View file
Original file line number Diff line number Diff line change
@@ -233,8 +233,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;
@@ -255,9 +257,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;
55 changes: 31 additions & 24 deletions docbook/administration_guide/en/configuration.sgml
View file
Original file line number Diff line number Diff line change
@@ -228,8 +228,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 <link linkend="admin.config.email">Email Configuration</link>).
</para>
</listitem>
</varlistentry>

@@ -254,11 +258,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>

@@ -361,7 +368,7 @@
<listitem>
<para>Associated with each action a list of flags to control who
should be notified.The default will be used if the action is not
included in $g_notify_flags orif the flag is not included in the
included in $g_notify_flags or if the flag is not included in the
specific action definition. The list of actions include: new,
assigned, resolved, bugnote, reopened, closed, deleted,
feedback.The default is:
@@ -504,7 +511,7 @@
<term>$g_smtp_host</term>
<listitem>
<para>This option specifies the SMTP server to submit messages to. The SMTP
server (MTA) then takes on the responsibility of deliverying such messages
server (MTA) then takes on the responsibility of delivering such messages
to their final destinations. To use the local SMTP (if available) set this
to 'localhost', otherwise use the fully qualified domain name of the remote
SMTP server. Default value is 'localhost'.
@@ -551,11 +558,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>
@@ -647,7 +654,7 @@
</para>
</listitem>
<listitem>
<para>the recipient has no email address extered</para>
<para>the recipient has no email address entered</para>
</listitem>
</itemizedlist>
</para>
@@ -881,7 +888,7 @@
<term>$g_show_realname</term>
<listitem>
<para>This control will replace the user's userid with their
realname. If it is set to ON, and the real name fiels has been
realname. If it is set to ON, and the real name field has been
populated, the replacement will occur. It defaults to OFF.
</para>
</listitem>
@@ -1324,10 +1331,10 @@
<varlistentry>
<term>$g_summary_category_include_project</term>
<listitem>
<para>Specifies whether category names should be preceeded by
<para>Specifies whether category names should be preceded by
project names (eg: [Project] Category) when the summary page is
viewed for all projects. This is useful in the case where category
names are common accross projects. The default is OFF.
names are common across projects. The default is OFF.
</para>
</listitem>
</varlistentry>
@@ -1423,12 +1430,12 @@
<section id="admin.config.uploads">
<title>File Upload</title>

<para>MantisBT allows users to upload file attachements and
associated them with bugs as well as projects. Bug attachments /
project documents can be uploaded to the webserver, database, or an
<para>MantisBT allows users to upload file attachments and
associate them with bugs as well as projects. Bug attachments /
project documents can be uploaded to the webserver, database or an
FTP server. When bugs are uploaded to the webserver they are
uploaded to the path that is configured in the project
properties.In case of problems getting the file upload feature to
properties. In case of problems getting the file upload feature to
work, check the following resources:
<ulink url="http://www.php.net/manual/en/features.file-upload.php">PHP
Manual
@@ -1448,7 +1455,7 @@
<varlistentry>
<term>$g_file_upload_method</term>
<listitem>
<para>Specify the location for uploading attachements. This can be
<para>Specify the location for uploading attachments. This can be
DISK, DATABASE, or FTP. In case of FTP, the files are saved on the
webserver (same as disk) as well as on the specified FTP server.
Default value is DATABASE.
@@ -1496,7 +1503,7 @@
<varlistentry>
<term>$g_file_upload_ftp_pass</term>
<listitem>
<para>Password to use when loggin in to the FTP server.</para>
<para>Password to use when logging in to the FTP server.</para>
</listitem>
</varlistentry>
<varlistentry>
@@ -1600,7 +1607,7 @@
<varlistentry>
<term>$g_bottom_include_page</term>
<listitem>
<para>If this page eixsts it will be displayed at the bottom of
<para>If this page exists it will be displayed at the bottom of
every page. It makes a good company branding include page.
</para>
</listitem>
@@ -2816,7 +2823,7 @@
<varlistentry>
<term>$$g_custom_field_edit_after_create</term>
<listitem>
<para>This flag determines whether to start editng a custom field
<para>This flag determines whether to start editing a custom field
immediately after creating it, or return to the definition list.
The default is ON (edit the custom field after creating).
</para>
@@ -3227,7 +3234,7 @@
<term>$g_time_tracking_stopwatch</term>
<listitem>
<para>
Instead of a text field turning this option on places a stopwatch on the page with <guibutton>Start/Stop</guibutton> and <guibutton>Reset</guibutton> buttons next to it. You must have $g_use_javascript switched on for this to take effect. A bit gimickie, but who cares.
Instead of a text field turning this option on places a stopwatch on the page with <guibutton>Start/Stop</guibutton> and <guibutton>Reset</guibutton> buttons next to it. You must have $g_use_javascript switched on for this to take effect. A bit gimmicky, but who cares.
</para>
</listitem>
</varlistentry>
10 changes: 5 additions & 5 deletions docbook/administration_guide/en/customizing_mantis.sgml
View file
Original file line number Diff line number Diff line change
@@ -431,7 +431,7 @@ function custom_function_override_enum_mine() {
</para>

<para>Notice "override" in the function name. This is because this method is
defined by the MantisBT adminstrator/webmaster and not part of the MantisBT source.
defined by the MantisBT administrator/webmaster and not part of the MantisBT source.
It is OK to override a method that doesn't exist.</para>

<para>As usual, when MantisBT is upgraded to future releases, the custom functions
@@ -806,21 +806,21 @@ $g_status_enum_workflow[CLOSED] ='20:feedback,50:assigned';

<para>custom_function_default_changelog_include_issue( $p_issue_id
) returns true or false if the issue if to be included in the
Changelogcustom_function_default_changelog_print_issue( $p_issue_id
Changelog. custom_function_default_changelog_print_issue( $p_issue_id
) returns a formatted string to be included for the issue in the
Changelogcustom_function_default_checkin( $p_issue_id, $p_comment,
Changelog. custom_function_default_issue_update_validate( $p_issue_id,
$p_file, $p_new_version ) registers a checkin in source control in
MantisBT custom_function_default_issue_update_validate( $p_issue_id,
$p_new_bug, $p_bug_note_text ) validate issue field settings before
an update occurs. It returns true or fails with an
error.custom_function_default_issue_update_notify( $p_issue_id )
notify after an issue has been
updatedcustom_function_default_issue_create_validate( $p_new_bug )
updated. custom_function_default_issue_create_validate( $p_new_bug )
validate issue field settings before an issue is created. It returns
true or fails with an
error.custom_function_default_issue_create_notify( $p_issue_id )
notify after an issue has been
openedcustom_function_default_issue_delete_validate( $p_issue_id )
opened. custom_function_default_issue_delete_validate( $p_issue_id )
validate issue field settings before an issue can be deleted. It
returns true or fails with an
error.custom_function_default_issue_delete_notify( $p_issue_id )
12 changes: 7 additions & 5 deletions docbook/administration_guide/en/page_descriptions.sgml
View file
Original file line number Diff line number Diff line change
@@ -13,7 +13,7 @@
remain at the login page. An error message will be displayed.The
administrator may allow users to sign up for their own accounts. If
so, a link to Signup for your own account will be available.The
administrator may also have annonymous login allowed. Annonymous
administrator may also have anonymous login allowed. Anonymous
users will be logged in under a common account.You will be allowed
to select a project to work in after logging in. You can make a
project your default selection from the Select Project screen or
@@ -82,7 +82,9 @@
filters. Each table row is color coded according to the issue
status. The colors can be customised through MantisBT
<link linkend="admin.config">Configuration</link>
.Severitiesblock

Severities
block
- prevents further work/progress from being made
crash - crashes the application or blocking,
major - major issue,
@@ -222,7 +224,7 @@

<title>Issue Edit page</title>

<para>The layout of this page resemples the Simple Issue View
<para>The layout of this page resembles the Simple Issue View
page, but here you can update various issue fields. The Reporter,
Category, Severity, and Reproducibility fields are editable but
shouldn't be unless there is a gross mis-categorization.Also
@@ -429,7 +431,7 @@
</para>
<para>
All fields are compared in length to be greater than or equal to
the minimum length, and less than or equal to the manimum length,
the minimum length, and less than or equal to the minimum length,
unless these values are 0. If the values are 0, the check is
skipped. All fields are also compared against the regular
expression. If the value matches the expression, then the value is
@@ -947,7 +949,7 @@
</para>
</listitem>
<listitem>
<para>the recipient has no email address extered</para>
<para>the recipient has no email address entered</para>
</listitem>
</itemizedlist>
The matrix on this page selects who will receive messages for each
9 changes: 4 additions & 5 deletions docbook/administration_guide/en/project_management.sgml
View file
Original file line number Diff line number Diff line change
@@ -54,7 +54,7 @@ function custom_function_override_changelog_print_issue( $p_issue_id, $p_issue_l

<para>By combining both customization features, it is also possible to do more advanced customization scenarios. For example, users can add a 'ChangelogSummary' custom field and include all issues that have such field in the change log. Through customizing what information being included for a qualifying issue, users can also include the 'ChangelogSummary' text rather than the native summary field.</para>

<para>In some cases, users know that they fixed an issue and that the fix will be included in the next release, however, they don't know yet the name of the release. In such case, the recommended approach is to always have a version defined that corresponds to the next release, which is typicalled called 'Next Release'. Once the release is cut and has a concrete name, then 'Next Release' can be renamed to the appropriate name and a new 'Next Release' can then be created. For teams that manage releases from multiple branches for the same project, then more than one next release can be possible. For example, 'Next Dev Release' and 'Next Stable Release'.</para>
<para>In some cases, users know that they fixed an issue and that the fix will be included in the next release, however, they don't know yet the name of the release. In such case, the recommended approach is to always have a version defined that corresponds to the next release, which is typically called 'Next Release'. Once the release is cut and has a concrete name, then 'Next Release' can be renamed to the appropriate name and a new 'Next Release' can then be created. For teams that manage releases from multiple branches for the same project, then more than one next release can be possible. For example, 'Next Dev Release' and 'Next Stable Release'.</para>

<para>Another common requirement is to be able to link to the change log of a specific project from the project's main website. There is a variety of ways to do that:
<itemizedlist>
@@ -80,7 +80,7 @@ function custom_function_override_changelog_print_issue( $p_issue_id, $p_issue_l
</para>
</listitem>
<listitem>
<para>To link to the changelog of version with id 1. The version id is unique accross all projects and hence in this case it is not necessary to include the project id/name. The version id can be figured out by going to the manage project page and editing the required version. The version_id will be included in the URL.
<para>To link to the changelog of version with id 1. The version id is unique across all projects and hence in this case it is not necessary to include the project id/name. The version id can be figured out by going to the manage project page and editing the required version. The version_id will be included in the URL.
<programlisting>
http://www.example.com/mantisbt/changelog_page.php?version_id=1
</programlisting>
@@ -157,7 +157,7 @@ function custom_function_override_roadmap_print_issue( $p_issue_id, $p_issue_lev
</para>

<para>
Some teams manage different branches for each of their projects (e.g. development and maintenance branches). As part of triaging the issue, they may decide that an issue should be targetted to multiple branches. Hence, frequently the request comes up to be able to target a single issue to multiple releases. The current MantisBT approach is that an issues represents an implementation or a fix for an issue on a specific branch. Since sometimes applying and verifying a fix to the two branches does not happen at the same time and in some cases the approach for fixing an issue is different based on the branch. Hence, the way to manage such scenario is to have the main issue for the initial fix and have related issues which capture the work relating to applying the fix to other branches. The issues for porting the fix can contain any discussions relating to progress, reflect the appropriate status and can go through the standard workflow process independent of the original issues.
Some teams manage different branches for each of their projects (e.g. development and maintenance branches). As part of triaging the issue, they may decide that an issue should be targeted to multiple branches. Hence, frequently the request comes up to be able to target a single issue to multiple releases. The current MantisBT approach is that an issues represents an implementation or a fix for an issue on a specific branch. Since sometimes applying and verifying a fix to the two branches does not happen at the same time and in some cases the approach for fixing an issue is different based on the branch. Hence, the way to manage such scenario is to have the main issue for the initial fix and have related issues which capture the work relating to applying the fix to other branches. The issues for porting the fix can contain any discussions relating to progress, reflect the appropriate status and can go through the standard workflow process independent of the original issues.
</para>

<para>Another common requirement is to be able to link to the roadmap of a specific project from the project's main website. There is a variety of ways to do that:
@@ -184,7 +184,7 @@ function custom_function_override_roadmap_print_issue( $p_issue_id, $p_issue_lev
</para>
</listitem>
<listitem>
<para>To link to the roadmap of version with id 1. The version id is unique accross all projects and hence in this case it is not necessary to include the project id/name. The version id can be figured out by going to the manage project page and editing the required version. The version_id will be included in the URL.
<para>To link to the roadmap of version with id 1. The version id is unique across all projects and hence in this case it is not necessary to include the project id/name. The version id can be figured out by going to the manage project page and editing the required version. The version_id will be included in the URL.
<programlisting>
http://www.example.com/mantisbt/roadmap_page.php?version_id=1
</programlisting>
@@ -215,7 +215,6 @@ http://www.example.com/mantisbt/project_page.php?project_id=1
To activate the Time Tracking feature you have to set the configuration option "time_tracking_enabled" to ON. To activating the Time Tracking you can :
<itemizedlist>
<listitem><para>

Static solution : change the variable '$g_time_tracking_enabled' in the configuration file 'config_defaults_inc.php', this will change the configuration for all the MantisBT instance ;
</para></listitem>
<listitem><para>
14 changes: 9 additions & 5 deletions docbook/administration_guide/en/user_management.sgml
View file
Original file line number Diff line number Diff line change
@@ -137,9 +137,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 <link linkend="admin.config.email">Email Configuration</link>).
</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
@@ -191,7 +195,7 @@

<para>The pruning function allows deleting of user accounts for accounts
that have been created more than a week ago, and they never logged in.
This is particulary useful for users who signed up with an invalid email
This is particularly useful for users who signed up with an invalid email
or with a typo in their email address address.</para>

<para>The account pruning can be done by administrators by going to
@@ -232,7 +236,7 @@
access levels. For example, a user may have REPORTER as the global
access level, but have a MANAGER access level to a specific project. Or
a user may have MANAGER as the global access level by VIEWER access to
a specific project. Access levels can be overriden for both public and
a specific project. Access levels can be overridden for both public and
private projects. However, overriding access level is not allowed for
users with global access ADMINISTRATOR.</para>

2 changes: 1 addition & 1 deletion docbook/administration_guide/en/workflow.sgml
View file
Original file line number Diff line number Diff line change
@@ -12,7 +12,7 @@
into MantisBT and reports a new issue.</para></listitem>
<listitem><para>SOAP API - Where an application automatically
reports an issue into MantisBT using the SOAP API web services
interfaces. For example, the nighlty build script can automatically
interfaces. For example, the nightly build script can automatically
report an issue if the build fails.</para></listitem>
<listitem><para>Email - This is not supported out of the box, but
there are existing MantisBT patches that would listen to emails on