From 4d980d81b946e73de23600e984c99f911190df0d Mon Sep 17 00:00:00 2001 From: Jonathan Rubenstein Date: Thu, 5 Nov 2026 18:47:21 +0200 Subject: [PATCH] [doc] Move Client information when asking for help into troubleshooting --- doc/idd_diagnostics.rst | 22 ---------------------- doc/troubleshooting.rst | 22 ++++++++++++++++++++++ 2 files changed, 22 insertions(+), 22 deletions(-) diff --git a/doc/idd_diagnostics.rst b/doc/idd_diagnostics.rst index 94af42af..967ff5b4 100644 --- a/doc/idd_diagnostics.rst +++ b/doc/idd_diagnostics.rst @@ -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. diff --git a/doc/troubleshooting.rst b/doc/troubleshooting.rst index 33e7797a..4eed3f1b 100644 --- a/doc/troubleshooting.rst +++ b/doc/troubleshooting.rst @@ -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