diff options
author | pennae <github@quasiparticle.net> | 2022-07-28 23:19:15 +0200 |
---|---|---|
committer | pennae <github@quasiparticle.net> | 2022-07-30 15:16:34 +0200 |
commit | 2e751c0772b9d48ff6923569adfa661b030ab6a2 (patch) | |
tree | 0accd740380b7b7fe3ea5965a3a4517674e79260 /nixos/modules/services/databases/couchdb.nix | |
parent | 52b0ad17e3727fe0c3ca028787128ede5fb86352 (diff) | |
download | nixpkgs-2e751c0772b9d48ff6923569adfa661b030ab6a2.tar nixpkgs-2e751c0772b9d48ff6923569adfa661b030ab6a2.tar.gz nixpkgs-2e751c0772b9d48ff6923569adfa661b030ab6a2.tar.bz2 nixpkgs-2e751c0772b9d48ff6923569adfa661b030ab6a2.tar.lz nixpkgs-2e751c0772b9d48ff6923569adfa661b030ab6a2.tar.xz nixpkgs-2e751c0772b9d48ff6923569adfa661b030ab6a2.tar.zst nixpkgs-2e751c0772b9d48ff6923569adfa661b030ab6a2.zip |
treewide: automatically md-convert option descriptions
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.
Diffstat (limited to 'nixos/modules/services/databases/couchdb.nix')
-rw-r--r-- | nixos/modules/services/databases/couchdb.nix | 30 |
1 files changed, 15 insertions, 15 deletions
diff --git a/nixos/modules/services/databases/couchdb.nix b/nixos/modules/services/databases/couchdb.nix index 39d1ead28fc..2a570d09a2c 100644 --- a/nixos/modules/services/databases/couchdb.nix +++ b/nixos/modules/services/databases/couchdb.nix @@ -37,7 +37,7 @@ in { enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to run CouchDB Server. ''; }; @@ -46,7 +46,7 @@ in { type = types.package; default = pkgs.couchdb3; defaultText = literalExpression "pkgs.couchdb3"; - description = '' + description = lib.mdDoc '' CouchDB package to use. ''; }; @@ -54,7 +54,7 @@ in { adminUser = mkOption { type = types.str; default = "admin"; - description = '' + description = lib.mdDoc '' Couchdb (i.e. fauxton) account with permission for all dbs and tasks. ''; @@ -63,7 +63,7 @@ in { adminPass = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' Couchdb (i.e. fauxton) account with permission for all dbs and tasks. ''; @@ -72,7 +72,7 @@ in { user = mkOption { type = types.str; default = "couchdb"; - description = '' + description = lib.mdDoc '' User account under which couchdb runs. ''; }; @@ -80,7 +80,7 @@ in { group = mkOption { type = types.str; default = "couchdb"; - description = '' + description = lib.mdDoc '' Group account under which couchdb runs. ''; }; @@ -90,7 +90,7 @@ in { databaseDir = mkOption { type = types.path; default = "/var/lib/couchdb"; - description = '' + description = lib.mdDoc '' Specifies location of CouchDB database files (*.couch named). This location should be writable and readable for the user the CouchDB service runs as (couchdb by default). @@ -100,7 +100,7 @@ in { uriFile = mkOption { type = types.path; default = "/run/couchdb/couchdb.uri"; - description = '' + description = lib.mdDoc '' This file contains the full URI that can be used to access this instance of CouchDB. It is used to help discover the port CouchDB is running on (if it was set to 0 (e.g. automatically assigned any free @@ -112,7 +112,7 @@ in { viewIndexDir = mkOption { type = types.path; default = "/var/lib/couchdb"; - description = '' + description = lib.mdDoc '' Specifies location of CouchDB view index files. This location should be writable and readable for the user that runs the CouchDB service (couchdb by default). @@ -122,7 +122,7 @@ in { bindAddress = mkOption { type = types.str; default = "127.0.0.1"; - description = '' + description = lib.mdDoc '' Defines the IP address by which CouchDB will be accessible. ''; }; @@ -130,7 +130,7 @@ in { port = mkOption { type = types.int; default = 5984; - description = '' + description = lib.mdDoc '' Defined the port number to listen. ''; }; @@ -138,7 +138,7 @@ in { logFile = mkOption { type = types.path; default = "/var/log/couchdb.log"; - description = '' + description = lib.mdDoc '' Specifies the location of file for logging output. ''; }; @@ -146,7 +146,7 @@ in { extraConfig = mkOption { type = types.lines; default = ""; - description = '' + description = lib.mdDoc '' Extra configuration. Overrides any other cofiguration. ''; }; @@ -155,14 +155,14 @@ in { type = types.path; default = "${cfg.package}/etc/vm.args"; defaultText = literalExpression ''"config.${opt.package}/etc/vm.args"''; - description = '' + description = lib.mdDoc '' vm.args configuration. Overrides Couchdb's Erlang VM parameters file. ''; }; configFile = mkOption { type = types.path; - description = '' + description = lib.mdDoc '' Configuration file for persisting runtime changes. File needs to be readable and writable from couchdb user/group. ''; |