00dani/stow
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Add a comment explaining $stow_path parameter of stow_contents()

Browse source 
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.
This commit is contained in:
Adam Spiers 2024-03-09 17:33:25 +00:00
parent f51fc1248c
commit 20bee7428e
1 changed files with 5 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
lib/Stow.pm.in
View file

@ -360,7 +360,11 @@ sub within_target_do {
# Name : stow_contents() # Name : stow_contents()
# Purpose : stow the contents of the given directory # Purpose : stow the contents of the given directory
# Parameters: $stow_path => relative path from current (i.e. target) 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 # : $package => the package whose contents are being stowed
# : $target => subpath relative to package directory which needs # : $target => subpath relative to package directory which needs
# : stowing as a symlink at subpath relative to target # : stowing as a symlink at subpath relative to target