Update binary logger docs#11369
Conversation
|
@jeffkl : Thanks for your contribution! The author(s) and reviewer(s) have been notified to review your proposed change. |
There was a problem hiding this comment.
Pull request overview
This PR updates the MSBuild logging documentation to better explain what is captured in a binary log (.binlog) and to set expectations about potential overhead when enabling binary logging on very large builds.
Changes:
- Adds a bullet list describing what information is included in a binary log.
- Adds a NOTE calling out potential performance overhead for large, complex builds when the binary logger is enabled.
| The binary log includes the following information from a build: | ||
| - Logged messages with the `diagnostic` verbosity level | ||
| - The full contents of files imported by each project |
There was a problem hiding this comment.
@jeffkl Can you evaluate Copilot's suggestions here?
There was a problem hiding this comment.
I'd say its subjective. Build events means less to me personally than messages. Warnings and errors are just messages. I don't think the binary log contains "diagnostic MSBuild-engine information" either. You can set a different env var to get that sort of logging.
But just adding the binary logger from the command-line just gives you a binary log, setting the MSBuildDebugEngine env var gives you a binary log and MSBuild engine diagnostic information. This part of the docs as far as I know is just talking about getting a binary log through a command-line argument.
|
Hi @jeffkl - This pull request was opened in the public repo. Microsoft contributors should work in the private repo, per the Microsoft Docs contributor guide. We can keep this PR open for review and merge, but would you make future content updates in the private repo? Thank you! Can you review the proposed changes? Important: When the changes are ready for publication, adding a #label:"aq-pr-triaged" |
prmerger-automator
Bot
added
the
aq-pr-triaged
|
Learn Build status updates of commit 05f7431: ✅ Validation status: passed
For more details, please refer to the build report. |
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
|
Learn Build status updates of commit 3f2731a: ✅ Validation status: passed
For more details, please refer to the build report. |
This update lists all of the things included in a binary log and adds a note that very large builds should consider not using it for every single build as it can add overhead.