You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* Added document for Gem::Uninstaller
* Apply suggestion from @deivid-rodriguez
Co-authored-by: David Rodríguez <2887858+deivid-rodriguez@users.noreply.github.com>
---------
Co-authored-by: David Rodríguez <2887858+deivid-rodriguez@users.noreply.github.com>
Copy file name to clipboardExpand all lines: lib/rubygems/uninstaller.rb
+17-6Lines changed: 17 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -42,10 +42,25 @@ class Gem::Uninstaller
42
42
attr_reader:spec
43
43
44
44
##
45
-
# Constructs an uninstaller that will uninstall +gem+
45
+
# Constructs an uninstaller that will uninstall gem named +gem+.
46
+
# +options+ is a Hash with the following keys:
47
+
#
48
+
# :version:: Version requirement for the gem to uninstall. If not specified,
49
+
# uses Gem::Requirement.default.
50
+
# :install_dir:: The directory where the gem is installed. If not specified,
51
+
# uses Gem.dir.
52
+
# :executables:: Whether executables should be removed without confirmation or not. If nil, asks the user explicitly.
53
+
# :all:: If more than one version matches the requirement, whether to forcefully remove all matching versions or ask the user to select specific matching versions that should be removed.
54
+
# :ignore:: Ignore broken dependency checks when uninstalling.
55
+
# :bin_dir:: Directory containing executables to remove. If not specified,
56
+
# uses Gem.bindir.
57
+
# :format_executable:: In order to find executables to be removed, format executable names using Gem::Installer.exec_format.
58
+
# :abort_on_dependent:: Directly abort uninstallation if dependencies would be broken, rather than asking the user for confirmation.
59
+
# :check_dev:: When checking if uninstalling gem would leave broken dependencies around, also consider development dependencies.
60
+
# :force:: Set both :all and :ignore to true for forced uninstallation.
61
+
# :user_install:: Uninstall from user gem directory instead of system directory.
0 commit comments