Conversation
doc/jit/zjit.md
Outdated
|
|
||
| ## Documentation | ||
|
|
||
| <h3 id="command-line-options">Command-Line Options</h3> |
There was a problem hiding this comment.
Is this meant to be a subset of --help? It seems weird to skip --zjit-stats, for example.
Lines 127 to 144 in 2ed287d
All options shown in --help are supposed to be user-facing features, so I would show the same list of options in the doc and help.
Also, given that this will be another place that has something like --help, it'd be nice to keep its maintenance cost low by allowing to basically copy-paste one to the other.
There was a problem hiding this comment.
I copied what seemed like relevant bits of YJIT's CLI. I can just reroute people to --help, too
There was a problem hiding this comment.
(see YJIT CLI docs)
There was a problem hiding this comment.
My experience from the YJIT doc maintenance is why I made the above comment. I would like the YJIT CLI doc to be fixed in the same way we fix it here.
I'm open to just rerouting people to --help to avoid the need of copy-pasting one to the other. But it seems useful for users to be able to see help while they're on the website without the need of running a ruby command. Maybe we could copy-paste the ZJIT section from the --help output if we want to just minimize the maintenance cost?
Co-authored-by: Stan Lo <stan001212@gmail.com>
Co-authored-by: Stan Lo <stan001212@gmail.com>
No description provided.