nix-community / impermanence

Modules to help you handle persistent state on systems with ephemeral root storage [maintainer=@talyz]
MIT License
1.09k stars 80 forks source link

Add descriptions for module options #81

Closed crunchcat closed 2 years ago

crunchcat commented 2 years ago

A couple of the options in these modules lack a description field. This causes documentation builds to fail with default settings (documentation.nixos.options.warningsAreErrors defaults to true and missing descriptions cause warnings). If you wanna see the error I’m seeing, add documentation.nixos.includeAllModules = true; to a system configuration that includes the Impermanence module.

I also added the example to the new users option in the NixOS module that was in your commit message.