Commit graph

128 commits

Author SHA1 Message Date
Edouard CHIN
da3c47bcfc [rubygems/rubygems] Document missing options from man pages:
- 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
2025-07-25 11:10:42 +09:00
David Rodríguez
60fca1defc
Cancel --force deprecation in favor of --redownload
I realized `--redownload` is not a good name, because it does not
necessarily redownloads gems. It only forces reinstallation even if gem
is already installed.

So I believe `--force` is actually a better name and the introduction of
`--force` was a misunderstanding of what the `--force` flag did at the
time.

Let's cancel the deprecation of `--force`.

For now the `--redownload` alias is left around until we decide what to
do with it.
2025-07-17 11:10:46 +09:00
Sweta Sanghavi
4ed2757543 [rubygems/rubygems] Update gemspec based on provided github username when exists
* Conditionally set changelog_url if gh username passed
and enabled
* conditionally set homepage, source code uri, homepage uri when gh
  username passed in
* update documentation to say username will also be used for gemspec file

1c1ada593b
2025-07-09 13:48:37 +09:00
David Rodríguez
3c552881d4 [rubygems/rubygems] Document that global_gem_cache also caches compiled extensions
265f718be7
2025-07-07 11:53:14 +09:00
David Rodríguez
3eeffea28d [rubygems/rubygems] Improve sentence
"locally to the installing Ruby installation" felt a bit confusing.

c950720719
2025-07-07 11:53:13 +09:00
David Rodríguez
6a5808965b [rubygems/rubygems] Stop allowing calling #gem on random objects
4b8570ae15
2025-07-07 11:53:12 +09:00
David Rodríguez
845e878f88 [rubygems/rubygems] Add default_cli_command documentation
I suspect most experienced users won't like the change in defaults, so
document the setting to toggle back the current default.

93e2e2bef9
2025-07-07 11:53:12 +09:00
David Rodríguez
cd3389e5c2 [rubygems/rubygems] Cancel path_relative_to_cwd change
It only affected the `--path` flag which is actually getting removed, so
I don't think it makes sense to make such change. The current behavior
is reasonable and I tried to codify it with a few more specs.

6f520eb146
2025-07-07 11:53:11 +09:00
David Rodríguez
9918ca1671 [rubygems/rubygems] Remove default_install_uses_path setting
The previous default can already be configured with `bundle config
path.system true`.

cb483b79db
2025-07-07 11:53:00 +09:00
David Rodríguez
fef0051926 [rubygems/rubygems] Remove auto_clean_without_path setting
There already different ways of toggling off this behavior, like setting
`bundle config clean false`, or configuring Bundler to install to system
gems with `bundle config path.system true`.

6daa09f60a
2025-07-07 11:52:58 +09:00
David Rodríguez
7f057e13e0
[rubygems/rubygems] Add a verbose setting to enable verbose output for all commands
0aa1be946f
2025-07-02 10:34:19 +09:00
Edouard CHIN
098b0cd7be
[rubygems/rubygems] Update man pages for the bundle doctor ssl subcommand:
- ### Problem

  The man pages for `bundle doctor` which shows up when running
  `bundle doctor --help` are no longer in sync with the CLI.

  ### Context

  In #8624, we introduced a change that modifies the structure of
  the `bundle doctor` command.
  The change added a new subcommand as well a new flag option
  `bundle doctor --ssl`

  Bundler uses man pages to display help of Thor commands, those man
  pages are indepedent from Thor options and need to be kept in sync.

  ### Solution

  Updated the man page for `bundle doctor`. Now that this command is
  a subcommand composed of `bundle doctor diagnose` (the default) ,
  and `bundle doctor ssl`, I modified the man page to follow
  the same markdown structure as other subcommands such as
  [bundle plugin](a902381660/bundler/lib/bundler/man/bundle-plugin.1.ronn)

de047f1458
2025-07-02 10:34:19 +09:00
David Rodríguez
cac7644bdb
[rubygems/rubygems] Document the simulate_version setting
1ffd83f6c2
2025-07-02 10:34:18 +09:00
David Rodríguez
daedebd64a
[rubygems/rubygems] Remove print_only_version_number setting
I don't think it makes sense to make this tiny behavior change
configurable. If someone wants to parse version output, and we have a
public setting, they are going to need to accommodate their regexps to
both values of the setting.

In addition to this, I plan to enhance version output with a note about
"simulated version", and in that case, "print_only_version_number" would
no longer hold, since what we print will be more than that anyways.

So, I'd like to remove the setting and change the output in Bundler 4
with no way to opt out.

d84e9dcf09
2025-07-02 10:34:18 +09:00
David Rodríguez
d6bfb73fb6 [rubygems/rubygems] Update some reference to Bundler 3 to Bundler 4
53174e0aa6
2025-06-30 12:56:50 +09:00
Hiroshi SHIBATA
59585b2f43 [rubygems/rubygems] Added manpages
f2826dafce
2025-06-30 12:56:50 +09:00
Joshua Young
8abb87b9c7 [rubygems/rubygems] Remove duplicate documentation for --changelog flag
9f1d07685f
2025-06-12 08:40:51 +09:00
David Rodríguez
3fdaa6a19c [rubygems/rubygems] Fix typos in some documentation lists making them render incorrectly
19739ba71c
2025-06-12 08:40:50 +09:00
David Rodríguez
ca7bd59794 [rubygems/rubygems] Update man pages month
3e4687616a
2025-06-12 08:40:50 +09:00
Matthew Hively
21a14ea230
[rubygems/rubygems] Moved the REMEMBERING OPTIONS section to be after CONFIGURATION KEYS
Since the remembering options are discouraged, the preferred method should be explained first.

Slight tweak to wording

Fix documentation spec test as per suggested patch

9f082ccf31
2025-06-03 07:47:14 +09:00
Matthew Hively
f4a5247ce4
[rubygems/rubygems] Clarify how BUNDLE_DEPLOYMENT, BUNDLE_FROZEN and BUNDLE_PATH are connected
9ed20bddab
2025-06-03 07:47:14 +09:00
Jacob Atzen
63dbb2f8a2 [rubygems/rubygems] Update docs for with/without consistency
The with and without flags accepts both comma and space separated values.

b6149f61e3
2025-03-12 18:02:09 +09:00
Michael Chui
fdf1076ef9 [rubygems/rubygems] docs(bundle-exec): recommend non-deprecated methods
3b4934fb69
2025-03-03 15:52:35 +09:00
Mateo
a98c3d229e [rubygems/rubygems] docs(bundle-config): hint default group when using only option
c258e45b44
2025-03-03 15:52:35 +09:00
Josef Šimánek
29e3ee0568 [rubygems/rubygems] Bring man pages up to date
591d2c0503
2025-03-03 15:52:35 +09:00
David Rodríguez
1fae0d7256 Use ronn-ng again for documentation generation
We switched to nronn because ronn-ng felt abandoned, but it seems
it has activity again, so switch back.
2025-01-14 12:24:37 +09:00
David Rodríguez
9e0eb9778d Merge RubyGems-3.6.2 and Bundler-2.6.2 2024-12-24 07:21:10 +09:00
David Rodríguez
cfb7213882 [rubygems/rubygems] Normalize CLI flag documentation and make sure all flags are documented
20a834818b
2024-12-11 17:56:28 +00:00
Adam Leach
e1fcf20ea1 [rubygems/rubygems] Add documentation for changelog flags in bundle gem
The --changelog and --no-changelog flags are missing from docs, this adds them in a way that matches other flags

92f77678fe
2024-12-11 17:56:28 +00:00
David Rodríguez
f658f66124 [rubygems/rubygems] Add missing --pre flag to bundle update --help
21335a7378
2024-12-11 17:56:27 +00:00
David Rodríguez
af11c8ef4f [rubygems/rubygems] Add missing --outdated flag to bundle show --help
2864e54ce3
2024-12-11 17:56:27 +00:00
David Rodríguez
a1fee6de95 [rubygems/rubygems] Add missing flags documentation to bundle outdated --help
ad3b654bf3
2024-12-11 17:56:26 +00:00
David Rodríguez
1806f3facc [rubygems/rubygems] Add several missing flags to bundle lock --help
4070da1264
2024-12-11 17:56:26 +00:00
David Rodríguez
496e791a2e [rubygems/rubygems] Add missing flag documentation to bundle inject --help
2a01773cdb
2024-12-11 17:56:25 +00:00
David Rodríguez
6e3a6f6411 [rubygems/rubygems] Add missing --version flag to bundle info --help
5022b49e31
2024-12-11 17:56:25 +00:00
David Rodríguez
f5ed1b56d0 [rubygems/rubygems] Add several missing flags to bundle gem --help
aaf6398870
2024-12-11 17:56:24 +00:00
David Rodríguez
443319de35 [rubygems/rubygems] Add missing --gemfile flag to exec, lock, and update command's help
418dfbf373
2024-12-11 17:56:24 +00:00
David Rodríguez
c4bd744800 [rubygems/rubygems] Normalize whitespace in option lists in man pages
33ff4f8f2f
2024-12-11 17:56:24 +00:00
David Rodríguez
5633cff415 [rubygems/rubygems] Add missing flag documentation to bundle cache --help
b760a882a1
2024-12-11 17:56:23 +00:00
David Rodríguez
e88039ee4c [rubygems/rubygems] Add missing --all-platforms flag to bundle binstubs --help
440b7b8282
2024-12-11 17:56:23 +00:00
David Rodríguez
447189d7de [rubygems/rubygems] Add missing --glob flag to bundle add --help
1e4dc0a703
2024-12-11 17:56:22 +00:00
David Rodríguez
bbd11a7975 [rubygems/rubygems] Add missing --target-rbconfig flag to bundle install --help
54dbcdc656
2024-12-11 17:56:22 +00:00
David Rodríguez
b37ab8c123 [rubygems/rubygems] Add missing man pages for bundle env and bundle licenses commands
6e1a515d58
2024-12-11 16:18:12 +00:00
David Rodríguez
d91ca85b97 [rubygems/rubygems] Bring man pages up to date
8288cfd3e0
2024-12-11 16:18:11 +00:00
David Rodríguez
e31f6a8f8b [rubygems/rubygems] Align all header lines with titles for consistency
83fd1c6718
2024-12-11 16:18:10 +00:00
Andrew Nesbitt
b4969348bf [rubygems/rubygems] Add man page for 'bundle issue' command
3f39571181
2024-11-20 19:13:27 +00:00
Andrew Nesbitt
0914da52e0 [rubygems/rubygems] Add man page for 'bundle fund' command
Signed-off-by: Andrew Nesbitt <andrewnez@gmail.com>

897819da36
2024-11-19 16:36:19 +00:00
David Rodríguez
db0c7be642 [rubygems/rubygems] Add a lockfile_checksums configuration to include checksums in fresh lockfiles
50b9ef8589
2024-11-11 19:24:42 +00:00
David Rodríguez
a1148d4aad [rubygems/rubygems] Cancel bundle console deprecation
506a863b36
2024-11-11 12:49:26 +00:00
David Rodríguez
ec0d0449dd [rubygems/rubygems] Remove confusing documentation
The first paragraph is misleading because command line flags that set
configuration are deprecated.

The second one is unnecessary because configuration precedence is
explained before the different configurations.

6cc64964ff
2024-10-30 14:20:52 +00:00