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/tasks/trackpoint.nix | |
parent | 52b0ad17e3727fe0c3ca028787128ede5fb86352 (diff) | |
download | nixpkgs-2e751c0772b9d48ff6923569adfa661b030ab6a2.tar nixpkgs-2e751c0772b9d48ff6923569adfa661b030ab6a2.tar.gz nixpkgs-2e751c0772b9d48ff6923569adfa661b030ab6a2.tar.bz2 nixpkgs-2e751c0772b9d48ff6923569adfa661b030ab6a2.tar.lz nixpkgs-2e751c0772b9d48ff6923569adfa661b030ab6a2.tar.xz nixpkgs-2e751c0772b9d48ff6923569adfa661b030ab6a2.tar.zst nixpkgs-2e751c0772b9d48ff6923569adfa661b030ab6a2.zip |
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/tasks/trackpoint.nix')
-rw-r--r-- | nixos/modules/tasks/trackpoint.nix | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/nixos/modules/tasks/trackpoint.nix b/nixos/modules/tasks/trackpoint.nix index 029d8a00295..d197a0feb33 100644 --- a/nixos/modules/tasks/trackpoint.nix +++ b/nixos/modules/tasks/trackpoint.nix @@ -12,7 +12,7 @@ with lib; enable = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Enable sensitivity and speed configuration for trackpoints. ''; }; @@ -21,7 +21,7 @@ with lib; default = 128; example = 255; type = types.int; - description = '' + description = lib.mdDoc '' Configure the trackpoint sensitivity. By default, the kernel configures 128. ''; @@ -31,7 +31,7 @@ with lib; default = 97; example = 255; type = types.int; - description = '' + description = lib.mdDoc '' Configure the trackpoint speed. By default, the kernel configures 97. ''; @@ -40,7 +40,7 @@ with lib; emulateWheel = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Enable scrolling while holding the middle mouse button. ''; }; @@ -48,7 +48,7 @@ with lib; fakeButtons = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Switch to "bare" PS/2 mouse support in case Trackpoint buttons are not recognized properly. This can happen for example on models like the L430, T450, T450s, on which the Trackpoint buttons are actually a part of the Synaptics touchpad. @@ -58,7 +58,7 @@ with lib; device = mkOption { default = "TPPS/2 IBM TrackPoint"; type = types.str; - description = '' + description = lib.mdDoc '' The device name of the trackpoint. You can check with xinput. Some newer devices (example x1c6) use "TPPS/2 Elan TrackPoint". ''; |