treewide: remove now-redundant lib.mdDoc calls
These (and the `*MD` functions apart from `literalMD`) are now no-ops
in nixpkgs and serve no purpose other than to add additional noise and
potentially mislead people into thinking unmarked DocBook documentation
will still be accepted.
Note that if backporting changes including documentation to 23.05,
the `mdDoc` calls will need to be re-added.
To reproduce this commit, run:
$ NIX_PATH=nixpkgs=flake:nixpkgs/e7e69199f0372364a6106a1e735f68604f4c5a25 \
nix shell nixpkgs#coreutils \
-c find . -name '*.nix' \
-exec nix run -- github:emilazy/nix-doc-munge/98dadf1f77351c2ba5dcb709a2a171d655f15099 \
--strip {} +
$ ./format
This commit is contained in:
Emily
parent
7398af11b8
commit
9f9e277b60
360 changed files with 2672 additions and 2853 deletions
|
|
@ -62,7 +62,7 @@ let
|
|||
options = {
|
||||
key = mkOption {
|
||||
type = types.nullOr types.str;
|
||||
description = lib.mdDoc ''
|
||||
description = ''
|
||||
The default GPG signing key fingerprint.
|
||||
|
||||
Set to `null` to let GnuPG decide what signing key
|
||||
|
|
@ -73,15 +73,14 @@ let
|
|||
signByDefault = mkOption {
|
||||
type = types.bool;
|
||||
default = false;
|
||||
description =
|
||||
lib.mdDoc "Whether commits and tags should be signed by default.";
|
||||
description = "Whether commits and tags should be signed by default.";
|
||||
};
|
||||
|
||||
gpgPath = mkOption {
|
||||
type = types.str;
|
||||
default = "${pkgs.gnupg}/bin/gpg2";
|
||||
defaultText = "\${pkgs.gnupg}/bin/gpg2";
|
||||
description = lib.mdDoc "Path to GnuPG binary to use.";
|
||||
description = "Path to GnuPG binary to use.";
|
||||
};
|
||||
};
|
||||
};
|
||||
|
|
@ -91,7 +90,7 @@ let
|
|||
condition = mkOption {
|
||||
type = types.nullOr types.str;
|
||||
default = null;
|
||||
description = lib.mdDoc ''
|
||||
description = ''
|
||||
Include this configuration only when {var}`condition`
|
||||
matches. Allowed conditions are described in
|
||||
{manpage}`git-config(1)`.
|
||||
|
|
@ -100,7 +99,7 @@ let
|
|||
|
||||
path = mkOption {
|
||||
type = with types; either str path;
|
||||
description = lib.mdDoc "Path of the configuration file to include.";
|
||||
description = "Path of the configuration file to include.";
|
||||
};
|
||||
|
||||
contents = mkOption {
|
||||
|
|
@ -118,7 +117,7 @@ let
|
|||
};
|
||||
};
|
||||
'';
|
||||
description = lib.mdDoc ''
|
||||
description = ''
|
||||
Configuration to include. If empty then a path must be given.
|
||||
|
||||
This follows the configuration structure as described in
|
||||
|
|
@ -129,7 +128,7 @@ let
|
|||
contentSuffix = mkOption {
|
||||
type = types.str;
|
||||
default = "gitconfig";
|
||||
description = lib.mdDoc ''
|
||||
description = ''
|
||||
Nix store name for the git configuration text file,
|
||||
when generating the configuration text from nix options.
|
||||
'';
|
||||
|
|
@ -146,13 +145,13 @@ in {
|
|||
|
||||
options = {
|
||||
programs.git = {
|
||||
enable = mkEnableOption (lib.mdDoc "Git");
|
||||
enable = mkEnableOption "Git";
|
||||
|
||||
package = mkOption {
|
||||
type = types.package;
|
||||
default = pkgs.git;
|
||||
defaultText = literalExpression "pkgs.git";
|
||||
description = lib.mdDoc ''
|
||||
description = ''
|
||||
Git package to install. Use {var}`pkgs.gitAndTools.gitFull`
|
||||
to gain access to {command}`git send-email` for instance.
|
||||
'';
|
||||
|
|
@ -161,27 +160,26 @@ in {
|
|||
userName = mkOption {
|
||||
type = types.nullOr types.str;
|
||||
default = null;
|
||||
description = lib.mdDoc "Default user name to use.";
|
||||
description = "Default user name to use.";
|
||||
};
|
||||
|
||||
userEmail = mkOption {
|
||||
type = types.nullOr types.str;
|
||||
default = null;
|
||||
description = lib.mdDoc "Default user email to use.";
|
||||
description = "Default user email to use.";
|
||||
};
|
||||
|
||||
aliases = mkOption {
|
||||
type = types.attrsOf types.str;
|
||||
default = { };
|
||||
example = { co = "checkout"; };
|
||||
description = lib.mdDoc "Git aliases to define.";
|
||||
description = "Git aliases to define.";
|
||||
};
|
||||
|
||||
signing = mkOption {
|
||||
type = types.nullOr signModule;
|
||||
default = null;
|
||||
description =
|
||||
lib.mdDoc "Options related to signing commits using GnuPG.";
|
||||
description = "Options related to signing commits using GnuPG.";
|
||||
};
|
||||
|
||||
extraConfig = mkOption {
|
||||
|
|
@ -191,7 +189,7 @@ in {
|
|||
core = { whitespace = "trailing-space,space-before-tab"; };
|
||||
url."ssh://git@host".insteadOf = "otherhost";
|
||||
};
|
||||
description = lib.mdDoc ''
|
||||
description = ''
|
||||
Additional configuration to add. The use of string values is
|
||||
deprecated and will be removed in the future.
|
||||
'';
|
||||
|
|
@ -205,7 +203,7 @@ in {
|
|||
pre-commit = ./pre-commit-script;
|
||||
}
|
||||
'';
|
||||
description = lib.mdDoc ''
|
||||
description = ''
|
||||
Configuration helper for Git hooks.
|
||||
See <https://git-scm.com/docs/githooks>
|
||||
for reference.
|
||||
|
|
@ -221,15 +219,14 @@ in {
|
|||
type = types.listOf types.str;
|
||||
default = [ ];
|
||||
example = [ "*~" "*.swp" ];
|
||||
description =
|
||||
lib.mdDoc "List of paths that should be globally ignored.";
|
||||
description = "List of paths that should be globally ignored.";
|
||||
};
|
||||
|
||||
attributes = mkOption {
|
||||
type = types.listOf types.str;
|
||||
default = [ ];
|
||||
example = [ "*.pdf diff=pdf" ];
|
||||
description = lib.mdDoc "List of defining attributes set globally.";
|
||||
description = "List of defining attributes set globally.";
|
||||
};
|
||||
|
||||
includes = mkOption {
|
||||
|
|
@ -244,16 +241,16 @@ in {
|
|||
}
|
||||
]
|
||||
'';
|
||||
description = lib.mdDoc "List of configuration files to include.";
|
||||
description = "List of configuration files to include.";
|
||||
};
|
||||
|
||||
lfs = {
|
||||
enable = mkEnableOption (lib.mdDoc "Git Large File Storage");
|
||||
enable = mkEnableOption "Git Large File Storage";
|
||||
|
||||
skipSmudge = mkOption {
|
||||
type = types.bool;
|
||||
default = false;
|
||||
description = lib.mdDoc ''
|
||||
description = ''
|
||||
Skip automatic downloading of objects on clone or pull.
|
||||
This requires a manual {command}`git lfs pull`
|
||||
every time a new commit is checked out on your repository.
|
||||
|
|
@ -262,8 +259,8 @@ in {
|
|||
};
|
||||
|
||||
difftastic = {
|
||||
enable = mkEnableOption (lib.mdDoc "") // {
|
||||
description = lib.mdDoc ''
|
||||
enable = mkEnableOption "" // {
|
||||
description = ''
|
||||
Enable the {command}`difftastic` syntax highlighter.
|
||||
See <https://github.com/Wilfred/difftastic>.
|
||||
'';
|
||||
|
|
@ -273,7 +270,7 @@ in {
|
|||
type = types.enum [ "light" "dark" ];
|
||||
default = "light";
|
||||
example = "dark";
|
||||
description = lib.mdDoc ''
|
||||
description = ''
|
||||
Determines whether difftastic should use the lighter or darker colors
|
||||
for syntax highlighting.
|
||||
'';
|
||||
|
|
@ -283,7 +280,7 @@ in {
|
|||
type = types.enum [ "always" "auto" "never" ];
|
||||
default = "auto";
|
||||
example = "always";
|
||||
description = lib.mdDoc ''
|
||||
description = ''
|
||||
Determines when difftastic should color its output.
|
||||
'';
|
||||
};
|
||||
|
|
@ -293,21 +290,21 @@ in {
|
|||
types.enum [ "side-by-side" "side-by-side-show-both" "inline" ];
|
||||
default = "side-by-side";
|
||||
example = "inline";
|
||||
description = lib.mdDoc ''
|
||||
description = ''
|
||||
Determines how the output displays - in one column or two columns.
|
||||
'';
|
||||
};
|
||||
};
|
||||
|
||||
delta = {
|
||||
enable = mkEnableOption (lib.mdDoc "") // {
|
||||
description = lib.mdDoc ''
|
||||
enable = mkEnableOption "" // {
|
||||
description = ''
|
||||
Whether to enable the {command}`delta` syntax highlighter.
|
||||
See <https://github.com/dandavison/delta>.
|
||||
'';
|
||||
};
|
||||
|
||||
package = mkPackageOptionMD pkgs "delta" { };
|
||||
package = mkPackageOption pkgs "delta" { };
|
||||
|
||||
options = mkOption {
|
||||
type = with types;
|
||||
|
|
@ -325,15 +322,15 @@ in {
|
|||
file-decoration-style = "none";
|
||||
};
|
||||
};
|
||||
description = lib.mdDoc ''
|
||||
description = ''
|
||||
Options to configure delta.
|
||||
'';
|
||||
};
|
||||
};
|
||||
|
||||
diff-so-fancy = {
|
||||
enable = mkEnableOption (lib.mdDoc "") // {
|
||||
description = lib.mdDoc ''
|
||||
enable = mkEnableOption "" // {
|
||||
description = ''
|
||||
Enable the {command}`diff-so-fancy` diff colorizer.
|
||||
See <https://github.com/so-fancy/diff-so-fancy>.
|
||||
'';
|
||||
|
|
@ -342,7 +339,7 @@ in {
|
|||
pagerOpts = mkOption {
|
||||
type = types.listOf types.str;
|
||||
default = [ "--tabs=4" "-RFX" ];
|
||||
description = lib.mdDoc ''
|
||||
description = ''
|
||||
Arguments to be passed to {command}`less`.
|
||||
'';
|
||||
};
|
||||
|
|
@ -351,7 +348,7 @@ in {
|
|||
type = types.bool;
|
||||
default = true;
|
||||
example = false;
|
||||
description = lib.mdDoc ''
|
||||
description = ''
|
||||
Whether the first block of an empty line should be colored.
|
||||
'';
|
||||
};
|
||||
|
|
@ -360,7 +357,7 @@ in {
|
|||
type = types.bool;
|
||||
default = true;
|
||||
example = false;
|
||||
description = lib.mdDoc ''
|
||||
description = ''
|
||||
Simplify git header chunks to a more human readable format.
|
||||
'';
|
||||
};
|
||||
|
|
@ -369,7 +366,7 @@ in {
|
|||
type = types.bool;
|
||||
default = true;
|
||||
example = false;
|
||||
description = lib.mdDoc ''
|
||||
description = ''
|
||||
Whether the `+` or `-` at
|
||||
line-start should be removed.
|
||||
'';
|
||||
|
|
@ -379,7 +376,7 @@ in {
|
|||
type = types.bool;
|
||||
default = true;
|
||||
example = false;
|
||||
description = lib.mdDoc ''
|
||||
description = ''
|
||||
By default, the separator for the file header uses Unicode
|
||||
line-drawing characters. If this is causing output errors on
|
||||
your terminal, set this to false to use ASCII characters instead.
|
||||
|
|
@ -390,7 +387,7 @@ in {
|
|||
type = types.nullOr types.int;
|
||||
default = null;
|
||||
example = false;
|
||||
description = lib.mdDoc ''
|
||||
description = ''
|
||||
By default, the separator for the file header spans the full
|
||||
width of the terminal. Use this setting to set the width of
|
||||
the file header manually.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue