stas 2003/02/17 19:38:46
Modified: src/docs/2.0/user/help help.pod
src/docs/1.0/guide help.pod
Log:
help us to help you
Revision Changes Path
1.18 +14 -3 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.17
retrieving revision 1.18
diff -u -r1.17 -r1.18
--- help.pod 31 Jan 2003 23:07:08 -0000 1.17
+++ help.pod 18 Feb 2003 03:38:46 -0000 1.18
@@ -18,6 +18,15 @@
that you are using and other relevant details. Please follow the
instructions in the following sections when reporting problems.
+B<The most important thing> to understand is that you should try hard
+to provide B<all> the information that may assist to understand and
+reproduce the problem. When you prepare a bug report, put yourself in
+the position of a person who is going to try to help you, realizing
+that a guess-work on behalf of that helpful person, more often doesn't
+work than it does. Unfortunately most people don't realize that, and
+it takes several emails to squeeze the needed details from the person
+reporting the bug, a process which may drag for days.
+
=head2 Wrong Apache/mod_perl combination
First of all:
@@ -28,6 +37,8 @@
So if you aren't using Apache 2.x with mod_perl 2.0 please do not send
any bug reports.
+META: mod_perl-1.99_0x is a to-be mod_perl 2.0.
+
=head2 Before Posting a Report
Before you post the report, make sure that you've checked the
@@ -142,9 +153,9 @@
For other remotely related to mod_perl questions see the references to
L<other documentation|docs::offsite::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>.
+Finally, if you are not familiar with the modperl list etiquette,
+please refer to the mod_perl mailing lists'
+L<Guidelines|maillist::email-etiquette> before posting.
=head1 Help on Related Topics
1.24 +52 -15 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.23
retrieving revision 1.24
diff -u -r1.23 -r1.24
--- help.pod 2 Sep 2002 06:47:12 -0000 1.23
+++ help.pod 18 Feb 2003 03:38:46 -0000 1.24
@@ -53,41 +53,78 @@
Subject: [mp1.0] response handler randomly segfaults
+B<The most important thing> to understand is that you should try hard
+to provide B<all> the information that may assist to understand and
+reproduce the problem. When you prepare a bug report, put yourself in
+the position of a person who is going to try to help you, realizing
+that a guess-work on behalf of that helpful person, more often doesn't
+work than it does. Unfortunately most people don't realize that, and
+it takes several emails to squeeze the needed details from the person
+reporting the bug, a process which may drag for days.
+
Always send the following details:
=over
-=item * Anything in the I<error_log> file that looks suspicious and possibly
related to the problem.
+=item *
-=item * Output of C<perl -V>
+Anything in the I<error_log> file that looks suspicious and possibly
+related to the problem.
-=item * Version of mod_perl
+=item *
-=item * Version of apache
+Output of C<perl -V>
-=item * Options given to mod_perl's Makefile.PL
+=item *
-=item * Server configuration details
+Version of mod_perl (hint: it's logged into the error_log file when
+the server has just started)
-=item * Relevant sections of your ErrorLog (make test's is: t/logs/error_log)
+=item *
-=item * If 'make test' fails, the output of 'make test TEST_VERBOSE=1'
+Version of apache (hint: it's logged into the error_log file when the
+server has just started)
-=back
+=item *
-Also check whether:
+Options given to mod_perl's Makefile.PL while building it. If you are
+using a pre-compiled binary (e.g., rpm), find the source package that
+was used to build this binary and retrieve this information from
+there.
-=over
+=item *
+
+Server configuration details (that's the relevant parts of your
+I<httpd.conf>, usually just the relevant mod_perl configuration
+sections).
+
+=item *
+
+Relevant sections of your C<ErrorLog> (make test's is: t/logs/error_log)
-=item * 'make test' passes 100%?
+=item *
-=item * the script works under mod_cgi if applicable
+If some other code doesn't work, minimize that code to a minimal size
+while it reproduces the problem and attach it to the report.
+
+=item *
+
+If you build from source, make sure that C<make test> passes 100%.
+
+If 'make test' fails, run the failing tests separately in a verbose
+mode|docs::1.0::guide::install/Manual_Testing> and attach the output of
+the run and the relevant sections of your C<ErrorLog> to the report.
=back
+If this is a script which doesn't use mod_perl api, try to test under
+mod_cgi if applicable
+
You should try to isolate the problem and send the smallest possible
-code snippet, that reproduces the problem. If the issue is unique and
-we cannot reproduce the problem, it's hard to solve it.
+code snippet, that reproduces the problem.
+
+Remember, that if we cannot reproduce the problem, we might not be
+able to solve it.
=over
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
