Skip to content

Commit 19d428b

Browse files
committed
Add help text to most addons.
1 parent f745d6e commit 19d428b

File tree

1 file changed

+19
-10
lines changed

1 file changed

+19
-10
lines changed

private/manifest.json

Lines changed: 19 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,55 +5,63 @@
55
"repo": "addons",
66
"script": "value_tracer/value_tracer.py",
77
"version_min": "7.0.0",
8-
"help": "Show variable changes during execution.\n\n\nvalue-tracer OP -- See the variable changes if OP (e.g. 'next') is executed.\n\nvalue-tracer-function -- Show execution history of current function with variable changes.\n\nvalue-tracer-inline -- Show execution history of current function with inline annotations.\n\nset value-tracer-inline-references -- Set whether all uses of a variable are annotated."
8+
"help": "Show variable changes during execution.\n\n\nvalue-tracer OP -- See the variable changes if OP (e.g. \"next\") is executed.\n\nvalue-tracer-function -- Show execution history of current function with variable changes.\n\nvalue-tracer-inline -- Show execution history of current function with inline annotations.\n\nset value-tracer-inline-references -- Set whether all uses of a variable are annotated."
99
},
1010
"load-all-symbols": {
1111
"description": "Search a directory tree for debug symbols.",
1212
"repo": "addons",
1313
"script": "automatic_symbol_loading/automatic_symbol_loading.py",
14-
"version_min": "7.0.0"
14+
"version_min": "7.0.0",
15+
"help": "Locate debug symbol files for the current recording.\n\n\nload-all-symbols DIRECTORY -- Recursively search DIRECTORY for relevant .debug files.\n\n\nFor each library loaded, UDB searches for a debug information file (.debug) with matching build ID."
1516
},
1617
"load-debug-symbols": {
1718
"description": "Add a debuginfo file.",
1819
"repo": "addons",
1920
"script": "load_debug_symbols/load_debug_symbols.py",
20-
"version_min": "7.0.0"
21+
"version_min": "7.0.0",
22+
"help": "Add a debug information file.\n\n\nload-debug-symbols FILE -- Load debug information from FILE."
2123
},
2224
"reconstruct-file": {
2325
"description": "Reconstruct a file from writes to a file descriptor.",
2426
"repo": "addons",
2527
"script": "reconstruct_file/reconstruct_file.py",
26-
"version_min": "7.0.0"
28+
"version_min": "7.0.0",
29+
"help": "Regenerate the content of a file that the debuggee read.\n\n\nType \"help reconstruct-file\" for usage information."
2730
},
2831
"reverse-step-maps": {
2932
"description": "Provides a mean to quickly get an understanding of instructions and maps used at the same time",
3033
"repo": "addons",
3134
"script": "reverse_step_map/reverse_step_map.py",
32-
"version_min": "7.0.0"
35+
"version_min": "7.0.0",
36+
"help": "NOTE: this addon requires the \"whatmap\" addon to be installed.\n\nNOTE: x86 only.\n\n\nrsm -- Identify memory maps used by the current instruction"
3337
},
3438
"ubt": {
3539
"description": "Adds a ubt command which adds basic block counts to frames within a backtrace.",
3640
"repo": "addons",
3741
"script": "backtrace_with_time/backtrace_with_time.py",
38-
"version_min": "7.0.0"
42+
"version_min": "7.0.0",
43+
"help": "ubt -- Backtrace with basic block counts."
3944
},
4045
"uregs": {
4146
"description": "Prints the values of all the registers at every basic block within a range.",
4247
"repo": "addons",
4348
"script": "regs_every_bb/regs_every_bb.py",
44-
"version_min": "7.0.0"
49+
"version_min": "7.0.0",
50+
"help": "uregs START_TIME END_TIME -- Sample register state at every basic block."
4551
},
4652
"usample": {
4753
"description": "Sampler which counts the number of times we find ourselves in a particular function.",
4854
"repo": "addons",
4955
"script": "sample_functions/sample_functions.py",
50-
"version_min": "7.0.0"
56+
"version_min": "7.0.0",
57+
"help": "usample START_TIME END_TIME STEP [FILENAME] -- Sample the function call stack."
5158
},
5259
"whatmap": {
5360
"description": "Looks up a variable or address within the maps of the debuggee.",
5461
"repo": "addons",
5562
"script": "what_map/what_map.py",
56-
"version_min": "7.0.0"
63+
"version_min": "7.0.0",
64+
"help": "whatmap EXPRESSION -- Locate memory map containing EXPRESSION.\n\n\nExamples:\n\nwhatmap my_variable: looks up the map where my_variable is stored.\n\nwhatmap *0x1234: looks up the map containing the address 0x1234."
5765
},
5866
"altui": {
5967
"description": "Altui provides a modern and user-friendly alternative to plain UDB and to TUI mode.",
@@ -79,7 +87,8 @@
7987
"description": "info wallclock-relative command to get wallclock time relative to the start of recording.",
8088
"repo": "addons",
8189
"script": "relative_wallclock/relative_wallclock.py",
82-
"version_min": "7.0.0"
90+
"version_min": "7.0.0",
91+
"help": "info-wallclock-relative -- Print wallclock time offset from start of recording."
8392
},
8493
"systemc-trace": {
8594
"description": "Extract waves from a SystemC recording.",

0 commit comments

Comments
 (0)