From 20bee7428ea0856d31bc9d0e56f98ed3ebcfd1e6 Mon Sep 17 00:00:00 2001 From: Adam Spiers Date: Sat, 9 Mar 2024 17:33:25 +0000 Subject: [PATCH] Add a comment explaining $stow_path parameter of stow_contents() At first sight this parameter looks redundant since we have $self->{stow_path}, but in one case the value can differ from that, so mention that explicitly. --- lib/Stow.pm.in | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/lib/Stow.pm.in b/lib/Stow.pm.in index b603455..ea34e66 100755 --- a/lib/Stow.pm.in +++ b/lib/Stow.pm.in @@ -360,7 +360,11 @@ sub within_target_do { # Name : stow_contents() # Purpose : stow the contents of the given directory # Parameters: $stow_path => relative path from current (i.e. target) directory -# : to the stow dir containing the package to be stowed +# : to the stow dir containing the package to be stowed. +# : This can differ from $self->{stow_path} when unfolding +# : a (sub)tree which is already stowed from a package +# : in a different stow directory (see the "Multiple Stow +# : Directories" section of the manual). # : $package => the package whose contents are being stowed # : $target => subpath relative to package directory which needs # : stowing as a symlink at subpath relative to target