hooks: document that hooks are not run within their own process

rsmarples · rsmarples · commit d531f8b063c2 · 2018-02-20T09:06:38.000Z
diff --git a/hooks/dhcpcd-run-hooks.8.in b/hooks/dhcpcd-run-hooks.8.in
@@ -22,7 +22,7 @@
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
-.Dd November 3, 2017
+.Dd Febuary 20, 2018
 .Dt DHCPCD-RUN-HOOKS 8
 .Os
 .Sh NAME
@@ -47,6 +47,19 @@ ntp or ypbind.
 A test hook is also supplied that simply echos the dhcp variables to the
 console from DISCOVER message.
 .Pp
+The hooks scripts are loaded into the current shell rather than executed
+in their own process.
+This allows each hook script, such as
+.Pa @SYSCONFDIR@/dhcpcd.enter-hook
+to customise environment variables or provide alternative functions to hooks
+further down the chain.
+As such, using the shell builtins
+.Ic exit ,
+.Ic exec
+or similar will cause
+.Nm
+to exit at that point.
+.Pp
 Each time
 .Nm
 is invoked,
