[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
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

View file

@ -288,8 +288,6 @@ RSpec.describe "The library itself" do
end
def cli_and_man_pages_in_sync!(commands)
undocumented_options = ["--all", "--local-git"]
commands.each do |command_name, opts|
man_page_path = man_tracked_files.find {|f| File.basename(f) == "bundle-#{command_name}.1.ronn" }
expect(man_page_path).to_not be_nil, "The command #{command_name} has no associated man page."
@ -298,8 +296,6 @@ RSpec.describe "The library itself" do
man_page_content = File.read(man_page_path)
opts.each do |option_name|
next if undocumented_options.include?(option_name.to_s)
error_msg = <<~EOM
The command #{command_name} has no mention of the option or subcommand `#{option_name}` in its man page.
Document the `#{option_name}` in the man page to discard this error.