[Rt-commit] rt branch, 4.0/config-copyedit, updated. rt-4.0.0rc5-18-g0c82509

Alex Vandiver alexmv at bestpractical.com
Tue Mar 1 13:22:15 EST 2011


The branch, 4.0/config-copyedit has been updated
       via  0c825098e41841d16eb7dd2919937c2199e5c0fd (commit)
       via  ec9a0b1b4bbbca9e014f627765390e328ded53d9 (commit)
       via  9d40756f4deb7d68de25feb10f2b0bb1b389bd6b (commit)
       via  d58f5b1a1214b72a69a68a2de58085c787f1ccef (commit)
       via  38ef215a36fa97e438433fc6efb2d75365a49dfe (commit)
      from  dd67b0ce712704525dad9687a61b4e941569b53b (commit)

Summary of changes:
 etc/RT_Config.pm.in |  400 +++++++++++++++++++++++++--------------------------
 lib/RT/Record.pm    |    3 +-
 lib/RT/Ticket.pm    |    7 -
 3 files changed, 200 insertions(+), 210 deletions(-)

- Log -----------------------------------------------------------------
commit 38ef215a36fa97e438433fc6efb2d75365a49dfe
Author: Alex Vandiver <alexmv at bestpractical.com>
Date:   Mon Feb 28 21:54:47 2011 -0500

    Whitespace cleanups

diff --git a/etc/RT_Config.pm.in b/etc/RT_Config.pm.in
index 7aeb081..7b80fcb 100755
--- a/etc/RT_Config.pm.in
+++ b/etc/RT_Config.pm.in
@@ -58,7 +58,7 @@ and NOT
 
 C<Set($EmailSubjectTagRegex, qr/(example.com|example.org)/i );>
 
-This setting would make RT behave exactly as it does without the 
+This setting would make RT behave exactly as it does without the
 setting enabled.
 
 =cut
@@ -700,7 +700,7 @@ Set(@EmailDashboardRemove, ());
 
 =head1 GnuPG Configuration
 
-A full description of the (somewhat extensive) GnuPG integration can be found 
+A full description of the (somewhat extensive) GnuPG integration can be found
 by running the command `perldoc L<RT::Crypt::GnuPG>`  (or `perldoc
         lib/RT/Crypt/GnuPG.pm` from your RT install directory).
 

commit d58f5b1a1214b72a69a68a2de58085c787f1ccef
Author: Alex Vandiver <alexmv at bestpractical.com>
Date:   Tue Mar 1 00:52:56 2011 -0500

    Remove configuration options which have been deprecated for more than 5 years

diff --git a/etc/RT_Config.pm.in b/etc/RT_Config.pm.in
index 7b80fcb..e617548 100755
--- a/etc/RT_Config.pm.in
+++ b/etc/RT_Config.pm.in
@@ -2318,26 +2318,6 @@ Set($RecordBaseClass, 'DBIx::SearchBuilder::Record::Cachable');
 
 =back
 
-=head1 Deprecated Options
-
-=over 4
-
-=item C<$AlwaysUseBase64>
-
-Encode blobs as base64 in DB (?)
-
-=item C<$TicketBaseURI>
-
-Base URI to tickets in this system; used when loading (?)
-
-=item C<$UseCodeTickets>
-
-This option is exists for backwards compatibility.  Don't use it.
-
-=back
-
-=cut
-
 =head1 Articles
 
 =item C<$ArticleOnTicketCreate>
diff --git a/lib/RT/Record.pm b/lib/RT/Record.pm
index 926bc21..52f9ab6 100644
--- a/lib/RT/Record.pm
+++ b/lib/RT/Record.pm
@@ -733,8 +733,7 @@ sub _EncodeLOB {
         #if the current attachment contains nulls and the
         #database doesn't support embedded nulls
 
-        if ( RT->Config->Get('AlwaysUseBase64') or
-             ( !$RT::Handle->BinarySafeBLOBs ) && ( $Body =~ /\x00/ ) ) {
+        if ( ( !$RT::Handle->BinarySafeBLOBs ) && ( $Body =~ /\x00/ ) ) {
 
             # set a flag telling us to mimencode the attachment
             $ContentEncoding = 'base64';
diff --git a/lib/RT/Ticket.pm b/lib/RT/Ticket.pm
index ccec951..3ad34cc 100644
--- a/lib/RT/Ticket.pm
+++ b/lib/RT/Ticket.pm
@@ -154,13 +154,6 @@ sub Load {
     # do the recursive load thing. be careful to cache all
     # the interim tickets we try so we don't loop forever.
 
-    # FIXME: there is no TicketBaseURI option in config
-    my $base_uri = RT->Config->Get('TicketBaseURI') || '';
-    #If it's a local URI, turn it into a ticket id
-    if ( $base_uri && $id =~ /^$base_uri(\d+)$/ ) {
-        $id = $1;
-    }
-
     unless ( $id =~ /^\d+$/ ) {
         $RT::Logger->debug("Tried to load a bogus ticket id: '$id'");
         return (undef);

commit 9d40756f4deb7d68de25feb10f2b0bb1b389bd6b
Author: Alex Vandiver <alexmv at bestpractical.com>
Date:   Tue Mar 1 01:04:06 2011 -0500

    More copyediting on the default configuration file

diff --git a/etc/RT_Config.pm.in b/etc/RT_Config.pm.in
index e617548..a9dce5b 100755
--- a/etc/RT_Config.pm.in
+++ b/etc/RT_Config.pm.in
@@ -34,8 +34,8 @@ C<$rtname> is the string that RT will look for in mail messages to
 figure out what ticket a new piece of mail belongs to.
 
 Your domain name is recommended, so as not to pollute the namespace.
-once you start using a given tag, you should probably never change it.
-(otherwise, mail for existing tickets won't get put in the right place)
+Once you start using a given tag, you should probably never change it;
+otherwise, mail for existing tickets won't get put in the right place.
 
 =cut
 
@@ -46,7 +46,7 @@ Set($rtname , "example.com");
 
 This regexp controls what subject tags RT recognizes as its own.
 If you're not dealing with historical C<$rtname> values, you'll likely
-never have to enable this feature.
+never have to change this configuration.
 
 Be VERY CAREFUL with it. Note that it overrides C<$rtname> for subject
 token matching and that you should use only "non-capturing" parenthesis
@@ -58,7 +58,7 @@ and NOT
 
 C<Set($EmailSubjectTagRegex, qr/(example.com|example.org)/i );>
 
-This setting would make RT behave exactly as it does without the
+The setting below would make RT behave exactly as it does without the
 setting enabled.
 
 =cut
@@ -70,8 +70,10 @@ setting enabled.
 =item C<$Organization>
 
 You should set this to your organization's DNS domain. For example,
-I<fsck.com> or I<asylum.arkham.ma.us>. It's used by the linking interface to
-guarantee that ticket URIs are unique and easy to construct.
+I<fsck.com> or I<asylum.arkham.ma.us>. It is used by the linking
+interface to guarantee that ticket URIs are unique and easy to
+construct.  Changing it after you have created tickets in the system
+will B<break> all existing ticket links!
 
 =cut
 
@@ -88,8 +90,10 @@ Set($MinimumPasswordLength , "5");
 
 =item C<$Timezone>
 
-C<$Timezone> is used to convert times entered by users into GMT and back again
-It should be set to a timezone recognized by your server.
+C<$Timezone> is the default timezone, used to convert times entered by
+users into GMT, as they are stored in the database, and back again;
+users can override this.  It should be set to a timezone recognized by
+your server.
 
 =cut
 
@@ -152,8 +156,8 @@ Set($DatabasePassword , '@DB_RT_PASS@');
 
 =item C<$DatabaseName>
 
-The name of the RT's database on your database server. For Oracle
-it's SID, DB objects are created in L<$DatabaseUser>'s schema.
+The name of the RT database on your database server. For Oracle, the
+SID and database objects are created in L<$DatabaseUser>'s schema.
 
 =cut
 
@@ -161,8 +165,9 @@ Set($DatabaseName , '@DB_DATABASE@');
 
 =item C<$DatabaseRequireSSL>
 
-If you're using Postgres and have compiled in SSL support,
-set C<$DatabaseRequireSSL> to 1 to turn on SSL communication.
+If you're using Postgres and have compiled in SSL support, set
+C<$DatabaseRequireSSL> to 1 to turn on SSL communication with the
+database.
 
 =cut
 
@@ -185,12 +190,12 @@ Set($UseSQLForACLChecks, undef);
 
 On the display page of a ticket from search results, RT provides links
 to the first, next, previous and last ticket from the results.  In
-order to build these links, TY needs to fetch the full result set from
+order to build these links, RT needs to fetch the full result set from
 the database, which can be resource-intensive.
 
 Set C<$TicketsItemMapSize> to number of tickets you want RT to examine
 to build these links. If the full result set is larger than this
-number, RT will omitthe "last" link in the menu.  Set this to zero to
+number, RT will omit the "last" link in the menu.  Set this to zero to
 always examine all results.
 
 =cut
@@ -258,7 +263,8 @@ Set($TruncateLongAttachments , undef);
 =item C<$DropLongAttachments>
 
 If this is set to a non-undef value, RT will silently drop attachments
-longer than C<MaxAttachmentSize>.
+longer than C<MaxAttachmentSize>.  C<$TruncateLongAttachments>, above,
+takes priority over this.
 
 =cut
 
@@ -286,11 +292,15 @@ all addresses used by your RT.  This lets RT avoid sending mail to
 itself.  It will also hide RT addresses from the list of "One-time Cc"
 and Bcc lists on ticket reply.
 
-If you have a number of addresses configured in your RT database already, you
-can generate a naive first pass regexp by using
+If you have a number of addresses configured in your RT database
+already, you can generate a naive first pass regexp by using:
 
     perl etc/upgrade/generate-rtaddressregexp
 
+If left blank, RT will generate a regexp for you, based on your
+comment and correspond address settings on your queues; this comes at
+a small cost in start-up speed.
+
 =cut
 
 Set($RTAddressRegexp , undef);
@@ -388,7 +398,7 @@ Set($MailCommand , 'sendmailpipe');
 
 =item C<$SetOutgoingMailFrom>
 
-C<$SetOutgoingMailFrom> tells RT to set the sender envelope with the correspond
+C<$SetOutgoingMailFrom> tells RT to set the sender envelope to the Correspond
 mail address of the ticket's queue.
 
 Warning: If you use this setting, bounced mails will appear to be incoming
@@ -405,10 +415,11 @@ address of the queue as it is handed to sendmail -f. This helps force
 the From_ header away from www-data or other email addresses that show
 up in the "Sent by" line in Outlook.
 
-The option is a hash reference of queue name to email address.
+The option is a hash reference of queue name to email address.  If
+there is no ticket involved, then the value of the C<Default> key will
+be used.
 
-If there is no ticket involved, then the value of the C<Default> key will be
-used.
+This option is irrelevant unless C<$SetOutgoingMailFrom> is set.
 
 =cut
 
@@ -431,7 +442,7 @@ by including an explicit Precedence header.
 
 If you set this value to C<undef> then we do not set a default
 Precedence header to outgoing mail. However, if there already is a
-Precedence header it will be preserved.
+Precedence header, it will be preserved.
 
 =cut
 
@@ -996,6 +1007,7 @@ Set($WebImagesURL, RT->Config->Get('WebPath') . "/NoAuth/images/");
 =item C<$LogoURL>
 
 C<$LogoURL> points to the URL of the RT logo displayed in the web UI.
+This can also be configured via the web UI.
 
 =cut
 
@@ -1038,10 +1050,9 @@ Set($LogoImageWidth, 181);
 
 =item C<$WebNoAuthRegex>
 
-What portion of RT's URL space should not require authentication.
-
-This is mostly for extension and doesn't mean RT will work without
-login if you change it.
+What portion of RT's URL space should not require authentication.  The
+default is almost certainly correct, and should only be changed if you
+are extending RT.
 
 =cut
 
@@ -1052,7 +1063,7 @@ Set($WebNoAuthRegex, qr{^ (?:/+NoAuth/ | /+REST/\d+\.\d+/NoAuth/) }x );
 What portion of RT's URLspace should be accessible to Unprivileged users
 This does not override the redirect from F</Ticket/Display.html> to
 F</SelfService/Display.html> when Unprivileged users attempt to access
-ticked displays
+ticked displays.
 
 =cut
 
@@ -1152,7 +1163,7 @@ Set($WikiImplicitLinks, 0);
 
 =item C<$TrustHTMLAttachments>
 
-if C<TrustHTMLAttachments> is not defined, we will display them
+If C<TrustHTMLAttachments> is not defined, we will display them
 as text. This prevents malicious HTML and JavaScript from being
 sent in a request (although there is probably more to it than that)
 
@@ -1279,7 +1290,7 @@ Set($AutoCreate, undef);
 C<$WebSessionClass> is the class you wish to use for managing Sessions.
 It defaults to use your SQL database, but if you are using MySQL 3.x and
 plans to use non-ascii Queue names, uncomment and add this line to
-F<RT_SiteConfig.pm> will prevent session corruption.
+F<RT_SiteConfig.pm> to prevent session corruption.
 
 =cut
 
@@ -1308,12 +1319,13 @@ Set($LogoutRefresh, 1);
 
 =item C<$WebSecureCookies>
 
-By default, RT's session cookie isn't marked as "secure" Some web browsers
-will treat secure cookies more carefully than non-secure ones, being careful
-not to write them to disk, only send them over an SSL secured connection
-and so on. To enable this behaviour, set C<$WebSecureCookies> to a true value.
-NOTE: You probably don't want to turn this on I<unless> users are only connecting
-via SSL encrypted HTTP connections.
+By default, RT's session cookie isn't marked as "secure" Some web
+browsers will treat secure cookies more carefully than non-secure
+ones, being careful not to write them to disk, only sendine them over
+an SSL secured connection, and so on. To enable this behaviour, set
+C<$WebSecureCookies> to a true value.  NOTE: You probably don't want
+to turn this on I<unless> users are only connecting via SSL encrypted
+HTTPS connections.
 
 =cut
 
@@ -1323,7 +1335,7 @@ Set($WebSecureCookies, 0);
 
 By default, RT clears its database cache after every page view.
 This ensures that you've always got the most current information
-when working in a multi-process (mod_perl or FastCGI) Environment
+when working in a multi-process (mod_perl or FastCGI) Environment.
 Setting C<$WebFlushDbCacheEveryRequest> to '0' will turn this off,
 which will speed RT up a bit, at the expense of a tiny bit of data
 accuracy.
@@ -1336,9 +1348,9 @@ Set($WebFlushDbCacheEveryRequest, '1');
 =item C<$MaxInlineBody>
 
 C<$MaxInlineBody> is the maximum attachment size that we want to see
-inline when viewing a transaction.  RT will inline any text if value
-is undefined or 0.  This option can be overridden by users in their
-preferences.
+inline when viewing a transaction.  RT will inline any text if the
+value is undefined or 0.  This option can be overridden by users in
+their preferences.
 
 =cut
 
@@ -1347,7 +1359,7 @@ Set($MaxInlineBody, 12000);
 =item C<$DefaultSummaryRows>
 
 C<$DefaultSummaryRows> is default number of rows displayed in for search
-results on the frontpage.
+results on the front page.
 
 =cut
 
@@ -1408,11 +1420,10 @@ Set($ShowTransactionImages, 1);
 
 =item C<$PlainTextPre>
 
-Normally plaintext attachments are displayed as HTML with line
-breaks preserved.  This causes space- and tab-based formatting not
-to be displayed correctly.  By setting $PlainTextPre they'll be
-displayed using <pre> instead so such formatting works, but they'll
-use a monospaced font, no matter what the value of C<$PlainTextMono> is.
+Normally plaintext attachments are displayed as HTML with line breaks
+preserved.  This causes space- and tab-based formatting not to be
+displayed correctly.  By setting $PlainTextPre messages will be
+displayed using <pre>; this option overrides C<$PlainTextMono>.
 
 =cut
 
@@ -1421,10 +1432,9 @@ Set($PlainTextPre, 0);
 
 =item C<$PlainTextMono>
 
-To display plaintext attachments,
 Set C<$PlainTextMono> to 1 to use monospaced font and preserve
-formatting, but unlike PlainTextPre, the text will wrap to fit into the
-UI.
+formatting; unlike C<$PlainTextPre>, the text will wrap to fit width
+of the browser window.
 
 =cut
 
@@ -1500,9 +1510,9 @@ Set($DefaultSelfServiceSearchResultFormat, qq{
 
 =item C<%AdminSearchResultFormat>
 
-In admin interface format strings similar to tickets search result
-formats are used. Use C<%AdminSearchResultFormat> to define format
-strings per RT class.
+In the admin interface, format strings similar to tickets result
+formats are used. Use C<%AdminSearchResultFormat> to define the format
+strings used in the admin interface on a per-RT-class basis.
 
 =cut
 
@@ -1628,11 +1638,12 @@ provides two formats:
   link after the URL.
 
 * 'httpurl_overwrite': also detects URLs as 'httpurl' format, but
-  replace URL with link and *adds spaces* into text if it's longer
-  then 30 chars. This allow browser to wrap long URLs and avoid
-  horizontal scrolling.
+  replaces the URL with a link and *adds spaces* into the text if it
+  is longer then 30 characters. This allows the browser to wrap long
+  URLs and avoid horizontal scrolling.
 
-See F<share/html/Elements/MakeClicky> for documentation on how to add your own.
+See F<share/html/Elements/MakeClicky> for documentation on how to add
+your own styles of link detection.
 
 =cut
 
@@ -1750,9 +1761,10 @@ Set(@LexiconLanguages, qw(*));
 =item C<@EmailInputEncodings>
 
 An array that contains default encodings used to guess which charset
-an attachment uses if not specified. Must be recognized by
-L<Encode::Guess>. First element can be '*' that enables encoding
-detection using L<Encode::Detect::Detector> if it's installed.
+an attachment uses, if it does not specify one explicitly.  All
+options must be recognized by L<Encode::Guess>.  The first element may
+also be '*', which enables encoding detection using
+L<Encode::Detect::Detector>, if installed.
 
 =cut
 
@@ -1775,9 +1787,10 @@ Set($EmailOutputEncoding, 'utf-8');
 
 =item C<$DateTimeFormat>
 
-You can choose date and time format.  See "Output formatters"
-section in perldoc F<lib/RT/Date.pm> for more options.  This option can
-be overridden by users in their preferences.
+You can choose date and time format.  See the "Output formatters"
+section in perldoc F<lib/RT/Date.pm> for more options.  This option
+can be overridden by users in their preferences.
+
 Some examples:
 
 C<Set($DateTimeFormat, 'LocalizedDateTime');>
@@ -1807,10 +1820,9 @@ past value? For example, should a date of "Tuesday" default to mean
 the date for next Tuesday or last Tuesday? Should the date "March 1"
 default to the date for next March or last March?
 
-Set $<AmbiguousDayInPast> for the last date, or $<$AmbiguousDayInFuture> for the
-next date.
-
-The default is usually good.
+Set C<$AmbiguousDayInPast> for the last date, or
+C<$AmbiguousDayInFuture> for the next date; the default is usually
+correct.
 
 =cut
 
@@ -2118,9 +2130,9 @@ Set($LinkTransactionsRun1Scrip, 0);
 
 =item C<$StrictLinkACL>
 
-When this feature is enabled a user needs I<ModifyTicket> rights on both
-tickets to link them together, otherwise he can have rights on either of
-them.
+When this feature is enabled a user needs I<ModifyTicket> rights on
+both tickets to link them together; otherwise, I<ModifyTicket> rights
+on either of them is sufficient.
 
 =cut
 
@@ -2169,9 +2181,10 @@ enable this option.
 =cut
 
 Set($CanonicalizeRedirectURLs, 0);
+
 =item C<$EnableReminders>
 
-Hide links/portlets related to Reminders by setting this to 0
+Hide all links and portlets related to Reminders by setting this to 0
 
 =cut
 
@@ -2182,6 +2195,7 @@ Set($EnableReminders,1);
 
 Set C<@Plugins> to a list of external RT plugins that should be enabled (those
 plugins have to be previously downloaded and installed).
+
 Example:
 
 C<Set(@Plugins, (qw(Extension::QuickDelete RT::Extension::CommandByMail)));>
@@ -2192,7 +2206,8 @@ Set(@Plugins, ());
 
 =item C<@JSFiles>
 
-a list of JavaScript files to be included in head
+A list of JavaScript files to be included in head.  Removing any of
+the default entries is not suggested.
 
 Example:
 
@@ -2220,12 +2235,11 @@ Set(@JSFiles, qw/
 
 =item C<$JSMinPath>
 
-Path to jsmin binary.
-You can go to http://www.crockford.com/javascript/jsmin.html to get one.
+Path to the jsmin binary, available from http://www.crockford.com/javascript/jsmin.html
 
-If specified, it'll be used to minify C<JSFiles>.
-If fails, RT will then try module L<JavaScript::Minifier>.
-If that still fails, RT will simply concatenate js files.
+If specified, it will be used to minify C<JSFiles>.  If it cannot be
+found, RT will fall back to the L<JavaScript::Minifier> module;
+failing that, RT will will simply concatenate the files.
 
 Example:
 
@@ -2235,7 +2249,7 @@ C<Set($JSMinPath, '/path/to/jsmin');>
 
 =item C<@CSSFiles>
 
-a list of css files to be included in head
+A list of additional CSS files to be included in head.
 
 Example:
 
@@ -2254,16 +2268,13 @@ Set(@CSSFiles, qw//);
 =item C<$ShowRTPortal>
 
 RT can show administrators a feed of recent RT releases and other
-related announcements and information from Best Practical on the
-top level Configuration page.
+related announcements and information from Best Practical on the top
+level Configuration page.  This feature helps you stay up to date on
+RT security announcements and version updates.
 
-This feature helps you stay up to date on RT security
-announcements and version updates.
-
-RT provides this feature using an "iframe" on
-C</Admin/index.html> which asks the administrator's
-browser to show an inline page from Best Practical's
-website.
+RT provides this feature using an "iframe" on C</Admin/index.html>
+which asks the administrator's browser to show an inline page from
+Best Practical's website.
 
 If you'd rather not make this feature available to
 your administrators, set C<$ShowRTPortal> to a false
@@ -2282,16 +2293,35 @@ Set($ShowRTPortal => 1);
 
 =item C<$DevelMode>
 
-RT comes with a "Development mode" setting.
-This setting, as a convenience for developers, turns on
-all sorts of development options that you most likely don't want in
-production:
+RT comes with a "Development mode" setting.  This setting, as a
+convenience for developers, turns on several of development options
+that you most likely don't want in production:
+
+=over 4
+
+=item *
+
+Uses L<Module::Refresh> to reload changed Perl modules on each
+request.
+
+=item *
+
+Turns off Mason's C<static_source> directive; this causes Mason to
+reload template files which have been modified on disk.
 
-* Turns off Mason's 'static_source' directive. By default, you can't
-  edit RT's web ui components on the fly and have RT magically pick up
-  your changes. (It's a big performance hit)
+=item *
 
-* More to come
+Turns on Mason's HTML C<error_format>; this renders compilation errors
+to the browser, along with a full stack trace.  It is possible for
+stack traces to reveal sensitive information such as passwords or
+ticket content.
+
+=item *
+
+Turns off caching of callbacks; this enables additional callbacks to
+be added while the server is running.
+
+=back
 
 =cut
 

commit ec9a0b1b4bbbca9e014f627765390e328ded53d9
Author: Alex Vandiver <alexmv at bestpractical.com>
Date:   Tue Mar 1 01:04:48 2011 -0500

    Remove explicit Default: lines; the defaults are in the file themself

diff --git a/etc/RT_Config.pm.in b/etc/RT_Config.pm.in
index a9dce5b..4056478 100755
--- a/etc/RT_Config.pm.in
+++ b/etc/RT_Config.pm.in
@@ -1075,8 +1075,6 @@ Should the ticket create and update forms use a more space efficient
 two column layout.  This layout may not work in narrow browsers if you
 set a MessageBoxWidth (below).
 
-Default: yes
-
 =cut
 
 Set($UseSideBySideLayout, 1);
@@ -1087,8 +1085,6 @@ For message boxes, set the entry box width, height and what type of
 wrapping to use.  These options can be overridden by users in their
 preferences.
 
-Default width: undef, height: 15
-
 When the width is set to undef, no column count is specified and the
 message box will take up 100% of the available width.  Combining this
 with HARD messagebox wrapping (below) is not recommended, as it will
@@ -1104,8 +1100,6 @@ Set($MessageBoxHeight, 15);
 
 =item C<$MessageBoxWrap>
 
-Default wrapping: "SOFT"  (choices "SOFT", "HARD")
-
 Wrapping is disabled when using MessageBoxRichText because
 of a bad interaction between IE and wrapping with the Rich
 Text Editor.
@@ -1709,8 +1703,6 @@ autocomplete unless you override their accessibility using a local overlay or a
 plugin.  Out of the box the following fields are public: Name, EmailAddress,
 RealName, NickName, and Organization.
 
-Default: C<< Set( $UserAutocompleteFields, { EmailAddress => 'STARTSWITH', Name => 'STARTSWITH', RealName => 'LIKE' })] ) >>
-
 =cut
 
 Set( $UserAutocompleteFields, {
@@ -1725,8 +1717,6 @@ Should unprivileged users be allowed to autocomplete users.  Setting this
 option to a true value means unprivileged users will be able to search all your
 users.
 
-Default: C<< Set( $AllowUserAutocompleteForUnprivileged, 0 ) >>
-
 =cut
 
 Set( $AllowUserAutocompleteForUnprivileged, 0 );
@@ -1736,8 +1726,6 @@ Set( $AllowUserAutocompleteForUnprivileged, 0 );
 Enable this to redirect to the created ticket display page automatically
 when using QuickCreate.
 
-Default: C<< Set( $DisplayTicketAfterQuickCreate, 0 ) >>
-
 =cut
 
 Set( $DisplayTicketAfterQuickCreate, 0 );

commit 0c825098e41841d16eb7dd2919937c2199e5c0fd
Author: Alex Vandiver <alexmv at bestpractical.com>
Date:   Tue Mar 1 01:22:14 2011 -0500

    Standardize Set(...) lines a bit

diff --git a/etc/RT_Config.pm.in b/etc/RT_Config.pm.in
index 4056478..20bf5b0 100755
--- a/etc/RT_Config.pm.in
+++ b/etc/RT_Config.pm.in
@@ -39,7 +39,7 @@ otherwise, mail for existing tickets won't get put in the right place.
 
 =cut
 
-Set($rtname , "example.com");
+Set($rtname, "example.com");
 
 
 =item C<$EmailSubjectTagRegex>
@@ -63,7 +63,7 @@ setting enabled.
 
 =cut
 
-#Set($EmailSubjectTagRegex, qr/\Q$rtname\E/i );
+# Set($EmailSubjectTagRegex, qr/\Q$rtname\E/i );
 
 
 
@@ -77,7 +77,7 @@ will B<break> all existing ticket links!
 
 =cut
 
-Set($Organization , "example.com");
+Set($Organization, "example.com");
 
 =item C<$MinimumPasswordLength>
 
@@ -86,7 +86,7 @@ passwords. Setting it to 0 disables this check.
 
 =cut
 
-Set($MinimumPasswordLength , "5");
+Set($MinimumPasswordLength, 5);
 
 =item C<$Timezone>
 
@@ -97,7 +97,7 @@ your server.
 
 =cut
 
-Set($Timezone , 'US/Eastern');
+Set($Timezone, "US/Eastern");
 
 =back
 
@@ -113,7 +113,7 @@ Valid types are "mysql", "Oracle" and "Pg"
 
 =cut
 
-Set($DatabaseType , '@DB_TYPE@');
+Set($DatabaseType, "@DB_TYPE@");
 
 =item C<$DatabaseHost>, C<$DatabaseRTHost>
 
@@ -125,8 +125,8 @@ for use in granting ACL rights on mysql.
 
 =cut
 
-Set($DatabaseHost   , '@DB_HOST@');
-Set($DatabaseRTHost , '@DB_RT_HOST@');
+Set($DatabaseHost,   "@DB_HOST@");
+Set($DatabaseRTHost, "@DB_RT_HOST@");
 
 =item C<$DatabasePort>
 
@@ -136,7 +136,7 @@ choose the correct default.
 
 =cut
 
-Set($DatabasePort , '@DB_PORT@');
+Set($DatabasePort, "@DB_PORT@");
 
 =item C<$DatabaseUser>
 
@@ -144,7 +144,7 @@ The name of the user to connect to the database as.
 
 =cut
 
-Set($DatabaseUser , '@DB_RT_USER@');
+Set($DatabaseUser, "@DB_RT_USER@");
 
 =item C<$DatabasePassword>
 
@@ -152,7 +152,7 @@ The password the C<$DatabaseUser> should use to access the database.
 
 =cut
 
-Set($DatabasePassword , '@DB_RT_PASS@');
+Set($DatabasePassword, q{@DB_RT_PASS@});
 
 =item C<$DatabaseName>
 
@@ -161,7 +161,7 @@ SID and database objects are created in L<$DatabaseUser>'s schema.
 
 =cut
 
-Set($DatabaseName , '@DB_DATABASE@');
+Set($DatabaseName, q{@DB_DATABASE@});
 
 =item C<$DatabaseRequireSSL>
 
@@ -171,7 +171,7 @@ database.
 
 =cut
 
-Set($DatabaseRequireSSL , undef);
+Set($DatabaseRequireSSL, undef);
 
 =item C<$UseSQLForACLChecks>
 
@@ -216,7 +216,7 @@ should I<not> be an address that's managed by your RT instance.
 
 =cut
 
-Set($OwnerEmail , 'root');
+Set($OwnerEmail, "root");
 
 =item C<$LoopsToRTOwner>
 
@@ -225,7 +225,7 @@ might be a loop to C<$OwnerEmail>.
 
 =cut
 
-Set($LoopsToRTOwner , 1);
+Set($LoopsToRTOwner, 1);
 
 =item C<$StoreLoops>
 
@@ -235,7 +235,7 @@ not to send mail to the sender of these messages.
 
 =cut
 
-Set($StoreLoops , undef);
+Set($StoreLoops, undef);
 
 =item C<$MaxAttachmentSize>
 
@@ -249,7 +249,7 @@ this to 8192. (8k)
 =cut
 
 
-Set($MaxAttachmentSize , 10000000);
+Set($MaxAttachmentSize, 10_000_000);
 
 =item C<$TruncateLongAttachments>
 
@@ -258,7 +258,7 @@ longer than C<$MaxAttachmentSize>.
 
 =cut
 
-Set($TruncateLongAttachments , undef);
+Set($TruncateLongAttachments, undef);
 
 =item C<$DropLongAttachments>
 
@@ -268,7 +268,7 @@ takes priority over this.
 
 =cut
 
-Set($DropLongAttachments , undef);
+Set($DropLongAttachments, undef);
 
 =item C<$ParseNewMessageForTicketCcs>
 
@@ -281,7 +281,7 @@ trouble.
 
 =cut
 
-Set($ParseNewMessageForTicketCcs , undef);
+Set($ParseNewMessageForTicketCcs, undef);
 
 =item C<$RTAddressRegexp>
 
@@ -303,7 +303,7 @@ a small cost in start-up speed.
 
 =cut
 
-Set($RTAddressRegexp , undef);
+Set($RTAddressRegexp, undef);
 
 =item C<$CanonicalizeEmailAddressMatch>, C<$CanonicalizeEmailAddressReplace>
 
@@ -319,8 +319,8 @@ passed to it.
 
 =cut
 
-#Set($CanonicalizeEmailAddressMatch , '@subdomain\.example\.com$');
-#Set($CanonicalizeEmailAddressReplace , '@example.com');
+# Set($CanonicalizeEmailAddressMatch, '@subdomain\.example\.com$');
+# Set($CanonicalizeEmailAddressReplace, '@example.com');
 
 =item C<$CanonicalizeOnCreate>
 
@@ -394,7 +394,7 @@ from it afterwards.
 
 =cut
 
-Set($MailCommand , 'sendmailpipe');
+Set($MailCommand, "sendmailpipe");
 
 =item C<$SetOutgoingMailFrom>
 
@@ -446,7 +446,7 @@ Precedence header, it will be preserved.
 
 =cut
 
-Set($DefaultMailPrecedence, 'bulk');
+Set($DefaultMailPrecedence, "bulk");
 
 =back
 
@@ -462,7 +462,7 @@ header to error mail.
 
 =cut
 
-Set($DefaultErrorMailPrecedence, 'bulk');
+Set($DefaultErrorMailPrecedence, "bulk");
 
 =back
 
@@ -496,7 +496,7 @@ C<Set($SendmailArguments,"-oi -t -ODeliveryMode=b -OErrorMode=m");>
 
 =cut
 
-Set($SendmailArguments , "-oi -t");
+Set($SendmailArguments, "-oi -t");
 
 
 =item C<$SendmailBounceArguments>
@@ -506,7 +506,7 @@ assuming RT needs to send an error (i.e. bounce).
 
 =cut
 
-Set($SendmailBounceArguments , '-f "<>"');
+Set($SendmailBounceArguments, '-f "<>"');
 
 =item C<$SendmailPath>
 
@@ -515,7 +515,7 @@ your sendmail binary in C<$SendmailPath>.
 
 =cut
 
-Set($SendmailPath , "/usr/sbin/sendmail");
+Set($SendmailPath, "/usr/sbin/sendmail");
 
 
 =back
@@ -578,9 +578,9 @@ address.
 
 =cut
 
-Set($CorrespondAddress , '');
+Set($CorrespondAddress, "");
 
-Set($CommentAddress , '');
+Set($CommentAddress, "");
 
 =item C<$DashboardAddress>
 
@@ -589,7 +589,7 @@ C<$OwnerEmail> will be used.
 
 =cut
 
-Set($DashboardAddress, '');
+Set($DashboardAddress, "");
 
 =item C<$UseFriendlyFromLine>
 
@@ -662,7 +662,7 @@ This currently only works with sendmail and sendmailpipe.
 
 =cut
 
-# Set($VERPPrefix, 'rt-');
+# Set($VERPPrefix, "rt-");
 # Set($VERPDomain, $RT::Organization);
 
 
@@ -696,7 +696,7 @@ Weekly, Monthly) of the dashboard and the dashboard's name.
 
 =cut
 
-Set($DashboardSubject, '%s Dashboard: %s');
+Set($DashboardSubject, "%s Dashboard: %s");
 
 =item C<@EmailDashboardRemove>
 
@@ -733,9 +733,9 @@ with incorrect GnuPG data.
 
 =cut
 
-Set( %GnuPG,
+Set(%GnuPG,
     Enable => @RT_GPG@,
-    OutgoingMessagesFormat => 'RFC', # Inline
+    OutgoingMessagesFormat => "RFC", # Inline
     AllowEncryptDataInDB   => 0,
 
     RejectOnMissingPrivateKey => 1,
@@ -754,7 +754,7 @@ NOTE that options with '-' character MUST be quoted.
 =cut
 
 Set(%GnuPGOptions,
-    homedir => '@RT_VAR_PATH@/data/gpg',
+    homedir => q{@RT_VAR_PATH@/data/gpg},
 
 # URL of a keyserver
 #    keyserver => 'hkp://subkeys.pgp.net',
@@ -791,8 +791,8 @@ From lowest to highest priority, the levels are:
 
 =cut
 
-Set($LogToSyslog    , 'info');
-Set($LogToScreen    , 'info');
+Set($LogToSyslog, "info");
+Set($LogToScreen, "info");
 
 =item C<$LogToFile>, C<$LogDir>, C<$LogToFileNamed>
 
@@ -807,9 +807,9 @@ direct file logging.
 
 =cut
 
-Set($LogToFile      , undef);
-Set($LogDir, '@RT_LOG_PATH@');
-Set($LogToFileNamed , "rt.log");    #log to rt.log
+Set($LogToFile, undef);
+Set($LogDir, q{@RT_LOG_PATH@});
+Set($LogToFileNamed, "rt.log");    #log to rt.log
 
 =item C<$LogStackTraces>
 
@@ -822,7 +822,7 @@ information such as passwords or ticket content in your logs.
 
 =cut
 
-Set($LogStackTraces, '');
+Set($LogStackTraces, "");
 
 =item C<@LogToSyslogConf>
 
@@ -869,7 +869,7 @@ option can be overridden by users in their preferences.
 
 =cut
 
-Set($WebDefaultStylesheet, 'aileron');
+Set($WebDefaultStylesheet, "aileron");
 
 =item C<$UsernameFormat>
 
@@ -880,7 +880,7 @@ EmailAddress.
 
 =cut
 
-Set($UsernameFormat, 'concise');
+Set($UsernameFormat, "concise");
 
 =item C<$ShowMoreAboutPrivilegedUsers>
 
@@ -899,7 +899,7 @@ This option can be controlled by users also.
 
 =cut
 
-Set($MoreAboutRequestorTicketList, 'Active');
+Set($MoreAboutRequestorTicketList, "Active");
 
 =item C<$MoreAboutRequestorExtraInfo>
 
@@ -910,7 +910,7 @@ not all the attributes are supported in this display because we're not building
 
 =cut
 
-Set($MoreAboutRequestorExtraInfo, '');
+Set($MoreAboutRequestorExtraInfo, "");
 
 =item C<$MoreAboutRequestorGroupsLimit>
 
@@ -934,7 +934,7 @@ huge owner list for installations where many users have the OwnTicket right.
 
 =cut
 
-Set( $AutocompleteOwners, 0 );
+Set($AutocompleteOwners, 0);
 
 =item C<$WebDomain>
 
@@ -943,7 +943,7 @@ anything else, but server name.
 
 =cut
 
-Set( $WebDomain, 'localhost' );
+Set($WebDomain, "localhost");
 
 =item C<$WebPort>
 
@@ -1207,7 +1207,7 @@ bounces and loops caused by auto-created requestors with bogus addresses.
 
 =cut
 
-Set($RedistributeAutoGeneratedMessages, 'privileged');
+Set($RedistributeAutoGeneratedMessages, "privileged");
 
 =item C<$PreferRichText>
 
@@ -1248,7 +1248,7 @@ of fallback to the login screen, even if REMOTE_USER failed.
 
 =cut
 
-Set($WebFallbackToInternalAuth , undef);
+Set($WebFallbackToInternalAuth, undef);
 
 =item C<$WebExternalGecos>
 
@@ -1257,7 +1257,7 @@ useful with mod_auth_pwcheck and IIS Integrated Windows logon.
 
 =cut
 
-Set($WebExternalGecos , undef);
+Set($WebExternalGecos, undef);
 
 =item C<$WebExternalAuto>
 
@@ -1266,7 +1266,7 @@ upon login, if it's missing in the Users table.
 
 =cut
 
-Set($WebExternalAuto , undef);
+Set($WebExternalAuto, undef);
 
 =item C<$AutoCreate>
 
@@ -1288,7 +1288,7 @@ F<RT_SiteConfig.pm> to prevent session corruption.
 
 =cut
 
-# Set($WebSessionClass , 'Apache::Session::File');
+# Set($WebSessionClass, "Apache::Session::File");
 
 =item C<$AutoLogoff>
 
@@ -1336,7 +1336,7 @@ accuracy.
 
 =cut
 
-Set($WebFlushDbCacheEveryRequest, '1');
+Set($WebFlushDbCacheEveryRequest, 1);
 
 
 =item C<$MaxInlineBody>
@@ -1391,7 +1391,7 @@ option can be overridden by users in their preferences.
 
 =cut
 
-Set($OldestTransactionsFirst, '1');
+Set($OldestTransactionsFirst, 1);
 
 =item C<$DeferTransactionLoading>
 
@@ -1401,7 +1401,7 @@ all the HTML for transaction history can be slow for long tickets.
 
 =cut
 
-#Set($DeferTransactionLoading, '1');
+# Set($DeferTransactionLoading, 1);
 
 =item C<$ShowTransactionImages>
 
@@ -1620,7 +1620,7 @@ At this time, this feature only applies to MySQL and PostgreSQL.
 
 =cut
 
-Set( $ChartsTimezonesInDB, 0 );
+Set($ChartsTimezonesInDB, 0);
 
 =item C<@Active_MakeClicky>
 
@@ -1651,7 +1651,7 @@ queue selection boxes on the web interface.
 
 =cut
 
-#Set($DefaultQueue, 'General');
+# Set($DefaultQueue, "General");
 
 =item C<$RememberDefaultQueue>
 
@@ -1660,7 +1660,7 @@ for the new ticket dropdown.
 
 =cut
 
-#Set($RememberDefaultQueue, 1);
+# Set($RememberDefaultQueue, 1);
 
 =item C<$DefaultTimeUnitsToHours>
 
@@ -1705,7 +1705,7 @@ RealName, NickName, and Organization.
 
 =cut
 
-Set( $UserAutocompleteFields, {
+Set($UserAutocompleteFields, {
     EmailAddress => 'STARTSWITH',
     Name         => 'STARTSWITH',
     RealName     => 'LIKE',
@@ -1719,7 +1719,7 @@ users.
 
 =cut
 
-Set( $AllowUserAutocompleteForUnprivileged, 0 );
+Set($AllowUserAutocompleteForUnprivileged, 0);
 
 =item C<$DisplayTicketAfterQuickCreate>
 
@@ -1728,7 +1728,7 @@ when using QuickCreate.
 
 =cut
 
-Set( $DisplayTicketAfterQuickCreate, 0 );
+Set($DisplayTicketAfterQuickCreate, 0);
 
 =back
 
@@ -1764,7 +1764,7 @@ The charset for localized email.  Must be recognized by Encode.
 
 =cut
 
-Set($EmailOutputEncoding, 'utf-8');
+Set($EmailOutputEncoding, "utf-8");
 
 
 =back
@@ -1781,14 +1781,14 @@ can be overridden by users in their preferences.
 
 Some examples:
 
-C<Set($DateTimeFormat, 'LocalizedDateTime');>
-C<Set($DateTimeFormat, { Format => 'ISO', Seconds => 0 });>
-C<Set($DateTimeFormat, 'RFC2822');>
-C<Set($DateTimeFormat, { Format => 'RFC2822', Seconds => 0, DayOfWeek => 0 });>
+C<Set($DateTimeFormat, "LocalizedDateTime");>
+C<Set($DateTimeFormat, { Format => "ISO", Seconds => 0 });>
+C<Set($DateTimeFormat, "RFC2822");>
+C<Set($DateTimeFormat, { Format => "RFC2822", Seconds => 0, DayOfWeek => 0 });>
 
 =cut
 
-Set($DateTimeFormat, 'DefaultFormat');
+Set($DateTimeFormat, "DefaultFormat");
 
 # Next two options are for Time::ParseDate
 
@@ -1799,7 +1799,7 @@ Set this to 1 if your local date convention looks like "dd/mm/yy" instead of
 
 =cut
 
-Set($DateDayBeforeMonth , 1);
+Set($DateDayBeforeMonth, 1);
 
 =item C<$AmbiguousDayInPast>, C<$AmbiguousDayInFuture>
 
@@ -2176,7 +2176,7 @@ Hide all links and portlets related to Reminders by setting this to 0
 
 =cut
 
-Set($EnableReminders,1);
+Set($EnableReminders, 1);
 
 
 =item C<@Plugins>
@@ -2231,7 +2231,7 @@ failing that, RT will will simply concatenate the files.
 
 Example:
 
-C<Set($JSMinPath, '/path/to/jsmin');>
+C<Set($JSMinPath, "/path/to/jsmin");>
 
 =cut
 
@@ -2272,7 +2272,7 @@ value.
 
 =cut
 
-Set($ShowRTPortal => 1);
+Set($ShowRTPortal, 1);
 
 
 =head1 Development Configuration
@@ -2313,7 +2313,7 @@ be added while the server is running.
 
 =cut
 
-Set($DevelMode, '@RT_DEVEL_MODE@');
+Set($DevelMode, "@RT_DEVEL_MODE@");
 
 
 =item C<$RecordBaseClass>
@@ -2332,7 +2332,7 @@ Valid values are:
 
 =cut
 
-Set($RecordBaseClass, 'DBIx::SearchBuilder::Record::Cachable');
+Set($RecordBaseClass, "DBIx::SearchBuilder::Record::Cachable");
 
 =back
 

-----------------------------------------------------------------------


More information about the Rt-commit mailing list