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 |
| > [!NOTE] | ||
| > Since the binary logger includes a substantial amount of information from the build, large builds can experience measurable overhead when it is enabled. | ||
| > Users with large, complex builds should consider only using the binary logger when necessary to avoid the potential for longer overall build times. |
|
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. |
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.