stas 02/04/15 01:55:42
Modified: src/docs/1.0/guide help.pod
src/docs/2.0/devel/help help.pod
src/docs/2.0/user/help help.pod
Log:
- start working on the section on how to report bugs with 2.0
Revision Changes Path
1.13 +2 -1 modperl-docs/src/docs/1.0/guide/help.pod
Index: help.pod
===================================================================
RCS file: /home/cvs/modperl-docs/src/docs/1.0/guide/help.pod,v
retrieving revision 1.12
retrieving revision 1.13
diff -u -r1.12 -r1.13
--- help.pod 15 Apr 2002 06:56:21 -0000 1.12
+++ help.pod 15 Apr 2002 08:55:42 -0000 1.13
@@ -24,7 +24,8 @@
help and you should I<RTFM> before you call for I<HELP>. (Remember the
fable of the shepherd boy and the wolves).
-For more information See L<Get help with
mod_perl|guide::help/Get_help_with_mod_perl>.
+For more information See L<Get help with
+mod_perl|guide::help/Get_help_with_mod_perl>.
=head1 How to Report Problems
1.8 +3 -5 modperl-docs/src/docs/2.0/devel/help/help.pod
Index: help.pod
===================================================================
RCS file: /home/cvs/modperl-docs/src/docs/2.0/devel/help/help.pod,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- help.pod 13 Apr 2002 16:02:06 -0000 1.7
+++ help.pod 15 Apr 2002 08:55:42 -0000 1.8
@@ -28,7 +28,7 @@
=head2 mod_perl 2.0 Core Development Discussion List
This list is used by the mod_perl 2.0 core developers to discuss
-design issues, solve problems and send patches and exchange ideas.
+design issues, solve problems, munch on patches and exchange ideas.
=over
@@ -60,11 +60,9 @@
Please use the output generated by I<t/REPORT> utility.
-If you get segmentation faults please send the stack backtrace to the
+If you get segmentation faults please send the L<stack
+backtrace|user::help::help/Resolving_Segmentation_Faults> to the
modperl developers list.
-
-META: link to the place explaining how to get it
-
=head2 mod_perl 2.0 Core Development CVS Commits List
1.4 +80 -2 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.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- help.pod 14 Apr 2002 07:11:49 -0000 1.3
+++ help.pod 15 Apr 2002 08:55:42 -0000 1.4
@@ -7,6 +7,84 @@
This chapter is for those needing help using mod_perl and related
software.
+There is a parallel L<Getting Help|devel::help::help> document written
+mainly for mod_perl core developers, but may be found useful to
+non-core problems as well.
+
+=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.x and 2.x on the same list.
+
+=head2 Wrong Apache/mod_perl combination
+
+First of all:
+
+ Apache 2.x doesn't work with mod_perl 1.x.
+ Apache 1.x doesn't work with mod_perl 2.x.
+
+So if you aren't using Apache 2.x with mod_perl 2.x please do not
+send any bug reports.
+
+=head2 Minimum Information
+
+Whenever you send a bug report make sure to include the information
+about your system by doing the following:
+
+ % cd modperl-2.0
+ % t/REPORT > mybugreport
+
+(this utility is autogenerated when C<perl Makefile.PL> is run.)
+
+Now add the problem description to the report and send it to the
+L<list|maillist::list-modperl>.
+
+META: soon we will have C<modperlbug> report script which will be
+installed system-wide
+
+=head2 Resolving Segmentation Faults
+
+If during C<make test> or the use of mod_perl you get a segmentation
+fault you should send to the list a stack backtrace. This
+L<section|devel::debug_c::debug_c/Analyzing_Dumped_Core_Files>
+explains how to extract this backtrace.
+
+Of course to generate a useful backtrace you need to have mod_perl
+with debugging symbols in it (and probably perl and/or httpd too).
+
+To get debug symbols for :
+
+=over
+
+=item * mod_perl
+
+rebuild mod_perl with C<MP_DEBUG=1>.
+
+ % perl Makefile.PL MP_DEBUG=1 ...
+ % make && make test && make install
+
+=item * httpd
+
+use C<--enable-maintainer-mode>:
+
+ % ./configure --enable-maintainer-mode ...
+ % make && make install
+
+=item * perl
+
+use C<-Doptimize='-g'>:
+
+ % ./Configure -Doptimize='-g' ...
+ % make && make test && make install
+
+=back
+
+Once a proper stack backtrace is obtained append it to the bug report
+as explained in the previous section.
+
+
=head1 Maintainers
Maintainer is the person(s) you should contact with updates,
@@ -14,7 +92,7 @@
=over
-=item *
+=item * Stas Bekman
=back
@@ -23,7 +101,7 @@
=over
-=item *
+=item * Stas Bekman
=back
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
