Add documentation regarding the "unspecified" architecture feature #3282
Conversation
Add documentation regarding "unspecified" architecture such that it provides an option for someone to ensure that no inherited environment is selected.
|
@gcampbell-msft : Thanks for your contribution! The author(s) have been notified to review your proposed change. |
docs/build/cmake-presets-vs.md
Outdated
| @@ -264,6 +264,8 @@ The `architecture.strategy` and `toolset.strategy` values tell CMake how to hand | |||
|
|
|||
| You should use `set` with IDE generators like the Visual Studio Generator. You should use `external` with command-line generators like Ninja. These values allow vendors like Visual Studio to source the required environment before CMake is invoked. For more information about the architecture and toolset fields, see the [list of Configure Presets](https://cmake.org/cmake/help/latest/manual/cmake-presets.7.html#configure-preset). | |||
|
|
|||
| Additionally, if you do not want any environment sourced, you can set architecture.value to "unspecified" and architecture.strategy to "external". However, you can only do this if you have Ninja set as the generator. Not having any environment sourced could be useful in cases where you are using a toolset other than MSVC where you don't need a specific environment in order to build, or you are in a linux/non-Windows environment. | |||
There was a problem hiding this comment.
Does this have to been used with Ninja? I thought it would apply to any command-line generator.
There was a problem hiding this comment.
This was based on @bobbrow notes regarding this PR in our email chain saying that the Ninja generator was a requirement.
|
@gcampbell-msft : Thanks for your contribution! The author(s) have been notified to review your proposed change. |
|
@gcampbell-msft : Thanks for your contribution! The author(s) have been notified to review your proposed change. |
There was a problem hiding this comment.
@gcampbell-msft LGTM. I'll merge the PR when you say you're done.
|
@gcampbell-msft : Thanks for your contribution! The author(s) have been notified to review your proposed change. |
Add "or" to final bullet point
|
@corob-msft : Thanks for your contribution! The author(s) have been notified to review your proposed change. |
|
@ktoliver : Thanks for your contribution! The author(s) have been notified to review your proposed change. |
This allows for a feature that does not source an environment to the user. This is useful in non-Windows situations where the user does not want any environment sourced.