@@ -336,7 +336,7 @@ def mkdir(list, mode: nil, noop: nil, verbose: nil)
336
336
337
337
#
338
338
# Creates directories at the paths in the given +list+
339
- # (an array of strings or a single string ),
339
+ # (a single path or an array of paths ),
340
340
# also creating ancestor directories as needed;
341
341
# returns +list+ if it is an array, <tt>[list]</tt> otherwise.
342
342
#
@@ -412,7 +412,7 @@ def fu_mkdir(path, mode) #:nodoc:
412
412
413
413
#
414
414
# Removes directories at the paths in the given +list+
415
- # (an array of strings or a single string );
415
+ # (a single path or an array of paths );
416
416
# returns +list+, if it is an array, <tt>[list]</tt> otherwise.
417
417
#
418
418
# Argument +list+ or its elements
@@ -464,7 +464,8 @@ def rmdir(list, parents: nil, noop: nil, verbose: nil)
464
464
465
465
# Creates {hard links}[https://en.wikipedia.org/wiki/Hard_link].
466
466
#
467
- # Arguments +src+ and +dest+
467
+ # Arguments +src+ (a single path or an array of paths)
468
+ # and +dest+ (a single path)
468
469
# should be {interpretable as paths}[rdoc-ref:FileUtils@Path+Arguments].
469
470
#
470
471
# When +src+ is the path to an existing file
@@ -531,7 +532,8 @@ def ln(src, dest, force: nil, noop: nil, verbose: nil)
531
532
532
533
# Creates {hard links}[https://en.wikipedia.org/wiki/Hard_link].
533
534
#
534
- # Arguments +src+ and +dest+
535
+ # Arguments +src+ (a single path or an array of paths)
536
+ # and +dest+ (a single path)
535
537
# should be {interpretable as paths}[rdoc-ref:FileUtils@Path+Arguments].
536
538
#
537
539
# If +src+ is the path to a directory and +dest+ does not exist,
@@ -615,7 +617,8 @@ def cp_lr(src, dest, noop: nil, verbose: nil,
615
617
616
618
# Creates {symbolic links}[https://en.wikipedia.org/wiki/Symbolic_link].
617
619
#
618
- # Arguments +src+ and +dest+
620
+ # Arguments +src+ (a single path or an array of paths)
621
+ # and +dest+ (a single path)
619
622
# should be {interpretable as paths}[rdoc-ref:FileUtils@Path+Arguments].
620
623
#
621
624
# When +src+ is the path to an existing file:
@@ -750,7 +753,8 @@ def link_entry(src, dest, dereference_root = false, remove_destination = false)
750
753
751
754
# Copies files from +src+ to +dest+.
752
755
#
753
- # Arguments +src+ and +dest+
756
+ # Arguments +src+ (a single path or an array of paths)
757
+ # and +dest+ (a single path)
754
758
# should be {interpretable as paths}[rdoc-ref:FileUtils@Path+Arguments].
755
759
#
756
760
# If +src+ is the path to a file and +dest+ is not the path to a directory,
@@ -991,7 +995,8 @@ def copy_stream(src, dest)
991
995
end
992
996
module_function :copy_stream
993
997
994
- # Moves files from +src+ to +dest+.
998
+ # Moves files from +src+ (a single path or an array of paths)
999
+ # to +dest+ (a single path).
995
1000
# If +src+ and +dest+ are on different devices,
996
1001
# first copies, then removes +src+.
997
1002
#
@@ -1087,7 +1092,8 @@ def mv(src, dest, force: nil, noop: nil, verbose: nil, secure: nil)
1087
1092
alias move mv
1088
1093
module_function :move
1089
1094
1090
- # Removes entries at the paths in the given +list+;
1095
+ # Removes entries at the paths in the given +list+
1096
+ # (a single path or an array of paths)
1091
1097
# returns +list+, if it is an array, <tt>[list]</tt> otherwise.
1092
1098
#
1093
1099
# Argument +list+ or its elements
@@ -1147,7 +1153,7 @@ def rm_f(list, noop: nil, verbose: nil)
1147
1153
module_function :safe_unlink
1148
1154
1149
1155
# Removes entries at the paths in the given +list+
1150
- # (an array of strings or a single string );
1156
+ # (a single path or an array of paths );
1151
1157
# returns +list+, if it is an array, <tt>[list]</tt> otherwise.
1152
1158
#
1153
1159
# Argument +list+ or its elements
@@ -1596,6 +1602,7 @@ def mode_to_s(mode) #:nodoc:
1596
1602
private_module_function :mode_to_s
1597
1603
1598
1604
# Changes permissions on the entries at the paths given in +list+
1605
+ # (a single path or an array of paths)
1599
1606
# to the permissions given by +mode+:
1600
1607
#
1601
1608
# - Modifies each entry that is a regular file using
@@ -1694,6 +1701,7 @@ def chmod_R(mode, list, noop: nil, verbose: nil, force: nil)
1694
1701
module_function :chmod_R
1695
1702
1696
1703
# Changes the owner and group on the entries at the paths given in +list+
1704
+ # (a single path or an array of paths)
1697
1705
# to the given +user+ and +group+:
1698
1706
#
1699
1707
# - Modifies each entry that is a regular file using
@@ -1818,7 +1826,8 @@ def fu_get_gid(group) #:nodoc:
1818
1826
private_module_function :fu_get_gid
1819
1827
1820
1828
# Updates modification times (mtime) and access times (atime)
1821
- # of the entries given by the paths in +list+;
1829
+ # of the entries given by the paths in +list+
1830
+ # (a single path or an array of paths);
1822
1831
# by default, creates an empty file for any path to a non-existent entry.
1823
1832
#
1824
1833
# Argument +list+ or its elements
0 commit comments