diff --git a/docs/content/support/official.md b/docs/content/support/official.md index fa9356eb..f994d555 100644 --- a/docs/content/support/official.md +++ b/docs/content/support/official.md @@ -11,24 +11,4 @@ These platforms are tested to work (with caveats, see below) and issues on these Furthermore, binaries are expected to be built and tested using the most recent version of stable Rust - if you are manually building 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 admin privileges in some cases to get data. -- The battery widget seems to have issues with dual battery systems, like some Thinkpads. -- 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 - -- The process widget may require elevated access (ex: `sudo btm`) to gather all data in some cases. _Please note that you should be certain that you trust any software you grant root privileges._ +If you encounter any issues, see the [troubleshooting page](../troubleshooting.md) or open an issue/discussion on GitHub. diff --git a/docs/content/support/unofficial.md b/docs/content/support/unofficial.md index d7f7ac7a..4fb745e8 100644 --- a/docs/content/support/unofficial.md +++ b/docs/content/support/unofficial.md @@ -11,6 +11,4 @@ Unofficially supported platforms known to compile/work: - Linux on PowerPC 64 LE (tested to compile in [CI](https://github.com/ClementTsang/bottom/blob/main/.github/workflows/ci.yml)) - Linux on an RISC-V (tested to compile in [CI](https://github.com/ClementTsang/bottom/blob/main/.github/workflows/ci.yml), tested to run on an [Allwinner D1 Nezha](https://github.com/ClementTsang/bottom/issues/564)) -## Known problems - -None at the moment. +If you encounter any issues, see the [troubleshooting page](../troubleshooting.md) or open an issue/discussion on GitHub - though as mentioned, unsupported platforms may go unfixed. diff --git a/docs/content/troubleshooting.md b/docs/content/troubleshooting.md index 4e178ca5..a1664e7c 100644 --- a/docs/content/troubleshooting.md +++ b/docs/content/troubleshooting.md @@ -1,4 +1,4 @@ -# Troubleshooting +# Troubleshooting/Known Issues ## The graph points look broken/strange @@ -78,11 +78,6 @@ Let's say you're installing [Iosevka](https://github.com/be5invis/Iosevka). The Setting a new font in Command Prompt/PowerShell -### Still having issues? - -If you're still having issues, feel free to open a [discussion](https://github.com/ClementTsang/bottom/discussions/new/) -question about it, and I (or others) can try to help. - ## Why can't I see all my temperature sensors on Windows? This is a [known limitation](./support/official.md#windows), some sensors may require admin privileges to get sensor data. @@ -171,3 +166,14 @@ sudo snap connect bottom:hardware-observe sudo snap connect bottom:system-observe sudo snap connect bottom:process-control ``` + +## I don't see any NVIDIA GPU information while using a musl-based binary + +The underlying interface we use for NVIDIA GPU information, nvml, only works with `glibc` and does not work with `musl` at the moment (see [this forum post](https://forums.developer.nvidia.com/t/provide-driver-for-muslc-to-install-it-in-musl-distros/219586/7) for some more details). As such, bottom may fail to get NVIDIA GPU information when using a musl-based binary until this is resolved. This applies to Linux and Windows from my understanding. + +To resolve this, use `glibc`-based binary builds if possible (e.g. the `gnu` binaries/non-`musl` packages in [releases](https://github.com/ClementTsang/bottom/releases)). + +## Still having issues? + +If you're still having issues, feel free to open a [discussion](https://github.com/ClementTsang/bottom/discussions/new/) +question about it, and I (or others) can try to help.