[Rt-commit] r19318 - rt/3.999/branches/config-in-db/lib/RT

sunnavy at bestpractical.com sunnavy at bestpractical.com
Tue Apr 21 08:23:52 EDT 2009


Author: sunnavy
Date: Tue Apr 21 08:23:52 2009
New Revision: 19318

Modified:
   rt/3.999/branches/config-in-db/lib/RT/Config.pm

Log:
updated RT::Config: replace set(...) with default:... pod

Modified: rt/3.999/branches/config-in-db/lib/RT/Config.pm
==============================================================================
--- rt/3.999/branches/config-in-db/lib/RT/Config.pm	(original)
+++ rt/3.999/branches/config-in-db/lib/RT/Config.pm	Tue Apr 21 08:23:52 2009
@@ -1,4 +1,5 @@
 package RT::Config;
+
 =head1 Base Configuration
 
 =over 4
@@ -12,9 +13,7 @@
 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
-
-set(rtname => "example.com");
+default: C<"example.com">
 
 
 =item C<email_subject_tag_regex>
@@ -27,20 +26,16 @@
 token matching and that you should use only "non-capturing" parenthesis
 grouping. For example:
 
-C<set(email_subject_tag_regex => qr/(?:example.com|example.org)/i );>
+C<qr/(?:example.com|example.org)/i>
 
 and NOT
 
-C<set(email_subject_tag_regex => qr/(example.com|example.org)/i );>
+C<qr/(example.com|example.org)/i>
 
 This setting would make RT behave exactly as it does without the 
 setting enabled.
 
-=cut
-
-set( email_subject_tag_regex => '{{rtname}}' );
-
-
+default: C<'{{rtname}}' >
 
 =item C<organization>
 
@@ -48,27 +43,21 @@
 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.
 
-=cut
-
-set(organization => "example.com");
+default: C<"example.com">
 
 =item C<minimum_password_length>
 
 C<minimum_password_length> defines the minimum length for user
 passwords. Setting it to 0 disables this check.
 
-=cut
-
-set(minimum_password_length => "5");
+default: C<"5">
 
 =item C<time_zone>
 
 C<time_zone> is used to convert times entered by users into GMT and back again
 It should be set to a time zone recognized by L<DateTime::TimeZone>.
 
-=cut
-
-set(time_zone => 'America/New_York');
+default: C<'America/New_York'>
 
 =back
 
@@ -86,9 +75,7 @@
 However, this option is beta. In some cases it result in performance
 improvements, but some setups can not handle it.
 
-=cut
-
-set(use_sql_for_acl_checks => undef);
+default: C<undef>
 
 =item C<full_text_search>
 
@@ -100,17 +87,12 @@
 for quick start. This script creates required structures in the DB and
 gives some ideas on next steps.
 
-=cut
-
-set( full_text_search =>
-    {
+default: C<< {
         enable  => 0,
         indexed => 0,
-
-        #    Table   => 'AttachmentsIndex',
-        #    Column  => 'ftsindex',
-    }
-);
+        #table   => 'AttachmentsIndex',
+        #column  => 'ftsindex',
+    } >>
 
 =back
 
@@ -124,18 +106,14 @@
 errors generated by the mail gateway to this address.  This address
 should _not_ be an address that's managed by your RT instance.
 
-=cut
-
-set(owner_email => 'root');
+default: C<'root'>
 
 =item C<loops_to_rt_owner>
 
 If C<loops_to_rt_owner> is defined, RT will send mail that it believes
 might be a loop to C<owner_email>
 
-=cut
-
-set(loops_to_rt_owner => 1);
+default: C<1>
 
 =item C<store_loops>
 
@@ -145,9 +123,7 @@
 As it does this, it will try to be careful not to send mail to the
 sender of these messages
 
-=cut
-
-set(store_loops => undef);
+default: C<undef>
 
 =item C<max_attachment_size>
 
@@ -158,28 +134,21 @@
 If you're running a postgres version earlier than 7.1, you will need
 to drop this to 8192. (8k)
 
-=cut
-
-
-set(max_attachment_size => 10000000);
+default: C<10000000>
 
 =item C<truncate_long_attachments>
 
 C<truncate_long_attachments>: if this is set to a non-'' value,
 RT will truncate attachments longer than C<max_attachment_size>.
 
-=cut
-
-set(truncate_long_attachments => undef);
+default: C<undef>
 
 =item C<drop_long_attachments>
 
 C<drop_long_attachments>: if this is set to a non-'' value,
 RT will silently drop attachments longer than C<MaxAttachmentSize>.
 
-=cut
-
-set(drop_long_attachments => undef);
+default: C<undef>
 
 =item C<parse_new_message_for_ticket_ccs>
 
@@ -189,18 +158,14 @@
 RT automatically and you enable this option without modifying
 C<rt_address_regexp> below, you will get yourself into a heap of trouble.
 
-=cut
-
-set(parse_new_message_for_ticket_ccs => undef);
+default: C<undef>
 
 =item C<rt_address_regexp> 
 
 C<rt_address_regexp> is used to make sure RT doesn't add itself as a ticket CC if
 the setting above is enabled.
 
-=cut
-
-set(rt_address_regexp => '^rt\@example.com$');
+default: C<'^rt\@example.com$'>
 
 =item C<canonicalize_email_match>, C<canonicalize_email_replace>
 
@@ -214,10 +179,8 @@
 By default, that routine performs a C<s/$match/$replace/gi> on any address
 passed to it.
 
-=cut
-
-set(canonicalize_email_match => 'a');
-set(canonicalize_email_replace => 'a');
+default: C<''>
+default: C<''>
 
 =item C<canonicalize_email_match>
 
@@ -225,9 +188,7 @@
 enter in the form but use the function CanonicalizeUserInfo in
 F<RT/User_Local.pm>
 
-=cut
-
-set(canonicalize_on_create => 0);
+default: C<0>
 
 =item C<sender_must_exist_in_external_database>
 
@@ -243,18 +204,14 @@
 If you define an AutoRejectRequest template, RT will use this
 template for the rejection message.
 
-=cut
-
-set(sender_must_exist_in_external_database => undef);
+default: C<undef>
 
 =item C<mail_plugins>
 
 C<mail_plugins> is a list of auth plugins for L<RT::Interface::Email>
 to use; see L<rt-mailgate>
 
-=cut
-
-set(mail_plugins => []);
+default: C<[]>
 
 
 =item C<unsafe_email_commands>
@@ -264,18 +221,14 @@
 is very unsafe, as it allows email with a forged sender to possibly
 resolve arbitrary tickets!
 
-=cut
-
 =item C<extract_subject_tag_match>, C<extract_subject_tag_no_match>
 
 The default "extract remote tracking tags" scrip settings; these
 detect when your RT is talking to another RT, and adjusts the
 subject accordingly.
 
-=cut
-
-set( extract_subject_tag_match => '\\[.+? #\\d+\\]' );
-#set( extract_subject_tag_no_match => "\[\Q{{rtname}}\\E #\\d+\\]/" );
+default: C<'\\[.+? #\\d+\\]' >
+#default: C<"\[\Q{{rtname}}\\E #\\d+\\]/" >
 
 =back
 
@@ -293,9 +246,7 @@
 Note that you should remove the '-t' from C<sendmail_arguments>
 if you use 'sendmail' rather than 'sendmailpipe'
 
-=cut
-
-set(mail_command => 'sendmailpipe');
+default: C<'sendmailpipe'>
 
 =back
 
@@ -313,11 +264,9 @@
 These options are good for most sendmail wrappers and workalikes
 
 These arguments are good for sendmail brand sendmail 8 and newer
-C<set(sendmail_arguments => "-oi -t -ODeliveryMode=b -OErrorMode=m");>
+C<default: C<"-oi -t -ODeliveryMode=b -OErrorMode=m">>
 
-=cut
-
-set(sendmail_arguments => "-oi -t");
+default: C<"-oi -t">
 
 
 =item C<sendmail_bounce_arguments>
@@ -325,18 +274,14 @@
 C<sendmail_bounce_arguments> defines what flags to pass to C<sendmail>
 assuming RT needs to send an error (ie. bounce).
 
-=cut
-
-set(sendmail_bounce_arguments => '-f "<>"');
+default: C<'-f "<>"'>
 
 =item C<sendmail_path>
 
 If you selected 'sendmailpipe' above, you MUST specify the path to
 your sendmail binary in C<sendmail_path>.
 
-=cut
-
-set(sendmail_path => "/usr/sbin/sendmail");
+default: C<"/usr/sbin/sendmail">
 
 
 =back
@@ -351,26 +296,20 @@
 
 C<smtp_server> should be set to the hostname of the SMTP server to use
 
-=cut
-
-set(smtp_server => undef);
+default: C<undef>
 
 =item C<smtp_from>
 
 C<smtp_from> should be set to the 'From' address to use, if not the
 email's 'From'
 
-=cut
-
-set(smtp_from => undef);
+default: C<undef>
 
 =item C<smtp_debug> 
 
 C<smtp_debug> should be set to true to debug SMTP mail sending
 
-=cut
-
-set(smtp_debug => 0);
+default: C<0>
 
 =back
 
@@ -383,9 +322,7 @@
 C<mail_params> defines a list of options passed to $mail_command if it
 is not 'sendmailpipe', 'sendmail', or 'smtp'
 
-=cut
-
-set(mail_params => []);
+default: C<[]>
 
 =item C<correspond_address>, C<comment_address>
 
@@ -397,20 +334,16 @@
 and comment mail tracked by RT, unless overridden by a queue-specific
 address.
 
-=cut
-
-set(correspond_address => '');
+default: C<''>
 
-set(comment_address => '');
+default: C<''>
 
 =item C<dashboard_address>
 
 The email address from which RT will send dashboards. If none is set, then
 C<owneremail> will be used.
 
-=cut
-
-set(dashboard_address => '');
+default: C<''>
 
 
 =item C<use_friendly_from_line>
@@ -418,18 +351,14 @@
 By default, RT sets the outgoing mail's "From:" header to
 "SenderName via RT".  Setting C<use_friendly_from_line> to 0 disables it.
 
-=cut
-
-set(use_friendly_from_line => 1);
+default: C<1>
 
 =item C<friendly_from_line_format>
 
 C<sprintf()> format of the friendly 'From:' header; its arguments
 are SenderName and SenderEmailAddress.
 
-=cut
-
-set(friendly_from_line_format => "\"%s via RT\" <%s>");
+default: C<"\"%s via RT\" <%s>">
 
 =item C<use_friendly_to_line>
 
@@ -440,18 +369,14 @@
 If you are using sendmail, rather than postfix, qmail, exim or some other MTA,
 you _must_ disable this option.
 
-=cut
-
-set(use_friendly_to_line => 0);
+default: C<0>
 
 =item C<friendly_to_line_format>
 
 C<sprintf()> format of the friendly 'From:' header; its arguments
 are WatcherType and TicketId.
 
-=cut
-
-set(friendly_to_line_format => "\"%s of {{rtname}} Ticket #%s\":;");
+default: C<"\"%s of {{rtname}} Ticket #%s\":;">
 
 =item C<notify_actor>
 
@@ -459,34 +384,29 @@
 already know what they've done. If you'd like to change this behaviour,
 Set C<notify_actor> to 1
 
-=cut
-
-set(notify_actor => 0);
+default: C<0>
 
 =item C<record_outgoing_email>
 
 By default, RT records each message it sends out to its own internal database.
 To change this behavior, set C<record_outgoing_email> to 0 
 
-=cut
-
-set(record_outgoing_email => 1);
+default: C<1>
 
 =item C<verp_prefix>, C<verp_prefix>
 
 VERP support (http://cr.yp.to/proto/verp.txt)
 
-uncomment the following two directives to generate envelope senders
+the following two directives means to generate envelope senders
 of the form C<${VERPPrefix}${originaladdress}@${VERPDomain}>
 (i.e. rt-jesse=fsck.com at rt.example.com ).
 
 This currently only works with sendmail and sendmailppie.
 
-=cut
-
-# set(verp_prefix => 'rt-');
-# set(verp_domain => $rt::organization);
+# verp_prefix => C<'rt-'>
+# verp_domain => C<$rt::organization>
 
+default: undef
 
 =item C<forward_from_user>
 
@@ -496,9 +416,7 @@
 To change this behavior, set C<forward_from_user> to true value and RT will use
 address of the current user and leave subject without RT's tag.
 
-=cut
-
-set(forward_from_user => 0);
+default: C<0>
 
 =item C<show_bcc_header>
 
@@ -507,9 +425,7 @@
 
 To change this set the following option to true value.
 
-=cut
-
-set(show_bcc_header => 0);
+default: C<0>
 
 =item C<dashboard_subject>
 
@@ -517,9 +433,7 @@
 Weekly, Monthly) of the dashboard and the dashboard's name. %1 for the name
 of the dashboard.
 
-=cut
-
-set(dashboard_subject => '%s Dashboard: %s');
+default: C<'%s Dashboard: %s'>
 
 =back
 
@@ -539,15 +453,11 @@
 If you want to allow people to encrypt attachments inside the DB then
 set C<allow_encrypt_data_in_db> to true
 
-=cut
-
-set( gnupg =>
-    {
+default: C<< {
         enable                   => 1,
         outgoing_messages_format => 'RFC',    # Inline
         allow_encrypt_data_in_db => 0,
-    }
-);
+    } >>
 
 =item C<gnupg_options>
 
@@ -558,10 +468,7 @@
 
 NOTE that options with '-' character MUST be quoted.
 
-=cut
-
-set( gnupg_options =>
-    {
+default: C<< {
         # homedir => '/home/jesse/svk/3.999-DANGEROUS/var/data/gpg',
 
         # URL of a keyserver
@@ -572,9 +479,7 @@
 
         # enables the automatic retrieving of keys when verifying signatures
         #    'auto-key-retrieve' => '',
-    }
-);
-
+    } >>
 
 =back
 
@@ -598,10 +503,7 @@
 From lowest to highest priority, the levels are:
  debug info notice warning error critical alert emergency
 
-=cut
-
-set(log_to_syslog => 'info');
-set(log_to_screen => 'info');
+default: C<'info'>
 
 =item C<log_to_file>, C<log_dir>, C<log_to_file_named>
 
@@ -614,11 +516,10 @@
 the direct API, Best Practical recommends using syslog instead of
 direct file logging.
 
-=cut
-
-set(log_to_file => undef);
-set(log_dir => '');
-set(log_to_file_named => "rt.log");    #log to rt.log
+default:
+log_to_file => C<undef>
+log_to_dir => C<''>
+log_to_file_named => C<"rt.log">
 
 =item C<log_to_syslog_conf>
 
@@ -628,9 +529,7 @@
 L<Log::Dispatch::Syslog> documentation for more information.)  (Maybe
 ident too, if you have multiple RT installations.)
 
-=cut
-
-set(log_to_syslog_conf => []);
+default: C<[]>
 
 =item C<statement_log>,
 
@@ -638,9 +537,7 @@
 DBIx-SearchBuilder 1.31_1 or higher; simply set C<statement_log> to be
 the level that you wish SQL statements to be logged at.
 
-=cut
-
-set(statement_log => undef);
+default: C<undef>
 
 =back
 
@@ -664,9 +561,7 @@
 easily and cleanly create your own stylesheets to apply to RT.  This
 option can be overridden by users in their preferences.
 
-=cut
-
-set(web_default_stylesheet => 'web2');
+default: C<'web2'>
 
 =item C<username_format>
 
@@ -675,10 +570,7 @@
 and whether the user is privileged or not. Verbose will show RealName and
 EmailAddress.
 
-=cut
-
-set(username_format => 'concise');
-
+default: C<'concise'>
 
 =item C<web_path>
 
@@ -690,37 +582,29 @@
 
 In most cases, you should leave C<web_path> set to '' (an empty value).
 
-=cut
-
-set(web_path => "");
+default: C<"">
 
 =item C<web_port>
 
 If we're running as a superuser, run on port 80
 Otherwise, pick a high port for this user.
 
-=cut
-
-set(web_port => 80);# + ($< * 7274) % 32766 + ($< && 1024));
+default: C<80>
 
 =item C<web_domain>
 
 you know what domain name is, right? ;)
 
-=cut
-
-set(web_domain => 'localhost' );
+default: C<'localhost' >
 
 =item C<web_base_url>, C<web_url>
 
 This is the Scheme, server and port for constructing urls to webrt
 C<web_base_url> doesn't need a trailing /
 
-=cut
+default: C<'http://{{web_domain}}:{{web_port}}'>
 
-set(web_base_url => 'http://{{web_domain}}:{{web_port}}');
-
-set(web_url => '{{web_base_url}}{{web_path}}/');
+default: C<'{{web_base_url}}{{web_path}}/'>
 
 =item C<web_images_url>
 
@@ -728,26 +612,19 @@
 Define the directory name to be used for images in rt web
 documents.
 
-=cut
-
-set(web_images_url => "{{web_path}}/NoAuth/images/");
+default: C<"{{web_path}}/NoAuth/images/">
 
 =item C<logo_url>
 
 C<logo_url> points to the URL of the RT logo displayed in the web UI
 
-=cut
-
-set(logo_url => "{{web_images_url}}bplogo.gif");
+default: C<"{{web_images_url}}bplogo.gif">
 
 =item C<web_no_auth_regex>
 
 What portion of RT's URLspace should not require authentication.
 
-=cut
-
-set(web_no_auth_regex => 
-      '(?x-ism:^ (?:\/+NoAuth\/ | \/+REST\/\d+\.\d+\/NoAuth\/) )' );
+default: C<'(?x-ism:^ (?:\/+NoAuth\/ | \/+REST\/\d+\.\d+\/NoAuth\/) )' >
 
 =item C<self_service_regex>
 
@@ -756,9 +633,7 @@
 F</SelfService/Display.html> when Unprivileged users attempt to access
 ticked displays
 
-=cut
-
-set(self_service_regex => '^(?:\/+SelfService\/)' );
+default: C<'^(?:\/+SelfService\/)' >
 
 =item C<message_box_width>, C<message_box_height>
 
@@ -771,42 +646,33 @@
 These settings only apply to the non-RichText message box.
 See below for Rich Text settings.
 
-=cut
-
-set(message_box_width => 72);
-set(message_box_height => 15);
+default:
+message_box_width => C<72>
+message_box_width => C<15>
 
 =item C<message_box_wrap>
 
 Default wrapping: "HARD"  (choices "SOFT", "HARD")
 
-=cut
-
-set(message_box_wrap => "HARD");
+default: C<"HARD">
 
 =item C<message_box_rich_text>
 
 Should "rich text" editing be enabled? This option lets your users send html email messages from the web interface.
 
-=cut
-
-set(message_box_rich_text => 1);
+default: C<1>
 
 =item C<message_box_rich_text_height>
 
 Height of RichText javascript enabled editing boxes (in pixels)
 
-=cut
-
-set(message_box_rich_text_height => 200);
+default: C<200>
 
 =item C<message_box_include_signature>
 
 Should your user's signatures (from their Preferences page) be included in comments and Replies
 
-=cut
-
-set(message_box_include_signature => 1);
+default: C<1>
 
 =item C<wiki_implicit_links>
 
@@ -815,9 +681,7 @@
 automatically become links to searches for those words.  If used on
 RTFM articles, it links to the RTFM article with that name.
 
-=cut
-
-set(wiki_implicit_links => 0);
+default: C<0>
 
 =item C<trust_html_attachments>
 
@@ -825,9 +689,7 @@
 as text. This prevents malicious HTML and javascript from being
 sent in a request (although there is probably more to it than that)
 
-=cut
-
-set(trust_html_attachments => undef);
+default: C<undef>
 
 =item C<redistribute_auto_generated_messages>
 
@@ -838,9 +700,7 @@
 only to privileged users. This helps to protect against malformed
 bounces and loops caused by autocreated requestors with bogus addresses.
 
-=cut
-
-set(redistribute_auto_generated_messages => 'privileged');
+default: C<'privileged'>
 
 =item C<prefer_rich_text>
 
@@ -849,45 +709,35 @@
 html to show only a minimal subset of HTML to avoid possible contamination
 by cross-site-scripting attacks.
 
-=cut
-
-set(prefer_rich_text => undef);
+default: C<undef>
 
 =item C<web_external_auth>
 
 If C<web_external_auth> is defined, RT will defer to the environment's
 REMOTE_USER variable.
 
-=cut
-
-set(web_external_auth => undef);
+default: C<undef>
 
 =item C<web_fallback_to_internal_auth>
 
 If C<web_fallback_to_internal_auth> is ''ined, the user is allowed a chance
 of fallback to the login screen, even if REMOTE_USER failed.
 
-=cut
-
-set(web_fallback_to_internal_auth => undef);
+default: C<undef>
 
 =item C<web_external_gecos>
 
 C<web_external_gecos> means to match 'gecos' field as the user identity);
 useful with mod_auth_pwcheck and IIS Integrated Windows logon.
 
-=cut
-
-set(web_external_gecos => undef);
+default: C<undef>
 
 =item C<web_external_auto>
 
 C<web_external_auto> will create users under the same name as REMOTE_USER
 upon login, if it's missing in the Users table.
 
-=cut
-
-set(web_external_auto => undef);
+default: C<undef>
 
 =item C<auto_create>
 
@@ -896,9 +746,7 @@
 Unprivileged users with C<{ privileged => 0 }>
 ( Must be a hashref of arguments )
 
-=cut
-
-set(auto_create => undef);
+default: C<undef>
 
 =item C<web_session_class>
 
@@ -907,9 +755,7 @@
 plans to use non-ascii Queue names, uncomment and add this line to
 F<RT_SiteConfig.pm> will prevent session corruption.
 
-=cut
-
-# set(web_session_class => 'Apache::Session::File');
+e.g. C<'Apache::Session::File'>
 
 =item C<auto_logoff>
 
@@ -918,9 +764,7 @@
 minutes. A user will be logged out if he or she doesn't send any requests 
 to RT for the defined time.
 
-=cut
-
-set(auto_logoff => 0);
+default: C<0>
 
 =item C<web_secure_cookies>
 
@@ -931,9 +775,7 @@
 NOTE: You probably don't want to turn this on _unless_ users are only connecting
 via SSL encrypted HTTP connections.
 
-=cut
-
-set(web_secure_cookies => 0);
+default: C<0>
 
 =item C<web_flush_db_cache_every_request>
 
@@ -944,9 +786,7 @@
 which will speed RT up a bit, at the expense of a tiny bit of data 
 accuracy.
 
-=cut
-
-set(web_flush_db_cache_every_request => '1');
+default: C<'1'>
 
 
 =item C<max_inline_body>
@@ -956,18 +796,14 @@
 is ''ined or 0.  This option can be overridden by users in their
 preferences.
 
-=cut
-
-set(max_inline_body => 12000);
+default: C<12000>
 
 =item C<default_summary_rows>
 
 C<default_summary_rows> is default number of rows displayed in for search
 results on the frontpage.
 
-=cut
-
-set(default_summary_rows => 10);
+default: C<10>
 
 =item C<oldest_transactions_first>
 
@@ -975,18 +811,14 @@
 history page, if you want see them at the top set this to '0'.  This
 option can be overridden by users in their preferences.
 
-=cut
-
-set(oldest_transactions_first => '1');
+default: C<'1'>
 
 =item C<show_transaction_images>
 
 By default, RT shows images attached to incoming (and outgoing) ticket updates
 inline. Set this variable to 0 if you'd like to disable that behaviour
 
-=cut
-
-set(show_transaction_images => 1);
+default: C<1>
 
 =item C<plain_text_pre>
 
@@ -996,9 +828,7 @@
 displayed using <pre> instead so such formatting works, but they'll
 use a monospaced font.
 
-=cut
-
-set(plain_text_pre => 0);
+default: C<0>
 
 
 =item C<show_unread_message_notifications>
@@ -1008,9 +838,7 @@
 
 Set C<show_unread_message_notifications> to a false value to disable this feature.
 
-=cut
-
-set(show_unread_message_notifications => 1);
+default: C<1>
 
 
 =item C<homepage_components>
@@ -1018,9 +846,7 @@
 C<homepage_components> is an arrayref of allowed components on a user's
 customized homepage ("RT at a glance").
 
-=cut
-
-set(homepage_components => [qw(QuickCreate QuickSearch MyAdminQueues MySupportQueues MyReminders RefreshHomepage Dashboards)]);
+default: C<[qw(QuickCreate QuickSearch MyAdminQueues MySupportQueues MyReminders RefreshHomepage Dashboards)]>
 
 
 =item C<mason_parameters>
@@ -1030,19 +856,15 @@
 for debugging, eg. profiling individual components with:
 
     use MasonX::Profiler; # available on CPAN
-    set(mason_parameters => [preamble => 'my $p = MasonX::Profiler->new($m, $r);']);
+    default: C<[preamble => 'my $p = MasonX::Profiler->new($m, $r);']>
 
-=cut
-
-set(mason_parameters => []);
+default: C<[]>
 
 =item C<default_search_result_format>
 
-C<default_search_result_format> is the default format for RT search results
-
-=cut
+default format for RT search results
 
-set(default_search_result_format => qq{
+default: C<< qq{
    '<B><A HREF="__WebPath__/Ticket/Display.html?id=__id__">__id__</a></B>/TITLE:#',
    '<B><A HREF="__WebPath__/Ticket/Display.html?id=__id__">__subject__</a></B>/TITLE:subject',
    status,
@@ -1055,7 +877,7 @@
    '<small>__created_relative__</small>',
    '<small>__told_relative__</small>',
    '<small>__last_updated_relative__</small>',
-   '<small>__time_left__</small>'});
+   '<small>__time_left__</small>'} >>
 
 
 =item C<suppress_inline_text_files>
@@ -1064,9 +886,7 @@
 text files (text-type attachments with file names) are prevented
 from being displayed in-line when viewing a ticket's history.
 
-=cut
-
-set(suppress_inline_text_files => undef);
+default: C<undef>
 
 =item C<dont_search_file_attachments>
 
@@ -1074,9 +894,7 @@
 files (attachments with file names) are not searched during full-content
 ticket searches.
 
-=cut
-
-set(dont_search_file_attachments => undef);
+default: C<undef>
 
 =item C<chart_font>
 
@@ -1085,9 +903,7 @@
 $chart_font to the absolute path of that font. Your GD library must have
 support for TrueType fonts to use this option.
 
-=cut
-
-set(chart_font => undef);
+default: C<undef>
 
 
 =item C<active_make_clicky>
@@ -1106,9 +922,7 @@
 
 See F<share/html/Elements/MakeClicky> for documentation on how to add your own.
 
-=cut
-
-set(active_make_clicky => []);
+default: C<[]>
 
 =item C<default_queue>
 
@@ -1116,9 +930,7 @@
 tickets. You may use either the queue's name or its ID. This only affects the
 queue selection boxes on the web interface.
 
-=cut
-
-set(default_queue => 'General');
+default: C<'General'>
 
 =back
 
@@ -1132,21 +944,18 @@
 handle requests. Having multiple servers means that serving a slow page will
 affect other users less.
 
-=cut
-
-set(standalone_min_servers => 1);
-set(standalone_max_servers => 1);
+default:
+standalone_min_servers => C<1>
+standalone_max_servers => C<1>
 
 =item C<standalone_min_spare_servers>, C<standalone_max_spare_servers>
 
 These next two options can be used to scale up and down the number of servers
 to adjust to load. These two options will respect the C<$standalone_min_servers
 > and C<$standalone_max_servers options>.
-
-=cut
-
-set(standalone_min_spare_servers => 0);
-set(standalone_max_spare_servers => 0);
+default:
+standalone_min_spare_servers => C<0>
+standalone_max_spare_servers => C<0>
 
 =item C<standalone_max_requests>
 
@@ -1154,9 +963,7 @@
 Setting this would be useful if, for example, memory usage slowly crawls up
 every hit.
 
-=cut
-
-#set(standalone_max_requests => 50);
+default: C<50>
 
 =item C<net_server_options>
 
@@ -1164,15 +971,12 @@
 L<Net::Server/DEFAULT ARGUMENTS>. For example, you could set
 reverse_lookups to get the hostnames for all users with:
 
-C<set(net_server_options => {reverse_lookups => 1});>
+C<{reverse_lookups => 1}>
 
-=cut
-
-set(net_server_options => []);
+default: C<[]>
 
 =back
 
-
 =head1 UTF-8 Configuration
 
 =over 4
@@ -1183,9 +987,7 @@
 interface.  Defaults to all *.po lexicons; setting it to C<qw(en ja)> will make
 RT bilingual instead of multilingual, but will save some memory.
 
-=cut
-
-set(lexicon_languages => [qw(*)]);
+default: C<[qw(*)]>
 
 =item C<email_input_encodings>
 
@@ -1193,17 +995,13 @@
 an attachment uses if not specified.  Must be recognized by
 L<Encode::Guess>.
 
-=cut
-
-set(email_input_encodings => [qw(utf-8 iso-8859-1 us-ascii)]);
+default: C<[qw(utf-8 iso-8859-1 us-ascii)]>
 
 =item C<email_output_encoding>
 
 The charset for localized email.  Must be recognized by Encode.
 
-=cut
-
-set(email_output_encoding => 'utf-8');
+default: C<'utf-8'>
 
 
 =back
@@ -1221,23 +1019,17 @@
 
 Some examples:
 
-C<set(date_time_format => '%a, %d %b %y %h:%m:%s %z');> # RFC2822
-C<set(date_time_format => '%y-%m-%d %h:%m:%s');> # ISO
-
-=cut
-
-set(date_time_format => '%Y-%m-%d %H:%M:%S');
+C<'%a, %d %b %y %h:%m:%s %z'>
+C<'%y-%m-%d %h:%m:%s'>
 
-# Next two options are for Time::ParseDate
+default: C<'%Y-%m-%d %H:%M:%S'>
 
 =item C<date_day_before_month>
 
 Set this to 1 if your local date convention looks like "dd/mm/yy"
 instead of "mm/dd/yy".
 
-=cut
-
-set(date_day_before_month => 1);
+default: C<1>
 
 =item C<ambiguous_day_in_past>, C<ambiguous_day_in_future>
 
@@ -1251,10 +1043,9 @@
 
 The default is usually good.
 
-=cut
-
-set(ambiguous_day_in_past => 0);
-set(ambiguous_day_in_future => 0);
+default:
+ambiguous_day_in_past => C<0>
+ambiguous_day_in_future => C<0>
 
 =back
 
@@ -1269,10 +1060,9 @@
 will break horribly. The statuses you add must be no longer than
 10 characters.
 
-=cut
-
-set(active_status => [qw(new open stalled)]);
-set(inactive_status => [qw(resolved rejected deleted)]);
+default:
+active_status => C<[qw(new open stalled)]>
+inactive_status =>  C<[qw(resolved rejected deleted)]>
 
 =item C<link_transactions_run1_scrip>
 
@@ -1280,9 +1070,7 @@
 transaction and run one scrip. Set this value to 1 if you want
 only one of the link transactions to have scrips run.
 
-=cut
-
-set(link_transactions_run1_scrip => 0);
+default: C<0>
 
 =item C<strict_link_acl>
 
@@ -1290,18 +1078,14 @@
 tickets to link them together, otherwise he can have rights on either of
 them.
 
-=cut
-
-set(strict_link_acl => 1);
+default: C<1>
 
 =item C<preview_scrip_messages>
 
 Set C<preview_scrip_messages> to 1 if the scrips preview on the ticket
 reply page should include the content of the messages to be sent.
 
-=cut
-
-set(preview_scrip_messages => 0);
+default: C<0>
 
 =item C<use_transaction_batch>
 
@@ -1310,9 +1094,7 @@
 simultaneously, instead of as two transactions, unaware of each
 others' existence.
 
-=cut
-
-set(use_transaction_batch => 1);
+default: C<1>
 
 =item C<custom_field_values_sources>
 
@@ -1320,9 +1102,7 @@
 L<RT::CustomFieldValues::External>.  This can be used to pull lists of
 custom field values from external sources at runtime.
 
-=cut
-
-set(custom_field_values_sources => []);
+default: C<[]>
 
 =item C<canonicalize_redirect_urls>
 
@@ -1332,16 +1112,13 @@
 If you use RT behind a reverse proxy, you almost certainly want to
 enable this option.
 
-=cut
+default: C<0>
 
-set(canonicalize_redirect_urls => 0);
 =item C<enable_reminders>
 
 Hide links/portlets related to Reminders by setting this to 0
 
-=cut
-
-set(enable_reminders => 1);
+default: C<1>
 
 =back
 


More information about the Rt-commit mailing list