Skip to content

Commit 81cb061

Browse files
author
Colin Robertson
authored
Merge pull request #1777 from 035/patch-1
Remove duplicate configuration properties
2 parents 87df165 + 65624dc commit 81cb061

File tree

1 file changed

+3
-18
lines changed

1 file changed

+3
-18
lines changed

docs/build/cmakesettings-reference.md

Lines changed: 3 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -27,11 +27,11 @@ A `configuration` has these properties:
2727
- `addressSDanitizerEnabled`: if `true` compiles the program with Address Sanitizer (Experimental on Windows). On Linux, compile with -fno-omit-frame-pointer and compiler optimization level -Os or -Oo for best results.
2828
- `addressSanitizerRuntimeFlags`: runtime flags passed to AddressSanitizer via the ASAN_OPTIONS environment variable. Format: flag1=value:flag2=value2.
2929
- `buildCommandArgs`: specifies native build switches passed to CMake after --build --. For example, passing -v when using the Ninja generator forces Ninja to output command lines. See [Ninja command line arguments](#ninja) for more information on Ninja commands.
30-
- `buildRoot`: specifies the directory in which CMake generates build scripts for the chosen generator. Maps to **-DCMAKE_BINARY_DIR** switch and specifies where the CMake cache will be created. If the folder does not exist, it is created. Supported macros include `${workspaceRoot}`, `${workspaceHash}`, `${projectFile}`, `${projectDir}`, `${thisFile}`, `${thisFileDir}`, `${name}`, `${generator}`, and `${env.VARIABLE}`.
30+
- `buildRoot`: specifies the directory in which CMake generates build scripts for the chosen generator. Maps to **-DCMAKE_BINARY_DIR** switch and specifies where *CMakeCache.txt* will be created. If the folder does not exist, it is created. Supported macros include `${workspaceRoot}`, `${workspaceHash}`, `${projectFile}`, `${projectDir}`, `${thisFile}`, `${thisFileDir}`, `${name}`, `${generator}`, `${env.VARIABLE}`.
3131
- `cacheGenerationCommand`: specifies a command line tool and arguments, for example *gencache.bat debug* to generate the cache. The command is run from the shell in the specified environment for the configuration when the user explicity requests regeneration, or a CMakeLists.txt or CMakeSettings.json file is modified.
32-
- `cacheRoot`: specifies the path to a CMake cache. This directory should contain an existing CMakeCache.txt file.
32+
- `cacheRoot`: specifies the path to a CMake cache. This directory should contain an existing *CMakeCache.txt* file.
3333
- `clangTidyChecks`: comma-separated list of warnigns which will be passed to clang-tidy; wildcards are allowed and '-' prefix will remove checks.
34-
- `cmakeCommandArgs`: specifies additional command-line options passed to CMake when invoked to generate the cache.
34+
- `cmakeCommandArgs`: specifies additional command-line options passed to CMake when invoked to generate the project files.
3535
- `cmakeToolchain`: specifies the toolchain file. This is passed to CMake using -DCMAKE_TOOLCHAIN_FILE."
3636
- `codeAnalysisRuleset`: specifies the ruleset to use when running code analysis. This can be a full path or the file name of a ruleset file installed by Visual Studio.
3737
- `configurationType`: specifies the build type configuration for the selected generator. May be one of:
@@ -74,22 +74,8 @@ When the active configuration specifies a Visual Studio generator, by default MS
7474
"buildCommandArgs": "-m:8 -v:minimal -p:PreferredToolArchitecture=x64"
7575
```
7676

77-
- `configurationType`: specifies the build type configuration for the selected generator. May be one of:
78-
79-
- Debug
80-
- Release
81-
- MinSizeRel
82-
- RelWithDebInfo
83-
84-
- `buildRoot`: specifies the directory in which CMake generates build scripts for the chosen generator. Maps to **-DCMAKE_BINARY_DIR** switch and specifies where the *CMakeCache.txt* will be created. If the folder does not exist, it is created.Supported macros include `${workspaceRoot}`, `${workspaceHash}`, `${projectFile}`, `${projectDir}`, `${thisFile}`, `${thisFileDir}`, `${name}`, `${generator}`, `${env.VARIABLE}`.
8577
- `installRoot`: specifies the directory in which CMake generates install targets for the chosen generator. Supported macros include `${workspaceRoot}`, `${workspaceHash}`, `${projectFile}`, `${projectDir}`, `${thisFile}`, `${thisFileDir}`, `${name}`, `${generator}`, `${env.VARIABLE}`.
86-
- `cmakeCommandArgs`: specifies additional command-line options passed to CMake when invoked to generate the project files.
87-
- `cmakeToolchain`: specifies the toolchain file. This is passed to CMake using -DCMAKE_TOOLCHAIN_FILE."
88-
- `buildCommandArgs`: specifies native build switches passed to CMake after --build --. For example, passing -v when using the Ninja generator forces Ninja to output command lines. See [Ninja command line arguments](#ninja) for more information on Ninja commands.
89-
- `ctestCommandArgs`: specifies additional command-line options passed to CTest when running the tests."
90-
- `codeAnalysisRuleset`: specifies the ruleset to use when running code analysis. This can be a full path or the file name of a ruleset file installed by Visual Studio.
9178
- `inheritEnvironments`: specifies one or more compiler environments that this configuration depends on. May be any custom environment or one of the predefined environments. For more information, see [Environments](#environments).
92-
- `installRoot`: specifies the directory in which CMake generates install targets for the chosen generator. Supported macros include `${workspaceRoot}`, `${workspaceHash}`, `${projectFile}`, `${projectDir}`, `${thisFile}`, `${thisFileDir}`, `${name}`, `${generator}`, `${env.VARIABLE}`.
9379
- `intelliSenseMode`: specifies the mode used for computing intellisense information". May be one of:
9480

9581
- windows-msvc-x86
@@ -112,7 +98,6 @@ When the active configuration specifies a Visual Studio generator, by default MS
11298
- linux-gcc-x64
11399
- linux-gcc-arm"
114100

115-
- `cacheRoot`: specifies the path to a CMake cache. This directory should contain an existing *CMakeCache.txt* file.
116101
- `name`: names the configuration. See [CMake predefined configuration reference](cmake-predefined-configuration-reference.md) for more information about the pre-defined configurations.
117102
- `wslPath`: the path to the launcher of an instance of Windows Subsystem for Linux.
118103

0 commit comments

Comments
 (0)