diff options
author | Matt Valentine-House <matt@eightbitraptor.com> | 2022-06-27 13:35:22 +0100 |
---|---|---|
committer | Peter Zhu <peter@peterzhu.ca> | 2022-06-28 10:10:26 -0400 |
commit | ca85bd818ac6f10d2f50ae04de0e2a79476e8266 (patch) | |
tree | 859d841a031d99c8925e2109c9cfb7bca4372241 /man | |
parent | 7d211c93af2253c5f5a4eb988a362f3220965980 (diff) |
[ci skip] Improve man page docs around --dump options
Notes
Notes:
Merged: https://github.com/ruby/ruby/pull/6067
Diffstat (limited to 'man')
-rw-r--r-- | man/ruby.1 | 40 |
1 files changed, 21 insertions, 19 deletions
diff --git a/man/ruby.1 b/man/ruby.1 index 944844b639..86ad73c2ab 100644 --- a/man/ruby.1 +++ b/man/ruby.1 @@ -423,35 +423,37 @@ Dump some information. .Pp Prints the specified target. .Ar target -can be one of; +can be one of: .Bl -hang -offset indent .It Sy version -version description same as -.Fl -version +Print version description (same as +.Fl -version). .It Sy usage -brief usage message same as -.Fl h +Print a brief usage message (same as +.Fl h). .It Sy help -Show long help message same as -.Fl -help +Show long help message (same as +.Fl -help). .It Sy syntax -check of syntax same as +Check syntax (same as .Fl c -.Fl -yydebug -.It Sy yydebug -compiler debug mode, same as -.Fl -yydebug +.Fl -yydebug). +.Pp +.El .Pp -Only specify this switch if you are going to debug the Ruby interpreter. +Or one of the following, which are intended for debugging the interpreter: +.Bl -hang -offset indent -tag -width "parsetree_with_comment" +.It Sy yydebug +Enable compiler debug mode (same as +.Fl -yydebug). .It Sy parsetree +Print a textual representation of the Ruby AST for the program. .It Sy parsetree_with_comment -AST nodes tree -.Pp -Only specify this switch if you are going to debug the Ruby interpreter. +Print a textual representation of the Ruby AST for the program, but with each node annoted with the associated Ruby source code. .It Sy insns -disassembled instructions -.Pp -Only specify this switch if you are going to debug the Ruby interpreter. +Print a list of disassembled bytecode instructions. +.It Sy insns_without_opt +Print the list of disassembled bytecode instructions before various optimizations have been applied. .El .Pp .It Fl -verbose |