From f60c203c459516ca89ba3baf9ddf1a79ecaf001e Mon Sep 17 00:00:00 2001 From: Adam Spiers Date: Mon, 1 Apr 2024 00:34:39 +0100 Subject: [PATCH] should_skip_target(): add docs explaining its purpose --- lib/Stow.pm.in | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/lib/Stow.pm.in b/lib/Stow.pm.in index f155295..8391a4a 100755 --- a/lib/Stow.pm.in +++ b/lib/Stow.pm.in @@ -641,7 +641,10 @@ sub stow_node { =head2 should_skip_target($target) Determine whether target is a stow directory which should -not be stowed to or unstowed from. +not be stowed to or unstowed from. This mechanism protects +stow directories from being altered by stow, and is a necessary +safety check because the stow directory could live beneath the +target directory. =over 4