Skip to content

Rename terminallogger docs and update with more details #9010

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.

Sign up for GitHub

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 1 commit into from
Jul 11, 2023
Merged

Rename terminallogger docs and update with more details #9010

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 0 additions & 19 deletions documentation/livelogger/Opt-In-Mechanism.md
View file
Open in desktop

This file was deleted.

38 changes: 38 additions & 0 deletions documentation/terminallogger/Opt-In-Mechanism.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# TerminalLogger Opt-in

## When should we use TerminalLogger

The TerminalLogger presents the user with the build's most relevant information at the time, automatically hiding all the information that is no longer relevant (as to prevent huge log outputs). However, many users might find this not very useful (or even counterproductive) such as those using a terminal without proper ANSI support or when redirecting the output to a file. For that reason, the users must be able to turn this feature on/off at will.

## Proposal

### Enabling for a single build

Using the `/terminallogger` or `/tl` command line switches, users are able to opt-in and use the TerminalLogger, EXCEPT when:

- The terminal does not support ANSI codes or color
- Output is redirected to a file or pipe

### Enabling for all builds

Users can set the `MSBUILDLIVELOGGER` environment variable to enable TerminalLogger without adding a swtich to all build invocations.

### TerminalLogger parameters

Both methods accept parameters:

- `true` forces TerminalLogger to be used even wwhen it would be disabled
- `false` forces TerminalLogger to not be used even when it would be enabled
- `auto` enables TerminalLogger when the terminal supports it and the session doesn't have redirected stdout/stderr

In cases where the TerminalLogger should not be enabled, the default ConsoleLogger should be used instead.

## Considerations

### Should TerminalLogger be used with other loggers (eg, BinaryLogger, FileLogger, custom loggers)?

TerminalLogger should only replace the current ConsoleLogger for the aforementioned cases. Additionally, other loggers can be used in conjunction.

### Should output be ignored with the `/noconsolelogger` flag enabled?

TerminalLogger serves as a replacement for ConsoleLogger, so it should behave similarly. When attaching the `/noconsolelogger` flag, it should not output anything.