Update readme

This commit is contained in:
Alexey Avramov 2020-12-31 23:48:22 +09:00
parent ce3c99225d
commit c6905072a6

View File

@ -64,7 +64,7 @@ Of course, you can also [download more RAM](https://downloadmoreram.com/), tune
- Low memory warnings. - Low memory warnings.
- [zram](https://www.kernel.org/doc/Documentation/blockdev/zram.txt) support (`mem_used_total` as a trigger); - [zram](https://www.kernel.org/doc/Documentation/blockdev/zram.txt) support (`mem_used_total` as a trigger);
- [PSI](https://lwn.net/Articles/759658/) ([pressure stall information](https://facebookmicrosites.github.io/psi/)) support; - [PSI](https://lwn.net/Articles/759658/) ([pressure stall information](https://facebookmicrosites.github.io/psi/)) support;
- Support for checking the OOM events in kmsg; - Optional checking kernel messages for OOM events;
- Easy setup with configuration files ([nohang.conf](https://github.com/hakavlad/nohang/blob/master/conf/nohang/nohang.conf.in), [nohang-desktop.conf](https://github.com/hakavlad/nohang/blob/master/conf/nohang/nohang-desktop.conf.in)). - Easy setup with configuration files ([nohang.conf](https://github.com/hakavlad/nohang/blob/master/conf/nohang/nohang.conf.in), [nohang-desktop.conf](https://github.com/hakavlad/nohang/blob/master/conf/nohang/nohang-desktop.conf.in)).
## Demo ## Demo
@ -148,10 +148,11 @@ $ sudo apt update
$ sudo apt install nohang $ sudo apt install nohang
$ sudo systemctl enable --now nohang-desktop.service $ sudo systemctl enable --now nohang-desktop.service
``` ```
Outdated and buggy nohang v0.1 release was packaged for [Debian 11](https://packages.debian.org/bullseye/source/nohang) and [Ubuntu 20.10](https://packages.ubuntu.com/source/groovy/nohang).
#### To install on Debian and Ubuntu-based systems: #### To install on Debian and Ubuntu-based systems:
Outdated and buggy nohang v0.1 release was packaged for [Debian 11](https://packages.debian.org/bullseye/source/nohang) and [Ubuntu 20.10](https://packages.ubuntu.com/source/groovy/nohang).
It's easy to build a deb package with the latest git snapshot. Install build dependencies: It's easy to build a deb package with the latest git snapshot. Install build dependencies:
```bash ```bash
$ sudo apt install make fakeroot $ sudo apt install make fakeroot
@ -256,18 +257,19 @@ optional arguments:
The program can be configured by editing the config file. The configuration includes the following sections: The program can be configured by editing the config file. The configuration includes the following sections:
1. Common zram settings 0. Checking kernel messages for OOM events;
2. Common PSI settings 1. Common zram settings;
3. Poll rate 2. Common PSI settings;
4. Warnings and notifications 3. Poll rate;
5. Soft threshold 4. Warnings and notifications;
6. Hard threshold 5. Soft threshold;
7. Customize victim selection 6. Hard threshold;
8. Customize soft corrective actions 7. Customize victim selection;
9. Misc settings 8. Customize soft corrective actions;
10. Verbosity, debug, logging 9. Misc settings;
10. Verbosity, debug, logging.
Just read the description of the parameters and edit the values. Please restart nohang to apply the changes. Just read the description of the parameters and edit the values. Please restart the daemon to apply the changes.
## How to test nohang ## How to test nohang