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

nixos/*: automatically convert option descriptions

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

View file

@ -48,10 +48,10 @@ in
defaultConfig = mkOption {
type = types.lines;
default = defaultConf;
description = ''
The default <filename>syslog.conf</filename> file configures a
description = lib.mdDoc ''
The default {file}`syslog.conf` file configures a
fairly standard setup of log files, which can be extended by
means of <varname>extraConfig</varname>.
means of {var}`extraConfig`.
'';
};
@ -59,9 +59,9 @@ in
type = types.lines;
default = "";
example = "news.* -/var/log/news";
description = ''
Additional text appended to <filename>syslog.conf</filename>,
i.e. the contents of <varname>defaultConfig</varname>.
description = lib.mdDoc ''
Additional text appended to {file}`syslog.conf`,
i.e. the contents of {var}`defaultConfig`.
'';
};