Logging behaviour doc #10859
Open
Logging behaviour doc #10859
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
donJoseLuis
approved these changes
Oct 23, 2024
JanKrivanek
reviewed
Oct 23, 2024
| There are various types of messages within MSBuild with different importances and purposes. . | ||
| There are some message types that are built-in within the engine, `errors`, `warnings`, and MSBuild engine information. The custom messages, that can come either from the engine or other sources, are selected and displayed based on the `importance` of the message. There can be high, normal, and low importance messages being displayed. | ||
|
|
||
| For more information on custom messages you can more ou Microsoft Learn page for the [MSBuild Message Task](https://learn.microsoft.com/visualstudio/msbuild/message-task) |
There was a problem hiding this comment.
Words order got broken here :-)
| The File logger saves all the build data to a file. It's verbosity is determined by passing the `verbosity` parameter to the `flp` attribute, or the default is set to `diagnostic`, and it follows the same message display rules as the console logger. | ||
|
|
||
| ### Binary logger / build logger | ||
| The binary logger is a bit different as it does not have a verbosity option. It includes all messages, projects and files from the build by default. |
There was a problem hiding this comment.
Suggested change
| The binary logger is a bit different as it does not have a verbosity option. It includes all messages, projects and files from the build by default. | |
| The binary logger does not have a verbosity option. It includes all messages, projects and files from the build by default. |
| | Low-importance messages | | ||
| | MSBuild engine information | | ||
|
|
||
| ### File logger |
There was a problem hiding this comment.
I'd reorder to make it correspond with how often we'd expect people use the different loggers:
- TL
- BL
- CL
- FL (it references CL so they should be together imo)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #10676
Context
There has some confusion about which logs display what type of message. This is to clarify what is to be expected from each logger and verbosity.