movefasta/nixpkgs
0
0
Fork 0
mirror of https://github.com/NixOS/nixpkgs.git synced 2025-07-14 06:00:33 +03:00
Code Activity

treewide: automatically md-convert option descriptions

Browse source 
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.
This commit is contained in:
pennae 2022-07-28 23:19:15 +02:00
parent 52b0ad17e3
commit 2e751c0772
1050 changed files with 9605 additions and 9605 deletions
Download patch file Download diff file Expand all files Collapse all files

26
nixos/modules/services/networking/ssh/lshd.nix
View file

@ -21,7 +21,7 @@ in
enable = mkOption {
type = types.bool;
default = false;
description = ''
description = lib.mdDoc ''
Whether to enable the GNU lshd SSH2 daemon, which allows
secure remote login.
'';
@ -30,7 +30,7 @@ in
portNumber = mkOption {
default = 22;
type = types.port;
description = ''
description = lib.mdDoc ''
The port on which to listen for connections.
'';
};
@ -38,7 +38,7 @@ in
interfaces = mkOption {
default = [];
type = types.listOf types.str;
description = ''
description = lib.mdDoc ''
List of network interfaces where listening for connections.
When providing the empty list, `[]', lshd listens on all
network interfaces.
@ -49,7 +49,7 @@ in
hostKey = mkOption {
default = "/etc/lsh/host-key";
type = types.str;
description = ''
description = lib.mdDoc ''
Path to the server's private key. Note that this key must
have been created, e.g., using "lsh-keygen --server |
lsh-writekey --server", so that you can run lshd.
@ -59,31 +59,31 @@ in
syslog = mkOption {
type = types.bool;
default = true;
description = "Whether to enable syslog output.";
description = lib.mdDoc "Whether to enable syslog output.";
};
passwordAuthentication = mkOption {
type = types.bool;
default = true;
description = "Whether to enable password authentication.";
description = lib.mdDoc "Whether to enable password authentication.";
};
publicKeyAuthentication = mkOption {
type = types.bool;
default = true;
description = "Whether to enable public key authentication.";
description = lib.mdDoc "Whether to enable public key authentication.";
};
rootLogin = mkOption {
type = types.bool;
default = false;
description = "Whether to enable remote root login.";
description = lib.mdDoc "Whether to enable remote root login.";
};
loginShell = mkOption {
default = null;
type = types.nullOr types.str;
description = ''
description = lib.mdDoc ''
If non-null, override the default login shell with the
specified value.
'';
@ -93,7 +93,7 @@ in
srpKeyExchange = mkOption {
default = false;
type = types.bool;
description = ''
description = lib.mdDoc ''
Whether to enable SRP key exchange and user authentication.
'';
};
@ -101,18 +101,18 @@ in
tcpForwarding = mkOption {
type = types.bool;
default = true;
description = "Whether to enable TCP/IP forwarding.";
description = lib.mdDoc "Whether to enable TCP/IP forwarding.";
};
x11Forwarding = mkOption {
type = types.bool;
default = true;
description = "Whether to enable X11 forwarding.";
description = lib.mdDoc "Whether to enable X11 forwarding.";
};
subsystems = mkOption {
type = types.listOf types.path;
description = ''
description = lib.mdDoc ''
List of subsystem-path pairs, where the head of the pair
denotes the subsystem name, and the tail denotes the path to
an executable implementing it.