movefasta/nixpkgs
1
0
Fork 0
mirror of https://github.com/NixOS/nixpkgs.git synced 2025-06-12 04:35:41 +03:00
Code Issues Projects Releases Packages 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

16
nixos/modules/services/cluster/kubernetes/pki.nix
View file

@ -44,13 +44,13 @@ in
enable = mkEnableOption "easyCert issuer service";
certs = mkOption {
description = "List of certificate specs to feed to cert generator.";
description = lib.mdDoc "List of certificate specs to feed to cert generator.";
default = {};
type = attrs;
};
genCfsslCACert = mkOption {
description = ''
description = lib.mdDoc ''
Whether to automatically generate cfssl CA certificate and key,
if they don't exist.
'';
@ -59,7 +59,7 @@ in
};
genCfsslAPICerts = mkOption {
description = ''
description = lib.mdDoc ''
Whether to automatically generate cfssl API webserver TLS cert and key,
if they don't exist.
'';
@ -68,7 +68,7 @@ in
};
cfsslAPIExtraSANs = mkOption {
description = ''
description = lib.mdDoc ''
Extra x509 Subject Alternative Names to be added to the cfssl API webserver TLS cert.
'';
default = [];
@ -77,7 +77,7 @@ in
};
genCfsslAPIToken = mkOption {
description = ''
description = lib.mdDoc ''
Whether to automatically generate cfssl API-token secret,
if they doesn't exist.
'';
@ -86,13 +86,13 @@ in
};
pkiTrustOnBootstrap = mkOption {
description = "Whether to always trust remote cfssl server upon initial PKI bootstrap.";
description = lib.mdDoc "Whether to always trust remote cfssl server upon initial PKI bootstrap.";
default = true;
type = bool;
};
caCertPathPrefix = mkOption {
description = ''
description = lib.mdDoc ''
Path-prefrix for the CA-certificate to be used for cfssl signing.
Suffixes ".pem" and "-key.pem" will be automatically appended for
the public and private keys respectively.
@ -103,7 +103,7 @@ in
};
caSpec = mkOption {
description = "Certificate specification for the auto-generated CAcert.";
description = lib.mdDoc "Certificate specification for the auto-generated CAcert.";
default = {
CN = "kubernetes-cluster-ca";
O = "NixOS";