diff --git a/lib/fileutils.rb b/lib/fileutils.rb index 23aef6e..c262aa2 100644 --- a/lib/fileutils.rb +++ b/lib/fileutils.rb @@ -435,6 +435,8 @@ def fu_mkdir(path, mode) #:nodoc: # Raises an exception if a directory does not exist # or if for any reason a directory cannot be removed. # + # Related: {methods for deleting}[rdoc-ref:FileUtils@Deleting]. + # def rmdir(list, parents: nil, noop: nil, verbose: nil) list = fu_list(list) fu_output_message "rmdir #{parents ? '-p ' : ''}#{list.join ' '}" if verbose @@ -1133,6 +1135,8 @@ def mv(src, dest, force: nil, noop: nil, verbose: nil, secure: nil) # # rm src0.dat src0.txt # + # Related: {methods for deleting}[rdoc-ref:FileUtils@Deleting]. + # # FileUtils.remove is an alias for FileUtils.rm. # def rm(list, force: nil, noop: nil, verbose: nil) @@ -1216,6 +1220,8 @@ def rm_f(list, noop: nil, verbose: nil) # rm -r src0.dat src0.txt # rm -r src1 # + # Related: {methods for deleting}[rdoc-ref:FileUtils@Deleting]. + # def rm_r(list, force: nil, noop: nil, verbose: nil, secure: nil) list = fu_list(list) fu_output_message "rm -r#{force ? 'f' : ''} #{list.join ' '}" if verbose @@ -1245,6 +1251,8 @@ def rm_r(list, force: nil, noop: nil, verbose: nil, secure: nil) # # FileUtils.rmtree is an alias for FileUtils.rm_rf. # + # Related: {methods for deleting}[rdoc-ref:FileUtils@Deleting]. + # def rm_rf(list, noop: nil, verbose: nil, secure: nil) rm_r list, force: true, noop: noop, verbose: verbose, secure: secure end @@ -1266,6 +1274,8 @@ def rm_rf(list, noop: nil, verbose: nil, secure: nil) # Optional argument +force+ specifies whether to ignore # raised exceptions of StandardError and its descendants. # + # Related: {methods for deleting}[rdoc-ref:FileUtils@Deleting]. + # def remove_entry_secure(path, force = false) unless fu_have_symlink? remove_entry path, force @@ -1386,6 +1396,8 @@ def remove_entry(path, force = false) # Optional argument +force+ specifies whether to ignore # raised exceptions of StandardError and its descendants. # + # Related: {methods for deleting}[rdoc-ref:FileUtils@Deleting]. + # def remove_file(path, force = false) Entry_.new(path).remove_file rescue @@ -1403,6 +1415,8 @@ def remove_file(path, force = false) # Optional argument +force+ specifies whether to ignore # raised exceptions of StandardError and its descendants. # + # Related: {methods for deleting}[rdoc-ref:FileUtils@Deleting]. + # def remove_dir(path, force = false) remove_entry path, force # FIXME?? check if it is a directory end @@ -1497,7 +1511,7 @@ def compare_stream(a, b) # using {File.chown}[https://docs.ruby-lang.org/en/master/File.html#method-c-chown]. # - mode: permissions - changes the permissions. # using {File.chmod}[https://docs.ruby-lang.org/en/master/File.html#method-c-chmod]. - # - noop: true - does not remove entries; returns +nil+. + # - noop: true - does not copy entries; returns +nil+. # - owner: owner - changes the owner if not +nil+, # using {File.chown}[https://docs.ruby-lang.org/en/master/File.html#method-c-chown]. # - preserve: true - preserve timestamps