Project

General

Profile

Bug #10838

ri's man page and options are wrong

Added by josh.cheek (Josh Cheek) over 5 years ago. Updated over 2 years ago.

Status:
Closed
Priority:
Normal
Target version:
-
ruby -v:
ruby 2.2.0p0
[ruby-core:68065]

Description

Man page

man ri is missing these options:

--[no-]interactive
--[no-]list-doc-dirs
-a, --[no-]all
-l, --[no-]list
    --server [PORT]
-v
--help

It lists two options that don't exist

--fmt
--[no-]use-cache

It lists the formats incorrectly as

ansi, bs, html, plain, simple

They should be:

ansi bs markdown rdoc

Help screen

ri --help is missing these options:

--help
--version
-v
-h

Invalid options print the help screen and an error message.
But -h prints neither. Instead it enters interactive mode.
Whatever it's doing, it's not documented anywhere.


Related issues

Precedes Ruby master - Bug #13487: Update ri man page (and others)ClosedActions

Updated by stomar (Marcus Stollsteimer) over 3 years ago

  • Assignee set to stomar (Marcus Stollsteimer)

The help screen was fixed hier: https://github.com/rdoc/rdoc/pull/448

The man page is WIP and will be fixed soon.

#2

Updated by stomar (Marcus Stollsteimer) over 3 years ago

  • Status changed from Open to Closed

Applied in changeset trunk|r58409.


ri.1: fix errors in ri man page

  • man/ri.1: fix some errors in ri man page (add missing options, remove options that do not exist, fix formatter list).

Reported by Josh Cheek. [ruby-core:68065] [Bug #10838]

#3

Updated by stomar (Marcus Stollsteimer) over 3 years ago

  • Precedes Bug #13487: Update ri man page (and others) added
#4

Updated by stomar (Marcus Stollsteimer) over 3 years ago

  • Backport changed from 2.0.0: UNKNOWN, 2.1: UNKNOWN, 2.2: UNKNOWN to 2.2: WONTFIX, 2.3: REQUIRED, 2.4: REQUIRED

Updated by nagachika (Tomoyuki Chikanaga) almost 3 years ago

  • Backport changed from 2.2: WONTFIX, 2.3: REQUIRED, 2.4: REQUIRED to 2.2: WONTFIX, 2.3: REQUIRED, 2.4: DONE

ruby_2_4 r61366 merged revision(s) 58409.

Updated by usa (Usaku NAKAMURA) over 2 years ago

  • Backport changed from 2.2: WONTFIX, 2.3: REQUIRED, 2.4: DONE to 2.2: WONTFIX, 2.3: DONE, 2.4: DONE

ruby_2_3 r62129 merged revision(s) 58409.

Also available in: Atom PDF