From 5e437cfbfc8f90f935125482a2edd5b31e5981cd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Zbigniew=20J=C4=99drzejewski-Szmek?= Date: Thu, 18 Jun 2020 11:30:24 +0200 Subject: [PATCH] Update documentation --- rust-zram-generator.spec | 15 ++++++++------- zram-generator.conf | 6 ++++++ 2 files changed, 14 insertions(+), 7 deletions(-) diff --git a/rust-zram-generator.spec b/rust-zram-generator.spec index f542fec..92f3d26 100644 --- a/rust-zram-generator.spec +++ b/rust-zram-generator.spec @@ -24,10 +24,11 @@ BuildRequires: rust-packaging BuildRequires: systemd-rpm-macros %global _description %{expand: -This is a systemd unit generator that creates a unit file to create a -zram device. To activate, copy -/usr/share/doc/zram-generator/zram-generator.conf.example to -/etc/systemd/zram-generator.conf and possibly edit to adjust the limits.} +This is a systemd unit generator that enables swap on zram. +(With zram, there is no physical swap device. Part of the avaialable RAM +is used to store compressed pages, essentially trading CPU cycles for memory.) + +To activate, install %{crate}-defaults subpackage.} %description %{_description} @@ -49,14 +50,14 @@ Recommends: util-linux %{_systemdgeneratordir}/zram-generator %{_unitdir}/swap-create@.service -%package -n %{crate}-default +%package -n %{crate}-defaults Summary: Default configuration for %{crate} BuildArch: noarch -%description -n %{crate}-default +%description -n %{crate}-defaults %{summary}. -%files +%files -n %{crate}-defaults %{_prefix}/lib/systemd/zram-generator.conf %endif diff --git a/zram-generator.conf b/zram-generator.conf index 507a0c4..1770e10 100644 --- a/zram-generator.conf +++ b/zram-generator.conf @@ -1 +1,7 @@ +# This config file enables a /dev/zram0 device with the default settings: +# — size — half of available RAM or 4GB, whichever is less +# — compression — most likely lzo-rle +# +# To disable, uninstall rust-zram-defaults or create empty +# /etc/systemd/zram-generator.conf file. [zram0]