0
0
Fork 0
mirror of https://github.com/NixOS/nixpkgs.git synced 2025-07-14 14:10:33 +03:00

nixos: remove all uses of lib.mdDoc

these changes were generated with nixq 0.0.2, by running

  nixq ">> lib.mdDoc[remove] Argument[keep]" --batchmode nixos/**.nix
  nixq ">> mdDoc[remove] Argument[keep]" --batchmode nixos/**.nix
  nixq ">> Inherit >> mdDoc[remove]" --batchmode nixos/**.nix

two mentions of the mdDoc function remain in nixos/, both of which
are inside of comments.

Since lib.mdDoc is already defined as just id, this commit is a no-op as
far as Nix (and the built manual) is concerned.
This commit is contained in:
stuebinm 2024-04-13 14:54:15 +02:00 committed by Jonathan Ringer
parent 1dd996e59a
commit 6afb255d97
1701 changed files with 13694 additions and 13865 deletions

View file

@ -72,14 +72,14 @@ in {
enable = mkOption {
type = types.bool;
default = false;
description = lib.mdDoc "Whenever to configure {command}`tmux` system-wide.";
description = "Whenever to configure {command}`tmux` system-wide.";
relatedPackages = [ "tmux" ];
};
aggressiveResize = mkOption {
default = false;
type = types.bool;
description = lib.mdDoc ''
description = ''
Resize the window to the size of the smallest session for which it is the current window.
'';
};
@ -88,31 +88,31 @@ in {
default = 0;
example = 1;
type = types.int;
description = lib.mdDoc "Base index for windows and panes.";
description = "Base index for windows and panes.";
};
clock24 = mkOption {
default = false;
type = types.bool;
description = lib.mdDoc "Use 24 hour clock.";
description = "Use 24 hour clock.";
};
customPaneNavigationAndResize = mkOption {
default = false;
type = types.bool;
description = lib.mdDoc "Override the hjkl and HJKL bindings for pane navigation and resizing in VI mode.";
description = "Override the hjkl and HJKL bindings for pane navigation and resizing in VI mode.";
};
escapeTime = mkOption {
default = 500;
example = 0;
type = types.int;
description = lib.mdDoc "Time in milliseconds for which tmux waits after an escape is input.";
description = "Time in milliseconds for which tmux waits after an escape is input.";
};
extraConfigBeforePlugins = mkOption {
default = "";
description = lib.mdDoc ''
description = ''
Additional contents of /etc/tmux.conf, to be run before sourcing plugins.
'';
type = types.lines;
@ -120,7 +120,7 @@ in {
extraConfig = mkOption {
default = "";
description = lib.mdDoc ''
description = ''
Additional contents of /etc/tmux.conf, to be run after sourcing plugins.
'';
type = types.lines;
@ -130,47 +130,47 @@ in {
default = 2000;
example = 5000;
type = types.int;
description = lib.mdDoc "Maximum number of lines held in window history.";
description = "Maximum number of lines held in window history.";
};
keyMode = mkOption {
default = defaultKeyMode;
example = "vi";
type = types.enum [ "emacs" "vi" ];
description = lib.mdDoc "VI or Emacs style shortcuts.";
description = "VI or Emacs style shortcuts.";
};
newSession = mkOption {
default = false;
type = types.bool;
description = lib.mdDoc "Automatically spawn a session if trying to attach and none are running.";
description = "Automatically spawn a session if trying to attach and none are running.";
};
reverseSplit = mkOption {
default = false;
type = types.bool;
description = lib.mdDoc "Reverse the window split shortcuts.";
description = "Reverse the window split shortcuts.";
};
resizeAmount = mkOption {
default = defaultResize;
example = 10;
type = types.int;
description = lib.mdDoc "Number of lines/columns when resizing.";
description = "Number of lines/columns when resizing.";
};
shortcut = mkOption {
default = defaultShortcut;
example = "a";
type = types.str;
description = lib.mdDoc "Ctrl following by this key is used as the main shortcut.";
description = "Ctrl following by this key is used as the main shortcut.";
};
terminal = mkOption {
default = defaultTerminal;
example = "screen-256color";
type = types.str;
description = lib.mdDoc ''
description = ''
Set the $TERM variable. Use tmux-direct if italics or 24bit true color
support is needed.
'';
@ -179,7 +179,7 @@ in {
secureSocket = mkOption {
default = true;
type = types.bool;
description = lib.mdDoc ''
description = ''
Store tmux socket under /run, which is more secure than /tmp, but as a
downside it doesn't survive user logout.
'';
@ -188,12 +188,12 @@ in {
plugins = mkOption {
default = [];
type = types.listOf types.package;
description = lib.mdDoc "List of plugins to install.";
description = "List of plugins to install.";
example = lib.literalExpression "[ pkgs.tmuxPlugins.nord ]";
};
withUtempter = mkOption {
description = lib.mdDoc ''
description = ''
Whether to enable libutempter for tmux.
This is required so that tmux can write to /var/run/utmp (which can be queried with `who` to display currently connected user sessions).
Note, this will add a guid wrapper for the group utmp!