Clarify that diff-hook no longer needs to be an absolute path

See: https://gerrit.lix.systems/c/lix/+/1864
Change-Id: Ic70bfe42b261a83f2cb68b8f102833b739b8e03a
This commit is contained in:
Rebecca Turner 2024-09-01 15:20:09 -07:00
parent 02eb07cfd5
commit b7b1b9723f
Signed by: rbt
SSH key fingerprint: SHA256:HU9KTlGeHEBIp12MT4UHG0uc//NRNoJMWfzVGX3igu4

View file

@ -637,10 +637,10 @@ public:
PathsSetting<std::optional<Path>> diffHook{ PathsSetting<std::optional<Path>> diffHook{
this, std::nullopt, "diff-hook", this, std::nullopt, "diff-hook",
R"( R"(
Absolute path to an executable capable of diffing build Path to an executable capable of diffing build results. The hook is
results. The hook is executed if `run-diff-hook` is true, and the executed if `run-diff-hook` is true, and the output of a build is
output of a build is known to not be the same. This program is not known to not be the same. This program is not executed to determine
executed to determine if two results are the same. if two results are the same.
The diff hook is executed by the same user and group who ran the The diff hook is executed by the same user and group who ran the
build. However, the diff hook does not have write access to the build. However, the diff hook does not have write access to the