Skip to content

Commit

Permalink
Merge pull request #9900 from maridematte/userConfigFile
Browse files Browse the repository at this point in the history
User config file description update
  • Loading branch information
ghogen authored Jan 10, 2024
2 parents 7a48f4b + 7c24d70 commit 330e139
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion docs/msbuild/customize-your-local-build.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,12 @@ When you work in a team that used a code repository like GitHub, source control,

## .user file

*Microsoft.Common.CurrentVersion.targets* imports `$(MSBuildProjectFullPath).user` if it exists, so you can create a file next to your project with that additional extension. For long-term changes you plan to check into source control, prefer changing the project itself, so that future maintainers do not have to know about this extension mechanism.
Using `$(MSBuildProjectFullPath).user`, also referred as `.user` file in this context, is also an option. This file is intended to keep extensions, options, or variables that are specific to your local machine. It is not intended to be uploaded to source control, and it is automatically checked on `.gitignore`. For more extensive changes prefer changing the project itself, so that future maintainers do not have to know about this extension mechanism.

On supported multitargeted projects the `.user` file is automatically imported in inner builds and outer builds, so you can just create the file within the solution. If you are working on another type of build, you can still use the `.user` file. You can create it within your solution and then import it in your project file.
```xml
<Import Project="$(MSBuildProjectFullPath).user" Condition="Exists('$(MSBuildProjectFullPath).user')"/>
```

## MSBuildExtensionsPath and MSBuildUserExtensionsPath

Expand Down

0 comments on commit 330e139

Please sign in to comment.