From 7b9249946ca2dcfd2d40d1f2b0829f33686ce906 Mon Sep 17 00:00:00 2001 From: Rageking8 <106309953+Rageking8@users.noreply.github.com> Date: Fri, 20 Jun 2025 16:08:34 +0800 Subject: [PATCH 1/6] Add backticks in reference for `Relog` and variants --- .../reference/sdk/functions/relog-a.md | 12 ++++---- .../reference/sdk/functions/relog-w.md | 12 ++++---- .../reference/sdk/functions/relog.md | 30 +++++++++---------- 3 files changed, 27 insertions(+), 27 deletions(-) diff --git a/docs/build-insights/reference/sdk/functions/relog-a.md b/docs/build-insights/reference/sdk/functions/relog-a.md index ca57d0fdb6..d2cf476c9d 100644 --- a/docs/build-insights/reference/sdk/functions/relog-a.md +++ b/docs/build-insights/reference/sdk/functions/relog-a.md @@ -4,7 +4,7 @@ description: "The C++ Build Insights SDK RelogA function reference." ms.date: "02/12/2020" helpviewer_keywords: ["C++ Build Insights", "C++ Build Insights SDK", "RelogA", "throughput analysis", "build time analysis", "vcperf.exe"] --- -# RelogA +# `RelogA` ::: moniker range="<=msvc-140" @@ -26,17 +26,17 @@ enum RESULT_CODE RelogA( ### Parameters -*inputLogFile*\ +*`inputLogFile`*\ The input ETW trace that you wish to read events from. -*outputLogFile*\ +*`outputLogFile`*\ The file in which to write the new events. -*relogDescriptor*\ -Pointer to a [RELOG_DESCRIPTOR](../other-types/relog-descriptor-struct.md) object. Use this object to configure the relogging session. +*`relogDescriptor`*\ +Pointer to a [`RELOG_DESCRIPTOR`](../other-types/relog-descriptor-struct.md) object. Use this object to configure the relogging session. ### Return Value -A result code from the [RESULT_CODE](../other-types/result-code-enum.md) enum. +A result code from the [`RESULT_CODE`](../other-types/result-code-enum.md) enum. ::: moniker-end diff --git a/docs/build-insights/reference/sdk/functions/relog-w.md b/docs/build-insights/reference/sdk/functions/relog-w.md index c4ed0ad3d9..6b3430a793 100644 --- a/docs/build-insights/reference/sdk/functions/relog-w.md +++ b/docs/build-insights/reference/sdk/functions/relog-w.md @@ -4,7 +4,7 @@ description: "The C++ Build Insights SDK RelogW function reference." ms.date: "02/12/2020" helpviewer_keywords: ["C++ Build Insights", "C++ Build Insights SDK", "RelogW", "throughput analysis", "build time analysis", "vcperf.exe"] --- -# RelogW +# `RelogW` ::: moniker range="<=msvc-140" @@ -26,17 +26,17 @@ enum RESULT_CODE RelogW( ### Parameters -*inputLogFile*\ +*`inputLogFile`*\ The input ETW trace that you wish to read events from. -*outputLogFile*\ +*`outputLogFile`*\ The file in which to write the new events. -*relogDescriptor*\ -Pointer to a [RELOG_DESCRIPTOR](../other-types/relog-descriptor-struct.md) object. Use this object to configure the relogging session. +*`relogDescriptor`*\ +Pointer to a [`RELOG_DESCRIPTOR`](../other-types/relog-descriptor-struct.md) object. Use this object to configure the relogging session. ### Return Value -A result code from the [RESULT_CODE](../other-types/result-code-enum.md) enum. +A result code from the [`RESULT_CODE`](../other-types/result-code-enum.md) enum. ::: moniker-end diff --git a/docs/build-insights/reference/sdk/functions/relog.md b/docs/build-insights/reference/sdk/functions/relog.md index 13259b2978..3340f8cd93 100644 --- a/docs/build-insights/reference/sdk/functions/relog.md +++ b/docs/build-insights/reference/sdk/functions/relog.md @@ -4,7 +4,7 @@ description: "The C++ Build Insights SDK Relog function reference." ms.date: "02/12/2020" helpviewer_keywords: ["C++ Build Insights", "C++ Build Insights SDK", "Relog", "throughput analysis", "build time analysis", "vcperf.exe"] --- -# Relog +# `Relog` ::: moniker range="<=msvc-140" @@ -43,39 +43,39 @@ RESULT_CODE Relog( ### Parameters -*TAnalyzerGroupMembers*\ +*`TAnalyzerGroupMembers`*\ This parameter is always deduced. -*TReloggerGroupMembers*\ +*`TReloggerGroupMembers`*\ This parameter is always deduced. -*inputLogFile*\ +*`inputLogFile`*\ The input ETW trace that you wish to read events from. -*outputLogFile*\ +*`outputLogFile`*\ The file in which to write the new events. -*numberOfAnalysisPasses*\ +*`numberOfAnalysisPasses`*\ The number of analysis passes to run on the input trace. The trace gets passed through the provided analyzer group once per analysis pass. -*systemEventsRetentionFlags*\ -A bitmask that specifies which system ETW events to keep in the relogged trace. For more information, see [RELOG_RETENTION_SYSTEM_EVENT_FLAGS](../other-types/relog-retention-system-event-flags-constants.md). +*`systemEventsRetentionFlags`*\ +A bitmask that specifies which system ETW events to keep in the relogged trace. For more information, see [`RELOG_RETENTION_SYSTEM_EVENT_FLAGS`](../other-types/relog-retention-system-event-flags-constants.md). -*analyzerGroup*\ -The analyzer group used for the analysis phase of the relogging session. Call [MakeStaticAnalyzerGroup](make-static-analyzer-group.md) to create an analyzer group. To use a dynamic analyzer group obtained from [MakeDynamicAnalyzerGroup](make-dynamic-analyzer-group.md), first encapsulate it inside a static analyzer group by passing its address to `MakeStaticAnalyzerGroup`. +*`analyzerGroup`*\ +The analyzer group used for the analysis phase of the relogging session. Call [`MakeStaticAnalyzerGroup`](make-static-analyzer-group.md) to create an analyzer group. To use a dynamic analyzer group obtained from [`MakeDynamicAnalyzerGroup`](make-dynamic-analyzer-group.md), first encapsulate it inside a static analyzer group by passing its address to `MakeStaticAnalyzerGroup`. -*reloggerGroup*\ -The relogger group that relogs events into the trace file specified in *outputLogFile*. Call [MakeStaticReloggerGroup](make-static-relogger-group.md) to create a relogger group. To use a dynamic relogger group obtained from [MakeDynamicReloggerGroup](make-dynamic-relogger-group.md), first encapsulate it inside a static relogger group by passing its address to `MakeStaticReloggerGroup`. +*`reloggerGroup`*\ +The relogger group that relogs events into the trace file specified in *`outputLogFile`*. Call [`MakeStaticReloggerGroup`](make-static-relogger-group.md) to create a relogger group. To use a dynamic relogger group obtained from [`MakeDynamicReloggerGroup`](make-dynamic-relogger-group.md), first encapsulate it inside a static relogger group by passing its address to `MakeStaticReloggerGroup`. ### Return Value -A result code from the [RESULT_CODE](../other-types/result-code-enum.md) enum. +A result code from the [`RESULT_CODE`](../other-types/result-code-enum.md) enum. ### Remark -The input trace is passed through the analyzer group *numberOfAnalysisPasses* times. There's no similar option for relogging passes. The trace is passed trough the relogger group only once, after all analysis passes are complete. +The input trace is passed through the analyzer group *`numberOfAnalysisPasses`* times. There's no similar option for relogging passes. The trace is passed trough the relogger group only once, after all analysis passes are complete. -The relogging of system events like CPU samples from within a relogger class isn't supported. Use the *systemEventsRetentionFlags* parameter to decide which system events to keep in the output trace. +The relogging of system events like CPU samples from within a relogger class isn't supported. Use the *`systemEventsRetentionFlags`* parameter to decide which system events to keep in the output trace. The `relog` function depends on the COM API. You must call `CoInitialize` before you call `relog`. Call `CoUninitialize` once `relog` has finished. If you call `relog` without a call to `CoInitialize` first, you'll get error code 9 (`RESULT_CODE_FAILURE_START_RELOGGER`). From 7d0999b32e53f14a466f8b4282d0b78eccf40c4e Mon Sep 17 00:00:00 2001 From: Rageking8 <106309953+Rageking8@users.noreply.github.com> Date: Fri, 20 Jun 2025 16:10:58 +0800 Subject: [PATCH 2/6] Add "s" to "Remark" heading in `Relog` reference --- docs/build-insights/reference/sdk/functions/relog.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/build-insights/reference/sdk/functions/relog.md b/docs/build-insights/reference/sdk/functions/relog.md index 3340f8cd93..a198e3bf6e 100644 --- a/docs/build-insights/reference/sdk/functions/relog.md +++ b/docs/build-insights/reference/sdk/functions/relog.md @@ -71,7 +71,7 @@ The relogger group that relogs events into the trace file specified in *`outputL A result code from the [`RESULT_CODE`](../other-types/result-code-enum.md) enum. -### Remark +### Remarks The input trace is passed through the analyzer group *`numberOfAnalysisPasses`* times. There's no similar option for relogging passes. The trace is passed trough the relogger group only once, after all analysis passes are complete. From 6a2daff4a87ee802703893269100149c72ae1236 Mon Sep 17 00:00:00 2001 From: Rageking8 <106309953+Rageking8@users.noreply.github.com> Date: Fri, 20 Jun 2025 16:18:01 +0800 Subject: [PATCH 3/6] Create new "Template parameters" section in `Relog` reference --- docs/build-insights/reference/sdk/functions/relog.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/build-insights/reference/sdk/functions/relog.md b/docs/build-insights/reference/sdk/functions/relog.md index a198e3bf6e..cdb862ad34 100644 --- a/docs/build-insights/reference/sdk/functions/relog.md +++ b/docs/build-insights/reference/sdk/functions/relog.md @@ -41,7 +41,7 @@ RESULT_CODE Relog( StaticReloggerGroup reloggerGroup); ``` -### Parameters +### Template parameters *`TAnalyzerGroupMembers`*\ This parameter is always deduced. @@ -49,6 +49,8 @@ This parameter is always deduced. *`TReloggerGroupMembers`*\ This parameter is always deduced. +### Parameters + *`inputLogFile`*\ The input ETW trace that you wish to read events from. From 3a7d6baf70325c1d9129dc74f19f4c86b2fbe5b3 Mon Sep 17 00:00:00 2001 From: Rageking8 <106309953+Rageking8@users.noreply.github.com> Date: Fri, 20 Jun 2025 16:20:33 +0800 Subject: [PATCH 4/6] Tighten wording for `TAnalyzerGroupMembers` and `TReloggerGroupMembers` in `Relog` reference --- docs/build-insights/reference/sdk/functions/relog.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/build-insights/reference/sdk/functions/relog.md b/docs/build-insights/reference/sdk/functions/relog.md index cdb862ad34..c48ea76960 100644 --- a/docs/build-insights/reference/sdk/functions/relog.md +++ b/docs/build-insights/reference/sdk/functions/relog.md @@ -44,10 +44,10 @@ RESULT_CODE Relog( ### Template parameters *`TAnalyzerGroupMembers`*\ -This parameter is always deduced. +This template parameter pack is always deduced. *`TReloggerGroupMembers`*\ -This parameter is always deduced. +This template parameter pack is always deduced. ### Parameters From 6a2827aadf1332134cde7f3d8d23070278f0dba1 Mon Sep 17 00:00:00 2001 From: Rageking8 <106309953+Rageking8@users.noreply.github.com> Date: Fri, 20 Jun 2025 16:25:26 +0800 Subject: [PATCH 5/6] Add links for `CoInitialize` and `CoUninitialize` in `Relog` reference --- docs/build-insights/reference/sdk/functions/relog.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/build-insights/reference/sdk/functions/relog.md b/docs/build-insights/reference/sdk/functions/relog.md index c48ea76960..c125343a7e 100644 --- a/docs/build-insights/reference/sdk/functions/relog.md +++ b/docs/build-insights/reference/sdk/functions/relog.md @@ -79,6 +79,6 @@ The input trace is passed through the analyzer group *`numberOfAnalysisPasses`* The relogging of system events like CPU samples from within a relogger class isn't supported. Use the *`systemEventsRetentionFlags`* parameter to decide which system events to keep in the output trace. -The `relog` function depends on the COM API. You must call `CoInitialize` before you call `relog`. Call `CoUninitialize` once `relog` has finished. If you call `relog` without a call to `CoInitialize` first, you'll get error code 9 (`RESULT_CODE_FAILURE_START_RELOGGER`). +The `relog` function depends on the COM API. You must call [`CoInitialize`](/windows/win32/api/objbase/nf-objbase-coinitialize) before you call `relog`. Call [`CoUninitialize`](/windows/win32/api/combaseapi/nf-combaseapi-couninitialize) once `relog` has finished. If you call `relog` without a call to `CoInitialize` first, you'll get error code 9 (`RESULT_CODE_FAILURE_START_RELOGGER`). ::: moniker-end From 97dcde0471e12476d63c69d89374f0ca0744d7b7 Mon Sep 17 00:00:00 2001 From: Rageking8 <106309953+Rageking8@users.noreply.github.com> Date: Fri, 20 Jun 2025 16:27:49 +0800 Subject: [PATCH 6/6] Remove double quotes for `ms.date` in reference for `Relog` and variants --- docs/build-insights/reference/sdk/functions/relog-a.md | 2 +- docs/build-insights/reference/sdk/functions/relog-w.md | 2 +- docs/build-insights/reference/sdk/functions/relog.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/build-insights/reference/sdk/functions/relog-a.md b/docs/build-insights/reference/sdk/functions/relog-a.md index d2cf476c9d..36ec0048ec 100644 --- a/docs/build-insights/reference/sdk/functions/relog-a.md +++ b/docs/build-insights/reference/sdk/functions/relog-a.md @@ -1,7 +1,7 @@ --- title: "RelogA" description: "The C++ Build Insights SDK RelogA function reference." -ms.date: "02/12/2020" +ms.date: 02/12/2020 helpviewer_keywords: ["C++ Build Insights", "C++ Build Insights SDK", "RelogA", "throughput analysis", "build time analysis", "vcperf.exe"] --- # `RelogA` diff --git a/docs/build-insights/reference/sdk/functions/relog-w.md b/docs/build-insights/reference/sdk/functions/relog-w.md index 6b3430a793..d042d6ce85 100644 --- a/docs/build-insights/reference/sdk/functions/relog-w.md +++ b/docs/build-insights/reference/sdk/functions/relog-w.md @@ -1,7 +1,7 @@ --- title: "RelogW" description: "The C++ Build Insights SDK RelogW function reference." -ms.date: "02/12/2020" +ms.date: 02/12/2020 helpviewer_keywords: ["C++ Build Insights", "C++ Build Insights SDK", "RelogW", "throughput analysis", "build time analysis", "vcperf.exe"] --- # `RelogW` diff --git a/docs/build-insights/reference/sdk/functions/relog.md b/docs/build-insights/reference/sdk/functions/relog.md index c125343a7e..4bf0bb1dce 100644 --- a/docs/build-insights/reference/sdk/functions/relog.md +++ b/docs/build-insights/reference/sdk/functions/relog.md @@ -1,7 +1,7 @@ --- title: "Relog" description: "The C++ Build Insights SDK Relog function reference." -ms.date: "02/12/2020" +ms.date: 02/12/2020 helpviewer_keywords: ["C++ Build Insights", "C++ Build Insights SDK", "Relog", "throughput analysis", "build time analysis", "vcperf.exe"] --- # `Relog`