Skip to content

Update vcperf-commands.md #4375

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Feb 23, 2023

Conversation

NelsonDaniel
Copy link
Contributor

Update commands documentation according to https://github.com/microsoft/vcperf#command-line-reference

@prmerger-automator
Copy link
Contributor

@NelsonDaniel : Thanks for your contribution! The author(s) have been notified to review your proposed change.

@prmerger-automator
Copy link
Contributor

@NelsonDaniel : Thanks for your contribution! The author(s) have been notified to review your proposed change.

@learn-build-service-prod
Copy link
Contributor

Learn Build status updates of commit 491bc61:

✅ Validation status: passed

File Status Preview URL Details
docs/build-insights/reference/vcperf-commands.md ✅Succeeded

For more details, please refer to the build report.

Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report.

For any questions, please:

@prmerger-automator
Copy link
Contributor

PRMerger Results

Issue Description
File Change Percent This PR contains file(s) with more than 20% file change.

@learn-build-service-prod
Copy link
Contributor

Learn Build status updates of commit 1312c8d:

✅ Validation status: passed

File Status Preview URL Details
docs/build-insights/reference/vcperf-commands.md ✅Succeeded

For more details, please refer to the build report.

Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report.

For any questions, please:

@prmerger-automator
Copy link
Contributor

PRMerger Results

Issue Description
File Change Percent This PR contains file(s) with more than 20% file change.

@Jak-MS
Copy link
Contributor

Jak-MS commented Jan 19, 2023

@kevcadieux

  • Can you review this PR?
  • IMPORTANT: When this content is ready to merge, you must add #sign-off in a comment or the approval may get overlooked.

#label:"aq-pr-triaged"
@MicrosoftDocs/public-repo-pr-review-team

@prmerger-automator prmerger-automator bot added the aq-pr-triaged Tracking label for the PR review team label Jan 19, 2023
@@ -18,23 +18,23 @@ This article lists and describes the commands available in *`vcperf.exe`*, and h
## Commands to start and stop traces

> [!IMPORTANT]
> The following commands all require administrative privileges.
> Unless /noadmin is provided, the following commands require administrative privileges.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider adding this note "Unless /noadmin is provided" in the vcperf documentation on GitHub as well.

@kevcadieux
Copy link
Contributor

@Jak-MS I reviewed the PR. I will let @NelsonDaniel sign off when he is ready.

@Court72
Copy link
Contributor

Court72 commented Jan 23, 2023

Hi @kevcadieux

Thanks for reviewing the PR!

FYI - in the public repos, PRMerger will accept sign-off from the listed author only (hence the need for you to add a #sign-off comment to signal that the PR is ready for the review team to merge).

Thanks.

@colin-home
Copy link
Contributor

@NelsonDaniel

Which version of the product do the /noadmin, /templates, and /levelN options appear in?

Stashing this update for Acrolinx and i18n here:

> [!IMPORTANT]
> Unless you specify `/noadmin`, the following commands require administrative privileges.

| Option           | Arguments and description |
|------------------|---------------------------|
| `/start`         | [`/noadmin`] [`/nocpusampling`] [`/level1` \| `/level2` \| `/level3`] `<sessionName>` |
|                  | Starts a trace under the given session name. <br/><br/> The `/noadmin` option runs *vcperf.exe* without admin privileges, and it ignores the `/nocpusampling` option. When you run vcperf without admin privileges, there can be more than one active session on a given machine. <br/><br/> The `/nocpusampling` option specifies *vcperf.exe* doesn't collect CPU samples. It prevents the use of the CPU Usage (Sampled) view in Windows Performance Analyzer, but makes the collected traces smaller. <br/><br/> The `/level1`, `/level2`, or `/level3` options specify which MSVC events to collect, in increasing level of information. Level 3 includes all events. Level 2 includes all events except template instantiation events. Level 1 includes all events except template instantiation, function, and file events. If unspecified, `/level2` is selected by default. <br/><br/> Once *vcperf.exe* starts tracing, it returns immediately. The trace collects events system-wide for all processes running on the machine. That means that you don't need to build your project in the same command prompt window as the one you use to run *vcperf.exe*. For example, you can build your project in Visual Studio. |
| `/stop`          | (1) [`/templates`] `<sessionName> <outputFile.etl>` <br/> (2) [`/templates`] `<sessionName> /timetrace <outputFile.json>` |
|                  | Stops the trace identified by the given session name. Runs a post-processing step on the trace to generate a file specified by the `<outputFile>` parameter. <br/><br/> The `/templates` option includes template instantiation events in the file. <br/><br/> (1) Generates a file viewable in Windows Performance Analyzer (WPA). The output file requires a `.etl` extension.<br/>(2) Generates a file viewable in the Microsoft Edge trace viewer (`edge://tracing`). The output file requires a `.json` extension. |
| `/stopnoanalyze` | `<sessionName> <rawOutputFile.etl>` |
|                  | Stops the trace identified by the given session name and writes the raw, unprocessed data in the specified output file. The resulting file isn't meant for viewing in WPA. <br/><br/> The post-processing step involved in the `/stop` command can sometimes be lengthy. You can use the `/stopnoanalyze` command to delay this post-processing step. Use the `/analyze` command when you're ready to produce a file viewable in Windows Performance Analyzer or the Microsoft Edge trace viewer. |

## Miscellaneous commands

| Option     | Arguments and description |
|------------|---------------------------|
| `/analyze` | (1) [`/templates`] `<rawInputFile.etl> <outputFile.etl>` <br/>(2) [`/templates`] `<rawInputFile.etl> /timetrace <outputFile.json>` |
|            | Accepts a raw trace file produced by the `/stopnoanalyze` command. Runs a post-processing step on this trace to generate the file specified by the `<outputFile>` parameter. <br/><br/> The `/templates` option includes template instantiation events in the file. <br/><br/> (1) Generates a file viewable in Windows Performance Analyzer (WPA). The output file requires a `.etl` extension. <br/><br/> (2) Generates a file viewable in the Microsoft Edge trace viewer (`edge://tracing`). The output file requires a `.json` extension. |

@NelsonDaniel
Copy link
Contributor Author

@NelsonDaniel

Which version of the product do the /noadmin, /templates, and /levelN options appear in?

Stashing this update for Acrolinx and i18n here:

> [!IMPORTANT]
> Unless you specify `/noadmin`, the following commands require administrative privileges.

| Option           | Arguments and description |
|------------------|---------------------------|
| `/start`         | [`/noadmin`] [`/nocpusampling`] [`/level1` \| `/level2` \| `/level3`] `<sessionName>` |
|                  | Starts a trace under the given session name. <br/><br/> The `/noadmin` option runs *vcperf.exe* without admin privileges, and it ignores the `/nocpusampling` option. When you run vcperf without admin privileges, there can be more than one active session on a given machine. <br/><br/> The `/nocpusampling` option specifies *vcperf.exe* doesn't collect CPU samples. It prevents the use of the CPU Usage (Sampled) view in Windows Performance Analyzer, but makes the collected traces smaller. <br/><br/> The `/level1`, `/level2`, or `/level3` options specify which MSVC events to collect, in increasing level of information. Level 3 includes all events. Level 2 includes all events except template instantiation events. Level 1 includes all events except template instantiation, function, and file events. If unspecified, `/level2` is selected by default. <br/><br/> Once *vcperf.exe* starts tracing, it returns immediately. The trace collects events system-wide for all processes running on the machine. That means that you don't need to build your project in the same command prompt window as the one you use to run *vcperf.exe*. For example, you can build your project in Visual Studio. |
| `/stop`          | (1) [`/templates`] `<sessionName> <outputFile.etl>` <br/> (2) [`/templates`] `<sessionName> /timetrace <outputFile.json>` |
|                  | Stops the trace identified by the given session name. Runs a post-processing step on the trace to generate a file specified by the `<outputFile>` parameter. <br/><br/> The `/templates` option includes template instantiation events in the file. <br/><br/> (1) Generates a file viewable in Windows Performance Analyzer (WPA). The output file requires a `.etl` extension.<br/>(2) Generates a file viewable in the Microsoft Edge trace viewer (`edge://tracing`). The output file requires a `.json` extension. |
| `/stopnoanalyze` | `<sessionName> <rawOutputFile.etl>` |
|                  | Stops the trace identified by the given session name and writes the raw, unprocessed data in the specified output file. The resulting file isn't meant for viewing in WPA. <br/><br/> The post-processing step involved in the `/stop` command can sometimes be lengthy. You can use the `/stopnoanalyze` command to delay this post-processing step. Use the `/analyze` command when you're ready to produce a file viewable in Windows Performance Analyzer or the Microsoft Edge trace viewer. |

## Miscellaneous commands

| Option     | Arguments and description |
|------------|---------------------------|
| `/analyze` | (1) [`/templates`] `<rawInputFile.etl> <outputFile.etl>` <br/>(2) [`/templates`] `<rawInputFile.etl> /timetrace <outputFile.json>` |
|            | Accepts a raw trace file produced by the `/stopnoanalyze` command. Runs a post-processing step on this trace to generate the file specified by the `<outputFile>` parameter. <br/><br/> The `/templates` option includes template instantiation events in the file. <br/><br/> (1) Generates a file viewable in Windows Performance Analyzer (WPA). The output file requires a `.etl` extension. <br/><br/> (2) Generates a file viewable in the Microsoft Edge trace viewer (`edge://tracing`). The output file requires a `.json` extension. |

Here is the release version: https://github.com/microsoft/vcperf/releases/tag/2.1.22062801

@prmerger-automator
Copy link
Contributor

@NelsonDaniel : Thanks for your contribution! The author(s) have been notified to review your proposed change.

@learn-build-service-prod
Copy link
Contributor

Learn Build status updates of commit 8fb952a:

✅ Validation status: passed

File Status Preview URL Details
docs/build-insights/reference/vcperf-commands.md ✅Succeeded

For more details, please refer to the build report.

Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report.

For any questions, please:

@prmerger-automator
Copy link
Contributor

PRMerger Results

Issue Description
File Change Percent This PR contains file(s) with more than 20% file change.

@colin-home colin-home merged commit bc381a6 into MicrosoftDocs:main Feb 23, 2023
@colin-home
Copy link
Contributor

@NelsonDaniel Thanks for the update. I assume since @kevcadieux made only one comment that it otherwise passed his review, so I merged it.

learn-build-service-prod bot added a commit that referenced this pull request Feb 23, 2023
…//github.com/MicrosoftDocs/cpp-docs (branch main) (#4817)

* Update vcperf-commands.md (#4375)

* Update vcperf-commands.md

Update commands according to https://github.com/microsoft/vcperf#command-line-reference

* Update vcperf-commands.md

* Update with grammar fixes for i18n

---------

Co-authored-by: Colin Robertson <[email protected]>

* Update tutorial-import-stl-named-module.md (#4429)

* Update tutorial-import-stl-named-module.md

The Title of the document doesn't reveal that this procedure is only for a command line case.  Suggest altering the titles to reflect this and improve clarity for readers searching for module documentation.

* Update tutorial-import-stl-named-module.md

Changed the capitalization at Microsoft's request.

---------

Co-authored-by: huypub <[email protected]>
Co-authored-by: learn-build-service-prod[bot] <113403604+learn-build-service-prod[bot]@users.noreply.github.com>
Co-authored-by: Nelson Daniel Troncoso <[email protected]>
Co-authored-by: Colin Robertson <[email protected]>
Co-authored-by: Centurion Maximus <[email protected]>
TylerMSFT pushed a commit that referenced this pull request Feb 23, 2023
* rewording ReadString documentation to be more accurate (#4815)

* reword nmax parameter wording for ReadString to be more accurate

* change suggested directory location

* acrolinx

* incorp review

* fix path

* improve path

* Confirm merge from FromPublicMasterBranch to main to sync with https://github.com/MicrosoftDocs/cpp-docs (branch main) (#4817)

* Update vcperf-commands.md (#4375)

* Update vcperf-commands.md

Update commands according to https://github.com/microsoft/vcperf#command-line-reference

* Update vcperf-commands.md

* Update with grammar fixes for i18n

---------

Co-authored-by: Colin Robertson <[email protected]>

* Update tutorial-import-stl-named-module.md (#4429)

* Update tutorial-import-stl-named-module.md

The Title of the document doesn't reveal that this procedure is only for a command line case.  Suggest altering the titles to reflect this and improve clarity for readers searching for module documentation.

* Update tutorial-import-stl-named-module.md

Changed the capitalization at Microsoft's request.

---------

Co-authored-by: huypub <[email protected]>
Co-authored-by: learn-build-service-prod[bot] <113403604+learn-build-service-prod[bot]@users.noreply.github.com>
Co-authored-by: Nelson Daniel Troncoso <[email protected]>
Co-authored-by: Colin Robertson <[email protected]>
Co-authored-by: Centurion Maximus <[email protected]>

* fix casing and wording

* acrolinx

---------

Co-authored-by: Anju del Moral Gonzalez <[email protected]>
Co-authored-by: TylerMSFT <[email protected]>
Co-authored-by: prmerger-automator[bot] <40007230+prmerger-automator[bot]@users.noreply.github.com>
Co-authored-by: learn-build-service-prod[bot] <113403604+learn-build-service-prod[bot]@users.noreply.github.com>
Co-authored-by: huypub <[email protected]>
Co-authored-by: Nelson Daniel Troncoso <[email protected]>
Co-authored-by: Colin Robertson <[email protected]>
Co-authored-by: Centurion Maximus <[email protected]>
Co-authored-by: Jak Koke <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants