Skip to content

Commit

Permalink
Add note about VM compatibility to README.md (#117)
Browse files Browse the repository at this point in the history
Fixes #116

Signed-off-by: Ethan Dye <[email protected]>
  • Loading branch information
ecdye committed Aug 6, 2024
1 parent 49dc1e1 commit 203ae24
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ Experimental Alpine support has also been added, other distributions may work bu
- [Swapiness on older Linux kernel versions](#swapiness-on-older-linux-kernel-versions)
- [Raspberry Pi 4 8GB compatibility](#raspberry-pi-4-8gb-compatibility)
- [Filesystem compatibility](#filesystem-compatibility)
- [Compatibility issues in virtual machines](#compatibility-issues-in-virtual-machines)
7. [Performance](#performance)
8. [Reference](#reference)

Expand Down Expand Up @@ -201,6 +202,15 @@ In some cases, with niche filesystems some manual editing of the code may be req

Pull requests adding support for filesystems that don't work automatically are welcome.

#### Compatibility issues in virtual machines

When running zram-config in a virtual machine (VM), you may encounter compatibility issues due to the differences in how VMs handle memory and storage compared to physical hardware.
Performance may vary, and certain features might not work as expected.
It is also common for VMs to not have implemented emulation in their kernel for zram.
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.


### 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 203ae24

Please sign in to comment.