3
0
Fork 0
forked from mirrors/nixpkgs
nixpkgs/nixos/doc/manual
danbst 8d8a7210e4 zramSwap: allow configure compression algorithm + cleanups
- add `zramSwap.algorithm` option, which allows to change compressor
declaratively. zstd as default
- add `zramSwap.swapDevices` option, which allows to define how many zram
devices will be used as swap. Rest devices can be managed freely
- simpler floating calculations
- fix udev race condition
- some documentation changes
- replaced `/sys/block/zram*` handling with `zramctl`, because I had occasional
"Device is busy" error (looks like zram has to be configured in predefined order)
- added `memoryPercent` and `algorithm` as restart triggers. I think, it was
a bug that changing `memoryPercent` in configuration wasn't applied immediately.
- removed a bind to .swap device. While it looks natural (when swap device goes
off, so should zram device), it wasn't implemented properly. This caused problems
with swapon/swapoff:
```
$ cat /proc/swaps
Filename                                Type            Size    Used    Priority
/dev/zram0                              partition       8166024 0       -2
/var/swapfile                           file            5119996 5120    1

$ sudo swapoff -a

$ sudo swapon -a
swapon: /dev/zram0: read swap header failed

$ cat /proc/swaps
Filename                                Type            Size    Used    Priority
/var/swapfile                           file            5119996 0       1
```
2019-01-17 15:58:53 +02:00
..
administration postgresql*: use underscores in version numbers 2018-10-30 14:32:21 +00:00
configuration docs: Remove nix-repl references 2018-12-03 21:37:54 -05:00
development nixos tests doc: minor fixes 2018-11-26 19:36:50 +01:00
installation nixos/doc: Actually fix partitioning instructions. 2018-10-08 12:35:04 -04:00
release-notes zramSwap: allow configure compression algorithm + cleanups 2019-01-17 15:58:53 +02:00
.gitignore nixos docs: ignore generated files 2018-05-01 19:50:02 -04:00
default.nix nixos: doc: rename manual to manualHTML, cleanup references 2018-09-23 20:47:58 +00:00
Makefile nixos/doc: Adds sub-folder to input files. 2018-10-03 22:34:57 -04:00
man-configuration.xml nixos docs: format =) 2018-05-01 19:57:09 -04:00
man-nixos-build-vms.xml nixos/doc: ran make format 2018-05-31 21:03:51 -04:00
man-nixos-enter.xml nixos/doc: ran make format 2018-05-31 21:03:51 -04:00
man-nixos-generate-config.xml nixos: doc typo and ws 2018-11-16 22:44:55 +01:00
man-nixos-install.xml nixos/doc+man: Fixes squishedtogether definitions. 2018-05-31 21:07:15 -04:00
man-nixos-option.xml nixos/doc+man: Fixes squishedtogether definitions. 2018-05-31 21:07:15 -04:00
man-nixos-rebuild.xml nixos manual: fix a typo that made it invalid XML 2019-01-13 23:23:32 +01:00
man-nixos-version.xml nixos/doc: ran make format 2018-05-31 21:03:51 -04:00
man-pages.xml nixos docs: format =) 2018-05-01 19:57:09 -04:00
manual.xml docs: format 2018-09-29 20:51:11 -04:00
options-to-docbook.xsl nixos: Split paras by \n\n in option descriptions 2018-09-02 08:10:37 +02:00
postprocess-option-descriptions.xsl nixos: Split paras by \n\n in option descriptions 2018-09-02 08:10:37 +02:00
README nixos/doc/manual: Fix typos in README. 2014-07-23 15:00:25 +02:00
shell.nix doc: Adds xml fixing script. (see previous and next commits) 2018-05-31 21:02:15 -04:00

To build the manual, you need Nix installed on your system (no need
for NixOS). To install Nix, follow the instructions at

    https://nixos.org/nix/download.html

When you have Nix on your system, in the root directory of the project
(i.e., `nixpkgs`), run:

    nix-build nixos/release.nix -A manual.x86_64-linux

When this command successfully finishes, it will tell you where the
manual got generated.