archive/ruby
1
0
Fork 0
mirror of https://github.com/ruby/ruby.git synced 2025-08-15 13:39:04 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

[rubygems/rubygems] Document missing options from man pages:

Browse source 
- The `bundle plugin uninstall --all` was missing.
- The `bundle plugin install --local-git` was missing due to being
  deprecated. We decided to reintroduce the doc for more clarity.

4da252945c
This commit is contained in:
Edouard CHIN 2025-07-24 14:57:53 +02:00 • committed by Hiroshi SHIBATA
parent 4dd708bf5d
commit da3c47bcfc
3 changed files with 18 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

10
lib/bundler/man/bundle-plugin.1
View file

@ -6,7 +6,7 @@
.SH "SYNOPSIS"
\fBbundle plugin\fR install PLUGINS [\-\-source=\fISOURCE\fR] [\-\-version=\fIversion\fR] [\-\-git=\fIgit\-url\fR] [\-\-branch=\fIbranch\fR|\-\-ref=\fIrev\fR] [\-\-path=\fIpath\fR]
.br
\fBbundle plugin\fR uninstall PLUGINS
\fBbundle plugin\fR uninstall PLUGINS [\-\-all]
.br
\fBbundle plugin\fR list
.br
@ -41,8 +41,16 @@ When you specify \fB\-\-git\fR, you can use \fB\-\-branch\fR or \fB\-\-ref\fR to
.TP
\fBbundle plugin install bundler\-graph \-\-path \.\./bundler\-graph\fR
Install bundler\-graph gem from a local path\.
.TP
\fBbundle plugin install bundler\-graph \-\-local\-git \.\./bundler\-graph\fR
This option is deprecated in favor of \fB\-\-git\fR\.
.SS "uninstall"
Uninstall the plugin(s) specified in PLUGINS\.
.P
\fBOPTIONS\fR
.TP
\fB\-\-all\fR
Uninstall all the installed plugins\. If no plugin is installed, then it does nothing\.
.SS "list"
List the installed plugins and available commands\.
.P

10
lib/bundler/man/bundle-plugin.1.ronn
View file

@ -6,7 +6,7 @@ bundle-plugin(1) -- Manage Bundler plugins
`bundle plugin` install PLUGINS [--source=<SOURCE>] [--version=<version>]
[--git=<git-url>] [--branch=<branch>|--ref=<rev>]
[--path=<path>]<br>
`bundle plugin` uninstall PLUGINS<br>
`bundle plugin` uninstall PLUGINS [--all]<br>
`bundle plugin` list<br>
`bundle plugin` help [COMMAND]
@ -42,10 +42,18 @@ Install the given plugin(s).
* `bundle plugin install bundler-graph --path ../bundler-graph`:
Install bundler-graph gem from a local path.
* `bundle plugin install bundler-graph --local-git ../bundler-graph`:
This option is deprecated in favor of `--git`.
### uninstall
Uninstall the plugin(s) specified in PLUGINS.
**OPTIONS**
* `--all`:
Uninstall all the installed plugins. If no plugin is installed, then it does nothing.
### list
List the installed plugins and available commands.