nixpkgs/nixos/modules/services/network-filesystems/u9fs.nix
pennae 2e751c0772 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.
2022-07-30 15:16:34 +02:00

79 lines
1.7 KiB
Nix

{ config, lib, pkgs, ... }:
with lib;
let
cfg = config.services.u9fs;
in
{
options = {
services.u9fs = {
enable = mkOption {
type = types.bool;
default = false;
description = lib.mdDoc "Whether to run the u9fs 9P server for Unix.";
};
listenStreams = mkOption {
type = types.listOf types.str;
default = [ "564" ];
example = [ "192.168.16.1:564" ];
description = lib.mdDoc ''
Sockets to listen for clients on.
See {command}`man 5 systemd.socket` for socket syntax.
'';
};
user = mkOption {
type = types.str;
default = "nobody";
description =
lib.mdDoc "User to run u9fs under.";
};
extraArgs = mkOption {
type = types.str;
default = "";
example = "-a none";
description =
lib.mdDoc ''
Extra arguments to pass on invocation,
see {command}`man 4 u9fs`
'';
};
};
};
config = mkIf cfg.enable {
systemd = {
sockets.u9fs = {
description = "U9fs Listening Socket";
wantedBy = [ "sockets.target" ];
after = [ "network.target" ];
inherit (cfg) listenStreams;
socketConfig.Accept = "yes";
};
services."u9fs@" = {
description = "9P Protocol Server";
reloadIfChanged = true;
requires = [ "u9fs.socket" ];
serviceConfig =
{ ExecStart = "-${pkgs.u9fs}/bin/u9fs ${cfg.extraArgs}";
StandardInput = "socket";
StandardError = "journal";
User = cfg.user;
AmbientCapabilities = "cap_setuid cap_setgid";
};
};
};
};
}