diff options
Diffstat (limited to 'nixos/modules/services/continuous-integration/buildbot/master.nix')
| -rw-r--r-- | nixos/modules/services/continuous-integration/buildbot/master.nix | 50 |
1 files changed, 25 insertions, 25 deletions
diff --git a/nixos/modules/services/continuous-integration/buildbot/master.nix b/nixos/modules/services/continuous-integration/buildbot/master.nix index 80c6c6abfd0..ab1a8076c93 100644 --- a/nixos/modules/services/continuous-integration/buildbot/master.nix +++ b/nixos/modules/services/continuous-integration/buildbot/master.nix @@ -61,7 +61,7 @@ in { factorySteps = mkOption { type = types.listOf types.str; - description = "Factory Steps"; + description = lib.mdDoc "Factory Steps"; default = []; example = [ "steps.Git(repourl='https://github.com/buildbot/pyflakes.git', mode='incremental')" @@ -71,7 +71,7 @@ in { changeSource = mkOption { type = types.listOf types.str; - description = "List of Change Sources."; + description = lib.mdDoc "List of Change Sources."; default = []; example = [ "changes.GitPoller('https://github.com/buildbot/pyflakes.git', workdir='gitpoller-workdir', branch='master', pollinterval=300)" @@ -81,18 +81,18 @@ in { enable = mkOption { type = types.bool; default = false; - description = "Whether to enable the Buildbot continuous integration server."; + description = lib.mdDoc "Whether to enable the Buildbot continuous integration server."; }; extraConfig = mkOption { type = types.str; - description = "Extra configuration to append to master.cfg"; + description = lib.mdDoc "Extra configuration to append to master.cfg"; default = "c['buildbotNetUsageData'] = None"; }; masterCfg = mkOption { type = types.path; - description = "Optionally pass master.cfg path. Other options in this configuration will be ignored."; + description = lib.mdDoc "Optionally pass master.cfg path. Other options in this configuration will be ignored."; default = defaultMasterCfg; defaultText = literalDocBook ''generated configuration file''; example = "/etc/nixos/buildbot/master.cfg"; @@ -100,7 +100,7 @@ in { schedulers = mkOption { type = types.listOf types.str; - description = "List of Schedulers."; + description = lib.mdDoc "List of Schedulers."; default = [ "schedulers.SingleBranchScheduler(name='all', change_filter=util.ChangeFilter(branch='master'), treeStableTimer=None, builderNames=['runtests'])" "schedulers.ForceScheduler(name='force',builderNames=['runtests'])" @@ -109,7 +109,7 @@ in { builders = mkOption { type = types.listOf types.str; - description = "List of Builders."; + description = lib.mdDoc "List of Builders."; default = [ "util.BuilderConfig(name='runtests',workernames=['example-worker'],factory=factory)" ]; @@ -117,52 +117,52 @@ in { workers = mkOption { type = types.listOf types.str; - description = "List of Workers."; + description = lib.mdDoc "List of Workers."; default = [ "worker.Worker('example-worker', 'pass')" ]; }; reporters = mkOption { default = []; type = types.listOf types.str; - description = "List of reporter objects used to present build status to various users."; + description = lib.mdDoc "List of reporter objects used to present build status to various users."; }; user = mkOption { default = "buildbot"; type = types.str; - description = "User the buildbot server should execute under."; + description = lib.mdDoc "User the buildbot server should execute under."; }; group = mkOption { default = "buildbot"; type = types.str; - description = "Primary group of buildbot user."; + description = lib.mdDoc "Primary group of buildbot user."; }; extraGroups = mkOption { type = types.listOf types.str; default = []; - description = "List of extra groups that the buildbot user should be a part of."; + description = lib.mdDoc "List of extra groups that the buildbot user should be a part of."; }; home = mkOption { default = "/home/buildbot"; type = types.path; - description = "Buildbot home directory."; + description = lib.mdDoc "Buildbot home directory."; }; buildbotDir = mkOption { default = "${cfg.home}/master"; defaultText = literalExpression ''"''${config.${opt.home}}/master"''; type = types.path; - description = "Specifies the Buildbot directory."; + description = lib.mdDoc "Specifies the Buildbot directory."; }; pbPort = mkOption { default = 9989; type = types.either types.str types.int; example = "'tcp:9990:interface=127.0.0.1'"; - description = '' + description = lib.mdDoc '' The buildmaster will listen on a TCP port of your choosing for connections from workers. It can also use this port for connections from remote Change Sources, @@ -170,51 +170,51 @@ in { This port should be visible to the outside world, and you’ll need to tell your worker admins about your choice. If put in (single) quotes, this can also be used as a connection string, - as defined in the <link xlink:href="https://twistedmatrix.com/documents/current/core/howto/endpoints.html">ConnectionStrings guide</link>. + as defined in the [ConnectionStrings guide](https://twistedmatrix.com/documents/current/core/howto/endpoints.html). ''; }; listenAddress = mkOption { default = "0.0.0.0"; type = types.str; - description = "Specifies the bind address on which the buildbot HTTP interface listens."; + description = lib.mdDoc "Specifies the bind address on which the buildbot HTTP interface listens."; }; buildbotUrl = mkOption { default = "http://localhost:8010/"; type = types.str; - description = "Specifies the Buildbot URL."; + description = lib.mdDoc "Specifies the Buildbot URL."; }; title = mkOption { default = "Buildbot"; type = types.str; - description = "Specifies the Buildbot Title."; + description = lib.mdDoc "Specifies the Buildbot Title."; }; titleUrl = mkOption { default = "Buildbot"; type = types.str; - description = "Specifies the Buildbot TitleURL."; + description = lib.mdDoc "Specifies the Buildbot TitleURL."; }; dbUrl = mkOption { default = "sqlite:///state.sqlite"; type = types.str; - description = "Specifies the database connection string."; + description = lib.mdDoc "Specifies the database connection string."; }; port = mkOption { default = 8010; type = types.int; - description = "Specifies port number on which the buildbot HTTP interface listens."; + description = lib.mdDoc "Specifies port number on which the buildbot HTTP interface listens."; }; package = mkOption { type = types.package; default = pkgs.python3Packages.buildbot-full; defaultText = literalExpression "pkgs.python3Packages.buildbot-full"; - description = "Package to use for buildbot."; + description = lib.mdDoc "Package to use for buildbot."; example = literalExpression "pkgs.python3Packages.buildbot"; }; @@ -222,14 +222,14 @@ in { default = [ pkgs.git ]; defaultText = literalExpression "[ pkgs.git ]"; type = types.listOf types.package; - description = "Packages to add to PATH for the buildbot process."; + description = lib.mdDoc "Packages to add to PATH for the buildbot process."; }; pythonPackages = mkOption { type = types.functionTo (types.listOf types.package); default = pythonPackages: with pythonPackages; [ ]; defaultText = literalExpression "pythonPackages: with pythonPackages; [ ]"; - description = "Packages to add the to the PYTHONPATH of the buildbot process."; + description = lib.mdDoc "Packages to add the to the PYTHONPATH of the buildbot process."; example = literalExpression "pythonPackages: with pythonPackages; [ requests ]"; }; }; |