cleanup_invalid_links: improve docs
This commit is contained in:
parent
08b06ccb40
commit
541faf68eb
1 changed files with 8 additions and 5 deletions
|
@ -1014,14 +1014,17 @@ sub find_stowed_path {
|
||||||
|
|
||||||
#===== METHOD ================================================================
|
#===== METHOD ================================================================
|
||||||
# Name : cleanup_invalid_links()
|
# Name : cleanup_invalid_links()
|
||||||
# Purpose : clean up invalid links that may block folding
|
# Purpose : clean up orphaned links that may block folding
|
||||||
# Parameters: $dir => path to directory to check
|
# Parameters: $dir => path to directory to check
|
||||||
# Returns : n/a
|
# Returns : n/a
|
||||||
# Throws : no exceptions
|
# Throws : no exceptions
|
||||||
# Comments : removing files from a stowed package is probably a bad practice
|
# Comments : This is invoked by unstow_contents().
|
||||||
# : so this kind of clean up is not _really_ stow's responsibility;
|
# : We only clean up links which are both orphaned and owned by
|
||||||
# : however, failing to clean up can block tree folding, so we'll do
|
# : Stow, i.e. they point to a non-existent location within a
|
||||||
# : it anyway
|
# : Stow package. These can block tree folding, and they can
|
||||||
|
# : easily occur when a file in Stow package is renamed or removed,
|
||||||
|
# : so the benefit should outweigh the low risk of actually someone
|
||||||
|
# : wanting to keep an orphaned link to within a Stow package.
|
||||||
#=============================================================================
|
#=============================================================================
|
||||||
sub cleanup_invalid_links {
|
sub cleanup_invalid_links {
|
||||||
my $self = shift;
|
my $self = shift;
|
||||||
|
|
Loading…
Reference in a new issue