FAQ: Replace the debugging section (again) with a checklist of information we need to start to fix bugs.

This commit is contained in:
Richard W.M. Jones
2013-08-16 13:35:12 +01:00
parent 0a484e868f
commit abc59d776a

View File

@@ -755,26 +755,47 @@ standalone programs).
=head1 DEBUGGING LIBGUESTFS
B<In summary:> enable debugging by setting these two environment
variables before running the program:
=head2 Help, it's not working!
Please supply all the information in this checklist, in an
email sent to C<libguestfs> @ C<redhat.com>:
=over 4
=item *
What are you trying to achieve?
=item *
What exact commands did you run?
=item *
What was the precise error / output of these commands?
=item *
Enable debugging, run the commands again, and capture the B<complete>
output. B<Do not edit the output.>
export LIBGUESTFS_DEBUG=1
export LIBGUESTFS_TRACE=1
This will produce a lot of output. Put the B<complete> output in an
email message or pastebin and send it
L<to the mailing list|/What mailing lists or chat rooms are available?>.
B<Do not edit the output.>
=item *
Include the version of libguestfs, the operating system version, and
how you installed libguestfs (eg. from source, C<yum install>, etc.)
If no libguestfs program works, run the program below and paste the
B<complete, unedited> output into an email or pastebin and send it to
the mailing list:
=item *
If no libguestfs program seems to work at all, run the program below
and paste the B<complete, unedited> output into the email:
libguestfs-test-tool
=back
=head2 How do I debug when using any libguestfs program or tool
(eg. virt-v2v or virt-df)?