gador/nixpkgs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki 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

18
nixos/modules/services/networking/git-daemon.nix
View File

@@ -15,7 +15,7 @@ in
enable = mkOption {
type = types.bool;
default = false;
description = ''
description = lib.mdDoc ''
Enable Git daemon, which allows public hosting of git repositories
without any access controls. This is mostly intended for read-only access.
@@ -31,7 +31,7 @@ in
type = types.str;
default = "";
example = "/srv/git/";
description = ''
description = lib.mdDoc ''
Remap all the path requests as relative to the given path. For example,
if you set base-path to /srv/git, then if you later try to pull
git://example.com/hello.git, Git daemon will interpret the path as /srv/git/hello.git.
@@ -41,7 +41,7 @@ in
exportAll = mkOption {
type = types.bool;
default = false;
description = ''
description = lib.mdDoc ''
Publish all directories that look like Git repositories (have the objects
and refs subdirectories), even if they do not have the git-daemon-export-ok file.
@@ -57,7 +57,7 @@ in
type = types.listOf types.str;
default = [];
example = [ "/srv/git" "/home/user/git/repo2" ];
description = ''
description = lib.mdDoc ''
A whitelist of paths of git repositories, or directories containing repositories
all of which would be published. Paths must not end in "/".
@@ -70,31 +70,31 @@ in
type = types.str;
default = "";
example = "example.com";
description = "Listen on a specific IP address or hostname.";
description = lib.mdDoc "Listen on a specific IP address or hostname.";
};
port = mkOption {
type = types.port;
default = 9418;
description = "Port to listen on.";
description = lib.mdDoc "Port to listen on.";
};
options = mkOption {
type = types.str;
default = "";
description = "Extra configuration options to be passed to Git daemon.";
description = lib.mdDoc "Extra configuration options to be passed to Git daemon.";
};
user = mkOption {
type = types.str;
default = "git";
description = "User under which Git daemon would be running.";
description = lib.mdDoc "User under which Git daemon would be running.";
};
group = mkOption {
type = types.str;
default = "git";
description = "Group under which Git daemon would be running.";
description = lib.mdDoc "Group under which Git daemon would be running.";
};
};