object-introspection icon indicating copy to clipboard operation
object-introspection copied to clipboard

Help message for -i,--debug-path unclear

Open JakeHillion opened this issue 3 years ago • 0 comments

I personally struggle to find the -i option every time I look for it in the help list. I think it's because, like -c, the argument is stored separately from the flag. We should look at making the help more consistent and useful for newcomers.

Current help message:

usage: oid ...
  -h,--help                      Print this message and exit
  -p,--pid <pid>                 Target process to attach to
  -c,--config-file               </path/to/oid.toml>
  -x,--data-buf-size <bytes>     Size of data segment (default:1MB)
                                 Accepts multiplicative suffix: K, M, G, T, P, E
  -d,--debug-level <level>       Verbose level for logging
  -l,--jit-logging               Enable JIT's logs
  -r,--remove-mappings           Remove oid mappings from target process
  -s,--script                    </path/to/script.oid>
  -S,--script-source             type:symbol:arg
  -t,--timeout <seconds>         How long to probe the target process for
  -k,--custom-code-file          </path/to/code.cpp>
                                 Use your own CPP file instead of CodeGen
  -e,--compile-and-exit          Compile only then exit
  -o,--cache-path <path>         Enable caching using the provided directory
  -u,--cache-remote              Enable upload/download of cache files
                                 Pick from {both,upload,download}
  -i,--debug-path                </path/to/binary>
                                 Run oid on a executable with debug infos instead of a running process
  -J,--dump-json [oid_out.json]  File to dump the results to, as JSON
                                 (in addition to the default RocksDB output)
  -B,--dump-data-segment         Dump the data segment's content, before TreeBuilder processes it
                                 Each argument gets its own dump file: 'dataseg.<oid-pid>.<arg>.dump'
  -j,--generate-jit-debug        Output debug info for the generated JIT code
  -n,--chase-raw-pointers        Generate probe for raw pointers
  -a,--log-all-structs           Log all structures
  -z,--disable-packed-structs    Disable appending packed attributes to the definition of structs
  -w,--disable-padding-hunter    Disable Padding Hunter
                                 Padded structs will be written to file called PADDING
  -T,--capture-thrift-isset      Capture the isset value for Thrift fields
  -m,--mode [prod]               Allows to specify a mode of operation/group of settings

        For problem reporting, questions and general comments please pop along
        to the Object Introspection Workplace group at https://fburl.com/oid.

JakeHillion avatar Jan 24 '23 15:01 JakeHillion