[mp2][doc][patch] minor documentation fixes
Hi,
The attached patches are applied to the Debian package of mod_perl2
2.0.4.
200_fix-pod-spelling-errors.patch fixes spelling errors in POD and
comments. The 'overriden -> overridden' fix may also be applied to
variable names, but is not done with this patch.
210_fix-pod-errors.patch fixes missing =over/=back in POD
220_fix-bad-whatis-entry.patch disables a POD block that seems to be
used as a comment and which was causing creation of a manual page
without a whatis entry.
Please consider integrating these in a future release.
Description: Fix spelling errors in documentation
This includes both POD and comments.
The 'overriden -> overridden' fix may also be applied to variable names,
but is not done with this patch.
Forwarded: no
Author: Damyan Ivanov <dmn@debian.org>
Last-Update: 2010-04-20
--- a/Apache-Test/lib/Apache/TestConfig.pm
+++ b/Apache-Test/lib/Apache/TestConfig.pm
@@ -2221,8 +2221,8 @@ sub custom_config_add_conf_opts {
# the logic is quite complicated with 'httpd' and 'apxs', since
# one is enough to run the test suite, and we need to avoid the
# situation where both are saved in custom config but only one
- # (let's say httpd) is overriden by the command line /env var and
- # a hell may break loose if we take that overriden httpd value and
+ # (let's say httpd) is overridden by the command line /env var and
+ # a hell may break loose if we take that overridden httpd value and
# also use apxs from custom config which could point to a different
# server. So if there is an override of apxs or httpd, do not use
# the custom config for apxs or httpd.
--- a/Apache-Test/lib/Apache/TestRun.pm
+++ b/Apache-Test/lib/Apache/TestRun.pm
@@ -1456,7 +1456,7 @@ F<lib/Apache/TestConfigData.pm> (if duri
F<~/.apache-test/Apache/TestConfigData.pm> and
F<Apache/TestConfigData.pm> in the perl's libraries.
-C<$config_overriden> - that means that we have either C<apxs> or
+C<$config_overridden> - that means that we have either C<apxs> or
C<httpd> values provided by user, via env vars or command line options.
=over
@@ -1477,12 +1477,12 @@ bundles Apache-Test).
3) make test
if $config_exists
- if $config_overriden
- override saved options (for those that were overriden)
+ if $config_overridden
+ override saved options (for those that were overridden)
else
use saved options
else
- if $config_overriden
+ if $config_overridden
save them in lib/Apache/TestConfigData.pm
(which will be installed on 'make install')
else
@@ -1523,12 +1523,12 @@ F<~/.apache-test/Apache/TestConfigData.p
3) make test
if $config_exists
- if $config_overriden
- override saved options (for those that were overriden)
+ if $config_overridden
+ override saved options (for those that were overridden)
else
use saved options
else
- if $config_overriden
+ if $config_overridden
save them in $custom_config_path
else
- run interactive prompt for C<httpd> and optionally for C<apxs>
--- a/Apache-Test/lib/Apache/TestTrace.pm
+++ b/Apache-Test/lib/Apache/TestTrace.pm
@@ -126,9 +126,9 @@ sub nc_trace {
}
sub trace_level {
- # overriden by user/-trace
+ # overridden by user/-trace
(defined $Level && $levels{$Level}) ||
- # or overriden by env var
+ # or overridden by env var
(exists $ENV{APACHE_TEST_TRACE_LEVEL} &&
$levels{$ENV{APACHE_TEST_TRACE_LEVEL}}) ||
# or default
--- a/Apache-Test/lib/Apache/TestUtil.pm
+++ b/Apache-Test/lib/Apache/TestUtil.pm
@@ -822,7 +822,7 @@ directory separators. The function is no
=item t_start_error_log_watch(), t_finish_error_log_watch()
This pair of functions provides an easy interface for checking
-the presence or absense of any particular message or messages
+the presence or absence of any particular message or messages
in the httpd error_log that were generated by the httpd daemon
as part of a test suite. It is likely, that you should proceed
this with a call to one of the t_*_is_expected() functions.
--- a/ModPerl-Registry/lib/ModPerl/RegistryCooker.pm
+++ b/ModPerl-Registry/lib/ModPerl/RegistryCooker.pm
@@ -61,7 +61,7 @@ use constant D_WARN => 2;
use constant D_COMPILE => 4;
use constant D_NOISE => 8;
-# the debug level can be overriden on the main server level of
+# the debug level can be overridden on the main server level of
# httpd.conf with:
# PerlSetVar ModPerl::RegistryCooker::DEBUG 4
use constant DEBUG => 0;
--- a/docs/api/APR.pod
+++ b/docs/api/APR.pod
@@ -18,7 +18,7 @@ libaprutil Libraries)
=head1 Description
-On load this modules prepares the APR enviroment (initializes memory
+On load this modules prepares the APR environment (initializes memory
pools, data structures, etc.)
You don't need to use this module explicitly, since it's already
--- a/docs/api/Apache2/Module.pod
+++ b/docs/api/Apache2/Module.pod
@@ -413,7 +413,7 @@ Remove a module from the list of loaded
=head2 C<top_module>
-Returns the first module in the module list. Usefull to start a
+Returns the first module in the module list. Useful to start a
module iteration.
$module = Apache2::Module::top_module();
--- a/docs/api/Apache2/Util.pod
+++ b/docs/api/Apache2/Util.pod
@@ -36,7 +36,7 @@ C<Apache2::Util> provides the following
=head2 C<escape_path>
-convert an OS path to a URL in an OS dependant way.
+convert an OS path to a URL in an OS dependent way.
$escaped_path = Apache2::Util::escape_path($path, $p);
$escaped_path = Apache2::Util::escape_path($path, $p, $partial);
--- a/docs/api/ModPerl/MM.pod
+++ b/docs/api/ModPerl/MM.pod
@@ -55,7 +55,7 @@ hasn't already specified a method I<MY::
C<ModPerl::MM> will DWIM and do nothing.
In case the functionality of C<ModPerl::MM> methods needs to be
-extended, rather than completely overriden, the C<ModPerl::MM> methods
+extended, rather than completely overridden, the C<ModPerl::MM> methods
can be called internally. For example if you need to modify constants
in addition to the modifications applied by
C<ModPerl::MM::MY::constants>, call the C<ModPerl::MM::MY::constants>
@@ -72,7 +72,7 @@ not C<ModPerl::MM>), then do your extra
In certain cases a developers may want to prevent from C<ModPerl::MM>
to override certain methods. In that case an explicit override in
I<Makefile.PL> will do the job. For example if you don't want the
-C<constants()> method to be overriden by C<ModPerl::MM>, add to your
+C<constants()> method to be overridden by C<ModPerl::MM>, add to your
I<Makefile.PL>:
sub MY::constants { shift->MM::constants(@_); }";
@@ -89,7 +89,7 @@ C<ModPerl::MM::WriteMakefile> supplies d
C<INC> and C<TYPEMAPS> unless they weren't passed to
C<ModPerl::MM::WriteMakefile> from I<Makefile.PL>.
-If the default values aren't satisfying these should be overriden in
+If the default values aren't satisfying these should be overridden in
I<Makefile.PL>. For example to supply an empty INC, explicitly set the
argument in I<Makefile.PL>.
--- a/docs/api/ModPerl/RegistryCooker.pod
+++ b/docs/api/ModPerl/RegistryCooker.pod
@@ -25,7 +25,7 @@ Provide ingredients that can be used by
=item *
-Provide a default behavior, which can be overriden in sub-classed
+Provide a default behavior, which can be overridden in sub-classed
META: in the future this functionality may move into a separate class.
--- a/lib/Apache2/compat.pm
+++ b/lib/Apache2/compat.pm
@@ -254,7 +254,7 @@ sub override_mp2_api {
}
# restore_mp2_api does the opposite of override_mp2_api(), it removes
-# the overriden API and restores the original mod_perl 2.0 API
+# the overridden API and restores the original mod_perl 2.0 API
sub restore_mp2_api {
my (@subs) = @_;
--- a/lib/Apache2/porting.pm
+++ b/lib/Apache2/porting.pm
@@ -84,9 +84,9 @@ BEGIN {
$package =~ s|/|::|g;
$package =~ s|.pm$||;
- # this picks the original require (which could be overriden
+ # this picks the original require (which could be overridden
# elsewhere, so we don't lose that) because we haven't
- # overriden it yet
+ # overridden it yet
return require $_[0] unless $packages{$package};
my $msg = "mod_perl 2.0 API doesn't include package '$package'.";
--- a/xs/APR/Pool/APR__Pool.h
+++ b/xs/APR/Pool/APR__Pool.h
@@ -49,7 +49,7 @@ APR_OPTIONAL_FN_TYPE(modperl_thx_interp_
#define MP_APR_POOL_SV_HAS_OWNERSHIP(sv) mpxs_pool_is_custom(sv)
/* before the magic is freed, one needs to carefully detach the
- * dependant pool magic added by mpxs_add_pool_magic (most of the time
+ * dependent pool magic added by mpxs_add_pool_magic (most of the time
* it'd be a parent pool), and postpone its destruction, until after
* the child pool is destroyed. Since if we don't do that the
* destruction of the parent pool will destroy the child pool C guts
--- a/todo/bugs_build
+++ b/todo/bugs_build
@@ -71,7 +71,7 @@ HPUX11i DSO
* we have a dependency check problem when xs/*/*.h use code from
xs/modperl_xs*.h, when the latter change 'make' won't rebuild the
- dependant files
+ dependent files
* Testing:
Need to put Philippe's smoking test into the core
Description: Fix POD errors
Forwarded: no
Author: Damyan Ivanov <dmn@debian.org>
Last-Update: 2010-04-20
--- a/Apache-Test/lib/Apache/Test.pm
+++ b/Apache-Test/lib/Apache/Test.pm
@@ -936,6 +936,8 @@ if no reason is given a default reason w
=head1 Additional Configuration Variables
+=over
+
=item basic_config
my $basic_cfg = Apache::Test::basic_config();
@@ -968,6 +970,8 @@ If no arguments are passed, the referenc
returned. If one or more arguments are passed the corresponding values
are returned.
+=back
+
=head1 Test::More Integration
There are a few caveats if you want to use I<Apache::Test> with
Description: Replace stray POD with =for comment
This is the only documented methd and leaving in =head2 makes the build
system generate a manual page lacking a basic requisite like the whatis
entry (=head1 NAME)
Forwarded: no
Author: Damyan Ivanov <dmn@debian.org>
Last-Update: 2010-04-20
--- a/Apache-Test/lib/Apache/TestServer.pm
+++ b/Apache-Test/lib/Apache/TestServer.pm
@@ -379,7 +379,7 @@ sub port_available {
}
}
-=head2 stop()
+=for comment head2 stop()
attempt to stop the server.
Reply to: