mirror of
https://github.com/NixOS/nixpkgs.git
synced 2025-11-10 17:54:53 +01:00
2e751c0772
the conversion procedure is simple: - find all things that look like options, ie calls to either `mkOption` or `lib.mkOption` that take an attrset. remember the attrset as the option - for all options, find a `description` attribute who's value is not a call to `mdDoc` or `lib.mdDoc` - textually convert the entire value of the attribute to MD with a few simple regexes (the set from mdize-module.sh) - if the change produced a change in the manual output, discard - if the change kept the manual unchanged, add some text to the description to make sure we've actually found an option. if the manual changes this time, keep the converted description this procedure converts 80% of nixos options to markdown. around 2000 options remain to be inspected, but most of those fail the "does not change the manual output check": currently the MD conversion process does not faithfully convert docbook tags like <code> and <package>, so any option using such tags will not be converted at all.
55 lines
1.4 KiB
Nix
55 lines
1.4 KiB
Nix
{ config, lib, name, ... }:
|
|
let
|
|
inherit (lib) mkOption types;
|
|
in
|
|
{
|
|
options = {
|
|
|
|
proxyPass = mkOption {
|
|
type = with types; nullOr str;
|
|
default = null;
|
|
example = "http://www.example.org/";
|
|
description = lib.mdDoc ''
|
|
Sets up a simple reverse proxy as described by <https://httpd.apache.org/docs/2.4/howto/reverse_proxy.html#simple>.
|
|
'';
|
|
};
|
|
|
|
index = mkOption {
|
|
type = with types; nullOr str;
|
|
default = null;
|
|
example = "index.php index.html";
|
|
description = lib.mdDoc ''
|
|
Adds DirectoryIndex directive. See <https://httpd.apache.org/docs/2.4/mod/mod_dir.html#directoryindex>.
|
|
'';
|
|
};
|
|
|
|
alias = mkOption {
|
|
type = with types; nullOr path;
|
|
default = null;
|
|
example = "/your/alias/directory";
|
|
description = lib.mdDoc ''
|
|
Alias directory for requests. See <https://httpd.apache.org/docs/2.4/mod/mod_alias.html#alias>.
|
|
'';
|
|
};
|
|
|
|
extraConfig = mkOption {
|
|
type = types.lines;
|
|
default = "";
|
|
description = lib.mdDoc ''
|
|
These lines go to the end of the location verbatim.
|
|
'';
|
|
};
|
|
|
|
priority = mkOption {
|
|
type = types.int;
|
|
default = 1000;
|
|
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.
|
|
'';
|
|
};
|
|
|
|
};
|
|
}
|