[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [PATCH 2/2] docs: rSTify "report-a-bug" page; move it to QEMU Git
From: |
Peter Maydell |
Subject: |
Re: [PATCH 2/2] docs: rSTify "report-a-bug" page; move it to QEMU Git |
Date: |
Mon, 29 Nov 2021 13:35:11 +0000 |
On Wed, 24 Nov 2021 at 14:27, Kashyap Chamarthy <kchamart@redhat.com> wrote:
>
> 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
I don't think the bug-reporting instructions really belong in 'devel',
because we would like all users to report bugs, not just developers.
I think the /about/ section would be a better home for this file.
-- PMM