Re: [Qemu-devel] [qemu-web PATCH] move bug reporting instructions from wiki to www

[Thomas Huth]

On 26.07.2017 13:10, Paolo Bonzini wrote:
> The bug reporting instructions are pretty static, and it is nicer if bug
> reporters stay within the familiar QEMU web site layout.  Move the page
> to qemu.org.
> 
> Signed-off-by: Paolo Bonzini <address@hidden>
> ---
>  _includes/footer.html      |  2 +-
>  contribute.md              |  2 +-
>  contribute/report-a-bug.md | 19 +++++++++++++++++++
>  3 files changed, 21 insertions(+), 2 deletions(-)
>  create mode 100644 contribute/report-a-bug.md
> 
> diff --git a/_includes/footer.html b/_includes/footer.html
> index cd28480..7a3e8b1 100644
> --- a/_includes/footer.html
> +++ b/_includes/footer.html
> @@ -7,9 +7,9 @@
>               </ul>
>               <ul class="style">
>                       <li><a href="/contribute">Contribute</a></li>
> +                     <li><a href="/contribute/report-a-bug">Reporting a 
> bug</a></li>
>                       <li><a 
> href="http://wiki.qemu-project.org/Documentation/GettingStartedDevelopers";>New
>  contributors</a></li>
>                       <li><a 
> href="http://wiki.qemu-project.org/Contribute/SubmitAPatch";>Submitting a 
> patch</a></li>
> -                     <li><a 
> href="http://wiki.qemu-project.org/Contribute/ReportABug";>Reporting a 
> bug</a></li>
>                       <li><a 
> href="http://wiki.qemu-project.org/Contribute/FAQ";>Contributor FAQ</a></li>
>               </ul>
>               <ul class="style">
> diff --git a/contribute.md b/contribute.md
> index fb2238d..e052654 100644
> --- a/contribute.md
> +++ b/contribute.md
> @@ -3,7 +3,7 @@ title: Contribute to QEMU!
>  permalink: /contribute/
>  ---
>  
> -* Report a bug: https://bugs.launchpad.net/qemu/<br>[How to report a 
> bug](http://wiki.qemu-project.org/Contribute/ReportABug)
> +* Report a bug: https://bugs.launchpad.net/qemu/<br>[How to report a 
> bug](report-a-bug/)

While you're at it, could you turn the launchpad URL into a clickable
URL, too? It is currently rendered as plain text.

>  * Clone the git repository: <br>`git clone 
> git://git.qemu-project.org/qemu.git`
>  
> diff --git a/contribute/report-a-bug.md b/contribute/report-a-bug.md
> new file mode 100644
> index 0000000..f0fd67b
> --- /dev/null
> +++ b/contribute/report-a-bug.md
> @@ -0,0 +1,19 @@
> +---
> +title: Reporting a bug
> +permalink: /contribute/report-a-bug
> +---
> +
> +Bugs can be filed at our [https://bugs.launchpad.net/qemu/ bug tracker].
> +
> +When submitting a bug report, please try to do the following:
> +
> +* Make sure you're reporting the bug against the [latest 
> release](/download/#source).  If possible, please try to reproduce with the 
> latest development tree too.

Please add also (since it still happens way too often):

* Please avoid to report bugs that you've found in the QEMU version
  that ships with your Linux distribution. If you've got a problem with
  the QEMU from your Linux distribution, use the bug tracker from your
  distro instead.

* 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.

> +* 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 as information about the guest (operating system, version, 
> 32/64-bit).
> +
> +* Do not contribute patches on the bug tracker; send patches to the mailing 
> list. Follow QEMU's [guidelines about submitting 
> patches](http://wiki.qemu.org/Contribute/SubmitAPatch).

Please also add something like this:

* Do NOT report security issues (or other bugs, too) as "private" bugs
  in the bug tracker. Non-public bugs tend to be ignored. See
  http://wiki.qemu.org/SecurityProcess for information about how to
  report security issues in a non-public way instead.

* If you encountered a problem with KVM in the kernel, use the kernel
  bug tracker instead (see http://www.linux-kvm.org/page/Bugs for
  details).

 Thanks,
  Thomas