diff options
author | pennae <github@quasiparticle.net> | 2022-07-28 23:19:15 +0200 |
---|---|---|
committer | pennae <github@quasiparticle.net> | 2022-07-30 15:16:34 +0200 |
commit | 2e751c0772b9d48ff6923569adfa661b030ab6a2 (patch) | |
tree | 0accd740380b7b7fe3ea5965a3a4517674e79260 /nixos/modules/misc/locate.nix | |
parent | 52b0ad17e3727fe0c3ca028787128ede5fb86352 (diff) |
treewide: automatically md-convert option descriptions
the conversion procedure is simple: - find all things that look like options, ie calls to either `mkOption` or `lib.mkOption` that take an attrset. remember the attrset as the option - for all options, find a `description` attribute who's value is not a call to `mdDoc` or `lib.mdDoc` - textually convert the entire value of the attribute to MD with a few simple regexes (the set from mdize-module.sh) - if the change produced a change in the manual output, discard - if the change kept the manual unchanged, add some text to the description to make sure we've actually found an option. if the manual changes this time, keep the converted description this procedure converts 80% of nixos options to markdown. around 2000 options remain to be inspected, but most of those fail the "does not change the manual output check": currently the MD conversion process does not faithfully convert docbook tags like <code> and <package>, so any option using such tags will not be converted at all.
Diffstat (limited to 'nixos/modules/misc/locate.nix')
-rw-r--r-- | nixos/modules/misc/locate.nix | 24 |
1 files changed, 12 insertions, 12 deletions
diff --git a/nixos/modules/misc/locate.nix b/nixos/modules/misc/locate.nix index 50495eebe4c29..bba35b752c9ab 100644 --- a/nixos/modules/misc/locate.nix +++ b/nixos/modules/misc/locate.nix @@ -19,9 +19,9 @@ 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. ''; }; @@ -30,7 +30,7 @@ in default = pkgs.findutils.locate; defaultText = literalExpression "pkgs.findutils"; example = literalExpression "pkgs.mlocate"; - description = '' + description = lib.mdDoc '' The locate implementation to use ''; }; @@ -55,15 +55,15 @@ in 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 +71,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 +159,7 @@ in "vboxsf" "vperfctrfs" ]; - description = '' + description = lib.mdDoc '' Which filesystem types to exclude from indexing ''; }; @@ -176,7 +176,7 @@ in "/nix/store" "/nix/var/log/nix" ]; - description = '' + description = lib.mdDoc '' Which paths to exclude from indexing ''; }; @@ -188,7 +188,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 +196,7 @@ in pruneBindMounts = mkOption { type = bool; default = false; - description = '' + description = lib.mdDoc '' Whether not to index bind mounts ''; }; |