Skip to content

Commit

Permalink
General performance plan one pager (#11048)
Browse files Browse the repository at this point in the history
* General performance plan one pager.

---------

Co-authored-by: Jan Krivanek <jankrivanek@microsoft.com>
Co-authored-by: Chet Husk <baronfel@users.noreply.github.com>
  • Loading branch information
3 people authored Jan 14, 2025
1 parent 71e99de commit a273f56
Showing 1 changed file with 41 additions and 0 deletions.
41 changes: 41 additions & 0 deletions documentation/specs/proposed/General_perf_onepager.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# General performance improvements
MSBuild is the main tool used for building various types of projects. It is used by Visual Studio, the .NET CLI, and other build tools. The performance of MSBuild is critical to the productivity of developers. This document outlines our goals to improve overall performance of MSBuild.

## Goals and Motivation

We are aiming for:
- Searching for opportunities to improve evaluation and build times. We can utilize the data collected by ETW traces, the VS perf lab, and previously identified performance issues.
- Reducing MSBuild overhead in the Visual Studio IDE.
- Collecting data to understand the current performance bottlenecks.

This document does not cover specific performance improvements, but rather outlines the general goals and motivation for the performance improvements.

## Impact

- Opening project/solution, branch switching and other operations using MSBuild code in VS should be less impacted by the MSBuild.
- Overall build times should be reduced.
- Even a small improvement can save a lot of time and computing resources across all builds done daily worldwide.

## Stakeholders

- Chet Husk (PM) - as a customer advocate
- David Kean - as a VS performance expert

## Risks

- Performance improvements might not be as significant as expected.
- We can break existing functionality while making changes.
- Some ideas and performance measurement findings might need to be skipped due to technical limitations or complexity/improvements ratio.

## Cost

Performance improvements are a long-term investment. We need to balance the cost of the improvements with the expected benefits.
We will need to invest time in collecting data, analyzing the data, and implementing improvements.

Our goal in this scope is to find small and medium size opprotunities (Achievable within a single sprint with 1-2 dev investment). Bigger functionalities such as evaluation caching and RAR caching are described in separate documents.

## Plan

- Collect data on the current performance bottlenecks.
- Identify opportunities for improvements.
- Implement improvements in time-boxed iterations.

0 comments on commit a273f56

Please sign in to comment.