You are viewing a plain text version of this content. The canonical link for it is here.
Posted to docs-cvs@perl.apache.org by st...@apache.org on 2002/08/18 09:31:48 UTC
cvs commit: modperl-docs/src/docs/2.0/user/help help.pod
stas 2002/08/18 00:31:48
Modified: src/docs/2.0/user/help help.pod
Log:
extend on problem reporting procedure
Revision Changes Path
1.11 +52 -29 modperl-docs/src/docs/2.0/user/help/help.pod
Index: help.pod
===================================================================
RCS file: /home/cvs/modperl-docs/src/docs/2.0/user/help/help.pod,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -r1.10 -r1.11
--- help.pod 31 Jul 2002 09:30:07 -0000 1.10
+++ help.pod 18 Aug 2002 07:31:48 -0000 1.11
@@ -14,31 +14,9 @@
=head1 Reporting Problems
Whenever you want to report a bug or a problem remember that in order
-to help you need to provide us the information about the software
-blocks that you are using. This is especially important now that we
-support mod_perl versions 1.0 and 2.0 on the same list.
-
-Make sure to include a good subject like explaining the problem in a
-few words. Also please mention that this a problem with mod_perl 2.0
-and not mod_perl 1.0. Here is an example of a good subject:
-
- Subject: [mp2.0] protocol module doesn't work with filters
-
-
-=head2 Please Ask Only Questions Related to mod_perl
-
-If you have general Apache questions, please refer to:
-http://httpd.apache.org/lists.html.
-
-If you have general Perl questions, please refer to:
-http://lists.perl.org/.
-
-For other remotely related to mod_perl questions see the references to
-L<other documentation|docs::offisite::other>.
-
-Finally, if you are posting to the list for the first time, please
-refer to the mod_perl mailing lists'
-L<Guidelines|maillist::email-etiquette>.
+to help you, you need to provide us the information about the software
+that you are using and other relevant details. Please follow the
+instructions in the following sections when reporting problems.
=head2 Wrong Apache/mod_perl combination
@@ -47,10 +25,21 @@
Apache 2.0 doesn't work with mod_perl 1.0.
Apache 1.0 doesn't work with mod_perl 2.0.
-So if you aren't using Apache 2.x with mod_perl 2.0 please do not
-send any bug reports.
+So if you aren't using Apache 2.x with mod_perl 2.0 please do not send
+any bug reports.
+
+=head2 Use a Proper Subject
+
+Make sure to include a good subject like explaining the problem in a
+few words. Also please mention that this a problem with mod_perl 2.0
+and not mod_perl 1.0. Here is an example of a good subject:
+
+ Subject: [mp2.0] protocol module doesn't work with filters
+
+This is especially important now that we support mod_perl versions 1.0
+and 2.0 on the same list.
-=head2 Minimum Information
+=head2 Important Information
Whenever you send a bug report make sure to include the information
about your system by doing the following:
@@ -58,7 +47,9 @@
% cd modperl-2.0
% t/REPORT > mybugreport
-(this utility is autogenerated when C<perl Makefile.PL> is run.)
+where C<modperl-2.0> is the source directory where mod_perl was built.
+The <t/REPORT> utility is autogenerated when C<perl Makefile.PL> is
+run, so you should have it already after building mod_perl.
Now add the problem description to the report and send it to the
L<list|maillist::modperl>.
@@ -66,6 +57,18 @@
META: soon we will have C<modperlbug> report script which will be
installed system-wide
+=head2 Problem Description
+
+If the problem incurs with your own code, please try to reduce the
+code to the very minimum and include it in the bug report. Remember
+that if you include a long code, chances that somebody will look at it
+are low. If the problem is with some CPAN module, just provide its
+name.
+
+Also remember to include the relevant part of I<httpd.conf> and of
+I<startup.pl> if applicable. Don't include whole files, only the parts
+that should aid to understand and reproduce the problem.
+
=head2 Resolving Segmentation Faults
If during C<make test> or the use of mod_perl you get a segmentation
@@ -101,11 +104,31 @@
% ./Configure -Doptimize='-g' ...
% make && make test && make install
+=item * 3rd party perl modules
+
+if the trace happens in one of the 3rd party perl modules, make sure
+to rebuild them, now that you've perl re-built with debugging
+flags. They will automatically pick the right compile flags from perl.
+
=back
Once a proper stack backtrace is obtained append it to the bug report
as explained in the previous section.
+=head2 Please Ask Only Questions Related to mod_perl
+
+If you have general Apache questions, please refer to:
+http://httpd.apache.org/lists.html.
+
+If you have general Perl questions, please refer to:
+http://lists.perl.org/.
+
+For other remotely related to mod_perl questions see the references to
+L<other documentation|docs::offisite::other>.
+
+Finally, if you are posting to the list for the first time, please
+refer to the mod_perl mailing lists'
+L<Guidelines|maillist::email-etiquette>.
=head1 Maintainers
---------------------------------------------------------------------
To unsubscribe, e-mail: docs-cvs-unsubscribe@perl.apache.org
For additional commands, e-mail: docs-cvs-help@perl.apache.org