docs: add section on WSL in Linux known issues, update links (#653)

Update support links in documentation; add section on WSL in Linux known issues.
This commit is contained in:
Clement Tsang 2021-12-31 13:50:40 -08:00 committed by GitHub
parent 1481fe4282
commit f35718b580
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 13 additions and 5 deletions

View file

@ -6,7 +6,7 @@ labels: "bug"
assignees: ""
---
Before you report, please take a look at [Troubleshooting](https://clementtsang.github.io/bottom/nightly/troubleshooting) to see if there's already an answer to your problem. Also check out [existing issues](https://github.com/ClementTsang/bottom/issues) and [known problems](https://clementtsang.github.io/bottom/nightly/support/#known-problems) to see if your problem is already reported/known/fixed.
Before you report, please take a look at [Troubleshooting](https://clementtsang.github.io/bottom/nightly/troubleshooting) to see if there's already an answer to your problem. Also check out [existing issues](https://github.com/ClementTsang/bottom/issues) and [known problems](https://clementtsang.github.io/bottom/nightly/support/official/#known-problems) to see if your problem is already reported/known/fixed.
Also, **please fill in all fields if possible** - if the issue is too hard to reproduce or vague, it may not be fixed!

View file

@ -69,7 +69,7 @@ bottom _officially_ supports the following operating systems and corresponding a
These platforms are tested to work for the most part and issues on these platforms will be fixed if possible.
Furthermore, binaries are expected to be built and tested using the most recent version of stable Rust.
For more details on known problems and unsupported platforms, feel free to check out [the documentation page on support](https://clementtsang.github.io/bottom/nightly/support).
For more details on known problems and unsupported platforms, feel free to check out [the documentation page on support](https://clementtsang.github.io/bottom/nightly/support/official/).
## Installation

View file

@ -13,13 +13,21 @@ bottom from the repo/source, then please try that as well.
## Known problems
### Linux
- If you're using Linux via WSL or WSL2:
- You may have issues with getting memory data.
- Temperature sensors may not be correctly reported.
- WSL2 will not match Windows' own Task Manager in terms of data.
### Windows
- The temperature widget seems to require elevated access in some cases to get data.
- The battery widget seems to have issues with dual battery systems, like some Thinkpads.
- If you run on WSL/WSL2, you may have issues with getting memory data.
- WSL and WSL2 (as far as I know) cannot correctly report temperature sensors.
- WSL2 will not match Windows' own Task Manager in terms of data.
- If you are using WSL or WSL2:
- You may have issues with getting memory data.
- Temperature sensors may not be correctly reported.
- WSL2 will not match Windows' own Task Manager in terms of data.
### macOS