From 571fca8e71901bb3f1e68d51defb29fac920ffbb Mon Sep 17 00:00:00 2001 From: "Richard W.M. Jones" Date: Thu, 13 Aug 2015 22:51:43 +0100 Subject: [PATCH] FAQ: Further improve debugging section. --- examples/guestfs-faq.pod | 33 ++++++++++++++++----------------- 1 file changed, 16 insertions(+), 17 deletions(-) diff --git a/examples/guestfs-faq.pod b/examples/guestfs-faq.pod index bc54c542e..d3454f6d8 100644 --- a/examples/guestfs-faq.pod +++ b/examples/guestfs-faq.pod @@ -893,24 +893,30 @@ standalone programs). =head2 Help, it's not working! -Please supply all the information in this checklist, in an -email sent to C @ C: +If no libguestfs program seems to work at all, run the program below +and paste the B output into the email to +C @ C: + + libguestfs-test-tool + +If a particular operation fails, supply all the information in this +checklist, in an email to C @ C: =over 4 -=item * +=item 1. -What are you trying to achieve? +What are you trying to do? -=item * +=item 2. -What exact commands did you run? +What exact command(s) did you run? -=item * +=item 3. -What was the precise error / output of these commands? +What was the precise error or output of these commands? -=item * +=item 4. Enable debugging, run the commands again, and capture the B output. B @@ -918,18 +924,11 @@ output. B export LIBGUESTFS_DEBUG=1 export LIBGUESTFS_TRACE=1 -=item * +=item 5. Include the version of libguestfs, the operating system version, and how you installed libguestfs (eg. from source, C, etc.) -=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