nix/8.nix-darwin
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

treewide: remove lib.mdDoc

Browse source
This commit is contained in:
Weijia Wang 2024-04-14 23:02:32 +02:00
parent 99b3f9a1f5
commit def1e23be8
102 changed files with 771 additions and 775 deletions
Download patch file Download diff file Expand all files Collapse all files

6
modules/programs/bash/default.nix
View file

@ -12,19 +12,19 @@ in
programs.bash.enable = mkOption {
type = types.bool;
default = true;
description = lib.mdDoc "Whether to configure bash as an interactive shell.";
description = "Whether to configure bash as an interactive shell.";
};
programs.bash.interactiveShellInit = mkOption {
default = "";
description = lib.mdDoc "Shell script code called during interactive bash shell initialisation.";
description = "Shell script code called during interactive bash shell initialisation.";
type = types.lines;
};
programs.bash.enableCompletion = mkOption {
type = types.bool;
default = false;
description = lib.mdDoc ''
description = ''
Enable bash completion for all interactive bash shells.
NOTE. This doesn't work with bash 3.2, which is the default on macOS.

16
modules/programs/direnv.nix
View file

@ -11,11 +11,11 @@ in {
];
options.programs.direnv = {
enable = lib.mkEnableOption (lib.mdDoc ''
enable = lib.mkEnableOption ''
direnv integration. Takes care of both installation and
setting up the sourcing of the shell. Additionally enables nix-direnv
integration.
'');
'';
package = lib.mkPackageOptionMD pkgs "direnv" {};
@ -26,17 +26,17 @@ in {
export FOO="foo"
echo "loaded direnv!"
'';
description = lib.mdDoc ''
description = ''
Extra lines to append to the sourced direnvrc
'';
};
silent = lib.mkEnableOption (lib.mdDoc ''
silent = lib.mkEnableOption ''
the hiding of direnv logging
'');
'';
loadInNixShell =
lib.mkEnableOption (lib.mdDoc ''
(lib.mkEnableOption ''
loading direnv in `nix-shell` `nix shell` or `nix develop`
'')
// {
@ -45,9 +45,9 @@ in {
nix-direnv = {
enable =
(lib.mkEnableOption (lib.mdDoc ''
(lib.mkEnableOption ''
a faster, persistent implementation of use_nix and use_flake, to replace the built-in one
''))
'')
// {
default = true;
};

22
modules/programs/fish.nix
View file

@ -51,7 +51,7 @@ in
enable = mkOption {
default = false;
description = lib.mdDoc ''
description = ''
Whether to configure fish as an interactive shell.
'';
type = types.bool;
@ -60,7 +60,7 @@ in
useBabelfish = mkOption {
type = types.bool;
default = false;
description = lib.mdDoc ''
description = ''
If enabled, the configured environment will be translated to native fish using [babelfish](https://github.com/bouk/babelfish).
Otherwise, [foreign-env](https://github.com/oh-my-fish/plugin-foreign-env) will be used.
'';
@ -69,7 +69,7 @@ in
babelfishPackage = mkOption {
type = types.package;
default = pkgs.babelfish;
description = lib.mdDoc ''
description = ''
The babelfish package to use when useBabelfish is
set to true.
'';
@ -78,7 +78,7 @@ in
vendor.config.enable = mkOption {
type = types.bool;
default = true;
description = lib.mdDoc ''
description = ''
Whether fish should source configuration snippets provided by other packages.
'';
};
@ -86,7 +86,7 @@ in
vendor.completions.enable = mkOption {
type = types.bool;
default = true;
description = lib.mdDoc ''
description = ''
Whether fish should use completion files provided by other packages.
'';
};
@ -94,14 +94,14 @@ in
vendor.functions.enable = mkOption {
type = types.bool;
default = true;
description = lib.mdDoc ''
description = ''
Whether fish should autoload fish functions provided by other packages.
'';
};
shellAliases = mkOption {
default = config.environment.shellAliases;
description = lib.mdDoc ''
description = ''
Set of aliases for fish shell. See {option}`environment.shellAliases`
for an option format description.
'';
@ -110,7 +110,7 @@ in
shellInit = mkOption {
default = "";
description = lib.mdDoc ''
description = ''
Shell script code called during fish shell initialisation.
'';
type = types.lines;
@ -118,7 +118,7 @@ in
loginShellInit = mkOption {
default = "";
description = lib.mdDoc ''
description = ''
Shell script code called during fish login shell initialisation.
'';
type = types.lines;
@ -126,7 +126,7 @@ in
interactiveShellInit = mkOption {
default = "";
description = lib.mdDoc ''
description = ''
Shell script code called during interactive fish shell initialisation.
'';
type = types.lines;
@ -134,7 +134,7 @@ in
promptInit = mkOption {
default = "";
description = lib.mdDoc ''
description = ''
Shell script code used to initialise fish prompt.
'';
type = types.lines;

4
modules/programs/gnupg.nix
View file

@ -13,7 +13,7 @@ in
agent.enable = mkOption {
type = types.bool;
default = false;
description = lib.mdDoc ''
description = ''
Enables GnuPG agent for every user session.
'';
};
@ -21,7 +21,7 @@ in
agent.enableSSHSupport = mkOption {
type = types.bool;
default = false;
description = lib.mdDoc ''
description = ''
Enable SSH agent support in GnuPG agent. Also sets SSH_AUTH_SOCK
environment variable correctly.
'';

2
modules/programs/info/default.nix
View file

@ -11,7 +11,7 @@ in
programs.info.enable = mkOption {
type = types.bool;
default = true;
description = lib.mdDoc "Whether to enable info pages and the {command}`info` command.";
description = "Whether to enable info pages and the {command}`info` command.";
};
};

2
modules/programs/man.nix
View file

@ -8,7 +8,7 @@ with lib;
programs.man.enable = mkOption {
type = types.bool;
default = true;
description = lib.mdDoc ''
description = ''
Whether to enable manual pages and the {command}`man` command.
This also includes "man" outputs of all `systemPackages`.
'';

4
modules/programs/nix-index/default.nix
View file

@ -11,14 +11,14 @@ in
programs.nix-index.enable = mkOption {
type = types.bool;
default = false;
description = lib.mdDoc "Whether to enable nix-index and its command-not-found helper.";
description = "Whether to enable nix-index and its command-not-found helper.";
};
programs.nix-index.package = mkOption {
type = types.package;
default = pkgs.nix-index;
defaultText = "pkgs.nix-index";
description = lib.mdDoc "This option specifies the nix-index package to use.";
description = "This option specifies the nix-index package to use.";
};
};

14
modules/programs/ssh/default.nix
View file

@ -14,7 +14,7 @@ let
hostNames = mkOption {
type = types.listOf types.str;
default = [];
description = lib.mdDoc ''
description = ''
A list of host names and/or IP numbers used for accessing
the host's ssh service.
'';
@ -23,7 +23,7 @@ let
default = null;
type = types.nullOr types.str;
example = "ecdsa-sha2-nistp521 AAAAE2VjZHN...UEPg==";
description = lib.mdDoc ''
description = ''
The public key data for the host. You can fetch a public key
from a running SSH server with the {command}`ssh-keyscan`
command. The public key should not include any host names, only
@ -33,7 +33,7 @@ let
publicKeyFile = mkOption {
default = null;
type = types.nullOr types.path;
description = lib.mdDoc ''
description = ''
The path to the public key file for the host. The public
key file is read at build time and saved in the Nix store.
You can fetch a public key file from a running SSH server
@ -54,7 +54,7 @@ let
keys = mkOption {
type = types.listOf types.str;
default = [];
description = lib.mdDoc ''
description = ''
A list of verbatim OpenSSH public keys that should be added to the
user's authorized keys. The keys are added to a file that the SSH
daemon reads in addition to the the user's authorized_keys file.
@ -68,7 +68,7 @@ let
keyFiles = mkOption {
type = types.listOf types.path;
default = [];
description = lib.mdDoc ''
description = ''
A list of files each containing one OpenSSH public key that should be
added to the user's authorized keys. The contents of the files are
read at build time and added to a file that the SSH daemon reads in
@ -106,7 +106,7 @@ in
services.openssh.authorizedKeysFiles = mkOption {
type = types.listOf types.str;
default = [];
description = lib.mdDoc ''
description = ''
Specify the rules for which files to read on the host.
This is an advanced option. If you're looking to configure user
@ -122,7 +122,7 @@ in
programs.ssh.knownHosts = mkOption {
default = {};
type = types.attrsOf (types.submodule host);
description = lib.mdDoc ''
description = ''
The set of system-wide known SSH hosts.
'';
example = literalExpression ''

16
modules/programs/tmux.nix
View file

@ -46,47 +46,47 @@ in
programs.tmux.enable = mkOption {
type = types.bool;
default = false;
description = lib.mdDoc "Whether to configure tmux.";
description = "Whether to configure tmux.";
};
programs.tmux.enableSensible = mkOption {
type = types.bool;
default = false;
example = true;
description = lib.mdDoc "Enable sensible configuration options for tmux.";
description = "Enable sensible configuration options for tmux.";
};
programs.tmux.enableMouse = mkOption {
type = types.bool;
default = false;
example = true;
description = lib.mdDoc "Enable mouse support for tmux.";
description = "Enable mouse support for tmux.";
};
programs.tmux.enableFzf = mkOption {
type = types.bool;
default = false;
example = true;
description = lib.mdDoc "Enable fzf keybindings for selecting tmux sessions and panes.";
description = "Enable fzf keybindings for selecting tmux sessions and panes.";
};
programs.tmux.enableVim = mkOption {
type = types.bool;
default = false;
example = true;
description = lib.mdDoc "Enable vim style keybindings for copy mode, and navigation of tmux panes.";
description = "Enable vim style keybindings for copy mode, and navigation of tmux panes.";
};
programs.tmux.iTerm2 = mkOption {
type = types.bool;
default = false;
example = true;
description = lib.mdDoc "Cater to iTerm2 and its tmux integration, as appropriate.";
description = "Cater to iTerm2 and its tmux integration, as appropriate.";
};
programs.tmux.defaultCommand = mkOption {
type = types.either types.str types.package;
description = lib.mdDoc "The default command to use for tmux panes.";
description = "The default command to use for tmux panes.";
};
programs.tmux.tmuxOptions = mkOption {
@ -98,7 +98,7 @@ in
programs.tmux.extraConfig = mkOption {
type = types.lines;
default = "";
description = lib.mdDoc "Extra configuration to add to {file}`tmux.conf`.";
description = "Extra configuration to add to {file}`tmux.conf`.";
};
};

10
modules/programs/vim.nix
View file

@ -18,14 +18,14 @@ in
programs.vim.enable = mkOption {
type = types.bool;
default = false;
description = lib.mdDoc "Whether to configure vim.";
description = "Whether to configure vim.";
};
programs.vim.enableSensible = mkOption {
type = types.bool;
default = false;
example = true;
description = lib.mdDoc "Enable sensible configuration options for vim.";
description = "Enable sensible configuration options for vim.";
};
programs.vim.extraKnownPlugins = mkOption {
@ -46,14 +46,14 @@ in
};
}
'';
description = lib.mdDoc "Custom plugin declarations to add to VAM's knownPlugins.";
description = "Custom plugin declarations to add to VAM's knownPlugins.";
};
programs.vim.plugins = mkOption {
type = types.listOf types.attrs;
default = [];
example = [ { names = [ "surround" "vim-nix" ]; } ];
description = lib.mdDoc "VAM plugin dictionaries to use for vim_configurable.";
description = "VAM plugin dictionaries to use for vim_configurable.";
};
programs.vim.package = mkOption {
@ -70,7 +70,7 @@ in
programs.vim.vimConfig = mkOption {
type = types.lines;
default = "";
description = lib.mdDoc "Extra vimrcConfig to use for vim_configurable.";
description = "Extra vimrcConfig to use for vim_configurable.";
};
};

26
modules/programs/zsh/default.nix
View file

@ -19,13 +19,13 @@ in
programs.zsh.enable = mkOption {
type = types.bool;
default = false;
description = lib.mdDoc "Whether to configure zsh as an interactive shell.";
description = "Whether to configure zsh as an interactive shell.";
};
programs.zsh.variables = mkOption {
type = types.attrsOf (types.either types.str (types.listOf types.str));
default = {};
description = lib.mdDoc ''
description = ''
A set of environment variables used in the global environment.
These variables will be set on shell initialisation.
The value of each variable can be either a string or a list of
@ -38,44 +38,44 @@ in
programs.zsh.shellInit = mkOption {
type = types.lines;
default = "";
description = lib.mdDoc "Shell script code called during zsh shell initialisation.";
description = "Shell script code called during zsh shell initialisation.";
};
programs.zsh.loginShellInit = mkOption {
type = types.lines;
default = "";
description = lib.mdDoc "Shell script code called during zsh login shell initialisation.";
description = "Shell script code called during zsh login shell initialisation.";
};
programs.zsh.interactiveShellInit = mkOption {
type = types.lines;
default = "";
description = lib.mdDoc "Shell script code called during interactive zsh shell initialisation.";
description = "Shell script code called during interactive zsh shell initialisation.";
};
programs.zsh.promptInit = mkOption {
type = types.lines;
default = "autoload -U promptinit && promptinit && prompt walters && setopt prompt_sp";
description = lib.mdDoc "Shell script code used to initialise the zsh prompt.";
description = "Shell script code used to initialise the zsh prompt.";
};
programs.zsh.enableCompletion = mkOption {
type = types.bool;
default = true;
description = lib.mdDoc "Enable zsh completion for all interactive zsh shells.";
description = "Enable zsh completion for all interactive zsh shells.";
};
programs.zsh.enableBashCompletion = mkOption {
type = types.bool;
default = true;
description = lib.mdDoc "Enable bash completion for all interactive zsh shells.";
description = "Enable bash completion for all interactive zsh shells.";
};
programs.zsh.enableGlobalCompInit = mkOption {
type = types.bool;
default = cfg.enableCompletion;
defaultText = literalExpression "config.${opt.enableCompletion}";
description = lib.mdDoc ''
description = ''
Enable execution of compinit call for all interactive zsh shells.
This option can be disabled if the user wants to extend its
@ -87,25 +87,25 @@ in
programs.zsh.enableFzfCompletion = mkOption {
type = types.bool;
default = false;
description = lib.mdDoc "Enable fzf completion.";
description = "Enable fzf completion.";
};
programs.zsh.enableFzfGit = mkOption {
type = types.bool;
default = false;
description = lib.mdDoc "Enable fzf keybindings for C-g git browsing.";
description = "Enable fzf keybindings for C-g git browsing.";
};
programs.zsh.enableFzfHistory = mkOption {
type = types.bool;
default = false;
description = lib.mdDoc "Enable fzf keybinding for Ctrl-r history search.";
description = "Enable fzf keybinding for Ctrl-r history search.";
};
programs.zsh.enableSyntaxHighlighting = mkOption {
type = types.bool;
default = false;
description = lib.mdDoc "Enable zsh-syntax-highlighting.";
description = "Enable zsh-syntax-highlighting.";
};
};