Add documentation about caching in MSBuild #11880
Conversation
There was a problem hiding this comment.
Pull Request Overview
Adds a detailed documentation page explaining the new MSBuild ResultsCache feature, how it stores and retrieves build outcomes, interacts with request flags, and integrates with other MSBuild components.
- Introduces
Results-Cache.mdwith an overview, core responsibilities, flag behaviors, and component interactions. - Includes a flow diagram placeholder and deep dives into build flags and cache compatibility.
- Describes how
ResultsCacheworks alongsideScheduler,BuildResult, andBuildRequest.
documentation/wiki/Results-Cache.md
Outdated
|
|
||
| * **Flags Affecting Build Behavior:** | ||
| * `IgnoreMissingEmptyAndInvalidImports`: This flag changes how MSBuild handles project imports. If a cached outcome was generated with a different setting for this flag than the current request, the cache might consider it a mismatch because the project evaluation could have been different. | ||
| * `FailOnUnresolvedSdk`: Similar to the imports flag, this affects SDK resolution. A cached outcome from a build with a different SDK resolution strategy might not be reusable. |
There was a problem hiding this comment.
Under what circumstances will it be reusable?
There was a problem hiding this comment.
The cached build had FailOnUnresolvedSdk flag set and the current build request had it set too
msbuild/src/Build/BackEnd/Components/Caching/ResultsCache.cs
Lines 363 to 367 in f88eb76
There was a problem hiding this comment.
Can we state that explicitly then please? The sentence is somewhat weird. I'm not sure about "might" in the context of the documentation.
Add documentation about caching in MSBuild