Skip to content

[DOC] More on paths and lists #86

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 14, 2022
Merged

[DOC] More on paths and lists #86

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5de8848
More on paths and lists
BurdetteLamar Jun 13, 2022
236367b
More on paths and lists
BurdetteLamar Jun 13, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 19 additions & 10 deletions lib/fileutils.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -336,7 +336,7 @@ def mkdir(list, mode: nil, noop: nil, verbose: nil)

#
# Creates directories at the paths in the given +list+
# (an array of strings or a single string),
# (a single path or an array of paths),
# also creating ancestor directories as needed;
# returns +list+ if it is an array, <tt>[list]</tt> otherwise.
#
Expand Down Expand Up @@ -412,7 +412,7 @@ def fu_mkdir(path, mode) #:nodoc:

#
# Removes directories at the paths in the given +list+
# (an array of strings or a single string);
# (a single path or an array of paths);
# returns +list+, if it is an array, <tt>[list]</tt> otherwise.
#
# Argument +list+ or its elements
Expand Down Expand Up @@ -464,7 +464,8 @@ def rmdir(list, parents: nil, noop: nil, verbose: nil)

# Creates {hard links}[https://en.wikipedia.org/wiki/Hard_link].
#
# 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].
#
# When +src+ is the path to an existing file
Expand Down Expand Up @@ -531,7 +532,8 @@ def ln(src, dest, force: nil, noop: nil, verbose: nil)

# Creates {hard links}[https://en.wikipedia.org/wiki/Hard_link].
#
# 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 directory and +dest+ does not exist,
Expand Down Expand Up @@ -615,7 +617,8 @@ def cp_lr(src, dest, noop: nil, verbose: nil,

# Creates {symbolic links}[https://en.wikipedia.org/wiki/Symbolic_link].
#
# 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].
#
# When +src+ is the path to an existing file:
Expand Down Expand Up @@ -750,7 +753,8 @@ def link_entry(src, dest, dereference_root = false, remove_destination = false)

# Copies files from +src+ to +dest+.
#
# 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,
Expand Down Expand Up @@ -991,7 +995,8 @@ def copy_stream(src, dest)
end
module_function :copy_stream

# Moves files from +src+ to +dest+.
# Moves files from +src+ (a single path or an array of paths)
# to +dest+ (a single path).
# If +src+ and +dest+ are on different devices,
# first copies, then removes +src+.
#
Expand Down Expand Up @@ -1087,7 +1092,8 @@ def mv(src, dest, force: nil, noop: nil, verbose: nil, secure: nil)
alias move mv
module_function :move

# Removes entries at the paths in the given +list+;
# Removes entries at the paths in the given +list+
# (a single path or an array of paths)
# returns +list+, if it is an array, <tt>[list]</tt> otherwise.
#
# Argument +list+ or its elements
Expand Down Expand Up @@ -1147,7 +1153,7 @@ def rm_f(list, noop: nil, verbose: nil)
module_function :safe_unlink

# Removes entries at the paths in the given +list+
# (an array of strings or a single string);
# (a single path or an array of paths);
# returns +list+, if it is an array, <tt>[list]</tt> otherwise.
#
# Argument +list+ or its elements
Expand Down Expand Up @@ -1596,6 +1602,7 @@ def mode_to_s(mode) #:nodoc:
private_module_function :mode_to_s

# Changes permissions on the entries at the paths given in +list+
# (a single path or an array of paths)
# to the permissions given by +mode+:
#
# - Modifies each entry that is a regular file using
Expand Down Expand Up @@ -1694,6 +1701,7 @@ def chmod_R(mode, list, noop: nil, verbose: nil, force: nil)
module_function :chmod_R

# Changes the owner and group on the entries at the paths given in +list+
# (a single path or an array of paths)
# to the given +user+ and +group+:
#
# - Modifies each entry that is a regular file using
Expand Down Expand Up @@ -1818,7 +1826,8 @@ def fu_get_gid(group) #:nodoc:
private_module_function :fu_get_gid

# Updates modification times (mtime) and access times (atime)
# of the entries given by the paths in +list+;
# of the entries given by the paths in +list+
# (a single path or an array of paths);
# by default, creates an empty file for any path to a non-existent entry.
#
# Argument +list+ or its elements
Expand Down