Project

General

Profile

Actions

Bug #19685

closed

ruby --helpに --yydebugの情報がない

Added by Little_Rubyist (Yla Aioi) 12 months ago. Updated 11 months ago.

Status:
Closed
Assignee:
-
Target version:
-
ruby -v:
ruby 3.2.2 (2023-03-30 revision e51014f9c0) [x86_64-darwin22]
[ruby-dev:<unknown>]

Description

https://speakerdeck.com/coe401_/implementing-plus-plus-operator-stepping-into-parse-dot-y?slide=9
をなぞって色々試していた時に -y や --yydebugの説明が ruby --help にないことに気が付きました.
-e については ruby --help にありますが, -y についての説明がなくて少しだけ探すことになりました.

man ruby の "DO NOT USE"に強い理由がないのであれば,

  • ruby --help のDump Listには yydebug の記載がある
  • るりまのオプション一覧に記載がある
  • -y というアルファベット1字の短縮されたオプションの用意がある
    という状況から, 追記してもいいのではと考えています.
    参考: https://docs.ruby-lang.org/ja/latest/doc/spec=2frubycmd.html#cmd_option

また, y.kanekoさん経由で

  • ruby -h は一画面に収まるようにしたいのでこっちの説明はよく使うものだけにしたい
  • ruby --help はいろいろでるのでこっちに追加するのは反対ではない
  • helpにだすのであれば man ruby の“DO NOT USE.“は外す方がいい
    という話は伺っています.
Actions #1

Updated by nobu (Nobuyoshi Nakada) 12 months ago

Little_Rubyist (Yla Aioi) wrote:

man ruby の "DO NOT USE"に強い理由がないのであれば,

"DO NOT USE"の理由は、一言でいうと

参考: https://docs.ruby-lang.org/ja/latest/doc/spec=2frubycmd.html#cmd_option

にもある

コンパイラそのものをデバッグする人以外には必要ないと思います。

というところです。
当然ながら、互換性なども 一切 保証・考慮されません。

また, y.kanekoさん経由で

  • ruby -h は一画面に収まるようにしたいのでこっちの説明はよく使うものだけにしたい
  • ruby --help はいろいろでるのでこっちに追加するのは反対ではない
  • helpにだすのであれば man ruby の“DO NOT USE.“は外す方がいい

なので、出すことは反対ではありませんが、完全に無保証であることは代わりに明記すべきだと思います。

Actions #2

Updated by matz (Yukihiro Matsumoto) 12 months ago

-y を追加しても構いませんが、その場合は中田さんの意見を尊重して追加するべきだと思います。

You can add -y, but in that case, I think you should respect @nobu's opinion.

Matz.

Actions #3

Updated by Little_Rubyist (Yla Aioi) 12 months ago

ありがとうございます.  @nobu さんの意見を踏まえた上で修正のPRを送ろうと思います.

Actions #4

Updated by nobu (Nobuyoshi Nakada) 12 months ago

  • ruby -h は一画面に収まるようにしたいのでこっちの説明はよく使うものだけにしたい
  • ruby --help はいろいろでるのでこっちに追加するのは反対ではない

ということで、usage_msg[]ではなくhelp_msg[]のほうに追加してください

Actions #5

Updated by Anonymous 11 months ago

  • Status changed from Open to Closed

Applied in changeset git|3fe0f8c68bf2cd861b7061de8a662885e5aa5234.


[Bug #19685]: Add -y and --yydebug document to --help

Add -y option information to --help
Fix a warning on the man page

Actions

Also available in: Atom PDF

Like0
Like0Like0Like0Like0Like0