ruby-changes:61524
From: Frank <ko1@a...>
Date: Fri, 5 Jun 2020 07:33:58 +0900 (JST)
Subject: [ruby-changes:61524] 3c9d3d18f6 (master): [rubygems/rubygems] Rebuild bundler man pages
https://git.ruby-lang.org/ruby.git/commit/?id=3c9d3d18f6 From 3c9d3d18f6d54b4e11c22e1b0f5cecce2bb26c0a Mon Sep 17 00:00:00 2001 From: Frank Lam <ryzingsun11@y...> Date: Thu, 21 May 2020 18:22:47 +0800 Subject: [rubygems/rubygems] Rebuild bundler man pages * Recently built man pages on my branch had odd whitespace/characters resulting from using the macOS installed version of groff (v1.19) and homebrew's (v1.24) * Followed the advice in this pull request: https://github.com/rubygems/rubygems/pull/3394 * Encountered invalid byte sequence sed error, found this link: https://lists.gnu.org/archive/html/groff/2014-10/msg00072.html https://github.com/rubygems/rubygems/commit/f379d1d70e diff --git a/man/bundle-check.1.txt b/man/bundle-check.1.txt index e82dd0e..8c81ba6 100644 --- a/man/bundle-check.1.txt +++ b/man/bundle-check.1.txt @@ -9,8 +9,8 @@ SYNOPSIS https://github.com/ruby/ruby/blob/trunk/man/bundle-check.1.txt#L9 bundle check [--dry-run] [--gemfile=FILE] [--path=PATH] DESCRIPTION - check searches the local machine for each of the gems requested in the - Gemfile. If all gems are found, Bundler prints a success message and + check searches the local machine for each of the gems requested in the + Gemfile. If all gems are found, Bundler prints a success message and exits with a status of 0. If not, the first missing gem is listed and Bundler exits status 1. @@ -23,8 +23,8 @@ OPTIONS https://github.com/ruby/ruby/blob/trunk/man/bundle-check.1.txt#L23 Use the specified gemfile instead of the [Gemfile(5)][Gemfile(5)]. - --path Specify a different path than the system default ($BUNDLE_PATH - or $GEM_HOME). Bundler will remember this value for future + --path Specify a different path than the system default ($BUNDLE_PATH + or $GEM_HOME). Bundler will remember this value for future installs on this machine. diff --git a/man/bundle-config.1.txt b/man/bundle-config.1.txt index e6add9e..e6f7e0e 100644 --- a/man/bundle-config.1.txt +++ b/man/bundle-config.1.txt @@ -68,29 +68,29 @@ REMEMBERING OPTIONS https://github.com/ruby/ruby/blob/trunk/man/bundle-config.1.txt#L68 foo or --without production, are remembered between commands and saved to your local application's configuration (normally, ./.bundle/config). - However, this will be changed in bundler 3, so it's better not to rely - on this behavior. If these options must be remembered, it's better to + However, this will be changed in bundler 3, so it's better not to rely + on this behavior. If these options must be remembered, it's better to set them using bundle config (e.g., bundle config set path foo). The options that can be configured are: - bin Creates a directory (defaults to ~/bin) and place any + bin Creates a directory (defaults to ~/bin) and place any executables from the gem there. These executables run in Bundler's context. If used, you might add this directory to your - environment's PATH variable. For instance, if the rails gem + environment's PATH variable. For instance, if the rails gem comes with a rails executable, this flag will create a bin/rails - executable that ensures that all referred dependencies will be + executable that ensures that all referred dependencies will be resolved using the bundled gems. deployment - In deployment mode, Bundler will 'roll-out' the bundle for - production use. Please check carefully if you want to have this + In deployment mode, Bundler will 'roll-out' the bundle for + production use. Please check carefully if you want to have this option enabled in development or test environments. - path The location to install the specified gems to. This defaults to - Rubygems' setting. Bundler shares this location with Rubygems, - gem install ... will have gem installed there, too. Therefore, - gems installed without a --path ... setting will show up by + path The location to install the specified gems to. This defaults to + Rubygems' setting. Bundler shares this location with Rubygems, + gem install ... will have gem installed there, too. Therefore, + gems installed without a --path ... setting will show up by calling gem list. Accordingly, gems installed to other locations will not get listed. @@ -98,15 +98,15 @@ REMEMBERING OPTIONS https://github.com/ruby/ruby/blob/trunk/man/bundle-config.1.txt#L98 A space-separated list of groups referencing gems to skip during installation. - with A space-separated list of groups referencing gems to include + with A space-separated list of groups referencing gems to include during installation. BUILD OPTIONS - You can use bundle config to give Bundler the flags to pass to the gem + You can use bundle config to give Bundler the flags to pass to the gem installer every time bundler tries to install a particular gem. - A very common example, the mysql gem, requires Snow Leopard users to - pass configuration flags to gem install to specify where to find the + A very common example, the mysql gem, requires Snow Leopard users to + pass configuration flags to gem install to specify where to find the mysql_config executable. @@ -115,7 +115,7 @@ BUILD OPTIONS https://github.com/ruby/ruby/blob/trunk/man/bundle-config.1.txt#L115 - Since the specific location of that executable can change from machine + Since the specific location of that executable can change from machine to machine, you can specify these flags on a per-machine basis. @@ -124,44 +124,44 @@ BUILD OPTIONS https://github.com/ruby/ruby/blob/trunk/man/bundle-config.1.txt#L124 - After running this command, every time bundler needs to install the + After running this command, every time bundler needs to install the mysql gem, it will pass along the flags you specified. CONFIGURATION KEYS - Configuration keys in bundler have two forms: the canonical form and + Configuration keys in bundler have two forms: the canonical form and the environment variable form. - For instance, passing the --without flag to bundle install(1) - bundle-install.1.html prevents Bundler from installing certain groups - specified in the Gemfile(5). Bundler persists this value in - app/.bundle/config so that calls to Bundler.setup do not try to find + For instance, passing the --without flag to bundle install(1) + bundle-install.1.html prevents Bundler from installing certain groups + specified in the Gemfile(5). Bundler persists this value in + app/.bundle/config so that calls to Bundler.setup do not try to find gems from the Gemfile that you didn't install. Additionally, subsequent - calls to bundle install(1) bundle-install.1.html remember this setting + calls to bundle install(1) bundle-install.1.html remember this setting and skip those groups. - The canonical form of this configuration is "without". To convert the - canonical form to the environment variable form, capitalize it, and - prepend BUNDLE_. The environment variable form of "without" is + The canonical form of this configuration is "without". To convert the + canonical form to the environment variable form, capitalize it, and + prepend BUNDLE_. The environment variable form of "without" is BUNDLE_WITHOUT. - Any periods in the configuration keys must be replaced with two - underscores when setting it via environment variables. The - configuration key local.rack becomes the environment variable + Any periods in the configuration keys must be replaced with two + underscores when setting it via environment variables. The + configuration key local.rack becomes the environment variable BUNDLE_LOCAL__RACK. LIST OF AVAILABLE KEYS - The following is a list of all configuration keys and their purpose. - You can learn more about their operation in bundle install(1) + The following is a list of all configuration keys and their purpose. + You can learn more about their operation in bundle install(1) bundle-install.1.html. o allow_bundler_dependency_conflicts - (BUNDLE_ALLOW_BUNDLER_DEPENDENCY_CONFLICTS): Allow resolving to - specifications that have dependencies on bundler that are + (BUNDLE_ALLOW_BUNDLER_DEPENDENCY_CONFLICTS): Allow resolving to + specifications that have dependencies on bundler that are incompatible with the running Bundler version. o allow_deployment_source_credential_changes - (BUNDLE_ALLOW_DEPLOYMENT_SOURCE_CREDENTIAL_CHANGES): When in - deployment mode, allow changing the credentials to a gem's source. + (BUNDLE_ALLOW_DEPLOYMENT_SOURCE_CREDENTIAL_CHANGES): When in + deployment mode, allow changing the credentials to a gem's source. Ex: https://some.host.com/gems/path/ -> https://user_name:password@s.../gems/path @@ -169,64 +169,64 @@ LIST OF AVAILABLE KEYS h (... truncated) -- ML: ruby-changes@q... Info: http://www.atdot.net/~ko1/quickml/