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

[rubygems/rubygems] Fix unintended double spaces in DSL documentation

Browse Source 
https://github.com/rubygems/rubygems/commit/b1826876d0
This commit is contained in:
David Rodríguez 2022-06-30 09:53:33 +02:00 committed by git
parent 8eb5198ccc
commit b0c639f249
2 changed files with 64 additions and 64 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

56
lib/bundler/man/gemfile.5
View File

@ -100,7 +100,7 @@ Each application \fImay\fR specify a Ruby engine version\. If an engine version
. .
.nf .nf
ruby "1\.8\.7", engine: "jruby", engine_version: "1\.6\.7" ruby "1\.8\.7", engine: "jruby", engine_version: "1\.6\.7"
. .
.fi .fi
. .
@ -113,7 +113,7 @@ Each application \fImay\fR specify a Ruby patchlevel\.
. .
.nf .nf
ruby "2\.0\.0", patchlevel: "247" ruby "2\.0\.0", patchlevel: "247"
. .
.fi .fi
. .
@ -156,9 +156,9 @@ Each \fIgem\fR \fBMAY\fR specify files that should be used when autorequiring vi
. .
.nf .nf
gem "redis", require: ["redis/connection/hiredis", "redis"] gem "redis", require: ["redis/connection/hiredis", "redis"]
gem "webmock", require: false gem "webmock", require: false
gem "byebug", require: true gem "byebug", require: true
. .
.fi .fi
. .
@ -172,8 +172,8 @@ The argument defaults to the name of the gem\. For example, these are identical:
.nf .nf
gem "nokogiri" gem "nokogiri"
gem "nokogiri", require: "nokogiri" gem "nokogiri", require: "nokogiri"
gem "nokogiri", require: true gem "nokogiri", require: true
. .
.fi .fi
. .
@ -186,8 +186,8 @@ Each \fIgem\fR \fBMAY\fR specify membership in one or more groups\. Any \fIgem\f
. .
.nf .nf
gem "rspec", group: :test gem "rspec", group: :test
gem "wirble", groups: [:development, :test] gem "wirble", groups: [:development, :test]
. .
.fi .fi
. .
@ -320,9 +320,9 @@ As with groups, you can specify one or more platforms:
. .
.nf .nf
gem "weakling", platforms: :jruby gem "weakling", platforms: :jruby
gem "ruby\-debug", platforms: :mri_18 gem "ruby\-debug", platforms: :mri_18
gem "nokogiri", platforms: [:mri_18, :jruby] gem "nokogiri", platforms: [:mri_18, :jruby]
. .
.fi .fi
. .
@ -338,7 +338,7 @@ You can select an alternate Rubygems repository for a gem using the \':source\'
. .
.nf .nf
gem "some_internal_gem", source: "https://gems\.example\.com" gem "some_internal_gem", source: "https://gems\.example\.com"
. .
.fi .fi
. .
@ -393,7 +393,7 @@ If a git repository does have a \fB\.gemspec\fR for the gem you attached it to,
. .
.nf .nf
gem "rails", "2\.3\.8", git: "https://github\.com/rails/rails\.git" gem "rails", "2\.3\.8", git: "https://github\.com/rails/rails\.git"
# bundle install will fail, because the \.gemspec in the rails # bundle install will fail, because the \.gemspec in the rails
# repository\'s master branch specifies version 3\.0\.0 # repository\'s master branch specifies version 3\.0\.0
. .
@ -454,7 +454,7 @@ A custom git source can be defined via the \fBgit_source\fR method\. Provide the
.nf .nf
git_source(:stash){ |repo_name| "https://stash\.corp\.acme\.pl/#{repo_name}\.git" } git_source(:stash){ |repo_name| "https://stash\.corp\.acme\.pl/#{repo_name}\.git" }
gem \'rails\', stash: \'forks/rails\' gem \'rails\', stash: \'forks/rails\'
. .
.fi .fi
. .
@ -467,7 +467,7 @@ In addition, if you wish to choose a specific branch:
. .
.nf .nf
gem "rails", stash: "forks/rails", branch: "branch_name" gem "rails", stash: "forks/rails", branch: "branch_name"
. .
.fi .fi
. .
@ -483,8 +483,8 @@ If the git repository you want to use is hosted on GitHub and is public, you can
. .
.nf .nf
gem "rails", github: "rails/rails" gem "rails", github: "rails/rails"
gem "rails", github: "rails" gem "rails", github: "rails"
. .
.fi .fi
. .
@ -497,7 +497,7 @@ Are both equivalent to
. .
.nf .nf
gem "rails", git: "git://github\.com/rails/rails\.git" gem "rails", git: "git://github\.com/rails/rails\.git"
. .
.fi .fi
. .
@ -513,7 +513,7 @@ You can also directly pass a pull request URL:
. .
.nf .nf
gem "rails", github: "https://github\.com/rails/rails/pull/43753" gem "rails", github: "https://github\.com/rails/rails/pull/43753"
. .
.fi .fi
. .
@ -526,7 +526,7 @@ Which is equivalent to:
. .
.nf .nf
gem "rails", github: "rails/rails", branch: "refs/pull/43753/head" gem "rails", github: "rails/rails", branch: "refs/pull/43753/head"
. .
.fi .fi
. .
@ -539,7 +539,7 @@ If the git repository you want to use is hosted as a GitHub Gist and is public,
. .
.nf .nf
gem "the_hatch", gist: "4815162342" gem "the_hatch", gist: "4815162342"
. .
.fi .fi
. .
@ -552,7 +552,7 @@ Is equivalent to:
. .
.nf .nf
gem "the_hatch", git: "https://gist\.github\.com/4815162342\.git" gem "the_hatch", git: "https://gist\.github\.com/4815162342\.git"
. .
.fi .fi
. .
@ -568,8 +568,8 @@ If the git repository you want to use is hosted on Bitbucket and is public, you
. .
.nf .nf
gem "rails", bitbucket: "rails/rails" gem "rails", bitbucket: "rails/rails"
gem "rails", bitbucket: "rails" gem "rails", bitbucket: "rails"
. .
.fi .fi
. .
@ -582,7 +582,7 @@ Are both equivalent to
. .
.nf .nf
gem "rails", git: "https://rails@bitbucket\.org/rails/rails\.git" gem "rails", git: "https://rails@bitbucket\.org/rails/rails\.git"
. .
.fi .fi
. .
@ -604,7 +604,7 @@ Unlike \fB:git\fR, bundler does not compile C extensions for gems specified as p
. .
.nf .nf
gem "rails", path: "vendor/rails" gem "rails", path: "vendor/rails"
. .
.fi .fi
. .
@ -648,7 +648,7 @@ platforms :ruby do
gem "sqlite3" gem "sqlite3"
end end
group :development, optional: true do group :development, optional: true do
gem "wirble" gem "wirble"
gem "faker" gem "faker"
end end

72
lib/bundler/man/gemfile.5.ronn
View File

@ -91,13 +91,13 @@ Each application _may_ specify a Ruby engine version. If an engine version is
specified, an engine _must_ also be specified. If the engine is "ruby" the specified, an engine _must_ also be specified. If the engine is "ruby" the
engine version specified _must_ match the Ruby version. engine version specified _must_ match the Ruby version.
ruby "1.8.7", engine: "jruby", engine_version: "1.6.7" ruby "1.8.7", engine: "jruby", engine_version: "1.6.7"
### PATCHLEVEL ### PATCHLEVEL
Each application _may_ specify a Ruby patchlevel. Each application _may_ specify a Ruby patchlevel.
ruby "2.0.0", patchlevel: "247" ruby "2.0.0", patchlevel: "247"
## GEMS ## GEMS
@ -124,23 +124,23 @@ Each _gem_ `MAY` specify files that should be used when autorequiring via
you want `required` has the same name as _gem_ or `false` to you want `required` has the same name as _gem_ or `false` to
prevent any file from being autorequired. prevent any file from being autorequired.
gem "redis", require: ["redis/connection/hiredis", "redis"] gem "redis", require: ["redis/connection/hiredis", "redis"]
gem "webmock", require: false gem "webmock", require: false
gem "byebug", require: true gem "byebug", require: true
The argument defaults to the name of the gem. For example, these are identical: The argument defaults to the name of the gem. For example, these are identical:
gem "nokogiri" gem "nokogiri"
gem "nokogiri", require: "nokogiri" gem "nokogiri", require: "nokogiri"
gem "nokogiri", require: true gem "nokogiri", require: true
### GROUPS ### GROUPS
Each _gem_ `MAY` specify membership in one or more groups. Any _gem_ that does Each _gem_ `MAY` specify membership in one or more groups. Any _gem_ that does
not specify membership in any group is placed in the `default` group. not specify membership in any group is placed in the `default` group.
gem "rspec", group: :test gem "rspec", group: :test
gem "wirble", groups: [:development, :test] gem "wirble", groups: [:development, :test]
The Bundler runtime allows its two main methods, `Bundler.setup` and The Bundler runtime allows its two main methods, `Bundler.setup` and
`Bundler.require`, to limit their impact to particular groups. `Bundler.require`, to limit their impact to particular groups.
@ -223,9 +223,9 @@ The full list of platforms and supported versions includes:
As with groups, you can specify one or more platforms: As with groups, you can specify one or more platforms:
gem "weakling", platforms: :jruby gem "weakling", platforms: :jruby
gem "ruby-debug", platforms: :mri_18 gem "ruby-debug", platforms: :mri_18
gem "nokogiri", platforms: [:mri_18, :jruby] gem "nokogiri", platforms: [:mri_18, :jruby]
All operations involving groups ([`bundle install`](bundle-install.1.html), `Bundler.setup`, All operations involving groups ([`bundle install`](bundle-install.1.html), `Bundler.setup`,
`Bundler.require`) behave exactly the same as if any groups not `Bundler.require`) behave exactly the same as if any groups not
@ -236,7 +236,7 @@ matching the current platform were explicitly excluded.
You can select an alternate Rubygems repository for a gem using the ':source' You can select an alternate Rubygems repository for a gem using the ':source'
option. option.
gem "some_internal_gem", source: "https://gems.example.com" gem "some_internal_gem", source: "https://gems.example.com"
This forces the gem to be loaded from this source and ignores any global sources This forces the gem to be loaded from this source and ignores any global sources
declared at the top level of the file. If the gem does not exist in this source, declared at the top level of the file. If the gem does not exist in this source,
@ -263,11 +263,11 @@ git repository using the `:git` parameter. The repository can be accessed via
several protocols: several protocols:
* `HTTP(S)`: * `HTTP(S)`:
gem "rails", git: "https://github.com/rails/rails.git" gem "rails", git: "https://github.com/rails/rails.git"
* `SSH`: * `SSH`:
gem "rails", git: "git@github.com:rails/rails.git" gem "rails", git: "git@github.com:rails/rails.git"
* `git`: * `git`:
gem "rails", git: "git://github.com/rails/rails.git" gem "rails", git: "git://github.com/rails/rails.git"
If using SSH, the user that you use to run `bundle install` `MUST` have the If using SSH, the user that you use to run `bundle install` `MUST` have the
appropriate keys available in their `$HOME/.ssh`. appropriate keys available in their `$HOME/.ssh`.
@ -295,7 +295,7 @@ to, a version specifier, if provided, means that the git repository is
only valid if the `.gemspec` specifies a version matching the version only valid if the `.gemspec` specifies a version matching the version
specifier. If not, bundler will print a warning. specifier. If not, bundler will print a warning.
gem "rails", "2.3.8", git: "https://github.com/rails/rails.git" gem "rails", "2.3.8", git: "https://github.com/rails/rails.git"
# bundle install will fail, because the .gemspec in the rails # bundle install will fail, because the .gemspec in the rails
# repository's master branch specifies version 3.0.0 # repository's master branch specifies version 3.0.0
@ -307,18 +307,18 @@ Git repositories support a number of additional options.
* `branch`, `tag`, and `ref`: * `branch`, `tag`, and `ref`:
You `MUST` only specify at most one of these options. The default You `MUST` only specify at most one of these options. The default
is `branch: "master"`. For example: is `branch: "master"`. For example:
gem "rails", git: "https://github.com/rails/rails.git", branch: "5-0-stable" gem "rails", git: "https://github.com/rails/rails.git", branch: "5-0-stable"
gem "rails", git: "https://github.com/rails/rails.git", tag: "v5.0.0" gem "rails", git: "https://github.com/rails/rails.git", tag: "v5.0.0"
gem "rails", git: "https://github.com/rails/rails.git", ref: "4aded" gem "rails", git: "https://github.com/rails/rails.git", ref: "4aded"
* `submodules`: * `submodules`:
For reference, a [git submodule](https://git-scm.com/book/en/v2/Git-Tools-Submodules) For reference, a [git submodule](https://git-scm.com/book/en/v2/Git-Tools-Submodules)
lets you have another git repository within a subfolder of your repository. lets you have another git repository within a subfolder of your repository.
Specify `submodules: true` to cause bundler to expand any Specify `submodules: true` to cause bundler to expand any
submodules included in the git repository submodules included in the git repository
If a git repository contains multiple `.gemspecs`, each `.gemspec` If a git repository contains multiple `.gemspecs`, each `.gemspec`
@ -346,11 +346,11 @@ as an argument, and a block which receives a single argument and interpolates it
string to return the full repo address: string to return the full repo address:
git_source(:stash){ |repo_name| "https://stash.corp.acme.pl/#{repo_name}.git" } git_source(:stash){ |repo_name| "https://stash.corp.acme.pl/#{repo_name}.git" }
gem 'rails', stash: 'forks/rails' gem 'rails', stash: 'forks/rails'
In addition, if you wish to choose a specific branch: In addition, if you wish to choose a specific branch:
gem "rails", stash: "forks/rails", branch: "branch_name" gem "rails", stash: "forks/rails", branch: "branch_name"
### GITHUB ### GITHUB
@ -363,33 +363,33 @@ If the git repository you want to use is hosted on GitHub and is public, you can
trailing ".git"), separated by a slash. If both the username and repository name are the trailing ".git"), separated by a slash. If both the username and repository name are the
same, you can omit one. same, you can omit one.
gem "rails", github: "rails/rails" gem "rails", github: "rails/rails"
gem "rails", github: "rails" gem "rails", github: "rails"
Are both equivalent to Are both equivalent to
gem "rails", git: "git://github.com/rails/rails.git" gem "rails", git: "git://github.com/rails/rails.git"
Since the `github` method is a specialization of `git_source`, it accepts a `:branch` named argument. Since the `github` method is a specialization of `git_source`, it accepts a `:branch` named argument.
You can also directly pass a pull request URL: You can also directly pass a pull request URL:
gem "rails", github: "https://github.com/rails/rails/pull/43753" gem "rails", github: "https://github.com/rails/rails/pull/43753"
Which is equivalent to: Which is equivalent to:
gem "rails", github: "rails/rails", branch: "refs/pull/43753/head" gem "rails", github: "rails/rails", branch: "refs/pull/43753/head"
### GIST ### GIST
If the git repository you want to use is hosted as a GitHub Gist and is public, you can use If the git repository you want to use is hosted as a GitHub Gist and is public, you can use
the :gist shorthand to specify the gist identifier (without the trailing ".git"). the :gist shorthand to specify the gist identifier (without the trailing ".git").
gem "the_hatch", gist: "4815162342" gem "the_hatch", gist: "4815162342"
Is equivalent to: Is equivalent to:
gem "the_hatch", git: "https://gist.github.com/4815162342.git" gem "the_hatch", git: "https://gist.github.com/4815162342.git"
Since the `gist` method is a specialization of `git_source`, it accepts a `:branch` named argument. Since the `gist` method is a specialization of `git_source`, it accepts a `:branch` named argument.
@ -400,12 +400,12 @@ If the git repository you want to use is hosted on Bitbucket and is public, you
trailing ".git"), separated by a slash. If both the username and repository name are the trailing ".git"), separated by a slash. If both the username and repository name are the
same, you can omit one. same, you can omit one.
gem "rails", bitbucket: "rails/rails" gem "rails", bitbucket: "rails/rails"
gem "rails", bitbucket: "rails" gem "rails", bitbucket: "rails"
Are both equivalent to Are both equivalent to
gem "rails", git: "https://rails@bitbucket.org/rails/rails.git" gem "rails", git: "https://rails@bitbucket.org/rails/rails.git"
Since the `bitbucket` method is a specialization of `git_source`, it accepts a `:branch` named argument. Since the `bitbucket` method is a specialization of `git_source`, it accepts a `:branch` named argument.
@ -423,7 +423,7 @@ version that bundler should use.
Unlike `:git`, bundler does not compile C extensions for Unlike `:git`, bundler does not compile C extensions for
gems specified as paths. gems specified as paths.
gem "rails", path: "vendor/rails" gem "rails", path: "vendor/rails"
If you would like to use multiple local gems directly from the filesystem, you can set a global `path` option to the path containing the gem's files. This will automatically load gemspec files from subdirectories. If you would like to use multiple local gems directly from the filesystem, you can set a global `path` option to the path containing the gem's files. This will automatically load gemspec files from subdirectories.
@ -452,7 +452,7 @@ applied to a group of gems by using block form.
gem "sqlite3" gem "sqlite3"
end end
group :development, optional: true do group :development, optional: true do
gem "wirble" gem "wirble"
gem "faker" gem "faker"
end end