treewide: use mdDoc for descriptions

Enable markdown syntax (instead of docbook) for descriptions.
This only affects external doc tooling that renders the descriptions.
This commit is contained in:
Erik Arvstedt
2022-12-18 20:01:52 +01:00
parent a9c1995ed9
commit 109dccca27
33 changed files with 292 additions and 292 deletions
+4 -4
View File
@@ -6,16 +6,16 @@ with lib;
nix-bitcoin.security.dbusHideProcessInformation = mkOption {
type = types.bool;
default = false;
description = ''
Only allow users with group 'proc' to retrieve systemd unit information like
description = mdDoc ''
Only allow users with group `proc` to retrieve systemd unit information like
cgroup paths (i.e. (sub)process command lines) via D-Bus.
This mitigates a systemd security issue where (sub)process command lines can
be retrieved by services even when their access to /proc is restricted
(via ProtectProc).
This option works by restricting the D-Bus method 'GetUnitProcesses', which
is also used internally by `systemctl status`.
This option works by restricting the D-Bus method `GetUnitProcesses`, which
is also used internally by {command}`systemctl status`.
'';
};
};