mirror of
https://github.com/gnif/LookingGlass.git
synced 2026-08-22 07:01:30 +00:00
[docs] guide: document current Looking Glass features
This commit is contained in:
Geoffrey McRae
111
.github/ISSUE_TEMPLATE/bug_report.md
vendored
111
.github/ISSUE_TEMPLATE/bug_report.md
vendored
@@ -1,73 +1,84 @@
|
||||
---
|
||||
name: Bug report
|
||||
about: Report bugs in Looking Glass (only confirmed bugs and feature requests please)
|
||||
|
||||
about: Report a reproducible Looking Glass fault
|
||||
---
|
||||
|
||||
### Issues are for Bug Reports and Feature Requests Only!
|
||||
## Before reporting
|
||||
|
||||
If you are looking for help or support please use one of the following methods
|
||||
Use the forum or Discord for setup help:
|
||||
|
||||
Create a New Topic on the Level1Tech's forum under the Looking Glass category:
|
||||
* https://forum.level1techs.com/c/software/lookingGlass/142
|
||||
- https://forum.level1techs.com/c/software/lookingGlass/142
|
||||
- https://discord.gg/52SMupxkvt
|
||||
|
||||
Ask for help in the Looking Glass discord server
|
||||
* https://discord.gg/52SMupxkvt
|
||||
Use GitHub issues for reproducible bugs and feature requests. Check the current
|
||||
documentation and existing issues first. Do not report a protocol mismatch
|
||||
until the client, IDD and OBS plugin have been updated to the same release.
|
||||
|
||||
*Issues that are not bug reports or feature requests will be closed & ignored*
|
||||
## Describe the fault
|
||||
|
||||
### Errors that are not bugs
|
||||
|
||||
Some errors generated by the LG client are not bugs, but rather issues with your
|
||||
system's configuration and/or timing. Please do not report these, but rather use
|
||||
one of the above resources to ask for advice/help.
|
||||
|
||||
* `LGMP_ERR_QUEUE_UNSUBSCRIBED` - Failure to heed advice on things such as
|
||||
using `isolcpus` and CPU pinning may result in this message, especially if you
|
||||
are over-taxing your CPU.
|
||||
|
||||
* `Could not create an SDL window: *` - Failure to create a SDL window is not an
|
||||
issue with Looking Glass but rather a more substantial issue with your system,
|
||||
such as missing hardware support for the RGBA32 pixmap format, or missing
|
||||
required OpenGL EGL features.
|
||||
|
||||
* `The host application is not compatible with this client` - The Looking Glass
|
||||
Host application in Windows is the incorrect version and is not compatible,
|
||||
you need to make sure you run matching versions of both the host and client
|
||||
applications.
|
||||
|
||||
### Bug Report Required Information
|
||||
|
||||
The entire (not truncated) output from the client application (if applicable).
|
||||
To obtain this run `looking-glass-client` in a terminal.
|
||||
What happened, what did you expect, and what exact steps reproduce it?
|
||||
|
||||
```
|
||||
PASTE CLIENT OUTPUT HERE
|
||||
DESCRIPTION AND STEPS
|
||||
```
|
||||
|
||||
The entire (not truncated) log file from the host application (if applicable).
|
||||
Normally, this is found on the guest system at:
|
||||
|
||||
%ProgramData%\Looking Glass (host)\looking-glass-host.txt
|
||||
|
||||
This log may be quite long, please delete the file first and then proceed to
|
||||
launch the host and reproduce the issue so that the log only contains the
|
||||
pertinent information.
|
||||
|
||||
Does it reproduce every time? If not, how often?
|
||||
|
||||
```
|
||||
PASTE HOST LOG FILE CONTENTS HERE
|
||||
REPRODUCTION RATE
|
||||
```
|
||||
|
||||
If the client is unexpectedly exiting without a backtrace, please provide one via
|
||||
gdb with the command `thread apply all bt`. If you are unsure how to do this
|
||||
please watch the video below on how to perform a Debug build and generate this
|
||||
backtrace.
|
||||
## Versions and system
|
||||
|
||||
https://www.youtube.com/watch?v=EqxxJK9Yo64
|
||||
- Looking Glass Client version:
|
||||
- Looking Glass IDD or legacy Host version:
|
||||
- OBS plugin version, if applicable:
|
||||
- Linux distribution and kernel:
|
||||
- X11 or Wayland, and compositor:
|
||||
- Host GPU and driver:
|
||||
- Guest GPU and driver, or IDD software mode:
|
||||
- Guest resolution and refresh rate:
|
||||
- Primary transport (`lgmp` or `spice`):
|
||||
- DMA enabled and successfully imported:
|
||||
|
||||
## Client output
|
||||
|
||||
Run `looking-glass-client` from a terminal, reproduce the fault and include its
|
||||
complete output from startup. Do not include only the final error.
|
||||
|
||||
```
|
||||
PASTE FULL BACKTRACE HERE
|
||||
PASTE COMPLETE CLIENT OUTPUT
|
||||
```
|
||||
|
||||
## Windows logs
|
||||
|
||||
For the IDD, use its notification-area helper to open
|
||||
`C:\ProgramData\Looking Glass (IDD)` and attach the current files plus rotated
|
||||
files from the affected run:
|
||||
|
||||
- `looking-glass-idd.txt`
|
||||
- `looking-glass-input.txt`
|
||||
- `looking-glass-idd-service.txt`
|
||||
- `looking-glass-idd-helper.txt`
|
||||
|
||||
For the legacy Host Application, attach:
|
||||
|
||||
- `C:\ProgramData\Looking Glass (host)\looking-glass-host.txt`
|
||||
- `C:\ProgramData\Looking Glass (host)\looking-glass-host-service.txt`
|
||||
|
||||
## Crash backtrace
|
||||
|
||||
For a client crash without a complete built-in trace, run the client under
|
||||
`gdb`, reproduce it, then run:
|
||||
|
||||
```
|
||||
thread apply all bt full
|
||||
```
|
||||
|
||||
Attach that output and keep the matching `looking-glass-client.debug` file
|
||||
available.
|
||||
|
||||
## Additional evidence
|
||||
|
||||
Attach screenshots, timing graphs, OBS logs or short recordings when they make
|
||||
the fault clearer. State which settings differ from their defaults.
|
||||
|
||||
Reference in New Issue
Block a user