Write some documentation about the build rules (followup to #3429) #4825

Open
opened 2026-01-30 23:57:34 +00:00 by claunia · 0 comments
Owner

Originally created by @DHowett-MSFT on GitHub (Nov 5, 2019).

Originally assigned to: @DHowett on GitHub.

The one comment I'd like you to follow up on eventually is:
"Please make a docs\MSBuildWizardry.md with all the rules and nuances here."

I feel like we're doing a lot of custom or interesting MSBuild stuff which should be documented somehow like:

  1. Moving the properties up to the top above the pre props so we can selectively pick them out in the pre files
  2. List out what's supposed to go in pre (properties) and post (item groups) and when exceptions are OK (when stuff like link dependencies has to be in a specific spot)
  3. Talk about the nuance of why most things are .vcxitems for just "grab bags" except the one that the WAP project references which is just .items (because the WAP project throws a fit and it is doing a simple extension match and will ignore it as just .items).

And so on and so forth. Maybe also include a link to that log debugging tool you used and how to generate a binlog.

Originally posted by @miniksa in https://github.com/microsoft/terminal/pull/3429#issuecomment-550048345

Originally created by @DHowett-MSFT on GitHub (Nov 5, 2019). Originally assigned to: @DHowett on GitHub. The one comment I'd like you to follow up on eventually is: "Please make a docs\MSBuildWizardry.md with all the rules and nuances here." I feel like we're doing a lot of custom or interesting MSBuild stuff which should be documented somehow like: 1. Moving the properties up to the top above the pre props so we can selectively pick them out in the pre files 2. List out what's supposed to go in pre (properties) and post (item groups) and when exceptions are OK (when stuff like link dependencies has to be in a specific spot) 3. Talk about the nuance of why most things are .vcxitems for just "grab bags" except the one that the WAP project references which is just .items (because the WAP project throws a fit and it is doing a simple extension match and will ignore it as just .items). And so on and so forth. Maybe also include a link to that log debugging tool you used and how to generate a binlog. _Originally posted by @miniksa in https://github.com/microsoft/terminal/pull/3429#issuecomment-550048345_
claunia added the Needs-Tag-FixIssue-DocsProduct-MetaArea-Build labels 2026-01-30 23:57:34 +00:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/terminal#4825