User config file description update #9900
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@maridematte : Thanks for your contribution! The author(s) have been notified to review your proposed change. |
|
@baronfel, update on the |
|
Learn Build status updates of commit ca42e07: ✅ Validation status: passed
For more details, please refer to the build report. For any questions, please:
|
|
Can you review the proposed changes? When the changes are ready for publication, add a #label:"aq-pr-triaged" |
ghogen
reviewed
Jan 10, 2024
|
Learn Build status updates of commit 7c24d70:
|
| @@ -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. | |||
There was a problem hiding this comment.
Suggested change
| 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. | |
| 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 excluded in the default Visual Studio `.gitignore`. For more extensive changes prefer changing the project itself, so that future maintainers do not have to know about this extension mechanism. |
| *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. |
There was a problem hiding this comment.
"inner" and "outer" builds are not generally user-facing concepts, so I'm not sure this is the best way to phrase this. @ghogen, what happened is that prior to 17.9, the .user file was imported only for the inner build, so it wasn't usable to tweak things like packaging. @maridematte made it more consistent for 17.9+. See dotnet/msbuild#9131 / dotnet/msbuild#9558. Can you think of a way to say that that's a bit more friendly?
Comment on lines
+23
to
+26
| 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')"/> | ||
| ``` |
There was a problem hiding this comment.
What motivated the "do it manually for a custom project type" stuff @maridematte? It's good advice but I'm not sure if users will be looking for that kind of thing in the context of this document.
There was a problem hiding this comment.
Since this is one of the only places that mention .user files I thought to add this bit here as it would feel out of place anywhere else. I think it is a useful bit of information to have in the docs and since it is short enough I think it is ok to add here even if it doesn't completely fit with the context of the document.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Added a bit more info on the
.userconfiguration file for MSBuild, since we did not have a lot previously.