Merge pull request #7913 from fricklerhandwerk/master

add information on the `build-hook` setting
This commit is contained in:
Eelco Dolstra 2023-02-27 17:33:25 +01:00 committed by GitHub
commit f08ad5bdba
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -201,7 +201,16 @@ public:
{"build-timeout"}}; {"build-timeout"}};
PathSetting buildHook{this, true, "", "build-hook", PathSetting buildHook{this, true, "", "build-hook",
"The path of the helper program that executes builds to remote machines."}; R"(
The path to the helper program that executes remote builds.
Nix communicates with the build hook over `stdio` using a custom protocol to request builds that cannot be performed directly by the Nix daemon.
The default value is the internal Nix binary that implements remote building.
> **Important**
>
> Change this setting only if you really know what youre doing.
)"};
Setting<std::string> builders{ Setting<std::string> builders{
this, "@" + nixConfDir + "/machines", "builders", this, "@" + nixConfDir + "/machines", "builders",