diff options
| author | Burdette Lamar <[email protected]> | 2022-06-17 08:36:20 -0500 |
|---|---|---|
| committer | git <[email protected]> | 2022-06-17 22:36:26 +0900 |
| commit | 9327b6f2221ef05c496e65ecce86722ea47a7c3b () | |
| tree | c1d7f8bf7aca277f9a0dec03803f0ee5717fa30b /lib/fileutils.rb | |
| parent | 721e012d42a9fbc5b8484805c880f70cfefa94ef (diff) | |
[ruby/fileutils] [DOC] Revisions for module-level doc (https://.com/ruby/fileutils/pull/90)
* Revisions for module-level doc https://.com/ruby/fileutils/commit/dcbad90a1f
| -rw-r--r-- | lib/fileutils.rb | 170 |
1 files changed, 80 insertions, 90 deletions
@@ -6,17 +6,90 @@ rescue LoadError # for make mjit-headers end # -# = fileutils.rb # -# Copyright (c) 2000-2007 Minero Aoki # -# This program is free software. -# You can distribute/modify this program under the same terms of ruby. # -# == module FileUtils # -# Namespace for several file utility methods for copying, moving, removing, etc. # # == Path Arguments # @@ -59,89 +132,6 @@ end # |-- find_executable.rb # `-- helper.rb # -# === Module Functions -# -# require 'fileutils' -# -# FileUtils.cd(dir, **options) -# FileUtils.cd(dir, **options) {|dir| block } -# FileUtils.pwd() -# FileUtils.mkdir(dir, **options) -# FileUtils.mkdir(list, **options) -# FileUtils.mkdir_p(dir, **options) -# FileUtils.mkdir_p(list, **options) -# FileUtils.rmdir(dir, **options) -# FileUtils.rmdir(list, **options) -# FileUtils.ln(target, link, **options) -# FileUtils.ln(targets, dir, **options) -# FileUtils.ln_s(target, link, **options) -# FileUtils.ln_s(targets, dir, **options) -# FileUtils.ln_sf(target, link, **options) -# FileUtils.cp(src, dest, **options) -# FileUtils.cp(list, dir, **options) -# FileUtils.cp_r(src, dest, **options) -# FileUtils.cp_r(list, dir, **options) -# FileUtils.mv(src, dest, **options) -# FileUtils.mv(list, dir, **options) -# FileUtils.rm(list, **options) -# FileUtils.rm_r(list, **options) -# FileUtils.rm_rf(list, **options) -# FileUtils.install(src, dest, **options) -# FileUtils.chmod(mode, list, **options) -# FileUtils.chmod_R(mode, list, **options) -# FileUtils.chown(user, group, list, **options) -# FileUtils.chown_R(user, group, list, **options) -# FileUtils.touch(list, **options) -# -# Possible <tt>options</tt> are: -# -# <tt>:force</tt> :: forced operation (rewrite files if exist, remove -# directories if not empty, etc.); -# <tt>:verbose</tt> :: print command to be run, in bash syntax, before -# performing it; -# <tt>:preserve</tt> :: preserve object's group, user and modification -# time on copying; -# <tt>:noop</tt> :: no changes are made (usable in combination with -# <tt>:verbose</tt> which will print the command to run) -# -# Each method documents the options that it honours. See also ::commands, -# ::options and ::options_of methods to introspect which command have which -# options. -# -# All methods that have the concept of a "source" file or directory can take -# either one file or a list of files in that argument. See the method -# documentation for examples. -# -# There are some `low level' methods, which do not accept keyword arguments: -# -# FileUtils.copy_entry(src, dest, preserve = false, dereference_root = false, remove_destination = false) -# FileUtils.copy_file(src, dest, preserve = false, dereference = true) -# FileUtils.copy_stream(srcstream, deststream) -# FileUtils.remove_entry(path, force = false) -# FileUtils.remove_entry_secure(path, force = false) -# FileUtils.remove_file(path, force = false) -# FileUtils.compare_file(path_a, path_b) -# FileUtils.compare_stream(stream_a, stream_b) -# FileUtils.uptodate?(file, cmp_list) -# -# == module FileUtils::Verbose -# -# This module has all methods of FileUtils module, but it outputs messages -# before acting. This equates to passing the <tt>:verbose</tt> flag to methods -# in FileUtils. -# -# == module FileUtils::NoWrite -# -# This module has all methods of FileUtils module, but never changes -# files/directories. This equates to passing the <tt>:noop</tt> flag to methods -# in FileUtils. -# -# == module FileUtils::DryRun -# -# This module has all methods of FileUtils module, but never changes -# files/directories. This equates to passing the <tt>:noop</tt> and -# <tt>:verbose</tt> flags to methods in FileUtils. -# # == Avoiding the TOCTTOU Vulnerability # # For certain methods that recursively remove entries, @@ -2411,7 +2401,7 @@ module FileUtils public # Returns an array of the string names of \FileUtils methods - # that accept one or more keyword arguments; # # FileUtils.commands.sort.take(3) # => ["cd", "chdir", "chmod"] # |