@@ -27,18 +27,18 @@ Subcommands
27
27
a different purpose. A brief summary of each command follows, with more detail
28
28
in the sections that follow.
29
29
30
- * :ref: `pretty_subcommand ` - Dump symbol and type information in a format that
30
+ * :ref: `pretty_subcommand ` - Dump symbol and type information in a format that
31
31
tries to look as much like the original source code as possible.
32
- * :ref: `dump_subcommand ` - Dump low level types and structures from the PDB
32
+ * :ref: `dump_subcommand ` - Dump low level types and structures from the PDB
33
33
file, including CodeView records, hash tables, PDB streams, etc.
34
- * :ref: `bytes_subcommand ` - Dump data from the PDB file's streams, records,
34
+ * :ref: `bytes_subcommand ` - Dump data from the PDB file's streams, records,
35
35
types, symbols, etc as raw bytes.
36
- * :ref: `yaml2pdb_subcommand ` - Given a yaml description of a PDB file, produce
36
+ * :ref: `yaml2pdb_subcommand ` - Given a yaml description of a PDB file, produce
37
37
a valid PDB file that matches that description.
38
- * :ref: `pdb2yaml_subcommand ` - For a given PDB file, produce a YAML
39
- description of some or all of the file in a way that the PDB can be
38
+ * :ref: `pdb2yaml_subcommand ` - For a given PDB file, produce a YAML
39
+ description of some or all of the file in a way that the PDB can be
40
40
reconstructed.
41
- * :ref: `merge_subcommand ` - Given two PDBs, produce a third PDB that is the
41
+ * :ref: `merge_subcommand ` - Given two PDBs, produce a third PDB that is the
42
42
result of merging the two input PDBs.
43
43
44
44
.. _pretty_subcommand :
@@ -49,18 +49,18 @@ pretty
49
49
.. program :: llvm-pdbutil pretty
50
50
51
51
.. important ::
52
- The **pretty ** subcommand is built on the Windows DIA SDK, and as such is not
52
+ The **pretty ** subcommand is built on the Windows DIA SDK, and as such is not
53
53
supported on non-Windows platforms.
54
54
55
55
USAGE: :program: `llvm-pdbutil ` pretty [*options *] <input PDB file>
56
56
57
57
Summary
58
58
^^^^^^^^^^^
59
59
60
- The *pretty * subcommand displays a very high level representation of your
61
- program's debug info. Since it is built on the Windows DIA SDK which is the
62
- standard API that Windows tools and debuggers query debug information, it
63
- presents a more authoritative view of how a debugger is going to interpret your
60
+ The *pretty * subcommand displays a very high level representation of your
61
+ program's debug info. Since it is built on the Windows DIA SDK which is the
62
+ standard API that Windows tools and debuggers query debug information, it
63
+ presents a more authoritative view of how a debugger is going to interpret your
64
64
debug information than a mode which displays low-level CodeView records.
65
65
66
66
Options
@@ -70,55 +70,55 @@ Filtering and Sorting Options
70
70
+++++++++++++++++++++++++++++
71
71
72
72
.. note ::
73
- *exclude * filters take priority over *include * filters. So if a filter
73
+ *exclude * filters take priority over *include * filters. So if a filter
74
74
matches both an include and an exclude rule, then it is excluded.
75
75
76
76
.. option :: -exclude-compilands= <string >
77
77
78
- When dumping compilands, compiland source-file contributions, or per-compiland
79
- symbols, this option instructs **llvm-pdbutil ** to omit any compilands that
78
+ When dumping compilands, compiland source-file contributions, or per-compiland
79
+ symbols, this option instructs **llvm-pdbutil ** to omit any compilands that
80
80
match the specified regular expression.
81
81
82
82
.. option :: -exclude-symbols= <string >
83
83
84
- When dumping global, public, or per-compiland symbols, this option instructs
85
- **llvm-pdbutil ** to omit any symbols that match the specified regular
84
+ When dumping global, public, or per-compiland symbols, this option instructs
85
+ **llvm-pdbutil ** to omit any symbols that match the specified regular
86
86
expression.
87
87
88
88
.. option :: -exclude-types= <string >
89
89
90
- When dumping types, this option instructs **llvm-pdbutil ** to omit any types
90
+ When dumping types, this option instructs **llvm-pdbutil ** to omit any types
91
91
that match the specified regular expression.
92
92
93
93
.. option :: -include-compilands= <string >
94
94
95
- When dumping compilands, compiland source-file contributions, or per-compiland
96
- symbols, limit the initial search to only those compilands that match the
95
+ When dumping compilands, compiland source-file contributions, or per-compiland
96
+ symbols, limit the initial search to only those compilands that match the
97
97
specified regular expression.
98
98
99
99
.. option :: -include-symbols= <string >
100
100
101
- When dumping global, public, or per-compiland symbols, limit the initial
101
+ When dumping global, public, or per-compiland symbols, limit the initial
102
102
search to only those symbols that match the specified regular expression.
103
103
104
104
.. option :: -include-types= <string >
105
105
106
- When dumping types, limit the initial search to only those types that match
106
+ When dumping types, limit the initial search to only those types that match
107
107
the specified regular expression.
108
108
109
109
.. option :: -min-class-padding= <uint >
110
110
111
- Only display types that have at least the specified amount of alignment
111
+ Only display types that have at least the specified amount of alignment
112
112
padding, accounting for padding in base classes and aggregate field members.
113
113
114
114
.. option :: -min-class-padding-imm= <uint >
115
115
116
- Only display types that have at least the specified amount of alignment
116
+ Only display types that have at least the specified amount of alignment
117
117
padding, ignoring padding in base classes and aggregate field members.
118
118
119
119
.. option :: -min-type-size= <uint >
120
120
121
- Only display types T where sizeof(T) is greater than or equal to the specified
121
+ Only display types T where sizeof(T) is greater than or equal to the specified
122
122
amount.
123
123
124
124
.. option :: -no-compiler-generated
@@ -127,7 +127,7 @@ Filtering and Sorting Options
127
127
128
128
.. option :: -no-enum-definitions
129
129
130
- When dumping an enum, don't show the full enum (e.g. the individual enumerator
130
+ When dumping an enum, don't show the full enum (e.g. the individual enumerator
131
131
values).
132
132
133
133
.. option :: -no-system-libs
@@ -233,12 +233,12 @@ Other Options
233
233
234
234
.. option :: -color-output
235
235
236
- Force color output on or off. By default, color if used if outputting to a
236
+ Force color output on or off. By default, color if used if outputting to a
237
237
terminal.
238
238
239
239
.. option :: -load-address= <uint >
240
240
241
- When displaying relative virtual addresses, assume the process is loaded at the
241
+ When displaying relative virtual addresses, assume the process is loaded at the
242
242
given address and display what would be the absolute address.
243
243
244
244
.. _dump_subcommand :
@@ -253,14 +253,14 @@ USAGE: :program:`llvm-pdbutil` dump [*options*] <input PDB file>
253
253
Summary
254
254
^^^^^^^^^^^
255
255
256
- The **dump ** subcommand displays low level information about the structure of a
257
- PDB file. It is used heavily by LLVM's testing infrastructure, but can also be
258
- used for PDB forensics. It serves a role similar to that of Microsoft's
259
- `cvdump ` tool.
260
-
261
- .. note ::
262
- The **dump ** subcommand exposes internal details of the file format. As
263
- such, the reader should be familiar with :doc: `/PDB/index ` before using this
256
+ The **dump ** subcommand displays low level information about the structure of a
257
+ PDB file. It is used heavily by LLVM's testing infrastructure, but can also be
258
+ used for PDB forensics. It serves a role similar to that of Microsoft's
259
+ `cvdump ` tool.
260
+
261
+ .. note ::
262
+ The **dump ** subcommand exposes internal details of the file format. As
263
+ such, the reader should be familiar with :doc: `/PDB/index ` before using this
264
264
command.
265
265
266
266
Options
@@ -388,8 +388,8 @@ Type Record Options
388
388
When used in conjunction with :option: `-type-index ` or :option: `-id-index `,
389
389
dumps the entire dependency graph for the specified index instead of just the
390
390
single record with the specified index. For example, if type index 0x4000 is
391
- a function whose return type has index 0x3000, and you specify
392
- `-dependents=0x4000 `, then this would dump both records (as well as any other
391
+ a function whose return type has index 0x3000, and you specify
392
+ `-dependents=0x4000 `, then this would dump both records (as well as any other
393
393
dependents in the tree).
394
394
395
395
Miscellaneous Options
0 commit comments