Skip to content

Commit

Permalink
Merge pull request #932 from wegank/mddoc-remove
Browse files Browse the repository at this point in the history
treewide: remove lib.mdDoc
  • Loading branch information
Enzime authored Apr 19, 2024
2 parents eb25dc6 + def1e23 commit 9e7c20f
Show file tree
Hide file tree
Showing 102 changed files with 771 additions and 775 deletions.
8 changes: 4 additions & 4 deletions modules/documentation/default.nix
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ in
documentation.enable = mkOption {
type = types.bool;
default = true;
description = lib.mdDoc ''
description = ''
Whether to install documentation of packages from
{option}`environment.systemPackages` into the generated system path.
Expand All @@ -100,7 +100,7 @@ in
documentation.man.enable = mkOption {
type = types.bool;
default = true;
description = lib.mdDoc ''
description = ''
Whether to install manual pages and the {command}`man` command.
This also includes "man" outputs.
'';
Expand All @@ -109,7 +109,7 @@ in
documentation.info.enable = mkOption {
type = types.bool;
default = true;
description = lib.mdDoc ''
description = ''
Whether to install info pages and the {command}`info` command.
This also includes "info" outputs.
'';
Expand All @@ -118,7 +118,7 @@ in
documentation.doc.enable = mkOption {
type = types.bool;
default = true;
description = lib.mdDoc ''
description = ''
Whether to install documentation distributed in packages' `/share/doc`.
Usually plain text and/or HTML.
This also includes "doc" outputs.
Expand Down
28 changes: 14 additions & 14 deletions modules/environment/default.nix
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ in
type = types.listOf types.package;
default = [];
example = literalExpression "[ pkgs.curl pkgs.vim ]";
description = lib.mdDoc ''
description = ''
The set of packages that appear in
/run/current-system/sw. These packages are
automatically available to all users, and are
Expand All @@ -34,39 +34,39 @@ in

environment.systemPath = mkOption {
type = types.listOf (types.either types.path types.str);
description = lib.mdDoc "The set of paths that are added to PATH.";
description = "The set of paths that are added to PATH.";
apply = x: if isList x then makeDrvBinPath x else x;
};

environment.profiles = mkOption {
type = types.listOf types.str;
description = lib.mdDoc "A list of profiles used to setup the global environment.";
description = "A list of profiles used to setup the global environment.";
};

environment.postBuild = mkOption {
type = types.lines;
default = "";
description = lib.mdDoc "Commands to execute when building the global environment.";
description = "Commands to execute when building the global environment.";
};

environment.extraOutputsToInstall = mkOption {
type = types.listOf types.str;
default = [];
example = [ "doc" "info" "devdoc" ];
description = lib.mdDoc "List of additional package outputs to be symlinked into {file}`/run/current-system/sw`.";
description = "List of additional package outputs to be symlinked into {file}`/run/current-system/sw`.";
};

environment.pathsToLink = mkOption {
type = types.listOf types.str;
default = [];
example = [ "/share/doc" ];
description = lib.mdDoc "List of directories to be symlinked in {file}`/run/current-system/sw`.";
description = "List of directories to be symlinked in {file}`/run/current-system/sw`.";
};

environment.darwinConfig = mkOption {
type = types.either types.path types.str;
default = "$HOME/.nixpkgs/darwin-configuration.nix";
description = lib.mdDoc ''
description = ''
The path of the darwin configuration.nix used to configure the system,
this updates the default darwin-config entry in NIX_PATH. Since this
changes an environment variable it will only apply to new shells.
Expand All @@ -79,14 +79,14 @@ in
environment.loginShell = mkOption {
type = types.str;
default = "$SHELL -l";
description = lib.mdDoc "Configure default login shell.";
description = "Configure default login shell.";
};

environment.variables = mkOption {
type = types.attrsOf (types.either types.str (types.listOf types.str));
default = {};
example = { EDITOR = "vim"; LANG = "nl_NL.UTF-8"; };
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
Expand All @@ -100,7 +100,7 @@ in
type = types.attrsOf types.str;
default = {};
example = { ll = "ls -l"; };
description = lib.mdDoc ''
description = ''
An attribute set that maps aliases (the top level attribute names in
this option) to command strings or directly to build outputs. The
alises are added to all users' shells.
Expand All @@ -110,7 +110,7 @@ in
environment.extraInit = mkOption {
type = types.lines;
default = "";
description = lib.mdDoc ''
description = ''
Shell script code called during global environment initialisation
after all variables and profileVariables have been set.
This code is asumed to be shell-independent, which means you should
Expand All @@ -120,7 +120,7 @@ in

environment.shellInit = mkOption {
default = "";
description = lib.mdDoc ''
description = ''
Shell script code called during shell initialisation.
This code is asumed to be shell-independent, which means you should
stick to pure sh without sh word split.
Expand All @@ -130,7 +130,7 @@ in

environment.loginShellInit = mkOption {
default = "";
description = lib.mdDoc ''
description = ''
Shell script code called during login shell initialisation.
This code is asumed to be shell-independent, which means you should
stick to pure sh without sh word split.
Expand All @@ -140,7 +140,7 @@ in

environment.interactiveShellInit = mkOption {
default = "";
description = lib.mdDoc ''
description = ''
Shell script code called during interactive shell initialisation.
This code is asumed to be shell-independent, which means you should
stick to pure sh without sh word split.
Expand Down
4 changes: 2 additions & 2 deletions modules/fonts/default.nix
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ in
fonts.fontDir.enable = mkOption {
type = types.bool;
default = false;
description = lib.mdDoc ''
description = ''
Whether to enable font management and install configured fonts to
{file}`/Library/Fonts`.
Expand All @@ -27,7 +27,7 @@ in
type = types.listOf types.path;
default = [ ];
example = literalExpression "[ pkgs.dejavu_fonts ]";
description = lib.mdDoc ''
description = ''
List of fonts to install.
Fonts present in later entries override those with the same filenames
Expand Down
Loading

0 comments on commit 9e7c20f

Please sign in to comment.