docs: add more troubleshooting notes

gschintgen commented 3 months ago

Description

add more specific note about setcap / appimage / flatpak
add note about AMD lowlatency issues on linux
add note about buffer overruns if there's a speed mismatch between host/client

Screenshot

Issues Fixed or Closed

Type of Change

[ ] Bug fix (non-breaking change which fixes an issue)
[ ] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
[ ] Dependency update (updates to dependencies)
[x] Documentation update (changes to documentation)
[ ] Repository update (changes to repository files, e.g. .github/...)

Checklist

[x] My code follows the style guidelines of this project
[x] I have performed a self-review of my own code
[ ] I have commented my code, particularly in hard-to-understand areas
[ ] I have added or updated the in code docstring/documentation-blocks for new or existing methods/components

Branch Updates

LizardByte requires that branches be up-to-date before merging. This means that after any PR is merged, this branch must be updated before it can be merged. You must also Allow edits from maintainers.

[x] I want maintainers to keep my branch updated

ReenigneArcher commented 3 months ago

Could you also remove troubleshooting info about patching nvidia drivers? This should no longer be necessary after #2471

gschintgen commented 3 months ago

Could you also remove troubleshooting info about patching nvidia drivers? This should no longer be necessary after #2471

Done. I'll add one more note: modeset=1 for KMS capture on nvidia cards, this has come up a few times. That should be all then.

codecov[bot] commented 3 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 8.74%. Comparing base (509576d) to head (436e000). Report is 151 commits behind head on master.

Additional details and impacted files

```diff @@ Coverage Diff @@ ## master #2684 +/- ## ========================================= - Coverage 8.77% 8.74% -0.04% ========================================= Files 94 94 Lines 17373 17373 Branches 8251 8251 ========================================= - Hits 1525 1519 -6 - Misses 12987 12994 +7 + Partials 2861 2860 -1 ``` | [Flag](https://app.codecov.io/gh/LizardByte/Sunshine/pull/2684/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=LizardByte) | Coverage Δ | | |---|---|---| | [Linux](https://app.codecov.io/gh/LizardByte/Sunshine/pull/2684/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=LizardByte) | `6.49% <ø> (-0.07%)` | :arrow_down: | | [Windows](https://app.codecov.io/gh/LizardByte/Sunshine/pull/2684/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=LizardByte) | `3.82% <ø> (ø)` | | | [macOS-12](https://app.codecov.io/gh/LizardByte/Sunshine/pull/2684/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=LizardByte) | `9.82% <ø> (ø)` | | | [macOS-13](https://app.codecov.io/gh/LizardByte/Sunshine/pull/2684/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=LizardByte) | `9.72% <ø> (-0.02%)` | :arrow_down: | | [macOS-14](https://app.codecov.io/gh/LizardByte/Sunshine/pull/2684/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=LizardByte) | `10.02% <ø> (ø)` | | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=LizardByte#carryforward-flags-in-the-pull-request-comment) to find out more. [see 5 files with indirect coverage changes](https://app.codecov.io/gh/LizardByte/Sunshine/pull/2684/indirect-changes?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=LizardByte)

LizardByte / Sunshine