diff options
author | Cody Cutrer <[email protected]> | 2023-10-09 11:35:20 -0600 |
---|---|---|
committer | git <[email protected]> | 2023-10-10 09:02:10 +0000 |
commit | fd21460898d2d5044c1bcc140927142921424791 (patch) | |
tree | 06c70a3d5d62c79ead270b0114b669c30911a1aa /lib/bundler/man | |
parent | 47274ba8c1faa3dedcb3c44c6d5082e4d673591f (diff) |
[rubygems/rubygems] Update bundle-plugin man page
The formatting was odd, and it hadn't been updated for how the global
source is handled.
https://github.com/rubygems/rubygems/commit/bf19a266ab
Diffstat (limited to 'lib/bundler/man')
-rw-r--r-- | lib/bundler/man/bundle-plugin.1 | 32 | ||||
-rw-r--r-- | lib/bundler/man/bundle-plugin.1.ronn | 10 |
2 files changed, 21 insertions, 21 deletions
diff --git a/lib/bundler/man/bundle-plugin.1 b/lib/bundler/man/bundle-plugin.1 index 6194553051..e295c30622 100644 --- a/lib/bundler/man/bundle-plugin.1 +++ b/lib/bundler/man/bundle-plugin.1 @@ -26,37 +26,37 @@ You can install, uninstall, and list plugin(s) with this command to extend funct .SS "install" Install the given plugin(s)\. . -.IP "\(bu" 4 -\fBbundle plugin install bundler\-graph\fR: Install bundler\-graph gem from RubyGems\.org\. The global source, specified in source in Gemfile is ignored\. +.TP +\fBbundle plugin install bundler\-graph\fR +Install bundler\-graph gem from globally configured sources (defaults to RubyGems\.org)\. The global source, specified in source in Gemfile is ignored\. . -.IP "\(bu" 4 -\fBbundle plugin install bundler\-graph \-\-source https://example\.com\fR: Install bundler\-graph gem from example\.com\. The global source, specified in source in Gemfile is not considered\. +.TP +\fBbundle plugin install bundler\-graph \-\-source https://example\.com\fR +Install bundler\-graph gem from example\.com\. The global source, specified in source in Gemfile is not considered\. . -.IP "\(bu" 4 -\fBbundle plugin install bundler\-graph \-\-version 0\.2\.1\fR: You can specify the version of the gem via \fB\-\-version\fR\. +.TP +\fBbundle plugin install bundler\-graph \-\-version 0\.2\.1\fR +You can specify the version of the gem via \fB\-\-version\fR\. . -.IP "\(bu" 4 -\fBbundle plugin install bundler\-graph \-\-git https://github\.com/rubygems/bundler\-graph\fR: Install bundler\-graph gem from Git repository\. \fB\-\-git\fR can be replaced with \fB\-\-local\-git\fR\. You cannot use both \fB\-\-git\fR and \fB\-\-local\-git\fR\. You can use standard Git URLs like: +.TP +\fBbundle plugin install bundler\-graph \-\-git https://github\.com/rubygems/bundler\-graph\fR +Install bundler\-graph gem from Git repository\. \fB\-\-git\fR can be replaced with \fB\-\-local\-git\fR\. You cannot use both \fB\-\-git\fR and \fB\-\-local\-git\fR\. You can use standard Git URLs like: . -.IP "\(bu" 4 +.IP \fBssh://[user@]host\.xz[:port]/path/to/repo\.git\fR . -.IP "\(bu" 4 +.br \fBhttp[s]://host\.xz[:port]/path/to/repo\.git\fR . -.IP "\(bu" 4 +.br \fB/path/to/repo\fR . -.IP "\(bu" 4 +.br \fBfile:///path/to/repo\fR . -.IP "" 0 -. .IP When you specify \fB\-\-git\fR/\fB\-\-local\-git\fR, you can use \fB\-\-branch\fR or \fB\-\-ref\fR to specify any branch, tag, or commit hash (revision) to use\. When you specify both, only the latter is used\. . -.IP "" 0 -. .SS "uninstall" Uninstall the plugin(s) specified in PLUGINS\. . diff --git a/lib/bundler/man/bundle-plugin.1.ronn b/lib/bundler/man/bundle-plugin.1.ronn index 4f234eeba7..a11df4c162 100644 --- a/lib/bundler/man/bundle-plugin.1.ronn +++ b/lib/bundler/man/bundle-plugin.1.ronn @@ -20,7 +20,7 @@ You can install, uninstall, and list plugin(s) with this command to extend funct Install the given plugin(s). * `bundle plugin install bundler-graph`: - Install bundler-graph gem from RubyGems.org. The global source, specified in source in Gemfile is ignored. + Install bundler-graph gem from globally configured sources (defaults to RubyGems.org). The global source, specified in source in Gemfile is ignored. * `bundle plugin install bundler-graph --source https://example.com`: Install bundler-graph gem from example.com. The global source, specified in source in Gemfile is not considered. @@ -31,10 +31,10 @@ Install the given plugin(s). * `bundle plugin install bundler-graph --git https://github.com/rubygems/bundler-graph`: Install bundler-graph gem from Git repository. `--git` can be replaced with `--local-git`. You cannot use both `--git` and `--local-git`. You can use standard Git URLs like: - * `ssh://[user@]host.xz[:port]/path/to/repo.git` - * `http[s]://host.xz[:port]/path/to/repo.git` - * `/path/to/repo` - * `file:///path/to/repo` + `ssh://[user@]host.xz[:port]/path/to/repo.git`<br> + `http[s]://host.xz[:port]/path/to/repo.git`<br> + `/path/to/repo`<br> + `file:///path/to/repo` When you specify `--git`/`--local-git`, you can use `--branch` or `--ref` to specify any branch, tag, or commit hash (revision) to use. When you specify both, only the latter is used. |