diff options
| author | Martin Duffy <martin.duffy@kitware.com> | 2024-08-16 12:49:10 (GMT) |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2024-08-22 14:24:23 (GMT) |
| commit | 1df94443fe5a24e43325b95d93043e8bf5565fa2 (patch) | |
| tree | 8657e1e1d54ed7ccdac6b249fb09b4bc65d709c8 /Help | |
| parent | a991a5019b87ab7119b2e7b92434c8f006404519 (diff) | |
| download | CMake-1df94443fe5a24e43325b95d93043e8bf5565fa2.zip CMake-1df94443fe5a24e43325b95d93043e8bf5565fa2.tar.gz CMake-1df94443fe5a24e43325b95d93043e8bf5565fa2.tar.bz2 | |
fileapi: Add support for user-wide queries
Fixes: #19168
Diffstat (limited to 'Help')
| -rw-r--r-- | Help/envvar/CMAKE_CONFIG_DIR.rst | 18 | ||||
| -rw-r--r-- | Help/manual/cmake-env-variables.7.rst | 3 | ||||
| -rw-r--r-- | Help/manual/cmake-file-api.7.rst | 4 | ||||
| -rw-r--r-- | Help/manual/cmake.1.rst | 8 |
4 files changed, 32 insertions, 1 deletions
diff --git a/Help/envvar/CMAKE_CONFIG_DIR.rst b/Help/envvar/CMAKE_CONFIG_DIR.rst new file mode 100644 index 0000000..1b5f14f --- /dev/null +++ b/Help/envvar/CMAKE_CONFIG_DIR.rst @@ -0,0 +1,18 @@ +CMAKE_CONFIG_DIR +---------------- + +.. versionadded:: 3.31 + +.. include:: ENV_VAR.txt + +Specify a CMake user-wide configuration directory for +:manual:`cmake-file-api(7)` queries. + +If this environment variable is not set, the default user-wide +configuration directory is platform-specific: + +- Windows: ``%LOCALAPPDATA%\CMake`` +- macOS: ``$XDG_CONFIG_HOME/CMake`` if set, otherwise + ``$HOME/Library/Application Support/CMake`` +- Linux/Other: ``$XDG_CONFIG_HOME/cmake`` if set, otherwise + ``$HOME/.config/cmake`` diff --git a/Help/manual/cmake-env-variables.7.rst b/Help/manual/cmake-env-variables.7.rst index 68ee79a..b2ceeae 100644 --- a/Help/manual/cmake-env-variables.7.rst +++ b/Help/manual/cmake-env-variables.7.rst @@ -43,8 +43,9 @@ Environment Variables that Control the Build /envvar/CMAKE_BUILD_PARALLEL_LEVEL /envvar/CMAKE_BUILD_TYPE /envvar/CMAKE_COLOR_DIAGNOSTICS - /envvar/CMAKE_CONFIGURATION_TYPES + /envvar/CMAKE_CONFIG_DIR /envvar/CMAKE_CONFIG_TYPE + /envvar/CMAKE_CONFIGURATION_TYPES /envvar/CMAKE_CROSSCOMPILING_EMULATOR /envvar/CMAKE_EXPORT_COMPILE_COMMANDS /envvar/CMAKE_GENERATOR diff --git a/Help/manual/cmake-file-api.7.rst b/Help/manual/cmake-file-api.7.rst index 260030e..a4ce5de 100644 --- a/Help/manual/cmake-file-api.7.rst +++ b/Help/manual/cmake-file-api.7.rst @@ -50,6 +50,10 @@ It has the following subdirectories: Clients may optionally create the ``reply/`` directory at any time and monitor it for the appearance of a new reply index file. +.. versionadded:: 3.31 + Users can add query files to ``api/v1/query`` inside the + :envvar:`CMAKE_CONFIG_DIR` to create user-wide queries for all CMake projects. + v1 Shared Stateless Query Files ------------------------------- diff --git a/Help/manual/cmake.1.rst b/Help/manual/cmake.1.rst index 794ef96..586a72e 100644 --- a/Help/manual/cmake.1.rst +++ b/Help/manual/cmake.1.rst @@ -266,6 +266,14 @@ Options from the top of a binary tree for a CMake project it will dump additional information such as the cache, log files etc. +.. option:: --print-config-dir + + .. versionadded:: 3.31 + + Print CMake config directory for user-wide FileAPI queries. + + See :envvar:`CMAKE_CONFIG_DIR` for more details. + .. option:: --log-level=<level> .. versionadded:: 3.16 |