1berry/ruby
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[ruby/fileutils] [DOC] Enhanced RDoc for #ln (https://github.com/ruby/fileutils/pull/69)

Browse Source 
Enhanced RDoc for #ln

https://github.com/ruby/fileutils/commit/79fc67f03f

Co-authored-by: Peter Zhu <peter@peterzhu.ca>
This commit is contained in:
Burdette Lamar 2022-05-14 08:38:09 -05:00 committed by git
parent 708e839dee
commit 48002ff187
1 changed files with 44 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

59
lib/fileutils.rb
View File

@ -358,25 +358,54 @@ module FileUtils
module_function :rmdir module_function :rmdir
# #
# :call-seq: # When +src+ is the path to an existing file
# FileUtils.ln(target, link, force: nil, noop: nil, verbose: nil) # and +dest+ is the path to a non-existent file,
# FileUtils.ln(target, dir, force: nil, noop: nil, verbose: nil) # creates a hard link at +dest+ pointing to +src+; returns zero:
# FileUtils.ln(targets, dir, force: nil, noop: nil, verbose: nil)
# #
# In the first form, creates a hard link +link+ which points to +target+. # Dir.children('tmp0/') # => ["t.txt"]
# If +link+ already exists, raises Errno::EEXIST. # Dir.children('tmp1/') # => []
# But if the +force+ option is set, overwrites +link+. # FileUtils.ln('tmp0/t.txt', 'tmp1/t.lnk') # => 0
# Dir.children('tmp1/') # => ["t.lnk"]
# #
# FileUtils.ln 'gcc', 'cc', verbose: true # When +src+ is the path to an existing file
# FileUtils.ln '/usr/bin/emacs21', '/usr/bin/emacs' # and +dest+ is the path to an existing directory,
# creates a hard link in +dest+ pointing to +src+; returns zero:
# #
# In the second form, creates a link +dir/target+ pointing to +target+. # Dir.children('tmp2') # => ["t.dat"]
# In the third form, creates several hard links in the directory +dir+, # Dir.children('tmp3') # => []
# pointing to each item in +targets+. # FileUtils.ln('tmp2/t.dat', 'tmp3') # => 0
# If +dir+ is not a directory, raises Errno::ENOTDIR. # Dir.children('tmp3') # => ["t.dat"]
# #
# FileUtils.cd '/sbin' # When +src+ is an array of paths to existing files
# FileUtils.ln %w(cp mv mkdir), '/bin' # Now /sbin/cp and /bin/cp are linked. # and +dest+ is the path to an existing directory,
# then for each path +target+ in +src+,
# creates a hard link in +dest+ pointing to +target+;
# returns +src+:
#
# Dir.children('tmp4/') # => []
# FileUtils.ln(['tmp0/t.txt', 'tmp2/t.dat'], 'tmp4/') # => ["tmp0/t.txt", "tmp2/t.dat"]
# Dir.children('tmp4/') # => ["t.dat", "t.txt"]
#
# Keyword arguments:
#
# - <tt>force: true</tt> - overwrites +dest+ if it exists.
# - <tt>noop: true</tt> - does not create links.
# - <tt>verbose: true</tt> - prints an equivalent command:
#
# FileUtils.ln('tmp0/t.txt', 'tmp1/t.lnk', verbose: true)
# FileUtils.ln('tmp2/t.dat', 'tmp3', verbose: true)
# FileUtils.ln(['tmp0/t.txt', 'tmp2/t.dat'], 'tmp4/', verbose: true)
#
# Output:
#
# ln tmp0/t.txt tmp1/t.lnk
# ln tmp2/t.dat tmp3
# ln tmp0/t.txt tmp2/t.dat tmp4/
#
# Raises an exception if +dest+ is the path to an existing file
# and keyword argument +force+ is not +true+.
#
# FileUtils#link is an alias for FileUtils#ln.
# #
def ln(src, dest, force: nil, noop: nil, verbose: nil) def ln(src, dest, force: nil, noop: nil, verbose: nil)
fu_output_message "ln#{force ? ' -f' : ''} #{[src,dest].flatten.join ' '}" if verbose fu_output_message "ln#{force ? ' -f' : ''} #{[src,dest].flatten.join ' '}" if verbose