From abc59d776a12fb96de6ff927054f3db2a9ed4fc4 Mon Sep 17 00:00:00 2001 From: "Richard W.M. Jones" Date: Fri, 16 Aug 2013 13:35:12 +0100 Subject: [PATCH] FAQ: Replace the debugging section (again) with a checklist of information we need to start to fix bugs. --- examples/guestfs-faq.pod | 39 ++++++++++++++++++++++++++++++--------- 1 file changed, 30 insertions(+), 9 deletions(-) diff --git a/examples/guestfs-faq.pod b/examples/guestfs-faq.pod index cf2f67f4a..071fd0fe6 100644 --- a/examples/guestfs-faq.pod +++ b/examples/guestfs-faq.pod @@ -755,26 +755,47 @@ standalone programs). =head1 DEBUGGING LIBGUESTFS -B 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 @ C: + +=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 +output. B export LIBGUESTFS_DEBUG=1 export LIBGUESTFS_TRACE=1 -This will produce a lot of output. Put the B output in an -email message or pastebin and send it -L. -B +=item * Include the version of libguestfs, the operating system version, and how you installed libguestfs (eg. from source, C, etc.) -If no libguestfs program works, run the program below and paste the -B 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 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)?