movefasta/nixpkgs
1
0
Fork 0
mirror of https://github.com/NixOS/nixpkgs.git synced 2025-06-12 12:45:27 +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

41
nixos/modules/services/web-servers/apache-httpd/default.nix
View file

@ -404,7 +404,7 @@ in
services.httpd = {
enable = mkEnableOption (lib.mdDoc "the Apache HTTP Server");
enable = mkEnableOption "the Apache HTTP Server";
package = mkPackageOption pkgs "apacheHttpd" { };
@ -413,7 +413,7 @@ in
default = confFile;
defaultText = literalExpression "confFile";
example = literalExpression ''pkgs.writeText "httpd.conf" "# my custom config file ..."'';
description = lib.mdDoc ''
description = ''
Override the configuration file used by Apache. By default,
NixOS generates one automatically.
'';
@ -422,7 +422,7 @@ in
extraConfig = mkOption {
type = types.lines;
default = "";
description = lib.mdDoc ''
description = ''
Configuration lines appended to the generated Apache
configuration file. Note that this mechanism will not work
when {option}`configFile` is overridden.
@ -438,7 +438,7 @@ in
{ name = "jk"; path = "''${pkgs.tomcat_connectors}/modules/mod_jk.so"; }
]
'';
description = lib.mdDoc ''
description = ''
Additional Apache modules to be used. These can be
specified as a string in the case of modules distributed
with Apache, or as an attribute set specifying the
@ -451,14 +451,14 @@ in
type = types.nullOr types.str;
example = "admin@example.org";
default = null;
description = lib.mdDoc "E-mail address of the server administrator.";
description = "E-mail address of the server administrator.";
};
logFormat = mkOption {
type = types.str;
default = "common";
example = "combined";
description = lib.mdDoc ''
description = ''
Log format for log files. Possible values are: combined, common, referer, agent, none.
See <https://httpd.apache.org/docs/2.4/logs.html> for more details.
'';
@ -467,7 +467,7 @@ in
logPerVirtualHost = mkOption {
type = types.bool;
default = true;
description = lib.mdDoc ''
description = ''
If enabled, each virtual host gets its own
{file}`access.log` and
{file}`error.log`, namely suffixed by the
@ -478,7 +478,7 @@ in
user = mkOption {
type = types.str;
default = "wwwrun";
description = lib.mdDoc ''
description = ''
User account under which httpd children processes run.
If you require the main httpd process to run as
@ -492,7 +492,7 @@ in
group = mkOption {
type = types.str;
default = "wwwrun";
description = lib.mdDoc ''
description = ''
Group under which httpd children processes run.
'';
};
@ -500,7 +500,7 @@ in
logDir = mkOption {
type = types.path;
default = "/var/log/httpd";
description = lib.mdDoc ''
description = ''
Directory for Apache's log files. It is created automatically.
'';
};
@ -531,7 +531,7 @@ in
};
}
'';
description = lib.mdDoc ''
description = ''
Specification of the virtual hosts served by Apache. Each
element should be an attribute set specifying the
configuration of the virtual host.
@ -541,13 +541,13 @@ in
enableMellon = mkOption {
type = types.bool;
default = false;
description = lib.mdDoc "Whether to enable the mod_auth_mellon module.";
description = "Whether to enable the mod_auth_mellon module.";
};
enablePHP = mkOption {
type = types.bool;
default = false;
description = lib.mdDoc "Whether to enable the PHP module.";
description = "Whether to enable the PHP module.";
};
phpPackage = mkPackageOption pkgs "php" { };
@ -555,7 +555,7 @@ in
enablePerl = mkOption {
type = types.bool;
default = false;
description = lib.mdDoc "Whether to enable the Perl module (mod_perl).";
description = "Whether to enable the Perl module (mod_perl).";
};
phpOptions = mkOption {
@ -565,7 +565,7 @@ in
''
date.timezone = "CET"
'';
description = lib.mdDoc ''
description = ''
Options appended to the PHP configuration file {file}`php.ini`.
'';
};
@ -574,8 +574,7 @@ in
type = types.enum [ "event" "prefork" "worker" ];
default = "event";
example = "worker";
description =
lib.mdDoc ''
description = ''
Multi-processing module to be used by Apache. Available
modules are `prefork` (handles each
request in a separate child process), `worker`
@ -590,14 +589,14 @@ in
type = types.int;
default = 150;
example = 8;
description = lib.mdDoc "Maximum number of httpd processes (prefork)";
description = "Maximum number of httpd processes (prefork)";
};
maxRequestsPerChild = mkOption {
type = types.int;
default = 0;
example = 500;
description = lib.mdDoc ''
description = ''
Maximum number of httpd requests answered per httpd child (prefork), 0 means unlimited.
'';
};
@ -605,14 +604,14 @@ in
sslCiphers = mkOption {
type = types.str;
default = "HIGH:!aNULL:!MD5:!EXP";
description = lib.mdDoc "Cipher Suite available for negotiation in SSL proxy handshake.";
description = "Cipher Suite available for negotiation in SSL proxy handshake.";
};
sslProtocols = mkOption {
type = types.str;
default = "All -SSLv2 -SSLv3 -TLSv1 -TLSv1.1";
example = "All -SSLv2 -SSLv3";
description = lib.mdDoc "Allowed SSL/TLS protocol versions.";
description = "Allowed SSL/TLS protocol versions.";
};
};

10
nixos/modules/services/web-servers/apache-httpd/location-options.nix
View file

@ -9,7 +9,7 @@ in
type = with types; nullOr str;
default = null;
example = "http://www.example.org/";
description = lib.mdDoc ''
description = ''
Sets up a simple reverse proxy as described by <https://httpd.apache.org/docs/2.4/howto/reverse_proxy.html#simple>.
'';
};
@ -18,7 +18,7 @@ in
type = with types; nullOr str;
default = null;
example = "index.php index.html";
description = lib.mdDoc ''
description = ''
Adds DirectoryIndex directive. See <https://httpd.apache.org/docs/2.4/mod/mod_dir.html#directoryindex>.
'';
};
@ -27,7 +27,7 @@ in
type = with types; nullOr path;
default = null;
example = "/your/alias/directory";
description = lib.mdDoc ''
description = ''
Alias directory for requests. See <https://httpd.apache.org/docs/2.4/mod/mod_alias.html#alias>.
'';
};
@ -35,7 +35,7 @@ in
extraConfig = mkOption {
type = types.lines;
default = "";
description = lib.mdDoc ''
description = ''
These lines go to the end of the location verbatim.
'';
};
@ -43,7 +43,7 @@ in
priority = mkOption {
type = types.int;
default = 1000;
description = lib.mdDoc ''
description = ''
Order of this location block in relation to the others in the vhost.
The semantics are the same as with `lib.mkOrder`. Smaller values have
a greater priority.

54
nixos/modules/services/web-servers/apache-httpd/vhost-options.nix
View file

@ -8,14 +8,14 @@ in
hostName = mkOption {
type = types.str;
default = name;
description = lib.mdDoc "Canonical hostname for the server.";
description = "Canonical hostname for the server.";
};
serverAliases = mkOption {
type = types.listOf types.str;
default = [];
example = ["www.example.org" "www.example.org:8080" "example.org"];
description = lib.mdDoc ''
description = ''
Additional names of virtual hosts served by this virtual host configuration.
'';
};
@ -25,17 +25,17 @@ in
options = {
port = mkOption {
type = types.port;
description = lib.mdDoc "Port to listen on";
description = "Port to listen on";
};
ip = mkOption {
type = types.str;
default = "*";
description = lib.mdDoc "IP to listen on. 0.0.0.0 for IPv4 only, * for all.";
description = "IP to listen on. 0.0.0.0 for IPv4 only, * for all.";
};
ssl = mkOption {
type = types.bool;
default = false;
description = lib.mdDoc "Whether to enable SSL (https) support.";
description = "Whether to enable SSL (https) support.";
};
};
}));
@ -45,7 +45,7 @@ in
{ ip = "192.154.1.1"; port = 80; }
{ ip = "*"; port = 8080; }
];
description = lib.mdDoc ''
description = ''
Listen addresses and ports for this virtual host.
::: {.note}
@ -59,7 +59,7 @@ in
listenAddresses = mkOption {
type = with types; nonEmptyListOf str;
description = lib.mdDoc ''
description = ''
Listen addresses for this virtual host.
Compared to `listen` this only sets the addresses
and the ports are chosen automatically.
@ -77,7 +77,7 @@ in
addSSL = mkOption {
type = types.bool;
default = false;
description = lib.mdDoc ''
description = ''
Whether to enable HTTPS in addition to plain HTTP. This will set defaults for
`listen` to listen on all interfaces on the respective default
ports (80, 443).
@ -87,7 +87,7 @@ in
onlySSL = mkOption {
type = types.bool;
default = false;
description = lib.mdDoc ''
description = ''
Whether to enable HTTPS and reject plain HTTP connections. This will set
defaults for `listen` to listen on all interfaces on port 443.
'';
@ -96,7 +96,7 @@ in
forceSSL = mkOption {
type = types.bool;
default = false;
description = lib.mdDoc ''
description = ''
Whether to add a separate nginx server block that permanently redirects (301)
all plain HTTP traffic to HTTPS. This will set defaults for
`listen` to listen on all interfaces on the respective default
@ -107,7 +107,7 @@ in
enableACME = mkOption {
type = types.bool;
default = false;
description = lib.mdDoc ''
description = ''
Whether to ask Let's Encrypt to sign a certificate for this vhost.
Alternately, you can use an existing certificate through {option}`useACMEHost`.
'';
@ -116,7 +116,7 @@ in
useACMEHost = mkOption {
type = types.nullOr types.str;
default = null;
description = lib.mdDoc ''
description = ''
A host of an existing Let's Encrypt certificate to use.
This is useful if you have many subdomains and want to avoid hitting the
[rate limit](https://letsencrypt.org/docs/rate-limits).
@ -128,7 +128,7 @@ in
acmeRoot = mkOption {
type = types.nullOr types.str;
default = "/var/lib/acme/acme-challenge";
description = lib.mdDoc ''
description = ''
Directory for the acme challenge which is PUBLIC, don't put certs or keys in here.
Set to null to inherit from config.security.acme.
'';
@ -137,26 +137,26 @@ in
sslServerCert = mkOption {
type = types.path;
example = "/var/host.cert";
description = lib.mdDoc "Path to server SSL certificate.";
description = "Path to server SSL certificate.";
};
sslServerKey = mkOption {
type = types.path;
example = "/var/host.key";
description = lib.mdDoc "Path to server SSL certificate key.";
description = "Path to server SSL certificate key.";
};
sslServerChain = mkOption {
type = types.nullOr types.path;
default = null;
example = "/var/ca.pem";
description = lib.mdDoc "Path to server SSL chain file.";
description = "Path to server SSL chain file.";
};
http2 = mkOption {
type = types.bool;
default = true;
description = lib.mdDoc ''
description = ''
Whether to enable HTTP 2. HTTP/2 is supported in all multi-processing modules that come with httpd. *However, if you use the prefork mpm, there will
be severe restrictions.* Refer to <https://httpd.apache.org/docs/2.4/howto/http2.html#mpm-config> for details.
'';
@ -166,14 +166,14 @@ in
type = types.nullOr types.str;
default = null;
example = "admin@example.org";
description = lib.mdDoc "E-mail address of the server administrator.";
description = "E-mail address of the server administrator.";
};
documentRoot = mkOption {
type = types.nullOr types.path;
default = null;
example = "/data/webserver/docs";
description = lib.mdDoc ''
description = ''
The path of Apache's document root directory. If left undefined,
an empty directory in the Nix store will be used as root.
'';
@ -187,7 +187,7 @@ in
dir = "/home/eelco/Dev/nix-homepage";
}
];
description = lib.mdDoc ''
description = ''
This option provides a simple way to serve static directories.
'';
};
@ -200,7 +200,7 @@ in
file = "/home/eelco/some-file.png";
}
];
description = lib.mdDoc ''
description = ''
This option provides a simple way to serve individual, static files.
::: {.note}
@ -220,7 +220,7 @@ in
AllowOverride All
</Directory>
'';
description = lib.mdDoc ''
description = ''
These lines go to httpd.conf verbatim. They will go after
directories and directory aliases defined by default.
'';
@ -229,7 +229,7 @@ in
enableUserDir = mkOption {
type = types.bool;
default = false;
description = lib.mdDoc ''
description = ''
Whether to enable serving {file}`~/public_html` as
`/~«username»`.
'';
@ -239,7 +239,7 @@ in
type = types.nullOr types.str;
default = null;
example = "http://newserver.example.org/";
description = lib.mdDoc ''
description = ''
If set, all requests for this host are redirected permanently to
the given URL.
'';
@ -249,7 +249,7 @@ in
type = types.str;
default = "common";
example = "combined";
description = lib.mdDoc ''
description = ''
Log format for Apache's log files. Possible values are: combined, common, referer, agent.
'';
};
@ -258,7 +258,7 @@ in
type = types.lines;
default = "";
example = "Disallow: /foo/";
description = lib.mdDoc ''
description = ''
Specification of pages to be ignored by web crawlers. See <http://www.robotstxt.org/> for details.
'';
};
@ -276,7 +276,7 @@ in
};
};
'';
description = lib.mdDoc ''
description = ''
Declarative location config. See <https://httpd.apache.org/docs/2.4/mod/core.html#location> for details.
'';
};