[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH 2/2] docs: rSTify "report-a-bug" page; move it to QEMU Git
From: |
Kashyap Chamarthy |
Subject: |
[PATCH 2/2] docs: rSTify "report-a-bug" page; move it to QEMU Git |
Date: |
Wed, 24 Nov 2021 15:27:28 +0100 |
This is also based on Paolo's suggestion[1] of "report-a-bug" page[2]
from the QEMU website being a candidate for docs/devel.
Converted from Markdown to rST using:
$> pandoc -f markdown -t rst report-a-bug.md \
-o reporting-a-bug.rst
Modifications:
- Rename this from "report-a-bug" page to "reporting-a-bug" to be
consistent with existing in-tree docs.
- Use internal rST reference to "submitting-a-patch.rst"; and slightly
tweak the sentence where this is referenced.
- Also tweak the description at the top of the 'index.rst' to to reflect
that the manual also documents some of QEMU's development processes.
[1] https://lists.nongnu.org/archive/html/qemu-devel/2021-11/msg04002.html
[2] https://www.qemu.org/contribute/report-a-bug/
Suggested-by: Paolo Bonzini <pbonzini@redhat.com>
Signed-off-by: Kashyap Chamarthy <kchamart@redhat.com>
---
docs/devel/index.rst | 8 +++++---
docs/devel/reporting-a-bug.rst | 37 ++++++++++++++++++++++++++++++++++
2 files changed, 42 insertions(+), 3 deletions(-)
create mode 100644 docs/devel/reporting-a-bug.rst
diff --git a/docs/devel/index.rst b/docs/devel/index.rst
index 424eff9294..39797679de 100644
--- a/docs/devel/index.rst
+++ b/docs/devel/index.rst
@@ -2,9 +2,10 @@
Developer Information
---------------------
-This section of the manual documents various parts of the internals of QEMU.
-You only need to read it if you are interested in reading or
-modifying QEMU's source code.
+This section of the manual documents some of QEMU's development
+practises, and various internals of QEMU. These documents are
+particularly useful for those interested in reading or modifying QEMU's
+source code.
.. toctree::
:maxdepth: 2
@@ -49,3 +50,4 @@ modifying QEMU's source code.
submitting-a-patch
submitting-a-pull-request
security-process
+ reporting-a-bug
diff --git a/docs/devel/reporting-a-bug.rst b/docs/devel/reporting-a-bug.rst
new file mode 100644
index 0000000000..a72f91caf4
--- /dev/null
+++ b/docs/devel/reporting-a-bug.rst
@@ -0,0 +1,37 @@
+.. _reporting-a-bug:
+
+Reporting a bug
+===============
+
+Bugs can be filed at our `bug
+tracker <https://gitlab.com/qemu-project/qemu/-/issues>`__, which is
+hosted on GitLab. Note: If you’ve got a problem with how your Linux
+distribution packages QEMU, please use the bug tracker from your distro
+instead.
+
+When submitting a bug report, please try to do the following:
+
+- Include the QEMU release version or the git commit hash into the
+ description, so that it is later still clear in which version you
+ have found the bug. Reports against the `latest
+ release </download/#source>`__ or even the latest development tree
+ are usually acted upon faster.
+
+- Include the full command line used to launch the QEMU guest.
+
+- Reproduce the problem directly with a QEMU command-line. Avoid
+ frontends and management stacks, to ensure that the bug is in QEMU
+ itself and not in a frontend.
+
+- Include information about the host and guest (operating system,
+ version, 32/64-bit).
+
+QEMU does not use GitLab merge requests; patches are sent to the mailing
+list according to the guidelines mentioned here: :ref:`submitting-a-patch`.
+
+Do **NOT** report security issues (or other bugs, too) as “confidential”
+bugs in the bug tracker. QEMU has a :ref:`security-process` for issues
+that should be reported in a non-public way instead.
+
+For problems with KVM in the kernel, use the kernel bug tracker instead;
+the `KVM wiki <https://www.linux-kvm.org/page/Bugs>`__ has the details.
--
2.31.1