On Fri, 1 Apr 2005, Geoffrey Young wrote:

>
> > hmm, ok.  how about this - we turn off the cron job that updates
> > perl.apache.org so that whatever changes we make during the port aren't
> > shown on the website.
>
> ok, I did this.  at least I hope I did :)
>
> so, you should be free to update the docs in svn as you
> find time without fear that they will propagate to the
> website.  at least that's the theory :)
>
> we'll see what state we're in on monday and go from there.

I think I've changed most of the docs now to use Apache2::*,
rather than Apache::*; of course, there's likely places I
missed. Also, in particular, the porting docs, and those
involving Apache2::compat, should be checked, as there it's
not a straight s/Apache/Apache2/g replace. Also, I'll have
to check more thoroughly if any of these changes resulted
in broken internal links.

I've also started a skeleton (attached) for a document
trying to describe for users the effects of these changes.

-- 
best regards,
randy
=head1 NAME

mod_perl 2.0 renaming

=head1 Description

This document discusses the effects of the decision to rename
parts of the mod_perl API.

=head1 Synopsis

During a sequence of release candidates leading up to
the official release of mod_perl 2, 
in late December, 2004 there was considerable discussion
regarding the choice of namespaces for the 2.0 API.
The main concern expressed was that some of the
C<Apache::*> modules used in mod_perl 2 had the same names
as those in mod_perl 1. After a lively and, at times,
heated debate, a proposal was made to rename parts of
the mod_perl 2 API - see the thread at
L<http://marc.theaimsgroup.com/?t=111135037100002&r=1&w=2>.
This proposal was subsequently voted on and then adopted.

=head1 Changes

The main changes involved in this renaming are as follows.

=over

=item *

Rename all C<Apache::*> modules to C<Apache2::*> (note
that this does I<not> apply to C<Apache::Test*> modules
in the C<Apache-Test> distribution).

=item *

Rename C<mod_perl.pm> to C<mod_perl2.pm>

=item *

Due to the renaming, methods such as C<Apache-E<gt>server>
are now called as C<Apache2-E<gt>server>

=item *

Discontinue the practice of installing mod_perl in a
relative F<Apache2> subdirectory, so that the use
of C<Apache2.pm> to adjust C<@INC> is no longer needed.

=back

Concurrent with these changes, a decision was also made to
refuse to install mod_perl 2 in the same Perl tree as any
installed mod_perl 2 package of version prior to 1.999_22.

=head1 Effects

The mod_perl developers did not take lightly the effects of
changing the API at such a late stage in the development cycle.
For most users the change to the new API should be relatively
straightforward:

=over

=item *

Before installing mod_perl 2, either remove an earlier
mod_perl 2 installation (prior to 1.999022), or else choose
to install the new version in a different area.

=item *

If building mod_perl 2 from source, the C<Makefile.PL> argument
of C<MP_INST_APACHE2> is no longer supported.

=item *

Replace the use of

    use Apache::SomeCoreModule;

in a script or module by

    use Apache2::SomeCoreModule;

Similarly, an Apache directive

    PerlModule Apache::SomeCoreModule

in an F<httpd.conf> file should be replace by

    PerlModule Apache2::SomeCoreModule

A similar substitution from C<mod_perl> to C<mod_perl2> should
be made in similar places.

=item *

Remove any occurrences of

    use Apache2;

in a script or module, as well as

    PerlModule Apache2

in an Apache configuration file.

=item *

If in a script or module you use a method such as
C<Apache-E<gt>server>, replace this with
C<Apache2-E<gt>server>.

=back

Beginning with mod_perl-1.999_22, an environment variable
C<$ENV{MOD_PERL_API_VERSION}> has been added to specify
which mod_perl version is being used.

=head1 See Also

The directions for 
L<installing mod_perl 2.0 |docs::2.0::user::install::install>.
Help is also available through the archives of and subscribing to
the L<mod_perl mailing list|maillist::modperl>.

=head1 Authors

L<The mod_perl development team and numerous
contributors|about::contributors::people>.

=cut
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]

Reply via email to