summaryrefslogtreecommitdiffstats
path: root/Help/manual
diff options
context:
space:
mode:
authorMartin Duffy <martin.duffy@kitware.com>2024-08-16 12:49:10 (GMT)
committerBrad King <brad.king@kitware.com>2024-08-22 14:24:23 (GMT)
commit1df94443fe5a24e43325b95d93043e8bf5565fa2 (patch)
tree8657e1e1d54ed7ccdac6b249fb09b4bc65d709c8 /Help/manual
parenta991a5019b87ab7119b2e7b92434c8f006404519 (diff)
downloadCMake-1df94443fe5a24e43325b95d93043e8bf5565fa2.zip
CMake-1df94443fe5a24e43325b95d93043e8bf5565fa2.tar.gz
CMake-1df94443fe5a24e43325b95d93043e8bf5565fa2.tar.bz2
fileapi: Add support for user-wide queries
Fixes: #19168
Diffstat (limited to 'Help/manual')
-rw-r--r--Help/manual/cmake-env-variables.7.rst3
-rw-r--r--Help/manual/cmake-file-api.7.rst4
-rw-r--r--Help/manual/cmake.1.rst8
3 files changed, 14 insertions, 1 deletions
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