Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Init of msbuild env variables document #9753

Merged
merged 1 commit into from
Feb 20, 2024

Conversation

f-alizada
Copy link
Contributor

Fixes #9739

Context

Please see the description in attached issue

Changes Made

Added the new file in wiki, which will describe the behavior and usage of different environment variables that are being respected and used in MSBuild.

Testing

Nothing to test

Notes

Next steps would be to transfer all environment variables from https://github.com/dotnet/msbuild/blob/main/documentation/wiki/MSBuild-Tips-%26-Tricks.md to have a separate well indexed file for easy search.

@JanKrivanek
Copy link
Member

Thank you for taking time to document this!!

It feels all the magic env vars should be documented on a single place - how about merging this info into

or vice versa extracting (and linking) the Tips&Tricks Env Vars section to this doc?

@f-alizada
Copy link
Contributor Author

Thank you for taking time to document this!!

It feels all the magic env vars should be documented on a single place - how about merging this info into

or vice versa extracting (and linking) the Tips&Tricks Env Vars section to this doc?

Thank you for mentioning that! :) Actually I was planing to do that once current initiative with env variables in separate file is approved. As was mentioned in the PR description I suggest to link (as you mentioned) the MSBuild tips and tricks to this file, for proper indexing and easy search online, but of course this suggestion is open to discussion!

@JanKrivanek
Copy link
Member

Oh I see now. Sounds good to me!

Copy link
Member

@AR-May AR-May left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Having MSBuild env variables documented in one place seems very reasonable to me for searching purposes.

@f-alizada f-alizada merged commit 53c4f49 into dotnet:main Feb 20, 2024
8 checks passed
@rainersigwald
Copy link
Member

I'm not opposed to putting together a better list for our own purposes, but we need to be clear that most of the environment variables are intentionally undocumented and unsupported. They're there primarily as emergency escape hatches for users who get into bad problems, and we don't test the combinations and so on.

@f-alizada f-alizada deleted the dev/f-alizada/envlist-doc branch June 14, 2024 10:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Documentation]: Document the env variable: MsBuildSkipEagerWildCardEvaluationRegexes
4 participants