Skip to content

[DOC] Small tweaks #89

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
BurdetteLamar merged 4 commits into from
Jun 16, 2022
Merged

[DOC] Small tweaks #89

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3a90c4e
Small tweaks
BurdetteLamar Jun 15, 2022
37f8899
Small tweaks
BurdetteLamar Jun 16, 2022
6f2914f
Small tweaks
BurdetteLamar Jun 16, 2022
320e1de
Small tweaks
BurdetteLamar Jun 16, 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
21 changes: 15 additions & 6 deletions lib/fileutils.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -368,6 +368,8 @@ def mkdir(list, mode: nil, noop: nil, verbose: nil)
#
# Raises an exception if for any reason a directory cannot be created.
#
# FileUtils.mkpath and FileUtils.makedirs are aliases for FileUtils.mkdir_p.
#
def mkdir_p(list, mode: nil, noop: nil, verbose: nil)
list = fu_list(list)
fu_output_message "mkdir -p #{mode ? ('-m %03o ' % mode) : ''}#{list.join ' '}" if verbose
Expand Down Expand Up @@ -1161,7 +1163,7 @@ def rm(list, force: nil, noop: nil, verbose: nil)
#
# FileUtils.rm(list, force: true, **kwargs)
#
# Argument +list+ or its elements
# Argument +list+ (a single path or an array of paths)
# should be {interpretable as paths}[rdoc-ref:FileUtils@Path+Arguments].
#
# See FileUtils.rm for keyword arguments.
Expand Down Expand Up @@ -1422,6 +1424,8 @@ def remove_dir(path, force = false)
# Arguments +a+ and +b+
# should be {interpretable as a path}[rdoc-ref:FileUtils@Path+Arguments].
#
# FileUtils.identical? and FileUtils.cmp are aliases for FileUtils.compare_file.
#
def compare_file(a, b)
return false unless File.size(a) == File.size(b)
File.open(a, 'rb') {|fa|
Expand Down Expand Up @@ -1458,8 +1462,8 @@ def compare_stream(a, b)
end
module_function :compare_stream

# Copies a file entry;
# see {install(1)}[https://man7.org/linux/man-pages/man1/install.1.html].
# Copies a file entry.
# See {install(1)}[https://man7.org/linux/man-pages/man1/install.1.html].
#
# Arguments +src+ (a single path or an array of paths)
# and +dest+ (a single path)
Expand Down Expand Up @@ -1638,7 +1642,8 @@ def mode_to_s(mode) #:nodoc:

# 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+:
# to the permissions given by +mode+;
# returns +list+ if it is an array, <tt>[list]</tt> otherwise:
#
# - Modifies each entry that is a regular file using
# {File.chmod}[https://docs.ruby-lang.org/en/master/File.html#method-c-chmod].
Expand Down Expand Up @@ -1737,7 +1742,8 @@ def chmod_R(mode, list, noop: nil, verbose: nil, force: nil)

# 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+:
# to the given +user+ and +group+;
# returns +list+ if it is an array, <tt>[list]</tt> otherwise:
#
# - Modifies each entry that is a regular file using
# {File.chown}[https://docs.ruby-lang.org/en/master/File.html#method-c-chown].
Expand Down Expand Up @@ -1863,7 +1869,10 @@ def fu_get_gid(group) #:nodoc:
# Updates modification times (mtime) and access times (atime)
# 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.
# returns +list+ if it is an array, <tt>[list]</tt> otherwise.
#
# By default, creates an empty file for any path to a non-existent entry;
# use keyword argument +nocreate+ to raise an exception instead.
#
# Argument +list+ or its elements
# should be {interpretable as paths}[rdoc-ref:FileUtils@Path+Arguments].
Expand Down