Skip to content

Commit c87c452

Browse files
committed
Address PR Feedback
1 parent cec3909 commit c87c452

File tree

3 files changed

+19
-8
lines changed

3 files changed

+19
-8
lines changed

docs/build-insights/reference/sdk/event-table.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,6 @@ The C++ Build Insights SDK is compatible with Visual Studio 2017 and above. To s
2929
[FRONT_END_FILE](#front-end-file)\
3030
[TEMPLATE_INSTANTIATION](#template-instantiation)\
3131
[SYMBOL_NAME](#symbol-name)\
32-
[TRANSLATION_UNIT_TYPE](#translation-unit-type)\
3332
[MODULE](#module)\
3433
[HEADER_UNIT](#header-unit)\
3534
[PRECOMPILED_HEADER](#precompiled-header)
@@ -81,7 +80,7 @@ The C++ Build Insights SDK is compatible with Visual Studio 2017 and above. To s
8180
| | Description | Occurs at the start and stop of the whole program analysis' bottom-up pass. |
8281
| <a name="c1-dll"></a> C1_DLL | Type | Activity |
8382
| | Parents | [FRONT_END_PASS](#front-end-pass) |
84-
| | Children | [FRONT_END_FILE](#front-end-file)<br/>[SYMBOL_NAME](#symbol-name)<br/>[TEMPLATE_INSTANTIATION](#template-instantiation)<br/>[TRANSLATION_UNIT_TYPE](#translation-unit-type) |
83+
| | Children | [FRONT_END_FILE](#front-end-file)<br/>[SYMBOL_NAME](#symbol-name)<br/>[TEMPLATE_INSTANTIATION](#template-instantiation) |
8584
| | Properties | None |
8685
| | Capture classes | [Activity](cpp-event-data-types/activity.md)<br/>[C1DLL](cpp-event-data-types/c1-dll.md) |
8786
| | Description | Occurs at the start and stop of a *c1.dll* or *c1xx.dll* invocation. These DLLs are the C and C++ front end of the compiler. They're invoked solely by the compiler driver (*cl.exe*). |
@@ -147,7 +146,7 @@ The C++ Build Insights SDK is compatible with Visual Studio 2017 and above. To s
147146
| | Description | Occurs when the compiler front end starts and stops processing a file. This event is recursive. Recursion happens when the front end is parsing included files. |
148147
| <a name="front-end-pass"></a> FRONT_END_PASS | Type | Activity |
149148
| | Parents | [COMPILER](#compiler) |
150-
| | Children | [C1_DLL](#c1-dll) |
149+
| | Children | [C1_DLL](#c1-dll)<br/>[MODULE](#module)<br/>[HEADER_UNIT](#header-unit)<br/>[PRECOMPILED_HEADER](#precompiled-header) |
151150
| | Properties | - Absolute path to input source file<br/>- Absolute path to output object file |
152151
| | Capture classes | [Activity](cpp-event-data-types/activity.md)<br/>[CompilerPass](cpp-event-data-types/compiler-pass.md)<br/>[FrontEndPass](cpp-event-data-types/front-end-pass.md) |
153152
| | Description | Occurs at the start and stop of the compiler front-end pass. This pass is responsible for parsing C/C++ source code and converting it into intermediate language. |
@@ -158,7 +157,7 @@ The C++ Build Insights SDK is compatible with Visual Studio 2017 and above. To s
158157
| | Capture classes | [Activity](cpp-event-data-types/activity.md)<br/>[Function](cpp-event-data-types/function.md) |
159158
| | Description | Occurs when starting and ending generating the code for a function. |
160159
| <a name="header-unit"></a> HEADER_UNIT | Type | Activity |
161-
| | Parents | [TRANSLATION_UNIT_TYPE](#translation-unit-type) |
160+
| | Parents | [FRONT_END_PASS](#front-end-pass) |
162161
| | Children | None |
163162
| | Properties | None |
164163
| | Capture classes | [SimpleEvent](cpp-event-data-types/simple-event.md)<br/>[TranslationUnitType](cpp-event-data-types/translation-unit-type.md)<br/>[HeaderUnit](cpp-event-data-types/header-unit.md) |
@@ -188,7 +187,7 @@ The C++ Build Insights SDK is compatible with Visual Studio 2017 and above. To s
188187
| | Capture classes | [Activity](cpp-event-data-types/activity.md)<br/>[LTCG](cpp-event-data-types/ltcg.md) |
189188
| | Description | Occurs at the start and stop of link-time code generation. |
190189
| <a name="module"></a> MODULE | Type | Activity |
191-
| | Parents | [TRANSLATION_UNIT_TYPE](#translation-unit-type) |
190+
| | Parents | [FRONT_END_PASS](#front-end-pass) |
192191
| | Children | None |
193192
| | Properties | None |
194193
| | Capture classes | [SimpleEvent](cpp-event-data-types/simple-event.md)<br/>[TranslationUnitType](cpp-event-data-types/translation-unit-type.md)<br/>[Module](cpp-event-data-types/module.md) |
@@ -230,7 +229,7 @@ The C++ Build Insights SDK is compatible with Visual Studio 2017 and above. To s
230229
| | Capture classes | [Activity](cpp-event-data-types/activity.md)<br/>[Pass2](cpp-event-data-types/pass2.md) |
231230
| | Description | Occurs at the start and stop of the linker's pass 2. |
232231
| <a name="precompiled-header"></a> PRECOMPILED_HEADER | Type | Activity |
233-
| | Parents | [TRANSLATION_UNIT_TYPE](#translation-unit-type) |
232+
| | Parents | [FRONT_END_PASS](#front-end-pass) |
234233
| | Children | None |
235234
| | Properties | None |
236235
| | Capture classes | [SimpleEvent](cpp-event-data-types/simple-event.md)<br/>[TranslationUnitType](cpp-event-data-types/translation-unit-type.md)<br/>[PrecompiledHeader](cpp-event-data-types/precompiled-header.md) |
@@ -266,7 +265,7 @@ The C++ Build Insights SDK is compatible with Visual Studio 2017 and above. To s
266265
| | Capture classes | [Activity](cpp-event-data-types/activity.md)<br/>[TopDown](cpp-event-data-types/top-down.md) |
267266
| | Description | Occurs at the start and stop of the whole program analysis' top-down pass. |
268267
| <a name="translation-unit-type"></a> TRANSLATION_UNIT_TYPE | Type | Activity |
269-
| | Parents | [C1_DLL](#c1-dll) |
268+
| | Parents | [FRONT_END_PASS](#front-end-pass) |
270269
| | Children | [MODULE](#module)<br/>[HEADER_UNIT](#header-unit)<br/>[PRECOMPILED_HEADER](#precompiled-header) |
271270
| | Properties | - The type of translation unit. |
272271
| | Capture classes | [SimpleEvent](cpp-event-data-types/simple-event.md)<br/>[TranslationUnitType](cpp-event-data-types/translation-unit-type.md) |

docs/build-insights/reference/sdk/overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ int main()
135135
| Functionality | C++ API | C API | Notes |
136136
|--|--|--|--|
137137
| Matching and filtering events | [MatchEventStackInMemberFunction](functions/match-event-stack-in-member-function.md)<br />[MatchEventStack](functions/match-event-stack.md)<br />[MatchEventInMemberFunction](functions/match-event-in-member-function.md)<br />[MatchEvent](functions/match-event.md) | | The C++ API offers functions that make it easy to extract the events you care about from your traces. With the C API, this filtering must be done by hand. |
138-
| Event data types | [Activity](cpp-event-data-types/activity.md)<br />[BackEndPass](cpp-event-data-types/back-end-pass.md)<br />[BottomUp](cpp-event-data-types/bottom-up.md)<br />[C1DLL](cpp-event-data-types/c1-dll.md)<br />[C2DLL](cpp-event-data-types/c2-dll.md)<br />[CodeGeneration](cpp-event-data-types/code-generation.md)<br />[CommandLine](cpp-event-data-types/command-line.md)<br />[Compiler](cpp-event-data-types/compiler.md)<br />[CompilerPass](cpp-event-data-types/compiler-pass.md)<br />[EnvironmentVariable](cpp-event-data-types/environment-variable.md)<br />[Event](cpp-event-data-types/event.md)<br />[EventGroup](cpp-event-data-types/event-group.md)<br />[EventStack](cpp-event-data-types/event-stack.md)<br />[ExecutableImageOutput](cpp-event-data-types/executable-image-output.md)<br />[ExpOutput](cpp-event-data-types/exp-output.md)<br />[FileInput](cpp-event-data-types/file-input.md)<br />[FileOutput](cpp-event-data-types/file-output.md)<br />[ForceInlinee](cpp-event-data-types/force-inlinee.md)<br />[FrontEndFile](cpp-event-data-types/front-end-file.md)<br />[FrontEndFileGroup](cpp-event-data-types/front-end-file-group.md)<br />[FrontEndPass](cpp-event-data-types/front-end-pass.md)<br />[Function](cpp-event-data-types/function.md)<br />[HeaderUnit](cpp-event-data-types/header-unit.md)<br />[ImpLibOutput](cpp-event-data-types/imp-lib-output.md)<br />[Invocation](cpp-event-data-types/invocation.md)<br />[InvocationGroup](cpp-event-data-types/invocation-group.md)<br />[LibOutput](cpp-event-data-types/lib-output.md)<br />[Linker](cpp-event-data-types/linker.md)<br />[LinkerGroup](cpp-event-data-types/linker-group.md)<br />[LinkerPass](cpp-event-data-types/linker-pass.md)<br />[LTCG](cpp-event-data-types/ltcg.md)<br />[Module](cpp-event-data-types/module.md)<br />[ObjOutput](cpp-event-data-types/obj-output.md)<br />[OptICF](cpp-event-data-types/opt-icf.md)<br />[OptLBR](cpp-event-data-types/opt-lbr.md)<br />[OptRef](cpp-event-data-types/opt-ref.md)<br />[Pass1](cpp-event-data-types/pass1.md)<br />[Pass2](cpp-event-data-types/pass2.md)<br />[PrecompiledHeader](cpp-event-data-types/precompiled-header.md)<br />[PreLTCGOptRef](cpp-event-data-types/pre-ltcg-opt-ref.md)<br />[SimpleEvent](cpp-event-data-types/simple-event.md)<br />[SymbolName](cpp-event-data-types/symbol-name.md)<br />[TemplateInstantiation](cpp-event-data-types/template-instantiation.md)<br />[TemplateInstantiationGroup](cpp-event-data-types/template-instantiation-group.md)<br />[Thread](cpp-event-data-types/thread.md)<br />[TopDown](cpp-event-data-types/top-down.md)<br />[TraceInfo](cpp-event-data-types/trace-info.md)<br />[TranslationUnitType](cpp-event-data-types/translation-unit-type.md)<br />[WholeProgramAnalysis](cpp-event-data-types/whole-program-analysis.md) | [CL_PASS_DATA](c-event-data-types/cl-pass-data-struct.md)<br />[EVENT_COLLECTION_DATA](c-event-data-types/event-collection-data-struct.md)<br />[EVENT_DATA](c-event-data-types/event-data-struct.md)<br />[EVENT_ID](c-event-data-types/event-id-enum.md)<br />[FILE_DATA](c-event-data-types/file-data-struct.md)<br />[FILE_TYPE_CODE](c-event-data-types/file-type-code-enum.md)<br />[FRONT_END_FILE_DATA](c-event-data-types/front-end-file-data-struct.md)<br />[FUNCTION_DATA](c-event-data-types/function-data-struct.md)<br />[FUNCTION_FORCE_INLINEE_DATA](c-event-data-types/function-force-inlinee-data-struct.md)<br />[INVOCATION_DATA](c-event-data-types/invocation-data-struct.md)<br />[INVOCATION_VERSION_DATA](c-event-data-types/invocation-version-data-struct.md)<br />[MSVC_TOOL_CODE](c-event-data-types/msvc-tool-code-enum.md)<br />[NAME_VALUE_PAIR_DATA](c-event-data-types/name-value-pair-data-struct.md)<br />[SYMBOL_NAME_DATA](c-event-data-types/symbol-name-data-struct.md)<br />[TEMPLATE_INSTANTIATION_DATA](c-event-data-types/template-instantiation-data-struct.md)<br />[TEMPLATE_INSTANTIATION_KIND_CODE](c-event-data-types/template-instantiation-kind-code-enum.md)<br />[TRACE_INFO_DATA](c-event-data-types/trace-info-data-struct.md)<br />[TRANSLATION_UNIT_PASS_CODE](c-event-data-types/translation-unit-pass-code-enum.md) | |
138+
| Event data types | [Activity](cpp-event-data-types/activity.md)<br />[BackEndPass](cpp-event-data-types/back-end-pass.md)<br />[BottomUp](cpp-event-data-types/bottom-up.md)<br />[C1DLL](cpp-event-data-types/c1-dll.md)<br />[C2DLL](cpp-event-data-types/c2-dll.md)<br />[CodeGeneration](cpp-event-data-types/code-generation.md)<br />[CommandLine](cpp-event-data-types/command-line.md)<br />[Compiler](cpp-event-data-types/compiler.md)<br />[CompilerPass](cpp-event-data-types/compiler-pass.md)<br />[EnvironmentVariable](cpp-event-data-types/environment-variable.md)<br />[Event](cpp-event-data-types/event.md)<br />[EventGroup](cpp-event-data-types/event-group.md)<br />[EventStack](cpp-event-data-types/event-stack.md)<br />[ExecutableImageOutput](cpp-event-data-types/executable-image-output.md)<br />[ExpOutput](cpp-event-data-types/exp-output.md)<br />[FileInput](cpp-event-data-types/file-input.md)<br />[FileOutput](cpp-event-data-types/file-output.md)<br />[ForceInlinee](cpp-event-data-types/force-inlinee.md)<br />[FrontEndFile](cpp-event-data-types/front-end-file.md)<br />[FrontEndFileGroup](cpp-event-data-types/front-end-file-group.md)<br />[FrontEndPass](cpp-event-data-types/front-end-pass.md)<br />[Function](cpp-event-data-types/function.md)<br />[HeaderUnit](cpp-event-data-types/header-unit.md)<br />[ImpLibOutput](cpp-event-data-types/imp-lib-output.md)<br />[Invocation](cpp-event-data-types/invocation.md)<br />[InvocationGroup](cpp-event-data-types/invocation-group.md)<br />[LibOutput](cpp-event-data-types/lib-output.md)<br />[Linker](cpp-event-data-types/linker.md)<br />[LinkerGroup](cpp-event-data-types/linker-group.md)<br />[LinkerPass](cpp-event-data-types/linker-pass.md)<br />[LTCG](cpp-event-data-types/ltcg.md)<br />[Module](cpp-event-data-types/module.md)<br />[ObjOutput](cpp-event-data-types/obj-output.md)<br />[OptICF](cpp-event-data-types/opt-icf.md)<br />[OptLBR](cpp-event-data-types/opt-lbr.md)<br />[OptRef](cpp-event-data-types/opt-ref.md)<br />[Pass1](cpp-event-data-types/pass1.md)<br />[Pass2](cpp-event-data-types/pass2.md)<br />[PrecompiledHeader](cpp-event-data-types/precompiled-header.md)<br />[PreLTCGOptRef](cpp-event-data-types/pre-ltcg-opt-ref.md)<br />[SimpleEvent](cpp-event-data-types/simple-event.md)<br />[SymbolName](cpp-event-data-types/symbol-name.md)<br />[TemplateInstantiation](cpp-event-data-types/template-instantiation.md)<br />[TemplateInstantiationGroup](cpp-event-data-types/template-instantiation-group.md)<br />[Thread](cpp-event-data-types/thread.md)<br />[TopDown](cpp-event-data-types/top-down.md)<br />[TraceInfo](cpp-event-data-types/trace-info.md)<br />[TranslationUnitType](cpp-event-data-types/translation-unit-type.md)<br />[WholeProgramAnalysis](cpp-event-data-types/whole-program-analysis.md) | [CL_PASS_DATA](c-event-data-types/cl-pass-data-struct.md)<br />[EVENT_COLLECTION_DATA](c-event-data-types/event-collection-data-struct.md)<br />[EVENT_DATA](c-event-data-types/event-data-struct.md)<br />[EVENT_ID](c-event-data-types/event-id-enum.md)<br />[FILE_DATA](c-event-data-types/file-data-struct.md)<br />[FILE_TYPE_CODE](c-event-data-types/file-type-code-enum.md)<br />[FRONT_END_FILE_DATA](c-event-data-types/front-end-file-data-struct.md)<br />[FUNCTION_DATA](c-event-data-types/function-data-struct.md)<br />[FUNCTION_FORCE_INLINEE_DATA](c-event-data-types/function-force-inlinee-data-struct.md)<br />[INVOCATION_DATA](c-event-data-types/invocation-data-struct.md)<br />[INVOCATION_VERSION_DATA](c-event-data-types/invocation-version-data-struct.md)<br />[MSVC_TOOL_CODE](c-event-data-types/msvc-tool-code-enum.md)<br />[NAME_VALUE_PAIR_DATA](c-event-data-types/name-value-pair-data-struct.md)<br />[SYMBOL_NAME_DATA](c-event-data-types/symbol-name-data-struct.md)<br />[TEMPLATE_INSTANTIATION_DATA](c-event-data-types/template-instantiation-data-struct.md)<br />[TEMPLATE_INSTANTIATION_KIND_CODE](c-event-data-types/template-instantiation-kind-code-enum.md)<br />[TRACE_INFO_DATA](c-event-data-types/trace-info-data-struct.md)<br />[TRANSLATION_UNIT_PASS_CODE](c-event-data-types/translation-unit-pass-code-enum.md)<br />[TRANSLATION_UNIT_TYPE](c-event-data-types/translation-unit-type.md)<br />[TRANSLATION_UNIT_TYPE_DATA](c-event-data-types/translation-unit-type-data.md) | |
139139

140140
### Activities and simple events
141141

docs/build-insights/toc.yml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -123,6 +123,8 @@
123123
href: ../build-insights/reference/sdk/cpp-event-data-types/front-end-pass.md
124124
- name: "Function"
125125
href: ../build-insights/reference/sdk/cpp-event-data-types/function.md
126+
- name: "HeaderUnit"
127+
href: ../build-insights/reference/sdk/cpp-event-data-types/header-unit.md
126128
- name: "ImpLibOutput"
127129
href: ../build-insights/reference/sdk/cpp-event-data-types/imp-lib-output.md
128130
- name: "Invocation"
@@ -139,6 +141,8 @@
139141
href: ../build-insights/reference/sdk/cpp-event-data-types/linker-pass.md
140142
- name: "LTCG"
141143
href: ../build-insights/reference/sdk/cpp-event-data-types/ltcg.md
144+
- name: "Module"
145+
href: ../build-insights/reference/sdk/cpp-event-data-types/module.md
142146
- name: "ObjOutput"
143147
href: ../build-insights/reference/sdk/cpp-event-data-types/obj-output.md
144148
- name: "OptICF"
@@ -151,6 +155,8 @@
151155
href: ../build-insights/reference/sdk/cpp-event-data-types/pass1.md
152156
- name: "Pass2"
153157
href: ../build-insights/reference/sdk/cpp-event-data-types/pass2.md
158+
- name: "PrecompiledHeader"
159+
href: ../build-insights/reference/sdk/cpp-event-data-types/precompiled-header.md
154160
- name: "PreLTCGOptRef"
155161
href: ../build-insights/reference/sdk/cpp-event-data-types/pre-ltcg-opt-ref.md
156162
- name: "RawEvent"
@@ -169,6 +175,8 @@
169175
href: ../build-insights/reference/sdk/cpp-event-data-types/top-down.md
170176
- name: "TraceInfo"
171177
href: ../build-insights/reference/sdk/cpp-event-data-types/trace-info.md
178+
- name: "TranslationUnitType"
179+
href: ../build-insights/reference/sdk/cpp-event-data-types/translation-unit-type.md
172180
- name: "WholeProgramAnalysis"
173181
href: ../build-insights/reference/sdk/cpp-event-data-types/whole-program-analysis.md
174182
- name: "Event data types (C)"
@@ -209,6 +217,10 @@
209217
href: ../build-insights/reference/sdk/c-event-data-types/trace-info-data-struct.md
210218
- name: "TRANSLATION_UNIT_PASS_CODE"
211219
href: ../build-insights/reference/sdk/c-event-data-types/translation-unit-pass-code-enum.md
220+
- name: "TRANSLATION_UNIT_TYPE"
221+
href: ../build-insights/reference/sdk/c-event-data-types/translation-unit-type.md
222+
- name: "TRANSLATION_UNIT_TYPE_DATA"
223+
href: ../build-insights/reference/sdk/c-event-data-types/translation-unit-type-data.md
212224
- name: "Other types"
213225
items:
214226
- name: "ANALYSIS_CALLBACKS"

0 commit comments

Comments
 (0)