movefasta/nixpkgs
0
0
Fork 0
mirror of https://github.com/NixOS/nixpkgs.git synced 2025-07-13 13:40:28 +03:00
Code Activity

nixos/*: automatically convert option descriptions

Browse source 
conversions were done using https://github.com/pennae/nix-doc-munge
using (probably) rev f34e145 running

    nix-doc-munge nixos/**/*.nix
    nix-doc-munge --import nixos/**/*.nix

the tool ensures that only changes that could affect the generated
manual *but don't* are committed, other changes require manual review
and are discarded.
This commit is contained in:
pennae 2022-08-28 21:18:44 +02:00
parent 5a643387ec
commit ef176dcf7e
808 changed files with 1523 additions and 1523 deletions
Download patch file Download diff file Expand all files Collapse all files

32
nixos/modules/services/misc/sourcehut/default.nix
View file

@ -67,7 +67,7 @@ let
type = types.str;
default = "postgresql:///localhost?user=${srv}srht&host=/run/postgresql";
};
migrate-on-upgrade = mkEnableOption "automatic migrations on package upgrade" // { default = true; };
migrate-on-upgrade = mkEnableOption (lib.mdDoc "automatic migrations on package upgrade") // { default = true; };
oauth-client-id = mkOption {
description = lib.mdDoc "${srv}.sr.ht's OAuth client id for meta.sr.ht.";
type = types.str;
@ -108,10 +108,10 @@ let
in
{
options.services.sourcehut = {
enable = mkEnableOption ''
enable = mkEnableOption (lib.mdDoc ''
sourcehut - git hosting, continuous integration, mailing list, ticket tracking,
task dispatching, wiki and account management services
'';
'');
services = mkOption {
type = with types; listOf (enum
@ -139,11 +139,11 @@ in
};
minio = {
enable = mkEnableOption ''local minio integration'';
enable = mkEnableOption (lib.mdDoc ''local minio integration'');
};
nginx = {
enable = mkEnableOption ''local nginx integration'';
enable = mkEnableOption (lib.mdDoc ''local nginx integration'');
virtualHost = mkOption {
type = types.attrs;
default = {};
@ -152,15 +152,15 @@ in
};
postfix = {
enable = mkEnableOption ''local postfix integration'';
enable = mkEnableOption (lib.mdDoc ''local postfix integration'');
};
postgresql = {
enable = mkEnableOption ''local postgresql integration'';
enable = mkEnableOption (lib.mdDoc ''local postgresql integration'');
};
redis = {
enable = mkEnableOption ''local redis integration in a dedicated redis-server'';
enable = mkEnableOption (lib.mdDoc ''local redis integration in a dedicated redis-server'');
};
settings = mkOption {
@ -308,7 +308,7 @@ in
oauth-client-secret = mkOptionNullOrStr "OAuth client secret.";
};
options."dispatch.sr.ht::gitlab" = {
enabled = mkEnableOption "GitLab integration";
enabled = mkEnableOption (lib.mdDoc "GitLab integration");
canonical-upstream = mkOption {
type = types.str;
description = lib.mdDoc "Canonical upstream.";
@ -328,7 +328,7 @@ in
};
options."builds.sr.ht" = commonServiceSettings "builds" // {
allow-free = mkEnableOption "nonpaying users to submit builds";
allow-free = mkEnableOption (lib.mdDoc "nonpaying users to submit builds");
redis = mkOption {
description = lib.mdDoc "The Redis connection used for the Celery worker.";
type = types.str;
@ -465,7 +465,7 @@ in
};
options."lists.sr.ht" = commonServiceSettings "lists" // {
allow-new-lists = mkEnableOption "Allow creation of new lists.";
allow-new-lists = mkEnableOption (lib.mdDoc "Allow creation of new lists.");
notify-from = mkOption {
description = lib.mdDoc "Outgoing email for notifications generated by users.";
type = types.str;
@ -539,7 +539,7 @@ in
type = types.str;
default = "redis+socket:///run/redis-sourcehut-metasrht/redis.sock?virtual_host=1";
};
welcome-emails = mkEnableOption "sending stock sourcehut welcome emails after signup";
welcome-emails = mkEnableOption (lib.mdDoc "sending stock sourcehut welcome emails after signup");
};
options."meta.sr.ht::api" = {
internal-ipnet = mkOption {
@ -560,7 +560,7 @@ in
example = { "git.sr.ht" = 12345; };
};
options."meta.sr.ht::billing" = {
enabled = mkEnableOption "the billing system";
enabled = mkEnableOption (lib.mdDoc "the billing system");
stripe-public-key = mkOptionNullOrStr "Public key for Stripe. Get your keys at https://dashboard.stripe.com/account/apikeys";
stripe-secret-key = mkOptionNullOrStr ''
An absolute file path (which should be outside the Nix-store)
@ -570,7 +570,7 @@ in
};
};
options."meta.sr.ht::settings" = {
registration = mkEnableOption "public registration";
registration = mkEnableOption (lib.mdDoc "public registration");
onboarding-redirect = mkOption {
description = lib.mdDoc "Where to redirect new users upon registration.";
type = types.str;
@ -601,9 +601,9 @@ in
default = 1024;
};
user-domain = mkOption {
description = ''
description = lib.mdDoc ''
Configures the user domain, if enabled.
All users are given <username>.this.domain.
All users are given \<username\>.this.domain.
'';
type = with types; nullOr str;
default = null;

2
nixos/modules/services/misc/sourcehut/service.nix
View file

@ -117,7 +117,7 @@ let
in
{
options.services.sourcehut.${srv} = {
enable = mkEnableOption "${srv} service";
enable = mkEnableOption (lib.mdDoc "${srv} service");
user = mkOption {
type = types.str;