[PATCH 1/2] kbase: debuglogs: Include more data to attach to bugreports

[Peter Krempa]

Promote the 'What to attach?' section to a first level heading and
request also the XML config of a VM, coredump backtrace if something
crashed and ask to not tear down the environment for the possibility to
ask for additional data.

Signed-off-by: Peter Krempa <pkrempa at redhat.com>
---
 docs/kbase/debuglogs.rst | 15 +++++++++++----
 1 file changed, 11 insertions(+), 4 deletions(-)

diff --git a/docs/kbase/debuglogs.rst b/docs/kbase/debuglogs.rst
index decc53a69b..523adfcacc 100644
--- a/docs/kbase/debuglogs.rst
+++ b/docs/kbase/debuglogs.rst
@@ -136,13 +136,20 @@ setting which depends on the host configuration, *journald* in our case:
     Logging outputs: 2:journald

 What to attach?
-~~~~~~~~~~~~~~~
+---------------

 Now you should go and reproduce the bug. Once you're finished, attach:

 -  ``/var/log/libvirt/libvirtd.log`` or whatever path you set for the daemon
    logs.
--  If the problem is related to a domain attach
-   ``/var/log/libvirt/qemu/$dom.log`` then. Or substitute ``qemu`` with whatever
-   hypervisor you are using.
+-  If the problem is related to a domain named ``$dom`` attach:
+
+   -  ``/var/log/libvirt/qemu/$dom.log`` (Or substitute ``qemu`` with whatever
+      hypervisor you are using.)
+   -  The XML configuration of the vm/domain obtained by ``virsh dumpxml $dom``
+
+-  If the problem involves a crash of ``libvirtd`` or any other component also
+   attach the core dump backtrace if possible (e.g. using ``coredumpctl``).
 -  If you are asked for client logs, ``/tmp/libvirt_client.log``.
+-  Ideally don't tear down the environment in case additionall information is
+   required.
-- 
2.26.2