system/systeroid
system/systeroid
1
0
Fork 0
mirror of https://github.com/orhun/systeroid synced 2024-10-01 13:13:32 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(readme): mention the environment variable for disabling the cache

Browse source
This commit is contained in:
Orhun Parmaksız 2022-03-18 15:55:21 +03:00
parent ef0edda75d
commit 7c48bc8a29
No known key found for this signature in database
GPG key ID: F83424824B3E4B90
1 changed files with 1 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
README.md
View file

@ -298,7 +298,7 @@ Kernel documentation should be present in one of the following paths for parsing
- `/usr/share/doc/linux-doc`
- `/usr/share/doc/linux-docs`
Then the parsed data is cached in `$HOME/.cache/systeroid-core` and used from there as long as the documentation is not updated.
Then the parsed data is cached in `$HOME/.cache/systeroid-core` and used from there as long as the documentation is not updated. The caching mechanism can be disabled via setting the `NOCACHE` environment variable.
This is a design choice due to the fact that different versions of kernels might be installed on different systems so the documentation might be too new or old if **systeroid** was to be shipped with a fixed set of parameter descriptions bundled in. With the parsing approach, documentation is always kept up-to-date.