Deemphasize MSBUILDDEBUGENGINE in binlog doc #8712
Conversation
At least one person skimmed over the section we wanted to emphasize (`-bl`) and focused on `MSBUILDDEBUGENGINE`, sharing lower-fidelity logs that are harder to understand. Remove the "Preferred way" callout--it's preferred in that section but not in general. Add a section header for command-line builds. Add some samples there.
| @@ -6,23 +6,37 @@ However, you should be aware what type of information is captured in the binary | |||
|
|
|||
| ⚠ NOTE: some build environments make secrets available using environment variables. Before sharing a binary log, make sure it does not expose API tokens or other important secrets. | |||
|
|
|||
| ## Capturing Binary Logs for command-line builds | |||
There was a problem hiding this comment.
Do you want to add "preferred way" or "preferred way for command-line builds" to this header?
There was a problem hiding this comment.
That seems a bit much to me, but I pushed a change to try to both explain why VS is different and also emphasize the command-line option. Look ok?
There was a problem hiding this comment.
I'm a bit concerned someone might read that and think binlogs from VS aren't trustworthy at all. If something only reproduces from VS, I can tell it must be doing something different from a command line build...but what? How is it different? When does it build that the command line doesn't or vice versa? I think I'd be ok if I had some assurance that building from within VS isn't wrong or if I didn't see that at all, but I think this version raises more questions than it answers, personally.
ce24e12 to
1754079
Compare
| Set `MSBUILDDEBUGENGINE` environment variable to `'1'` and (optionally) set `MSBUILDDEBUGPATH` to an existing destination folder to store the captured logs. Then start Visual Studio from the same shell to inherit the environment: | ||
|
|
||
| `cmd:` | ||
| ``` | ||
|
|
||
| ```batch | ||
| > SET MSBUILDDEBUGENGINE=1 |
There was a problem hiding this comment.
@rainersigwald I see this has already been merged (and the changes look good!), but I wanted to provide feedback that using > in a sample block (both here and below) isn't ideal:
- It's already in a
batch/powershellblock and formatted appropriately. - If someone copy/pastes it directly, then it doesn't work, because
>is a redirection character.
(No need to create a new PR for this, but please keep in mind for future edits)
At least one person skimmed over the section we wanted to emphasize (
-bl) and focused onMSBUILDDEBUGENGINE, sharing lower-fidelity logs that are harder to understand.Remove the "Preferred way" callout--it's preferred in that section but not in general. Add a section header for command-line builds. Add some samples there.