Skip to content

Commit

Permalink
Add note about bind_dir to README
Browse files Browse the repository at this point in the history
Signed-off-by: Ethan Dye <[email protected]>
  • Loading branch information
ecdye committed Dec 29, 2024
1 parent 3a50e1f commit 239b5fa
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ Don't make it much higher than the compression algorithm (and the additional zra
`swappiness` 150 because the improved performance of zram allows more usage without any adverse affects from the default of 60.
It can be raised up to 200 which will improve performance in high memory pressure situations.

`target_dir` is the directory you wish to hold in zram, and the original will be moved to a bind mount `bind_dir` and is synchronized on start, stop, and write commands.
`target_dir` is the directory you wish to hold in zram, and the original will be moved to a bind mount and is synchronized on start, stop, and write commands.

`oldlog_dir` will enable log-rotation to an off device directory while retaining only live logs in zram.
Usually in `/opt` or `/var`, name optional.
Expand Down Expand Up @@ -190,6 +190,14 @@ It is also common for VMs to not have implemented emulation in their kernel for
If you experience issues, it may be better to not use zram-config in your VM environment.
It is recommended to thoroughly test zram-config in your specific VM setup to ensure it meets your needs.

#### Removal of `bind_dir` in `ztab`

Older versions of zram-config included the option to manually configure a `bind_dir` in the `ztab`.
This functionality was removed in favor of automatically creating a bind mount as it is less confusing and more consistent with the rest of the code.

Checks are in place to automatically convert `ztab` to this new format.
If errors occur, you may need to manually edit `ztab` to fix any issues.

### Performance

LZO-RLE offers the best performance and is probably the best choice, and from kernel 5.1 and onward it is the default.
Expand Down

0 comments on commit 239b5fa

Please sign in to comment.