1 files changed, 76 insertions, 22 deletions
@@ -291,7 +291,7 @@ module FileUtils
 #
 # Keyword arguments:
 #
- # - <tt>mode: <i>integer</i></tt> - also calls <tt>File.chmod(mode, path)</tt>;
 # see {File.chmod}[https://docs.ruby-lang.org/en/master/File.html#method-c-chmod].
 # - <tt>noop: true</tt> - does not create directories.
 # - <tt>verbose: true</tt> - prints an equivalent command:
@@ -334,7 +334,7 @@ module FileUtils
 #
 # Keyword arguments:
 #
- # - <tt>mode: <i>integer</i></tt> - also calls <tt>File.chmod(mode, path)</tt>;
 # see {File.chmod}[https://docs.ruby-lang.org/en/master/File.html#method-c-chmod].
 # - <tt>noop: true</tt> - does not create directories.
 # - <tt>verbose: true</tt> - prints an equivalent command:
@@ -1177,6 +1177,9 @@ module FileUtils
 # Avoids a local vulnerability that can exist in certain circumstances;
 # see {Avoiding the TOCTTOU Vulnerability}[rdoc-ref:FileUtils@Avoiding+the+TOCTTOU+Vulnerability].
 #
 def remove_entry_secure(path, force = false)
 unless fu_have_symlink?
 remove_entry path, force
@@ -1263,12 +1266,14 @@ module FileUtils
 end
 private_module_function :fu_stat_identical_entry?
 #
- # This method removes a file system entry +path+.
- # +path+ might be a regular file, a directory, or something.
- # If +path+ is a directory, remove it recursively.
 #
- # See also remove_entry_secure.
 #
 def remove_entry(path, force = false)
 Entry_.new(path).postorder_traverse do |ent|
@@ -1283,9 +1288,11 @@ module FileUtils
 end
 module_function :remove_entry
 #
- # Removes a file +path+.
- # This method ignores StandardError if +force+ is true.
 #
 def remove_file(path, force = false)
 Entry_.new(path).remove_file
@@ -1294,20 +1301,20 @@ module FileUtils
 end
 module_function :remove_file
 #
- # Removes a directory +dir+ and its contents recursively.
- # This method ignores StandardError if +force+ is true.
 #
 def remove_dir(path, force = false)
 remove_entry path, force # FIXME?? check if it is a directory
 end
 module_function :remove_dir
- #
- # Returns true if the contents of a file +a+ and a file +b+ are identical.
- #
- # FileUtils.compare_file('somefile', 'somefile') #=> true
- # FileUtils.compare_file('/dev/null', '/dev/urandom') #=> false
 #
 def compare_file(a, b)
 return false unless File.size(a) == File.size(b)
@@ -1324,8 +1331,8 @@ module FileUtils
 module_function :identical?
 module_function :cmp
- #
- # Returns true if the contents of a stream +a+ and +b+ are identical.
 #
 def compare_stream(a, b)
 bsize = fu_stream_blksize(a, b)
@@ -1342,13 +1349,60 @@ module FileUtils
 end
 module_function :compare_stream
 #
- # If +src+ is not same as +dest+, copies it and changes the permission
- # mode to +mode+. If +dest+ is a directory, destination is +dest+/+src+.
- # This method removes destination before copy.
 #
- # FileUtils.install 'ruby', '/usr/local/bin/ruby', mode: 0755, verbose: true
- # FileUtils.install 'lib.rb', '/usr/local/lib/ruby/site_ruby', verbose: true
 #
 def install(src, dest, mode: nil, owner: nil, group: nil, preserve: nil,
 noop: nil, verbose: nil)