summaryrefslogtreecommitdiff
path: root/lib/fileutils.rb
diff options
context:
space:
mode:
authorBurdette Lamar <[email protected]>2022-06-14 15:42:23 -0500
committergit <[email protected]>2022-06-15 05:42:26 +0900
commit788a5e14faee9a2a9b32afa9326b7b91a46def33 (patch)
tree2ae9c44a8dd3cb228d0b21045e5100964466c6f7 /lib/fileutils.rb
parentab10f111c3450761048e85223629b87606c0d52e (diff)
[ruby/fileutils] [DOC] More on cp_r (https://github.com/ruby/fileutils/pull/87)
* More on cp_r https://github.com/ruby/fileutils/commit/82a2b62578
Diffstat (limited to 'lib/fileutils.rb')
-rw-r--r--lib/fileutils.rb63
1 files changed, 43 insertions, 20 deletions
diff --git a/lib/fileutils.rb b/lib/fileutils.rb
index 81c5e31f76..f257abb60e 100644
--- a/lib/fileutils.rb
+++ b/lib/fileutils.rb
@@ -817,9 +817,10 @@ module FileUtils
alias copy cp
module_function :copy
- # Recursively copies files from +src+ to +dest+.
+ # Recursively copies files.
#
- # Arguments +src+ and +dest+
+ # Arguments +src+ (a single path or an array of paths)
+ # and +dest+ (a single path)
# should be {interpretable as paths}[rdoc-ref:FileUtils@Path+Arguments].
#
# If +src+ is the path to a file and +dest+ is not the path to a directory,
@@ -841,31 +842,53 @@ module FileUtils
# If +src+ is the path to a directory and +dest+ does not exist,
# recursively copies +src+ to +dest+:
#
- # FileUtils.mkdir_p(['src2/dir0', 'src2/dir1'])
- # FileUtils.touch('src2/dir0/src0.txt')
- # FileUtils.touch('src2/dir0/src1.txt')
- # FileUtils.touch('src2/dir1/src2.txt')
- # FileUtils.touch('src2/dir1/src3.txt')
+ # tree('src2')
+ # src2
+ # |-- dir0
+ # | |-- src0.txt
+ # | `-- src1.txt
+ # `-- dir1
+ # |-- src2.txt
+ # `-- src3.txt
+ # FileUtils.exist?('dest2') # => false
+ #
# FileUtils.cp_r('src2', 'dest2')
- # File.exist?('dest2/dir0/src0.txt') # => true
- # File.exist?('dest2/dir0/src1.txt') # => true
- # File.exist?('dest2/dir1/src2.txt') # => true
- # File.exist?('dest2/dir1/src3.txt') # => true
+ # tree('dest2')
+ # dest2
+ # |-- dir0
+ # | |-- src0.txt
+ # | `-- src1.txt
+ # `-- dir1
+ # |-- src2.txt
+ # `-- src3.txt
#
# If +src+ and +dest+ are paths to directories,
# recursively copies +src+ to <tt>dest/src</tt>:
#
- # FileUtils.mkdir_p(['src3/dir0', 'src3/dir1'])
- # FileUtils.touch('src3/dir0/src0.txt')
- # FileUtils.touch('src3/dir0/src1.txt')
- # FileUtils.touch('src3/dir1/src2.txt')
- # FileUtils.touch('src3/dir1/src3.txt')
+ # tree('src3')
+ # src3
+ # |-- dir0
+ # | |-- src0.txt
+ # | `-- src1.txt
+ # `-- dir1
+ # |-- src2.txt
+ # `-- src3.txt
# FileUtils.mkdir('dest3')
+ #
# FileUtils.cp_r('src3', 'dest3')
- # File.exist?('dest3/src3/dir0/src0.txt') # => true
- # File.exist?('dest3/src3/dir0/src1.txt') # => true
- # File.exist?('dest3/src3/dir1/src2.txt') # => true
- # File.exist?('dest3/src3/dir1/src3.txt') # => true
+ # tree('dest3')
+ # dest3
+ # `-- src3
+ # |-- dir0
+ # | |-- src0.txt
+ # | `-- src1.txt
+ # `-- dir1
+ # |-- src2.txt
+ # `-- src3.txt
+ #
+ # If +src+ is an array of paths and +dest+ is a directory,
+ # recursively copies from each path in +src+ to +dest+;
+ # the paths in +src+ may point to files and/or directories.
#
# Keyword arguments:
#