movefasta/nixpkgs
1
0
Fork 0
mirror of https://github.com/NixOS/nixpkgs.git synced 2025-06-12 04:35:41 +03:00
Code Issues Projects Releases Packages Wiki Activity

nixos: remove all uses of lib.mdDoc

Browse source 
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
Download patch file Download diff file Expand all files Collapse all files

52
nixos/modules/services/web-apps/bookstack.nix
View file

@ -34,22 +34,22 @@ in {
options.services.bookstack = {
enable = mkEnableOption (lib.mdDoc "BookStack");
enable = mkEnableOption "BookStack";
user = mkOption {
default = "bookstack";
description = lib.mdDoc "User bookstack runs as.";
description = "User bookstack runs as.";
type = types.str;
};
group = mkOption {
default = "bookstack";
description = lib.mdDoc "Group bookstack runs as.";
description = "Group bookstack runs as.";
type = types.str;
};
appKeyFile = mkOption {
description = lib.mdDoc ''
description = ''
A file containing the Laravel APP_KEY - a 32 character long,
base64 encoded key used for encryption where needed. Can be
generated with `head -c 32 /dev/urandom | base64`.
@ -63,13 +63,13 @@ in {
default = config.networking.fqdnOrHostName;
defaultText = lib.literalExpression "config.networking.fqdnOrHostName";
example = "bookstack.example.com";
description = lib.mdDoc ''
description = ''
The hostname to serve BookStack on.
'';
};
appURL = mkOption {
description = lib.mdDoc ''
description = ''
The root URL that you want to host BookStack on. All URLs in BookStack will be generated using this value.
If you change this in the future you may need to run a command to update stored URLs in the database. Command example: `php artisan bookstack:update-url https://old.example.com https://new.example.com`
'';
@ -80,7 +80,7 @@ in {
};
dataDir = mkOption {
description = lib.mdDoc "BookStack data directory";
description = "BookStack data directory";
default = "/var/lib/bookstack";
type = types.path;
};
@ -89,29 +89,29 @@ in {
host = mkOption {
type = types.str;
default = "localhost";
description = lib.mdDoc "Database host address.";
description = "Database host address.";
};
port = mkOption {
type = types.port;
default = 3306;
description = lib.mdDoc "Database host port.";
description = "Database host port.";
};
name = mkOption {
type = types.str;
default = "bookstack";
description = lib.mdDoc "Database name.";
description = "Database name.";
};
user = mkOption {
type = types.str;
default = user;
defaultText = literalExpression "user";
description = lib.mdDoc "Database username.";
description = "Database username.";
};
passwordFile = mkOption {
type = with types; nullOr path;
default = null;
example = "/run/keys/bookstack-dbpassword";
description = lib.mdDoc ''
description = ''
A file containing the password corresponding to
{option}`database.user`.
'';
@ -119,7 +119,7 @@ in {
createLocally = mkOption {
type = types.bool;
default = false;
description = lib.mdDoc "Create the database and database user locally.";
description = "Create the database and database user locally.";
};
};
@ -127,39 +127,39 @@ in {
driver = mkOption {
type = types.enum [ "smtp" "sendmail" ];
default = "smtp";
description = lib.mdDoc "Mail driver to use.";
description = "Mail driver to use.";
};
host = mkOption {
type = types.str;
default = "localhost";
description = lib.mdDoc "Mail host address.";
description = "Mail host address.";
};
port = mkOption {
type = types.port;
default = 1025;
description = lib.mdDoc "Mail host port.";
description = "Mail host port.";
};
fromName = mkOption {
type = types.str;
default = "BookStack";
description = lib.mdDoc "Mail \"from\" name.";
description = "Mail \"from\" name.";
};
from = mkOption {
type = types.str;
default = "mail@bookstackapp.com";
description = lib.mdDoc "Mail \"from\" email.";
description = "Mail \"from\" email.";
};
user = mkOption {
type = with types; nullOr str;
default = null;
example = "bookstack";
description = lib.mdDoc "Mail username.";
description = "Mail username.";
};
passwordFile = mkOption {
type = with types; nullOr path;
default = null;
example = "/run/keys/bookstack-mailpassword";
description = lib.mdDoc ''
description = ''
A file containing the password corresponding to
{option}`mail.user`.
'';
@ -167,7 +167,7 @@ in {
encryption = mkOption {
type = with types; nullOr (enum [ "tls" ]);
default = null;
description = lib.mdDoc "SMTP encryption mechanism to use.";
description = "SMTP encryption mechanism to use.";
};
};
@ -175,7 +175,7 @@ in {
type = types.str;
default = "18M";
example = "1G";
description = lib.mdDoc "The maximum size for uploads (e.g. images).";
description = "The maximum size for uploads (e.g. images).";
};
poolConfig = mkOption {
@ -188,7 +188,7 @@ in {
"pm.max_spare_servers" = 4;
"pm.max_requests" = 500;
};
description = lib.mdDoc ''
description = ''
Options for the bookstack PHP pool. See the documentation on `php-fpm.conf`
for details on configuration directives.
'';
@ -210,7 +210,7 @@ in {
enableACME = true;
}
'';
description = lib.mdDoc ''
description = ''
With this option, you can customize the nginx virtualHost settings.
'';
};
@ -231,7 +231,7 @@ in {
options = {
_secret = mkOption {
type = nullOr str;
description = lib.mdDoc ''
description = ''
The path to a file containing the value the
option should be set to in the final
configuration file.
@ -253,7 +253,7 @@ in {
OIDC_ISSUER_DISCOVER = true;
}
'';
description = lib.mdDoc ''
description = ''
BookStack configuration options to set in the
{file}`.env` file.