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/web-apps/onlyoffice.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/web-apps/onlyoffice.nix')
-rw-r--r-- | nixos/modules/services/web-apps/onlyoffice.nix | 20 |
1 files changed, 10 insertions, 10 deletions
diff --git a/nixos/modules/services/web-apps/onlyoffice.nix b/nixos/modules/services/web-apps/onlyoffice.nix index ce6a3e835e3..15fc3b03a83 100644 --- a/nixos/modules/services/web-apps/onlyoffice.nix +++ b/nixos/modules/services/web-apps/onlyoffice.nix @@ -14,13 +14,13 @@ in hostname = mkOption { type = types.str; default = "localhost"; - description = "FQDN for the onlyoffice instance."; + description = lib.mdDoc "FQDN for the onlyoffice instance."; }; jwtSecretFile = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' Path to a file that contains the secret to sign web requests using JSON Web Tokens. If left at the default value null signing is disabled. ''; @@ -30,37 +30,37 @@ in type = types.package; default = pkgs.onlyoffice-documentserver; defaultText = "pkgs.onlyoffice-documentserver"; - description = "Which package to use for the OnlyOffice instance."; + description = lib.mdDoc "Which package to use for the OnlyOffice instance."; }; port = mkOption { type = types.port; default = 8000; - description = "Port the OnlyOffice DocumentServer should listens on."; + description = lib.mdDoc "Port the OnlyOffice DocumentServer should listens on."; }; examplePort = mkOption { type = types.port; default = null; - description = "Port the OnlyOffice Example server should listens on."; + description = lib.mdDoc "Port the OnlyOffice Example server should listens on."; }; postgresHost = mkOption { type = types.str; default = "/run/postgresql"; - description = "The Postgresql hostname or socket path OnlyOffice should connect to."; + description = lib.mdDoc "The Postgresql hostname or socket path OnlyOffice should connect to."; }; postgresName = mkOption { type = types.str; default = "onlyoffice"; - description = "The name of databse OnlyOffice should user."; + description = lib.mdDoc "The name of databse OnlyOffice should user."; }; postgresPasswordFile = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' Path to a file that contains the password OnlyOffice should use to connect to Postgresql. Unused when using socket authentication. ''; @@ -69,7 +69,7 @@ in postgresUser = mkOption { type = types.str; default = "onlyoffice"; - description = '' + description = lib.mdDoc '' The username OnlyOffice should use to connect to Postgresql. Unused when using socket authentication. ''; @@ -78,7 +78,7 @@ in rabbitmqUrl = mkOption { type = types.str; default = "amqp://guest:guest@localhost:5672"; - description = "The Rabbitmq in amqp URI style OnlyOffice should connect to."; + description = lib.mdDoc "The Rabbitmq in amqp URI style OnlyOffice should connect to."; }; }; |