Skip to content

Commit

Permalink
nixos/nix-daemon: doc: use literalExample
Browse files Browse the repository at this point in the history
Makes the example more readable by not squashed everything onto one
single line.
  • Loading branch information
bjornfor committed Mar 5, 2017
1 parent 4da4207 commit 316e7d6
Showing 1 changed file with 17 additions and 16 deletions.
33 changes: 17 additions & 16 deletions nixos/modules/services/misc/nix-daemon.nix
Expand Up @@ -164,22 +164,23 @@ in
buildMachines = mkOption {
type = types.listOf types.attrs;
default = [];
example = [
{ hostName = "voila.labs.cs.uu.nl";
sshUser = "nix";
sshKey = "/root/.ssh/id_buildfarm";
system = "powerpc-darwin";
maxJobs = 1;
}
{ hostName = "linux64.example.org";
sshUser = "buildfarm";
sshKey = "/root/.ssh/id_buildfarm";
system = "x86_64-linux";
maxJobs = 2;
supportedFeatures = [ "kvm" ];
mandatoryFeatures = [ "perf" ];
}
];
example = literalExample ''
[ { hostName = "voila.labs.cs.uu.nl";
sshUser = "nix";
sshKey = "/root/.ssh/id_buildfarm";
system = "powerpc-darwin";
maxJobs = 1;
}
{ hostName = "linux64.example.org";
sshUser = "buildfarm";
sshKey = "/root/.ssh/id_buildfarm";
system = "x86_64-linux";
maxJobs = 2;
supportedFeatures = [ "kvm" ];
mandatoryFeatures = [ "perf" ];
}
]
'';
description = ''
This option lists the machines to be used if distributed
builds are enabled (see
Expand Down

0 comments on commit 316e7d6

Please sign in to comment.