[doc] Move Client information when asking for help into troubleshooting

This commit is contained in:
Jonathan Rubenstein
2026-11-05 18:47:21 +02:00
committed by Geoffrey McRae
parent db7801551f
commit 4d980d81b9
2 changed files with 22 additions and 22 deletions

View File

@@ -51,25 +51,3 @@ Frame schedule owner
Input owner
Identifies the client currently allowed to send direct input. Only one
client can own it at a time.
.. _client_help_information:
Client information when asking for help
---------------------------------------
The Looking Glass client outputs a lot of useful information during normal
operation, which helps a lot with debugging and support when issues arise.
This information is available when running the client in a terminal.
When asking for help, it is important to include the following:
* version information about the client, and IDD;
* Linux distribution and kernel;
* X11 or Wayland and the compositor name;
* host and guest GPU models and drivers;
* whether ``lgmp:allowDMA`` is enabled;
* the guest resolution and refresh rate; and
* accurate reproduction steps that lead to your issue.
All of this information is helpful, and should not be excluded.

View File

@@ -10,6 +10,28 @@ pass.
idd_diagnostics
.. _client_help_information:
Client information when asking for help
---------------------------------------
The Looking Glass client outputs a lot of useful information during normal
operation, which helps a lot with debugging and support when issues arise.
This information is available when running the client in a terminal.
When asking for help, it is important to include the following:
* version information about the client, and IDD;
* Linux distribution and kernel;
* X11 or Wayland and the compositor name;
* host and guest GPU models and drivers;
* whether ``lgmp:allowDMA`` is enabled;
* the guest resolution and refresh rate; and
* accurate reproduction steps that lead to your issue.
All of this information is helpful, and should not be excluded.
.. _when_launching_looking_glass_the_desktop_doesnt_appear:
The Looking Glass monitor is missing in Windows