[Spice-devel] [PATCH spice-space] Update support.rst

[Uri Lublin]

Hi Snir,

Looks good to me.

Some suggestions at the bottom (inlined).

Feel free to fix/ignore and push with Frediano's ack.

On 3/24/19 6:04 PM, Snir Sheriber wrote:
> ---
> 
> Due to outdated links reported Daniel P. Berrangé in
> "[Spice-devel] Bug tracker links outdated"
> 
> In addition i did changes in the text so i sent it for review
> 
> 
> ---
>   support.rst | 20 ++++++++------------
>   1 file changed, 8 insertions(+), 12 deletions(-)
> 
> diff --git a/support.rst b/support.rst
> index 728c9d1..0e5c4f5 100644
> --- a/support.rst
> +++ b/support.rst
> @@ -7,12 +7,8 @@ Support
>   .. _Spice User Manual: spice-user-manual.html
>   .. _spice for newbies: {filename}/static/docs/spice_for_newbies.pdf
>   .. _Spice list archive: http://lists.freedesktop.org/archives/spice-devel/
> -.. _opened bugs: https://bugs.freedesktop.org/describecomponents.cgi?product=Spice
> -.. _bug-tracker: https://bugs.freedesktop.org/enter_bug.cgi?product=Spice
> -.. _feature-tracker: https://bugs.freedesktop.org/enter_bug.cgi?product=Spice&component=RFE
> +.. _issues: https://gitlab.freedesktop.org/groups/spice/-/issues
>   .. _Features: features.html
> -.. _search: https://bugs.freedesktop.org/query.cgi?product=Spice
> -.. _opened RFEs: https://bugs.freedesktop.org/buglist.cgi?component=RFE&list_id=560478&product=Spice&resolution=---
>   
>   Using Spice for the first time?
>   +++++++++++++++++++++++++++++++
> @@ -30,20 +26,20 @@ Spice project would like to have your feedback - either negative or positive. Pl
>   
>   Found a bug? Want to help and report?
>   +++++++++++++++++++++++++++++++++++++
> -#. Look at `opened bugs`_ to see whether it is a known bug.
> +#. Look at `issues`_ to see whether it is a known bug.
>   
> -   - There is no need to open a new bug in case it is a known bug, but optionally you can add your comment to the existing bug report or add yourself to the CC list.
> +   - There is no need to open a new issue in case it is already known, but optionally you can add your comment to the existing issue.
>      - In case you are not using the latest version of Spice, upgrade and see if it was resolved.
>   
> -#. Open a new bug report in Spice `bug-tracker`_ that follow these guidelines:
> +#. Create a new issue under the relevant project in Spice `issues`_ and follow these guidelines:
>   
>      - Write clear and detailed description of the bug.
>      - Provide instructions on how to reproduce the bug.
> -   - Specify the relevant components and their versions.
> +   - Specify all relevant components and their versions.
>      - Attach relevant logs.
>   
> -     - Spice server send its log messages to stdout, so you will need to redirect QEMU stdout to a file in order to have a server log file.
> -     - Linux Spice client log is /tmp/spicec.log, Windows Spice client log is in %temp%\spicec.log.
> +     - Spice server send its log messages to stdout, use G_MESSAGES_DEBUG=all and redirect QEMU stdout to a file in order to have a server log file.

s/send/sends/

Maybe replace with: use G_MESSAGES_DEBUG=all for debug-level logging,
possibly moving the "redirect ..." to a separate line.
Also maybe redirect also stderr to that file.

> +     - To get Spice client debug messages to stdout run it with --spice-debug.

I would make the client similar to the server:
- Spice client sends its log messages to stdout, use --spice-debug to 
enable debug level logging.
(or also add the "redirect stdout to a file" ... if you want)

Uri.

>   
>      - Provide the necessary information:
>   
> @@ -55,4 +51,4 @@ Your help for tracking down the bug is very important, so please try to be as co
>   
>   Like to have a new feature?
>   +++++++++++++++++++++++++++
> -First look at Spice `opened RFEs`_ or `search`_ to see whether it was already requested. In addition, refer to the Features_ page. If it was not requested you can submit your request in Spice `feature-tracker`_ using a clear and detailed description.
> +First search `issues`_ to see whether it was already requested. In addition, refer to the Features_ page. If it was not requested you can submit a new issue using a clear and detailed description.