diff options
Diffstat (limited to 'nixpkgs/nixos/modules/misc/locate.nix')
-rw-r--r-- | nixpkgs/nixos/modules/misc/locate.nix | 37 |
1 files changed, 18 insertions, 19 deletions
diff --git a/nixpkgs/nixos/modules/misc/locate.nix b/nixpkgs/nixos/modules/misc/locate.nix index 204a89143008..b83e280b2846 100644 --- a/nixpkgs/nixos/modules/misc/locate.nix +++ b/nixpkgs/nixos/modules/misc/locate.nix @@ -19,18 +19,18 @@ in enable = mkOption { type = bool; default = false; - description = '' + description = lib.mdDoc '' If enabled, NixOS will periodically update the database of - files used by the <command>locate</command> command. + files used by the {command}`locate` command. ''; }; locate = mkOption { type = package; - default = pkgs.findutils; + default = pkgs.findutils.locate; defaultText = literalExpression "pkgs.findutils"; example = literalExpression "pkgs.mlocate"; - description = '' + description = lib.mdDoc '' The locate implementation to use ''; }; @@ -39,31 +39,30 @@ in type = str; default = "02:15"; example = "hourly"; - description = '' + description = lib.mdDoc '' Update the locate database at this interval. Updates by default at 2:15 AM every day. The format is described in - <citerefentry><refentrytitle>systemd.time</refentrytitle> - <manvolnum>7</manvolnum></citerefentry>. + {manpage}`systemd.time(7)`. - To disable automatic updates, set to <literal>"never"</literal> - and run <command>updatedb</command> manually. + To disable automatic updates, set to `"never"` + and run {command}`updatedb` manually. ''; }; extraFlags = mkOption { type = listOf str; default = [ ]; - description = '' - Extra flags to pass to <command>updatedb</command>. + description = lib.mdDoc '' + Extra flags to pass to {command}`updatedb`. ''; }; output = mkOption { type = path; default = "/var/cache/locatedb"; - description = '' + description = lib.mdDoc '' The database file to build. ''; }; @@ -71,9 +70,9 @@ in localuser = mkOption { type = nullOr str; default = "nobody"; - description = '' + description = lib.mdDoc '' The user to search non-network directories as, using - <command>su</command>. + {command}`su`. ''; }; @@ -159,7 +158,7 @@ in "vboxsf" "vperfctrfs" ]; - description = '' + description = lib.mdDoc '' Which filesystem types to exclude from indexing ''; }; @@ -176,7 +175,7 @@ in "/nix/store" "/nix/var/log/nix" ]; - description = '' + description = lib.mdDoc '' Which paths to exclude from indexing ''; }; @@ -188,7 +187,7 @@ in <literal>[ ".bzr" ".cache" ".git" ".hg" ".svn" ]</literal>, if supported by the locate implementation (i.e. mlocate or plocate). ''; - description = '' + description = lib.mdDoc '' Directory components which should exclude paths containing them from indexing ''; }; @@ -196,7 +195,7 @@ in pruneBindMounts = mkOption { type = bool; default = false; - description = '' + description = lib.mdDoc '' Whether not to index bind mounts ''; }; @@ -250,7 +249,7 @@ in }; warnings = optional (isMorPLocate && cfg.localuser != null) - "mlocate does not support the services.locate.localuser option; updatedb will run as root. (Silence with services.locate.localuser = null.)" + "mlocate and plocate do not support the services.locate.localuser option. updatedb will run as root. Silence this warning by setting services.locate.localuser = null." ++ optional (isFindutils && cfg.pruneNames != [ ]) "findutils locate does not support pruning by directory component" ++ optional (isFindutils && cfg.pruneBindMounts) |