[Rt-commit] rt branch, 4.2/devel-docs, created. rt-4.2.10-136-g3751ead
Alex Vandiver
alexmv at bestpractical.com
Thu Mar 5 18:03:15 EST 2015
The branch, 4.2/devel-docs has been created
at 3751ead1e080611ddc826a36cadef3311c813090 (commit)
- Log -----------------------------------------------------------------
commit 9b6fb803599bae81798dd3f1a200b1a49728b980
Author: Alex Vandiver <alexmv at bestpractical.com>
Date: Thu Mar 5 17:51:26 2015 -0500
Break out developer-targeted upgrade documentation from admin documentation
diff --git a/devel/docs/UPGRADING-4.0 b/devel/docs/UPGRADING-4.0
new file mode 100644
index 0000000..18ed8a6
--- /dev/null
+++ b/devel/docs/UPGRADING-4.0
@@ -0,0 +1,24 @@
+=head1 UPGRADING FROM BEFORE 4.0.0
+
+This documentation notes internals changes between the 3.8 and 4.0
+series that are primarily of interest to developers writing extensions
+or local customizations. It is not an exhaustive list.
+
+=over
+
+=item *
+
+The deprecated classes RT::Action::Generic, RT::Condition::Generic and
+RT::Search::Generic have been removed, but you shouldn't have been using them
+anyway. You should have been using RT::Action, RT::Condition and RT::Search,
+respectively.
+
+=item *
+
+The menu system has been reworked significantly; the C<Privileged> and
+C<Unprivileged> callbacks in C<Elements/Tabs>, along with
+L<RT::Interface::Web::Menu>, comprise the new menuing hooks.
+
+=back
+
+=cut
diff --git a/devel/docs/UPGRADING-4.2 b/devel/docs/UPGRADING-4.2
new file mode 100644
index 0000000..d74c879
--- /dev/null
+++ b/devel/docs/UPGRADING-4.2
@@ -0,0 +1,46 @@
+=head1 UPGRADING FROM RT 4.0.0 and greater
+
+This documentation notes internals changes between the 4.0 and 4.2
+series that are primarily of interest to developers writing extensions
+or local customizations. It is not an exhaustive list.
+
+=over
+
+=item *
+
+The link direction and type maps are consolidated into RT::Link. If you
+wrote local customizations or extensions utilizing C<%RT::Ticket::LINKDIRMAP>,
+C<%RT::Ticket::LINKTYPEMAP>, C<RT::Ticket-E<gt>LINKDIRMAP>,
+C<RT::Ticket-E<gt>LINKTYPEMAP>, or C<%RT::Record::LINKDIRMAP>, you will need to
+switch to C<%RT::Link::DIRMAP> and C<%RT::Link::TYPEMAP>.
+
+=item *
+
+MakeClicky handlers added via a callback are now passed an "object" key in
+the parameter hash instead of "ticket". The object may be any L<RT::Record>
+subclass.
+
+=item *
+
+C<ShowUser> handlers (C</Elements/ShowUser*>) have moved out of Mason components
+and into C<RT::User> methods. Any custom username formats will need to be
+reimplemented as C<RT::User> methods. Renaming should follow that of the core
+components:
+
+ /Elements/ShowUserConcise => RT::User->_FormatUserConcise
+ /Elements/ShowUserVerbose => RT::User->_FormatUserVerbose
+
+The C<_FormatUser*> methods are passed a hash containing the keys C<User> and
+C<Address>, which have the same properties as before.
+
+=item *
+
+CSS is no longer processed through Mason; it's served by a proper static file
+handler. If you used the C<Begin> or C<End> callbacks of C<main.css> in the
+aileron, web2, or ballard themes, you should transition to the
+L<RT_Config/@CSSFiles> config option. If you need to target specific themes,
+you can use the class set on the E<lt>C<body>E<gt> element (for example:
+body.aileron). See F<docs/customizing/styling_rt.pod> for more information
+on custom styles.
+
+=back
diff --git a/docs/UPGRADING-4.0 b/docs/UPGRADING-4.0
index fd0d738..0a3249c 100644
--- a/docs/UPGRADING-4.0
+++ b/docs/UPGRADING-4.0
@@ -1,5 +1,8 @@
=head1 UPGRADING FROM BEFORE 4.0.0
+See F<devel/docs/UPGRADING-4.0> for internals changes relevant to
+extension writers. The following is tailored to RT administrators:
+
=head2 Common issues
RT now defaults to a database name of rt4 and an installation root of
@@ -85,14 +88,6 @@ to RT4.
You must also remove RT::FM from your @Plugins line in RT_SiteConfig.pm.
-
-=head2 Removals and updates
-
-The deprecated classes RT::Action::Generic, RT::Condition::Generic and
-RT::Search::Generic have been removed, but you shouldn't have been using them
-anyway. You should have been using RT::Action, RT::Condition and RT::Search,
-respectively.
-
=over
=item *
diff --git a/docs/UPGRADING-4.2 b/docs/UPGRADING-4.2
index 07a6004..6869f99 100644
--- a/docs/UPGRADING-4.2
+++ b/docs/UPGRADING-4.2
@@ -4,9 +4,12 @@ The 4.2 release is a major upgrade and as such there are more changes
than in a minor bugfix release (e.g., 4.0.13 to 4.0.14) and some of these
changes are backward-incompatible. The following lists some of the notable
changes, especially those that might require you to change a configuration
-option or other setting due to a change in RT. Read this section carefully
+option or other setting due to a change in RT. Read this section carefully
before you upgrade and look for changes to features you currently use.
+See F<devel/docs/UPGRADING-4.0> for internals changes relevant to
+extension writers.
+
=over
=item *
@@ -27,14 +30,6 @@ you about the rename. To avoid this you should set C<$LogToSTDERR> instead.
=item *
-The link direction and type maps are consolidated into RT::Link. If you
-wrote local customizations or extensions utilizing C<%RT::Ticket::LINKDIRMAP>,
-C<%RT::Ticket::LINKTYPEMAP>, C<RT::Ticket-E<gt>LINKDIRMAP>,
-C<RT::Ticket-E<gt>LINKTYPEMAP>, or C<%RT::Record::LINKDIRMAP>, you will need to
-switch to C<%RT::Link::DIRMAP> and C<%RT::Link::TYPEMAP>.
-
-=item *
-
C<$LinkTransactionsRun1Scrip> is removed. If you were relying on this behavior
(by setting it to 1), you should adjust your scrips to ignore one of the link
transactions.
@@ -47,30 +42,11 @@ implemented and controlled display in the attachments list but not history.
=item *
-MakeClicky handlers added via a callback are now passed an "object" key in
-the parameter hash instead of "ticket". The object may be any L<RT::Record>
-subclass.
-
-=item *
-
C<$MessageBoxWrap> was removed. Wrapping is now always C<SOFT>. If you want hard
line breaks, enter them manually.
=item *
-C<ShowUser> handlers (C</Elements/ShowUser*>) have moved out of Mason components
-and into C<RT::User> methods. Any custom username formats will need to be
-reimplemented as C<RT::User> methods. Renaming should follow that of the core
-components:
-
- /Elements/ShowUserConcise => RT::User->_FormatUserConcise
- /Elements/ShowUserVerbose => RT::User->_FormatUserVerbose
-
-The C<_FormatUser*> methods are passed a hash containing the keys C<User> and
-C<Address>, which have the same properties as before.
-
-=item *
-
Rich text (HTML) messages are now preferred for display. If you prefer plain
text messages, set L<RT_Config/$PreferRichText> to 0.
@@ -148,16 +124,6 @@ Lifecycles.
=item *
-CSS is no longer processed through Mason; it's served by a proper static file
-handler. If you used the C<Begin> or C<End> callbacks of C<main.css> in the
-aileron, web2, or ballard themes, you should transition to the
-L<RT_Config/@CSSFiles> config option. If you need to target specific themes,
-you can use the class set on the E<lt>C<body>E<gt> element (for example:
-body.aileron). See F<docs/customizing/styling_rt.pod> for more information
-on custom styles.
-
-=item *
-
There are now HTML versions of the standard plain text templates. Running
make upgrade as described in the F<README> will insert the new templates into
existing installs. While new installs use the HTML templates by default,
diff --git a/t/99-policy.t b/t/99-policy.t
index b08ab96..f0cf5d0 100644
--- a/t/99-policy.t
+++ b/t/99-policy.t
@@ -11,7 +11,7 @@ find( { wanted => sub {
$File::Find::prune = 1 if $_ eq "t/tmp" or m{/\.git$};
},
no_chdir => 1 },
- qw{etc lib share t bin sbin devel/tools docs} );
+ qw{etc lib share t bin sbin devel/tools docs devel/docs} );
if ( my $dir = `git rev-parse --git-dir 2>/dev/null` ) {
# We're in a git repo, use the ignore list
@@ -145,6 +145,6 @@ check( $_, compile_perl => 1, exec => 1 )
for grep{ -f $_} map {s/\.in$//; $_} grep {m{^etc/upgrade/[^/]+$}} @files;
check( $_, exec => -1 )
- for grep {m{^docs/}} @files;
+ for grep {m{^(devel/)?docs/}} @files;
done_testing;
diff --git a/t/pod.t b/t/pod.t
index 11371b6..53b1972 100644
--- a/t/pod.t
+++ b/t/pod.t
@@ -3,4 +3,4 @@ use warnings;
use Test::More;
use Test::Pod;
-all_pod_files_ok( all_pod_files("lib","docs","etc","bin","sbin"));
+all_pod_files_ok( all_pod_files("lib","devel","docs","etc","bin","sbin"));
commit bffabaabf8f38f9ba4b89c0e0b5fa0975dabc37d
Author: Alex Vandiver <alexmv at bestpractical.com>
Date: Thu Mar 5 17:53:38 2015 -0500
Document the new rights interface
Fixes: I#29515
diff --git a/devel/docs/UPGRADING-4.2 b/devel/docs/UPGRADING-4.2
index d74c879..b5e52be 100644
--- a/devel/docs/UPGRADING-4.2
+++ b/devel/docs/UPGRADING-4.2
@@ -43,4 +43,10 @@ you can use the class set on the E<lt>C<body>E<gt> element (for example:
body.aileron). See F<docs/customizing/styling_rt.pod> for more information
on custom styles.
+=item *
+
+The C<AddRights> and C<AddRightCategories> methods on L<RT::Class>,
+L<RT::CustomField>, L<RT::Group>, L<RT::Queue>, and L<RT::System> were
+refactored into L<RT::Record::Role::Rights/AddRight>.
+
=back
commit 3751ead1e080611ddc826a36cadef3311c813090
Author: Alex Vandiver <alexmv at bestpractical.com>
Date: Thu Mar 5 18:00:50 2015 -0500
Ensure that UPGRADING files are pod-checked
Because they do not end in .pod, .pl, or .pm, nor contain "perl" in
their shebang line, all_pod_files() does not find the upgrading files.
Add them explicitly.
diff --git a/t/pod.t b/t/pod.t
index 53b1972..1283cfe 100644
--- a/t/pod.t
+++ b/t/pod.t
@@ -3,4 +3,8 @@ use warnings;
use Test::More;
use Test::Pod;
-all_pod_files_ok( all_pod_files("lib","devel","docs","etc","bin","sbin"));
+all_pod_files_ok(
+ all_pod_files("lib","devel","docs","etc","bin","sbin"),
+ <docs/UPGRADING*>,
+ <devel/docs/UPGRADING*>,
+);
-----------------------------------------------------------------------
More information about the rt-commit
mailing list